d2d40728b3610abd80effa54112450ebdf660647
[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@exim.org'&   "Moderated, low volume announcements list"
448 .row &'exim-users@exim.org'&      "General discussion list"
449 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
450 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
451 .endtable
452
453 You can subscribe to these lists, change your existing subscriptions, and view
454 or search the archives via the mailing lists link on the Exim home page.
455 .cindex "Debian" "mailing list for"
456 If you are using a Debian distribution of Exim, you may wish to subscribe to
457 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
458 via this web page:
459 .display
460 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
461 .endd
462 Please ask Debian-specific questions on that list and not on the general Exim
463 lists.
464
465 .section "Bug reports" "SECID5"
466 .cindex "bug reports"
467 .cindex "reporting bugs"
468 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
469 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
470 whether some behaviour is a bug or not, the best thing to do is to post a
471 message to the &'exim-dev'& mailing list and have it discussed.
472
473
474
475 .section "Where to find the Exim distribution" "SECTavail"
476 .cindex "FTP site"
477 .cindex "HTTPS download site"
478 .cindex "distribution" "FTP site"
479 .cindex "distribution" "https site"
480 The master distribution site for the Exim distribution is
481 .display
482 &url(https://downloads.exim.org/)
483 .endd
484 The service is available over HTTPS, HTTP and FTP.
485 We encourage people to migrate to HTTPS.
486
487 The content served at &url(https://downloads.exim.org/) is identical to the
488 content served at &url(https://ftp.exim.org/pub/exim) and
489 &url(ftp://ftp.exim.org/pub/exim).
490
491 If accessing via a hostname containing &'ftp'&, then the file references that
492 follow are relative to the &_exim_& directories at these sites.
493 If accessing via the hostname &'downloads'& then the subdirectories described
494 here are top-level directories.
495
496 There are now quite a number of independent mirror sites around
497 the world. Those that I know about are listed in the file called &_Mirrors_&.
498
499 Within the top exim directory there are subdirectories called &_exim3_& (for
500 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
501 distributions), and &_Testing_& for testing versions. In the &_exim4_&
502 subdirectory, the current release can always be found in files called
503 .display
504 &_exim-n.nn.tar.xz_&
505 &_exim-n.nn.tar.gz_&
506 &_exim-n.nn.tar.bz2_&
507 .endd
508 where &'n.nn'& is the highest such version number in the directory. The three
509 files contain identical data; the only difference is the type of compression.
510 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
511 most portable to old systems.
512
513 .cindex "distribution" "signing details"
514 .cindex "distribution" "public key"
515 .cindex "public key for signed distribution"
516 The distributions will be PGP signed by an individual key of the Release
517 Coordinator.  This key will have a uid containing an email address in the
518 &'exim.org'& domain and will have signatures from other people, including
519 other Exim maintainers.  We expect that the key will be in the "strong set" of
520 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
521 PGP keys, a version of which can be found in the release directory in the file
522 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
523 such as &'pool.sks-keyservers.net'&.
524
525 At the time of the last update, releases were being made by Jeremy Harris and signed
526 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
527 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
528 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
529
530 The signatures for the tar bundles are in:
531 .display
532 &_exim-n.nn.tar.xz.asc_&
533 &_exim-n.nn.tar.gz.asc_&
534 &_exim-n.nn.tar.bz2.asc_&
535 .endd
536 For each released version, the log of changes is made available in a
537 separate file in the directory &_ChangeLogs_& so that it is possible to
538 find out what has changed without having to download the entire distribution.
539
540 .cindex "documentation" "available formats"
541 The main distribution contains ASCII versions of this specification and other
542 documentation; other formats of the documents are available in separate files
543 inside the &_exim4_& directory of the FTP site:
544 .display
545 &_exim-html-n.nn.tar.gz_&
546 &_exim-pdf-n.nn.tar.gz_&
547 &_exim-postscript-n.nn.tar.gz_&
548 &_exim-texinfo-n.nn.tar.gz_&
549 .endd
550 These tar files contain only the &_doc_& directory, not the complete
551 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
552
553
554 .section "Limitations" "SECID6"
555 .ilist
556 .cindex "limitations of Exim"
557 .cindex "bang paths" "not handled by Exim"
558 Exim is designed for use as an Internet MTA, and therefore handles addresses in
559 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
560 simple two-component bang paths can be converted by a straightforward rewriting
561 configuration. This restriction does not prevent Exim from being interfaced to
562 UUCP as a transport mechanism, provided that domain addresses are used.
563 .next
564 .cindex "domainless addresses"
565 .cindex "address" "without domain"
566 Exim insists that every address it handles has a domain attached. For incoming
567 local messages, domainless addresses are automatically qualified with a
568 configured domain value. Configuration options specify from which remote
569 systems unqualified addresses are acceptable. These are then qualified on
570 arrival.
571 .next
572 .cindex "transport" "external"
573 .cindex "external transports"
574 The only external transport mechanisms that are currently implemented are SMTP
575 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
576 transport is available, and there are facilities for writing messages to files
577 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
578 to send messages to other transport mechanisms such as UUCP, provided they can
579 handle domain-style addresses. Batched SMTP input is also catered for.
580 .next
581 Exim is not designed for storing mail for dial-in hosts. When the volumes of
582 such mail are large, it is better to get the messages &"delivered"& into files
583 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
584 other means.
585 .next
586 Although Exim does have basic facilities for scanning incoming messages, these
587 are not comprehensive enough to do full virus or spam scanning. Such operations
588 are best carried out using additional specialized software packages. If you
589 compile Exim with the content-scanning extension, straightforward interfaces to
590 a number of common scanners are provided.
591 .endlist
592
593
594 .section "Runtime configuration" "SECID7"
595 Exim's runtime configuration is held in a single text file that is divided
596 into a number of sections. The entries in this file consist of keywords and
597 values, in the style of Smail 3 configuration files. A default configuration
598 file which is suitable for simple online installations is provided in the
599 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
600
601
602 .section "Calling interface" "SECID8"
603 .cindex "Sendmail compatibility" "command line interface"
604 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
605 can be a straight replacement for &_/usr/lib/sendmail_& or
606 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
607 about Sendmail in order to run Exim. For actions other than sending messages,
608 Sendmail-compatible options also exist, but those that produce output (for
609 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
610 format. There are also some additional options that are compatible with Smail
611 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
612 documents all Exim's command line options. This information is automatically
613 made into the man page that forms part of the Exim distribution.
614
615 Control of messages in the queue can be done via certain privileged command
616 line options. There is also an optional monitor program called &'eximon'&,
617 which displays current information in an X window, and which contains a menu
618 interface to Exim's command line administration options.
619
620
621
622 .section "Terminology" "SECID9"
623 .cindex "terminology definitions"
624 .cindex "body of message" "definition of"
625 The &'body'& of a message is the actual data that the sender wants to transmit.
626 It is the last part of a message and is separated from the &'header'& (see
627 below) by a blank line.
628
629 .cindex "bounce message" "definition of"
630 When a message cannot be delivered, it is normally returned to the sender in a
631 delivery failure message or a &"non-delivery report"& (NDR). The term
632 &'bounce'& is commonly used for this action, and the error reports are often
633 called &'bounce messages'&. This is a convenient shorthand for &"delivery
634 failure error report"&. Such messages have an empty sender address in the
635 message's &'envelope'& (see below) to ensure that they cannot themselves give
636 rise to further bounce messages.
637
638 The term &'default'& appears frequently in this manual. It is used to qualify a
639 value which is used in the absence of any setting in the configuration. It may
640 also qualify an action which is taken unless a configuration setting specifies
641 otherwise.
642
643 The term &'defer'& is used when the delivery of a message to a specific
644 destination cannot immediately take place for some reason (a remote host may be
645 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
646 until a later time.
647
648 The word &'domain'& is sometimes used to mean all but the first component of a
649 host's name. It is &'not'& used in that sense here, where it normally refers to
650 the part of an email address following the @ sign.
651
652 .cindex "envelope, definition of"
653 .cindex "sender" "definition of"
654 A message in transit has an associated &'envelope'&, as well as a header and a
655 body. The envelope contains a sender address (to which bounce messages should
656 be delivered), and any number of recipient addresses. References to the
657 sender or the recipients of a message usually mean the addresses in the
658 envelope. An MTA uses these addresses for delivery, and for returning bounce
659 messages, not the addresses that appear in the header lines.
660
661 .cindex "message" "header, definition of"
662 .cindex "header section" "definition of"
663 The &'header'& of a message is the first part of a message's text, consisting
664 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
665 &'Subject:'&, etc. Long header lines can be split over several text lines by
666 indenting the continuations. The header is separated from the body by a blank
667 line.
668
669 .cindex "local part" "definition of"
670 .cindex "domain" "definition of"
671 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
672 part of an email address that precedes the @ sign. The part that follows the
673 @ sign is called the &'domain'& or &'mail domain'&.
674
675 .cindex "local delivery" "definition of"
676 .cindex "remote delivery, definition of"
677 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
678 delivery to a file or a pipe on the local host from delivery by SMTP over
679 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
680 host it is running on are &'remote'&.
681
682 .cindex "return path" "definition of"
683 &'Return path'& is another name that is used for the sender address in a
684 message's envelope.
685
686 .cindex "queue" "definition of"
687 The term &'queue'& is used to refer to the set of messages awaiting delivery
688 because this term is in widespread use in the context of MTAs. However, in
689 Exim's case, the reality is more like a pool than a queue, because there is
690 normally no ordering of waiting messages.
691
692 .cindex "queue runner" "definition of"
693 The term &'queue runner'& is used to describe a process that scans the queue
694 and attempts to deliver those messages whose retry times have come. This term
695 is used by other MTAs and also relates to the command &%runq%&, but in Exim
696 the waiting messages are normally processed in an unpredictable order.
697
698 .cindex "spool directory" "definition of"
699 The term &'spool directory'& is used for a directory in which Exim keeps the
700 messages in its queue &-- that is, those that it is in the process of
701 delivering. This should not be confused with the directory in which local
702 mailboxes are stored, which is called a &"spool directory"& by some people. In
703 the Exim documentation, &"spool"& is always used in the first sense.
704
705
706
707
708
709
710 . ////////////////////////////////////////////////////////////////////////////
711 . ////////////////////////////////////////////////////////////////////////////
712
713 .chapter "Incorporated code" "CHID2"
714 .cindex "incorporated code"
715 .cindex "regular expressions" "library"
716 .cindex "PCRE2"
717 .cindex "OpenDMARC"
718 A number of pieces of external code are included in the Exim distribution.
719
720 .ilist
721 Regular expressions are supported in the main Exim program and in the
722 Exim monitor using the freely-distributable PCRE2 library, copyright
723 &copy; University of Cambridge. The source to PCRE2 is not longer shipped with
724 Exim, so you will need to use the version of PCRE2 shipped with your system,
725 or obtain and install the full version of the library from
726 &url(https://github.com/PhilipHazel/pcre2/releases).
727 .next
728 .cindex "cdb" "acknowledgment"
729 Support for the cdb (Constant DataBase) lookup method is provided by code
730 contributed by Nigel Metheringham of (at the time he contributed it) Planet
731 Online Ltd. The implementation is completely contained within the code of Exim.
732 It does not link against an external cdb library. The code contains the
733 following statements:
734
735 .blockquote
736 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
737
738 This program is free software; you can redistribute it and/or modify it under
739 the terms of the GNU General Public License as published by the Free Software
740 Foundation; either version 2 of the License, or (at your option) any later
741 version.
742 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
743 the spec and sample code for cdb can be obtained from
744 &url(https://cr.yp.to/cdb.html). This implementation borrows
745 some code from Dan Bernstein's implementation (which has no license
746 restrictions applied to it).
747 .endblockquote
748 .next
749 .cindex "SPA authentication"
750 .cindex "Samba project"
751 .cindex "Microsoft Secure Password Authentication"
752 Client support for Microsoft's &'Secure Password Authentication'& is provided
753 by code contributed by Marc Prud'hommeaux. Server support was contributed by
754 Tom Kistner. This includes code taken from the Samba project, which is released
755 under the Gnu GPL.
756 .next
757 .cindex "Cyrus"
758 .cindex "&'pwcheck'& daemon"
759 .cindex "&'pwauthd'& daemon"
760 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
761 by code taken from the Cyrus-SASL library and adapted by Alexander S.
762 Sabourenkov. The permission notice appears below, in accordance with the
763 conditions expressed therein.
764
765 .blockquote
766 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
767
768 Redistribution and use in source and binary forms, with or without
769 modification, are permitted provided that the following conditions
770 are met:
771
772 .olist
773 Redistributions of source code must retain the above copyright
774 notice, this list of conditions and the following disclaimer.
775 .next
776 Redistributions in binary form must reproduce the above copyright
777 notice, this list of conditions and the following disclaimer in
778 the documentation and/or other materials provided with the
779 distribution.
780 .next
781 The name &"Carnegie Mellon University"& must not be used to
782 endorse or promote products derived from this software without
783 prior written permission. For permission or any other legal
784 details, please contact
785 .display
786               Office of Technology Transfer
787               Carnegie Mellon University
788               5000 Forbes Avenue
789               Pittsburgh, PA  15213-3890
790               (412) 268-4387, fax: (412) 268-7395
791               tech-transfer@andrew.cmu.edu
792 .endd
793 .next
794 Redistributions of any form whatsoever must retain the following
795 acknowledgment:
796
797 &"This product includes software developed by Computing Services
798 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
799
800 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
801 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
802 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
803 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
804 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
805 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
806 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
807 .endlist
808 .endblockquote
809
810 .next
811 .cindex "Exim monitor" "acknowledgment"
812 .cindex "X-windows"
813 .cindex "Athena"
814 The Exim Monitor program, which is an X-Window application, includes
815 modified versions of the Athena StripChart and TextPop widgets.
816 This code is copyright by DEC and MIT, and their permission notice appears
817 below, in accordance with the conditions expressed therein.
818
819 .blockquote
820 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
821 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
822
823 All Rights Reserved
824
825 Permission to use, copy, modify, and distribute this software and its
826 documentation for any purpose and without fee is hereby granted,
827 provided that the above copyright notice appear in all copies and that
828 both that copyright notice and this permission notice appear in
829 supporting documentation, and that the names of Digital or MIT not be
830 used in advertising or publicity pertaining to distribution of the
831 software without specific, written prior permission.
832
833 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
834 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
835 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
836 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
837 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
838 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
839 SOFTWARE.
840 .endblockquote
841
842 .next
843 .cindex "opendmarc" "acknowledgment"
844 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
845 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
846 derived code are indicated in the respective source files. The full OpenDMARC
847 license is provided in the LICENSE.opendmarc file contained in the distributed
848 source code.
849
850 .next
851 Many people have contributed code fragments, some large, some small, that were
852 not covered by any specific license requirements. It is assumed that the
853 contributors are happy to see their code incorporated into Exim under the GPL.
854 .endlist
855
856
857
858
859
860 . ////////////////////////////////////////////////////////////////////////////
861 . ////////////////////////////////////////////////////////////////////////////
862
863 .chapter "How Exim receives and delivers mail" "CHID11" &&&
864          "Receiving and delivering mail"
865
866
867 .section "Overall philosophy" "SECID10"
868 .cindex "design philosophy"
869 Exim is designed to work efficiently on systems that are permanently connected
870 to the Internet and are handling a general mix of mail. In such circumstances,
871 most messages can be delivered immediately. Consequently, Exim does not
872 maintain independent queues of messages for specific domains or hosts, though
873 it does try to send several messages in a single SMTP connection after a host
874 has been down, and it also maintains per-host retry information.
875
876
877 .section "Policy control" "SECID11"
878 .cindex "policy control" "overview"
879 Policy controls are now an important feature of MTAs that are connected to the
880 Internet. Perhaps their most important job is to stop MTAs from being abused as
881 &"open relays"& by misguided individuals who send out vast amounts of
882 unsolicited junk and want to disguise its source. Exim provides flexible
883 facilities for specifying policy controls on incoming mail:
884
885 .ilist
886 .cindex "&ACL;" "introduction"
887 Exim 4 (unlike previous versions of Exim) implements policy controls on
888 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
889 series of statements that may either grant or deny access. ACLs can be used at
890 several places in the SMTP dialogue while receiving a message from a remote
891 host. However, the most common places are after each RCPT command, and at the
892 very end of the message. The sysadmin can specify conditions for accepting or
893 rejecting individual recipients or the entire message, respectively, at these
894 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
895 error code.
896 .next
897 An ACL is also available for locally generated, non-SMTP messages. In this
898 case, the only available actions are to accept or deny the entire message.
899 .next
900 When Exim is compiled with the content-scanning extension, facilities are
901 provided in the ACL mechanism for passing the message to external virus and/or
902 spam scanning software. The result of such a scan is passed back to the ACL,
903 which can then use it to decide what to do with the message.
904 .next
905 When a message has been received, either from a remote host or from the local
906 host, but before the final acknowledgment has been sent, a locally supplied C
907 function called &[local_scan()]& can be run to inspect the message and decide
908 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
909 is accepted, the list of recipients can be modified by the function.
910 .next
911 Using the &[local_scan()]& mechanism is another way of calling external scanner
912 software. The &%SA-Exim%& add-on package works this way. It does not require
913 Exim to be compiled with the content-scanning extension.
914 .next
915 After a message has been accepted, a further checking mechanism is available in
916 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
917 runs at the start of every delivery process.
918 .endlist
919
920
921
922 .section "User filters" "SECID12"
923 .cindex "filter" "introduction"
924 .cindex "Sieve filter"
925 In a conventional Exim configuration, users are able to run private filters by
926 setting up appropriate &_.forward_& files in their home directories. See
927 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
928 configuration needed to support this, and the separate document entitled
929 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
930 of filtering are available:
931
932 .ilist
933 Sieve filters are written in the standard filtering language that is defined
934 by RFC 3028.
935 .next
936 Exim filters are written in a syntax that is unique to Exim, but which is more
937 powerful than Sieve, which it pre-dates.
938 .endlist
939
940 User filters are run as part of the routing process, described below.
941
942
943
944 .section "Message identification" "SECTmessiden"
945 .cindex "message ids" "details of format"
946 .cindex "format" "of message id"
947 .cindex "id of message"
948 .cindex "base62"
949 .cindex "base36"
950 .cindex "Darwin"
951 .cindex "Cygwin"
952 .cindex "exim_msgdate"
953 Every message handled by Exim is given a &'message id'& which is sixteen
954 characters long. It is divided into three parts, separated by hyphens, for
955 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
956 normally encoding numbers in base 62. However, in the Darwin operating
957 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
958 (avoiding the use of lower case letters) is used instead, because the message
959 id is used to construct filenames, and the names of files in those systems are
960 not always case-sensitive.
961
962 .cindex "pid (process id)" "re-use of"
963 The detail of the contents of the message id have changed as Exim has evolved.
964 Earlier versions relied on the operating system not re-using a process id (pid)
965 within one second. On modern operating systems, this assumption can no longer
966 be made, so the algorithm had to be changed. To retain backward compatibility,
967 the format of the message id was retained, which is why the following rules are
968 somewhat eccentric:
969
970 .ilist
971 The first six characters of the message id are the time at which the message
972 started to be received, to a granularity of one second. That is, this field
973 contains the number of seconds since the start of the epoch (the normal Unix
974 way of representing the date and time of day).
975 .next
976 After the first hyphen, the next six characters are the id of the process that
977 received the message.
978 .next
979 There are two different possibilities for the final two characters:
980 .olist
981 .oindex "&%localhost_number%&"
982 If &%localhost_number%& is not set, this value is the fractional part of the
983 time of reception, normally in units of 1/2000 of a second, but for systems
984 that must use base 36 instead of base 62 (because of case-insensitive file
985 systems), the units are 1/1000 of a second.
986 .next
987 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
988 the fractional part of the time, which in this case is in units of 1/200
989 (1/100) of a second.
990 .endlist
991 .endlist
992
993 After a message has been received, Exim waits for the clock to tick at the
994 appropriate resolution before proceeding, so that if another message is
995 received by the same process, or by another process with the same (re-used)
996 pid, it is guaranteed that the time will be different. In most cases, the clock
997 will already have ticked while the message was being received.
998
999 The exim_msgdate utility (see section &<<SECTexim_msgdate>>&) can be
1000 used to display the date, and optionally the process id, of an Exim
1001 Message ID.
1002
1003
1004 .section "Receiving mail" "SECID13"
1005 .cindex "receiving mail"
1006 .cindex "message" "reception"
1007 The only way Exim can receive mail from another host is using SMTP over
1008 TCP/IP, in which case the sender and recipient addresses are transferred using
1009 SMTP commands. However, from a locally running process (such as a user's MUA),
1010 there are several possibilities:
1011
1012 .ilist
1013 If the process runs Exim with the &%-bm%& option, the message is read
1014 non-interactively (usually via a pipe), with the recipients taken from the
1015 command line, or from the body of the message if &%-t%& is also used.
1016 .next
1017 If the process runs Exim with the &%-bS%& option, the message is also read
1018 non-interactively, but in this case the recipients are listed at the start of
1019 the message in a series of SMTP RCPT commands, terminated by a DATA
1020 command. This is called &"batch SMTP"& format,
1021 but it isn't really SMTP. The SMTP commands are just another way of passing
1022 envelope addresses in a non-interactive submission.
1023 .next
1024 If the process runs Exim with the &%-bs%& option, the message is read
1025 interactively, using the SMTP protocol. A two-way pipe is normally used for
1026 passing data between the local process and the Exim process.
1027 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1028 example, the ACLs for SMTP commands are used for this form of submission.
1029 .next
1030 A local process may also make a TCP/IP call to the host's loopback address
1031 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1032 does not treat the loopback address specially. It treats all such connections
1033 in the same way as connections from other hosts.
1034 .endlist
1035
1036
1037 .cindex "message sender, constructed by Exim"
1038 .cindex "sender" "constructed by Exim"
1039 In the three cases that do not involve TCP/IP, the sender address is
1040 constructed from the login name of the user that called Exim and a default
1041 qualification domain (which can be set by the &%qualify_domain%& configuration
1042 option). For local or batch SMTP, a sender address that is passed using the
1043 SMTP MAIL command is ignored. However, the system administrator may allow
1044 certain users (&"trusted users"&) to specify a different sender addresses
1045 unconditionally, or all users to specify certain forms of different sender
1046 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1047 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1048 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1049 users to change sender addresses.
1050
1051 Messages received by either of the non-interactive mechanisms are subject to
1052 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1053 (either over TCP/IP or interacting with a local process) can be checked by a
1054 number of ACLs that operate at different times during the SMTP session. Either
1055 individual recipients or the entire message can be rejected if local policy
1056 requirements are not met. The &[local_scan()]& function (see chapter
1057 &<<CHAPlocalscan>>&) is run for all incoming messages.
1058
1059 Exim can be configured not to start a delivery process when a message is
1060 received; this can be unconditional, or depend on the number of incoming SMTP
1061 connections or the system load. In these situations, new messages wait on the
1062 queue until a queue runner process picks them up. However, in standard
1063 configurations under normal conditions, delivery is started as soon as a
1064 message is received.
1065
1066
1067
1068
1069
1070 .section "Handling an incoming message" "SECID14"
1071 .cindex "spool directory" "files that hold a message"
1072 .cindex "file" "how a message is held"
1073 When Exim accepts a message, it writes two files in its spool directory. The
1074 first contains the envelope information, the current status of the message, and
1075 the header lines, and the second contains the body of the message. The names of
1076 the two spool files consist of the message id, followed by &`-H`& for the
1077 file containing the envelope and header, and &`-D`& for the data file.
1078
1079 .cindex "spool directory" "&_input_& sub-directory"
1080 By default, all these message files are held in a single directory called
1081 &_input_& inside the general Exim spool directory. Some operating systems do
1082 not perform very well if the number of files in a directory gets large; to
1083 improve performance in such cases, the &%split_spool_directory%& option can be
1084 used. This causes Exim to split up the input files into 62 sub-directories
1085 whose names are single letters or digits. When this is done, the queue is
1086 processed one sub-directory at a time instead of all at once, which can improve
1087 overall performance even when there are not enough files in each directory to
1088 affect file system performance.
1089
1090 The envelope information consists of the address of the message's sender and
1091 the addresses of the recipients. This information is entirely separate from
1092 any addresses contained in the header lines. The status of the message includes
1093 a list of recipients who have already received the message. The format of the
1094 first spool file is described in chapter &<<CHAPspool>>&.
1095
1096 .cindex "rewriting" "addresses"
1097 Address rewriting that is specified in the rewrite section of the configuration
1098 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1099 both in the header lines and the envelope, at the time the message is accepted.
1100 If during the course of delivery additional addresses are generated (for
1101 example, via aliasing), these new addresses are rewritten as soon as they are
1102 generated. At the time a message is actually delivered (transported) further
1103 rewriting can take place; because this is a transport option, it can be
1104 different for different forms of delivery. It is also possible to specify the
1105 addition or removal of certain header lines at the time the message is
1106 delivered (see chapters &<<CHAProutergeneric>>& and
1107 &<<CHAPtransportgeneric>>&).
1108
1109
1110
1111 .section "Life of a message" "SECID15"
1112 .cindex "message" "life of"
1113 .cindex "message" "frozen"
1114 A message remains in the spool directory until it is completely delivered to
1115 its recipients or to an error address, or until it is deleted by an
1116 administrator or by the user who originally created it. In cases when delivery
1117 cannot proceed &-- for example when a message can neither be delivered to its
1118 recipients nor returned to its sender, the message is marked &"frozen"& on the
1119 spool, and no more deliveries are attempted.
1120
1121 .cindex "frozen messages" "thawing"
1122 .cindex "message" "thawing frozen"
1123 An administrator can &"thaw"& such messages when the problem has been
1124 corrected, and can also freeze individual messages by hand if necessary. In
1125 addition, an administrator can force a delivery error, causing a bounce message
1126 to be sent.
1127
1128 .oindex "&%timeout_frozen_after%&"
1129 .oindex "&%ignore_bounce_errors_after%&"
1130 There are options called &%ignore_bounce_errors_after%& and
1131 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1132 The first applies only to frozen bounces, the second to all frozen messages.
1133
1134 .cindex "message" "log file for"
1135 .cindex "log" "file for each message"
1136 While Exim is working on a message, it writes information about each delivery
1137 attempt to its main log file. This includes successful, unsuccessful, and
1138 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1139 lines are also written to a separate &'message log'& file for each message.
1140 These logs are solely for the benefit of the administrator and are normally
1141 deleted along with the spool files when processing of a message is complete.
1142 The use of individual message logs can be disabled by setting
1143 &%no_message_logs%&; this might give an improvement in performance on very busy
1144 systems.
1145
1146 .cindex "journal file"
1147 .cindex "file" "journal"
1148 All the information Exim itself needs to set up a delivery is kept in the first
1149 spool file, along with the header lines. When a successful delivery occurs, the
1150 address is immediately written at the end of a journal file, whose name is the
1151 message id followed by &`-J`&. At the end of a delivery run, if there are some
1152 addresses left to be tried again later, the first spool file (the &`-H`& file)
1153 is updated to indicate which these are, and the journal file is then deleted.
1154 Updating the spool file is done by writing a new file and renaming it, to
1155 minimize the possibility of data loss.
1156
1157 Should the system or Exim crash after a successful delivery but before
1158 the spool file has been updated, the journal is left lying around. The next
1159 time Exim attempts to deliver the message, it reads the journal file and
1160 updates the spool file before proceeding. This minimizes the chances of double
1161 deliveries caused by crashes.
1162
1163
1164
1165 .section "Processing an address for delivery" "SECTprocaddress"
1166 .cindex "drivers" "definition of"
1167 .cindex "router" "definition of"
1168 .cindex "transport" "definition of"
1169 The main delivery processing elements of Exim are called &'routers'& and
1170 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1171 number of them is provided in the source distribution, and compile-time options
1172 specify which ones are included in the binary. Runtime options specify which
1173 ones are actually used for delivering messages.
1174
1175 .cindex "drivers" "instance definition"
1176 Each driver that is specified in the runtime configuration is an &'instance'&
1177 of that particular driver type. Multiple instances are allowed; for example,
1178 you can set up several different &(smtp)& transports, each with different
1179 option values that might specify different ports or different timeouts. Each
1180 instance has its own identifying name. In what follows we will normally use the
1181 instance name when discussing one particular instance (that is, one specific
1182 configuration of the driver), and the generic driver name when discussing
1183 the driver's features in general.
1184
1185 A &'router'& is a driver that operates on an address, either determining how
1186 its delivery should happen, by assigning it to a specific transport, or
1187 converting the address into one or more new addresses (for example, via an
1188 alias file). A router may also explicitly choose to fail an address, causing it
1189 to be bounced.
1190
1191 A &'transport'& is a driver that transmits a copy of the message from Exim's
1192 spool to some destination. There are two kinds of transport: for a &'local'&
1193 transport, the destination is a file or a pipe on the local host, whereas for a
1194 &'remote'& transport the destination is some other host. A message is passed
1195 to a specific transport as a result of successful routing. If a message has
1196 several recipients, it may be passed to a number of different transports.
1197
1198 .cindex "preconditions" "definition of"
1199 An address is processed by passing it to each configured router instance in
1200 turn, subject to certain preconditions, until a router accepts the address or
1201 specifies that it should be bounced. We will describe this process in more
1202 detail shortly. First, as a simple example, we consider how each recipient
1203 address in a message is processed in a small configuration of three routers.
1204
1205 To make this a more concrete example, it is described in terms of some actual
1206 routers, but remember, this is only an example. You can configure Exim's
1207 routers in many different ways, and there may be any number of routers in a
1208 configuration.
1209
1210 The first router that is specified in a configuration is often one that handles
1211 addresses in domains that are not recognized specifically by the local host.
1212 Typically these are addresses for arbitrary domains on the Internet. A precondition
1213 is set up which looks for the special domains known to the host (for example,
1214 its own domain name), and the router is run for addresses that do &'not'&
1215 match. Typically, this is a router that looks up domains in the DNS in order to
1216 find the hosts to which this address routes. If it succeeds, the address is
1217 assigned to a suitable SMTP transport; if it does not succeed, the router is
1218 configured to fail the address.
1219
1220 The second router is reached only when the domain is recognized as one that
1221 &"belongs"& to the local host. This router does redirection &-- also known as
1222 aliasing and forwarding. When it generates one or more new addresses from the
1223 original, each of them is routed independently from the start. Otherwise, the
1224 router may cause an address to fail, or it may simply decline to handle the
1225 address, in which case the address is passed to the next router.
1226
1227 The final router in many configurations is one that checks to see if the
1228 address belongs to a local mailbox. The precondition may involve a check to
1229 see if the local part is the name of a login account, or it may look up the
1230 local part in a file or a database. If its preconditions are not met, or if
1231 the router declines, we have reached the end of the routers. When this happens,
1232 the address is bounced.
1233
1234
1235
1236 .section "Processing an address for verification" "SECID16"
1237 .cindex "router" "for verification"
1238 .cindex "verifying address" "overview"
1239 As well as being used to decide how to deliver to an address, Exim's routers
1240 are also used for &'address verification'&. Verification can be requested as
1241 one of the checks to be performed in an ACL for incoming messages, on both
1242 sender and recipient addresses, and it can be tested using the &%-bv%& and
1243 &%-bvs%& command line options.
1244
1245 When an address is being verified, the routers are run in &"verify mode"&. This
1246 does not affect the way the routers work, but it is a state that can be
1247 detected. By this means, a router can be skipped or made to behave differently
1248 when verifying. A common example is a configuration in which the first router
1249 sends all messages to a message-scanning program unless they have been
1250 previously scanned. Thus, the first router accepts all addresses without any
1251 checking, making it useless for verifying. Normally, the &%no_verify%& option
1252 would be set for such a router, causing it to be skipped in verify mode.
1253
1254
1255
1256
1257 .section "Running an individual router" "SECTrunindrou"
1258 .cindex "router" "running details"
1259 .cindex "preconditions" "checking"
1260 .cindex "router" "result of running"
1261 As explained in the example above, a number of preconditions are checked before
1262 running a router. If any are not met, the router is skipped, and the address is
1263 passed to the next router. When all the preconditions on a router &'are'& met,
1264 the router is run. What happens next depends on the outcome, which is one of
1265 the following:
1266
1267 .ilist
1268 &'accept'&: The router accepts the address, and either assigns it to a
1269 transport or generates one or more &"child"& addresses. Processing the
1270 original address ceases
1271 .oindex "&%unseen%&"
1272 unless the &%unseen%& option is set on the router. This option
1273 can be used to set up multiple deliveries with different routing (for example,
1274 for keeping archive copies of messages). When &%unseen%& is set, the address is
1275 passed to the next router. Normally, however, an &'accept'& return marks the
1276 end of routing.
1277
1278 Any child addresses generated by the router are processed independently,
1279 starting with the first router by default. It is possible to change this by
1280 setting the &%redirect_router%& option to specify which router to start at for
1281 child addresses. Unlike &%pass_router%& (see below) the router specified by
1282 &%redirect_router%& may be anywhere in the router configuration.
1283 .next
1284 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1285 requests that the address be passed to another router. By default, the address
1286 is passed to the next router, but this can be changed by setting the
1287 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1288 must be below the current router (to avoid loops).
1289 .next
1290 &'decline'&: The router declines to accept the address because it does not
1291 recognize it at all. By default, the address is passed to the next router, but
1292 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1293 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1294 &'decline'& into &'fail'&.
1295 .next
1296 &'fail'&: The router determines that the address should fail, and queues it for
1297 the generation of a bounce message. There is no further processing of the
1298 original address unless &%unseen%& is set on the router.
1299 .next
1300 &'defer'&: The router cannot handle the address at the present time. (A
1301 database may be offline, or a DNS lookup may have timed out.) No further
1302 processing of the address happens in this delivery attempt. It is tried again
1303 next time the message is considered for delivery.
1304 .next
1305 &'error'&: There is some error in the router (for example, a syntax error in
1306 its configuration). The action is as for defer.
1307 .endlist
1308
1309 If an address reaches the end of the routers without having been accepted by
1310 any of them, it is bounced as unrouteable. The default error message in this
1311 situation is &"unrouteable address"&, but you can set your own message by
1312 making use of the &%cannot_route_message%& option. This can be set for any
1313 router; the value from the last router that &"saw"& the address is used.
1314
1315 Sometimes while routing you want to fail a delivery when some conditions are
1316 met but others are not, instead of passing the address on for further routing.
1317 You can do this by having a second router that explicitly fails the delivery
1318 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1319 facility for this purpose.
1320
1321
1322 .section "Duplicate addresses" "SECID17"
1323 .cindex "case of local parts"
1324 .cindex "address duplicate, discarding"
1325 .cindex "duplicate addresses"
1326 Once routing is complete, Exim scans the addresses that are assigned to local
1327 and remote transports and discards any duplicates that it finds. During this
1328 check, local parts are treated case-sensitively. This happens only when
1329 actually delivering a message; when testing routers with &%-bt%&, all the
1330 routed addresses are shown.
1331
1332
1333
1334 .section "Router preconditions" "SECTrouprecon"
1335 .cindex "router" "preconditions, order of processing"
1336 .cindex "preconditions" "order of processing"
1337 The preconditions that are tested for each router are listed below, in the
1338 order in which they are tested. The individual configuration options are
1339 described in more detail in chapter &<<CHAProutergeneric>>&.
1340
1341 .olist
1342 .cindex affix "router precondition"
1343 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1344 the local parts handled by the router may or must have certain prefixes and/or
1345 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1346 skipped. These conditions are tested first. When an affix is present, it is
1347 removed from the local part before further processing, including the evaluation
1348 of any other conditions.
1349 .next
1350 Routers can be designated for use only when not verifying an address, that is,
1351 only when routing it for delivery (or testing its delivery routing). If the
1352 &%verify%& option is set false, the router is skipped when Exim is verifying an
1353 address.
1354 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1355 &%verify_recipient%&, which independently control the use of the router for
1356 sender and recipient verification. You can set these options directly if
1357 you want a router to be used for only one type of verification.
1358 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1359 .next
1360 If the &%address_test%& option is set false, the router is skipped when Exim is
1361 run with the &%-bt%& option to test an address routing. This can be helpful
1362 when the first router sends all new messages to a scanner of some sort; it
1363 makes it possible to use &%-bt%& to test subsequent delivery routing without
1364 having to simulate the effect of the scanner.
1365 .next
1366 Routers can be designated for use only when verifying an address, as
1367 opposed to routing it for delivery. The &%verify_only%& option controls this.
1368 Again, cutthrough delivery counts as a verification.
1369 .next
1370 Individual routers can be explicitly skipped when running the routers to
1371 check an address given in the SMTP EXPN command (see the &%expn%& option).
1372
1373 .next
1374 If the &%domains%& option is set, the domain of the address must be in the set
1375 of domains that it defines.
1376 .cindex "tainted data" "de-tainting"
1377 .cindex "de-tainting" "using router domains option"
1378 A match verifies the variable &$domain$& (which carries tainted data)
1379 and assigns an untainted value to the &$domain_data$& variable.
1380 Such an untainted value is often needed in the transport.
1381 For specifics of the matching operation and the resulting untainted value,
1382 refer to section &<<SECTdomainlist>>&.
1383
1384 When an untainted value is wanted, use this option
1385 rather than the generic &%condition%& option.
1386
1387 .next
1388 .vindex "&$local_part_prefix$&"
1389 .vindex "&$local_part_prefix_v$&"
1390 .vindex "&$local_part$&"
1391 .vindex "&$local_part_suffix$&"
1392 .vindex "&$local_part_suffix_v$&"
1393 .cindex affix "router precondition"
1394 If the &%local_parts%& option is set, the local part of the address must be in
1395 the set of local parts that it defines.
1396 A match verifies the variable &$local_part$& (which carries tainted data)
1397 and assigns an untainted value to the &$local_part_data$& variable.
1398 Such an untainted value is often needed in the transport.
1399 For specifics of the matching operation and the resulting untainted value,
1400 refer to section &<<SECTlocparlis>>&.
1401
1402 When an untainted value is wanted, use this option
1403 rather than the generic &%condition%& option.
1404
1405 If &%local_part_prefix%& or
1406 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1407 part before this check. If you want to do precondition tests on local parts
1408 that include affixes, you can do so by using a &%condition%& option (see below)
1409 that uses the variables &$local_part$&, &$local_part_prefix$&,
1410 &$local_part_prefix_v$&, &$local_part_suffix$&
1411 and &$local_part_suffix_v$& as necessary.
1412
1413 .next
1414 .vindex "&$local_user_uid$&"
1415 .vindex "&$local_user_gid$&"
1416 .vindex "&$home$&"
1417 If the &%check_local_user%& option is set, the local part must be the name of
1418 an account on the local host. If this check succeeds, the uid and gid of the
1419 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1420 user's home directory is placed in &$home$&; these values can be used in the
1421 remaining preconditions.
1422
1423 .next
1424 If the &%router_home_directory%& option is set, it is expanded at this point,
1425 because it overrides the value of &$home$&. If this expansion were left till
1426 later, the value of &$home$& as set by &%check_local_user%& would be used in
1427 subsequent tests. Having two different values of &$home$& in the same router
1428 could lead to confusion.
1429
1430 .next
1431 If the &%senders%& option is set, the envelope sender address must be in the
1432 set of addresses that it defines.
1433
1434 .next
1435 If the &%require_files%& option is set, the existence or non-existence of
1436 specified files is tested.
1437
1438 .next
1439 .cindex "customizing" "precondition"
1440 If the &%condition%& option is set, it is evaluated and tested. This option
1441 uses an expanded string to allow you to set up your own custom preconditions.
1442 Expanded strings are described in chapter &<<CHAPexpand>>&.
1443
1444 Note that while using
1445 this option for address matching technically works,
1446 it does not set any de-tainted values.
1447 Such values are often needed, either for router-specific options or
1448 for transport options.
1449 Using the &%domains%& and &%local_parts%& options is usually the most
1450 convenient way to obtain them.
1451 .endlist
1452
1453
1454 Note that &%require_files%& comes near the end of the list, so you cannot use
1455 it to check for the existence of a file in which to lookup up a domain, local
1456 part, or sender. However, as these options are all expanded, you can use the
1457 &%exists%& expansion condition to make such tests within each condition. The
1458 &%require_files%& option is intended for checking files that the router may be
1459 going to use internally, or which are needed by a specific transport (for
1460 example, &_.procmailrc_&).
1461
1462
1463
1464 .section "Delivery in detail" "SECID18"
1465 .cindex "delivery" "in detail"
1466 When a message is to be delivered, the sequence of events is as follows:
1467
1468 .olist
1469 If a system-wide filter file is specified, the message is passed to it. The
1470 filter may add recipients to the message, replace the recipients, discard the
1471 message, cause a new message to be generated, or cause the message delivery to
1472 fail. The format of the system filter file is the same as for Exim user filter
1473 files, described in the separate document entitled &'Exim's interfaces to mail
1474 filtering'&.
1475 .cindex "Sieve filter" "not available for system filter"
1476 (&*Note*&: Sieve cannot be used for system filter files.)
1477
1478 Some additional features are available in system filters &-- see chapter
1479 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1480 filter only once per delivery attempt, however many recipients it has. However,
1481 if there are several delivery attempts because one or more addresses could not
1482 be immediately delivered, the system filter is run each time. The filter
1483 condition &%first_delivery%& can be used to detect the first run of the system
1484 filter.
1485 .next
1486 Each recipient address is offered to each configured router, in turn, subject to
1487 its preconditions, until one is able to handle it. If no router can handle the
1488 address, that is, if they all decline, the address is failed. Because routers
1489 can be targeted at particular domains, several locally handled domains can be
1490 processed entirely independently of each other.
1491 .next
1492 .cindex "routing" "loops in"
1493 .cindex "loop" "while routing"
1494 A router that accepts an address may assign it to a local or a remote
1495 transport. However, the transport is not run at this time. Instead, the address
1496 is placed on a list for the particular transport, which will be run later.
1497 Alternatively, the router may generate one or more new addresses (typically
1498 from alias, forward, or filter files). New addresses are fed back into this
1499 process from the top, but in order to avoid loops, a router ignores any address
1500 which has an identically-named ancestor that was processed by itself.
1501 .next
1502 When all the routing has been done, addresses that have been successfully
1503 handled are passed to their assigned transports. When local transports are
1504 doing real local deliveries, they handle only one address at a time, but if a
1505 local transport is being used as a pseudo-remote transport (for example, to
1506 collect batched SMTP messages for transmission by some other means) multiple
1507 addresses can be handled. Remote transports can always handle more than one
1508 address at a time, but can be configured not to do so, or to restrict multiple
1509 addresses to the same domain.
1510 .next
1511 Each local delivery to a file or a pipe runs in a separate process under a
1512 non-privileged uid, and these deliveries are run one at a time. Remote
1513 deliveries also run in separate processes, normally under a uid that is private
1514 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1515 run in parallel. The maximum number of simultaneous remote deliveries for any
1516 one message is set by the &%remote_max_parallel%& option.
1517 The order in which deliveries are done is not defined, except that all local
1518 deliveries happen before any remote deliveries.
1519 .next
1520 .cindex "queue runner"
1521 When it encounters a local delivery during a queue run, Exim checks its retry
1522 database to see if there has been a previous temporary delivery failure for the
1523 address before running the local transport. If there was a previous failure,
1524 Exim does not attempt a new delivery until the retry time for the address is
1525 reached. However, this happens only for delivery attempts that are part of a
1526 queue run. Local deliveries are always attempted when delivery immediately
1527 follows message reception, even if retry times are set for them. This makes for
1528 better behaviour if one particular message is causing problems (for example,
1529 causing quota overflow, or provoking an error in a filter file).
1530 .next
1531 .cindex "delivery" "retry in remote transports"
1532 Remote transports do their own retry handling, since an address may be
1533 deliverable to one of a number of hosts, each of which may have a different
1534 retry time. If there have been previous temporary failures and no host has
1535 reached its retry time, no delivery is attempted, whether in a queue run or
1536 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1537 .next
1538 If there were any permanent errors, a bounce message is returned to an
1539 appropriate address (the sender in the common case), with details of the error
1540 for each failing address. Exim can be configured to send copies of bounce
1541 messages to other addresses.
1542 .next
1543 .cindex "delivery" "deferral"
1544 If one or more addresses suffered a temporary failure, the message is left on
1545 the queue, to be tried again later. Delivery of these addresses is said to be
1546 &'deferred'&.
1547 .next
1548 When all the recipient addresses have either been delivered or bounced,
1549 handling of the message is complete. The spool files and message log are
1550 deleted, though the message log can optionally be preserved if required.
1551 .endlist
1552
1553
1554
1555
1556 .section "Retry mechanism" "SECID19"
1557 .cindex "delivery" "retry mechanism"
1558 .cindex "retry" "description of mechanism"
1559 .cindex "queue runner"
1560 Exim's mechanism for retrying messages that fail to get delivered at the first
1561 attempt is the queue runner process. You must either run an Exim daemon that
1562 uses the &%-q%& option with a time interval to start queue runners at regular
1563 intervals or use some other means (such as &'cron'&) to start them. If you do
1564 not arrange for queue runners to be run, messages that fail temporarily at the
1565 first attempt will remain in your queue forever. A queue runner process works
1566 its way through the queue, one message at a time, trying each delivery that has
1567 passed its retry time.
1568 You can run several queue runners at once.
1569
1570 Exim uses a set of configured rules to determine when next to retry the failing
1571 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1572 should give up trying to deliver to the address, at which point it generates a
1573 bounce message. If no retry rules are set for a particular host, address, and
1574 error combination, no retries are attempted, and temporary errors are treated
1575 as permanent.
1576
1577
1578
1579 .subsection "Temporary delivery failure" SECID20
1580 .cindex "delivery" "temporary failure"
1581 There are many reasons why a message may not be immediately deliverable to a
1582 particular address. Failure to connect to a remote machine (because it, or the
1583 connection to it, is down) is one of the most common. Temporary failures may be
1584 detected during routing as well as during the transport stage of delivery.
1585 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1586 is on a file system where the user is over quota. Exim can be configured to
1587 impose its own quotas on local mailboxes; where system quotas are set they will
1588 also apply.
1589
1590 If a host is unreachable for a period of time, a number of messages may be
1591 waiting for it by the time it recovers, and sending them in a single SMTP
1592 connection is clearly beneficial. Whenever a delivery to a remote host is
1593 deferred,
1594 .cindex "hints database" "deferred deliveries"
1595 Exim makes a note in its hints database, and whenever a successful
1596 SMTP delivery has happened, it looks to see if any other messages are waiting
1597 for the same host. If any are found, they are sent over the same SMTP
1598 connection, subject to a configuration limit as to the maximum number in any
1599 one connection.
1600
1601
1602
1603 .subsection "Permanent delivery failure" SECID21
1604 .cindex "delivery" "permanent failure"
1605 .cindex "bounce message" "when generated"
1606 When a message cannot be delivered to some or all of its intended recipients, a
1607 bounce message is generated. Temporary delivery failures turn into permanent
1608 errors when their timeout expires. All the addresses that fail in a given
1609 delivery attempt are listed in a single message. If the original message has
1610 many recipients, it is possible for some addresses to fail in one delivery
1611 attempt and others to fail subsequently, giving rise to more than one bounce
1612 message. The wording of bounce messages can be customized by the administrator.
1613 See chapter &<<CHAPemsgcust>>& for details.
1614
1615 .cindex "&'X-Failed-Recipients:'& header line"
1616 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1617 failed addresses, for the benefit of programs that try to analyse such messages
1618 automatically.
1619
1620 .cindex "bounce message" "recipient of"
1621 A bounce message is normally sent to the sender of the original message, as
1622 obtained from the message's envelope. For incoming SMTP messages, this is the
1623 address given in the MAIL command. However, when an address is expanded via a
1624 forward or alias file, an alternative address can be specified for delivery
1625 failures of the generated addresses. For a mailing list expansion (see section
1626 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1627 of the list.
1628
1629
1630
1631 .subsection "Failures to deliver bounce messages" SECID22
1632 .cindex "bounce message" "failure to deliver"
1633 If a bounce message (either locally generated or received from a remote host)
1634 itself suffers a permanent delivery failure, the message is left in the queue,
1635 but it is frozen, awaiting the attention of an administrator. There are options
1636 that can be used to make Exim discard such failed messages, or to keep them
1637 for only a short time (see &%timeout_frozen_after%& and
1638 &%ignore_bounce_errors_after%&).
1639
1640
1641
1642
1643
1644 . ////////////////////////////////////////////////////////////////////////////
1645 . ////////////////////////////////////////////////////////////////////////////
1646
1647 .chapter "Building and installing Exim" "CHID3"
1648 .scindex IIDbuex "building Exim"
1649
1650 .section "Unpacking" "SECID23"
1651 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1652 creates a directory with the name of the current release (for example,
1653 &_exim-&version()_&) into which the following files are placed:
1654
1655 .table2 140pt
1656 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1657 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1658   documented"
1659 .irow &_LICENCE_&         "the GNU General Public Licence"
1660 .irow &_Makefile_&        "top-level make file"
1661 .irow &_NOTICE_&          "conditions for the use of Exim"
1662 .irow &_README_&          "list of files, directories and simple build &&&
1663   instructions"
1664 .endtable
1665
1666 Other files whose names begin with &_README_& may also be present. The
1667 following subdirectories are created:
1668
1669 .table2 140pt
1670 .irow &_Local_&           "an empty directory for local configuration files"
1671 .irow &_OS_&              "OS-specific files"
1672 .irow &_doc_&             "documentation files"
1673 .irow &_exim_monitor_&    "source files for the Exim monitor"
1674 .irow &_scripts_&         "scripts used in the build process"
1675 .irow &_src_&             "remaining source files"
1676 .irow &_util_&            "independent utilities"
1677 .endtable
1678
1679 The main utility programs are contained in the &_src_& directory and are built
1680 with the Exim binary. The &_util_& directory contains a few optional scripts
1681 that may be useful to some sites.
1682
1683
1684 .section "Multiple machine architectures and operating systems" "SECID24"
1685 .cindex "building Exim" "multiple OS/architectures"
1686 The building process for Exim is arranged to make it easy to build binaries for
1687 a number of different architectures and operating systems from the same set of
1688 source files. Compilation does not take place in the &_src_& directory.
1689 Instead, a &'build directory'& is created for each architecture and operating
1690 system.
1691 .cindex "symbolic link" "to build directory"
1692 Symbolic links to the sources are installed in this directory, which is where
1693 the actual building takes place. In most cases, Exim can discover the machine
1694 architecture and operating system for itself, but the defaults can be
1695 overridden if necessary.
1696 .cindex compiler requirements
1697 .cindex compiler version
1698 A C99-capable compiler will be required for the build.
1699
1700
1701 .section "PCRE2 library" "SECTpcre"
1702 .cindex "PCRE2 library"
1703 Exim no longer has an embedded regular-expression library as the vast majority of
1704 modern systems include PCRE2 as a system library, although you may need to
1705 install the PCRE2 package or the PCRE2 development package for your operating
1706 system. If your system has a normal PCRE2 installation the Exim build
1707 process will need no further configuration. If the library or the
1708 headers are in an unusual location you will need to either set the PCRE2_LIBS
1709 and INCLUDE directives appropriately,
1710 or set PCRE2_CONFIG=yes to use the installed &(pcre-config)& command.
1711 If your operating system has no
1712 PCRE2 support then you will need to obtain and build the current PCRE2
1713 from &url(https://github.com/PhilipHazel/pcre2/releases).
1714 More information on PCRE2 is available at &url(https://www.pcre.org/).
1715
1716 .section "DBM libraries" "SECTdb"
1717 .cindex "DBM libraries" "discussion of"
1718 .cindex "hints database" "DBM files used for"
1719 Even if you do not use any DBM files in your configuration, Exim still needs a
1720 DBM library in order to operate, because it uses indexed files for its hints
1721 databases. Unfortunately, there are a number of DBM libraries in existence, and
1722 different operating systems often have different ones installed.
1723
1724 .cindex "Solaris" "DBM library for"
1725 .cindex "IRIX, DBM library for"
1726 .cindex "BSD, DBM library for"
1727 .cindex "Linux, DBM library for"
1728 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1729 Linux distribution, the DBM configuration should happen automatically, and you
1730 may be able to ignore this section. Otherwise, you may have to learn more than
1731 you would like about DBM libraries from what follows.
1732
1733 .cindex "&'ndbm'& DBM library"
1734 Licensed versions of Unix normally contain a library of DBM functions operating
1735 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1736 versions of Unix seem to vary in what they contain as standard. In particular,
1737 some early versions of Linux have no default DBM library, and different
1738 distributors have chosen to bundle different libraries with their packaged
1739 versions. However, the more recent releases seem to have standardized on the
1740 Berkeley DB library.
1741
1742 Different DBM libraries have different conventions for naming the files they
1743 use. When a program opens a file called &_dbmfile_&, there are several
1744 possibilities:
1745
1746 .olist
1747 A traditional &'ndbm'& implementation, such as that supplied as part of
1748 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1749 .next
1750 .cindex "&'gdbm'& DBM library"
1751 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1752 compatibility interface it makes two different hard links to it with names
1753 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1754 filename is used unmodified.
1755 .next
1756 .cindex "Berkeley DB library"
1757 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1758 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1759 programmer exactly the same as the traditional &'ndbm'& implementation.
1760 .next
1761 If the Berkeley package is used in its native mode, it operates on a single
1762 file called &_dbmfile_&; the programmer's interface is somewhat different to
1763 the traditional &'ndbm'& interface.
1764 .next
1765 To complicate things further, there are several very different versions of the
1766 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1767 2.&'x'& and 3.&'x'& were current for a while,
1768 but the latest versions when Exim last revamped support were numbered 5.&'x'&.
1769 Maintenance of some of the earlier releases has ceased,
1770 and Exim no longer supports versions before 3.&'x'&.
1771 All versions of Berkeley DB could be obtained from
1772 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1773 page with far newer versions listed.
1774 It is probably wise to plan to move your storage configurations away from
1775 Berkeley DB format, as today there are smaller and simpler alternatives more
1776 suited to Exim's usage model.
1777 .next
1778 .cindex "&'tdb'& DBM library"
1779 Yet another DBM library, called &'tdb'&, is available from
1780 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1781 operates on a single file.
1782 .endlist
1783
1784 .cindex "USE_DB"
1785 .cindex "DBM libraries" "configuration for building"
1786 Exim and its utilities can be compiled to use any of these interfaces. In order
1787 to use any version of the Berkeley DB package in native mode, you must set
1788 USE_DB in an appropriate configuration file (typically
1789 &_Local/Makefile_&). For example:
1790 .code
1791 USE_DB=yes
1792 .endd
1793 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1794 error is diagnosed if you set more than one of these.
1795 You can set USE_NDBM if needed to override an operating system default.
1796
1797 At the lowest level, the build-time configuration sets none of these options,
1798 thereby assuming an interface of type (1). However, some operating system
1799 configuration files (for example, those for the BSD operating systems and
1800 Linux) assume type (4) by setting USE_DB as their default, and the
1801 configuration files for Cygwin set USE_GDBM. Anything you set in
1802 &_Local/Makefile_&, however, overrides these system defaults.
1803
1804 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1805 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1806 in one of these lines:
1807 .code
1808 DBMLIB = -ldb
1809 DBMLIB = -ltdb
1810 DBMLIB = -lgdbm -lgdbm_compat
1811 .endd
1812 The last of those was for a Linux having GDBM provide emulated NDBM facilities.
1813 Settings like that will work if the DBM library is installed in the standard
1814 place. Sometimes it is not, and the library's header file may also not be in
1815 the default path. You may need to set INCLUDE to specify where the header
1816 file is, and to specify the path to the library more fully in DBMLIB, as in
1817 this example:
1818 .code
1819 INCLUDE=-I/usr/local/include/db-4.1
1820 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1821 .endd
1822 There is further detailed discussion about the various DBM libraries in the
1823 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1824
1825
1826
1827 .section "Pre-building configuration" "SECID25"
1828 .cindex "building Exim" "pre-building configuration"
1829 .cindex "configuration for building Exim"
1830 .cindex "&_Local/Makefile_&"
1831 .cindex "&_src/EDITME_&"
1832 Before building Exim, a local configuration file that specifies options
1833 independent of any operating system has to be created with the name
1834 &_Local/Makefile_&. A template for this file is supplied as the file
1835 &_src/EDITME_&, and it contains full descriptions of all the option settings
1836 therein. These descriptions are therefore not repeated here. If you are
1837 building Exim for the first time, the simplest thing to do is to copy
1838 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1839
1840 There are three settings that you must supply, because Exim will not build
1841 without them. They are the location of the runtime configuration file
1842 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1843 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1844 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1845 a colon-separated list of filenames; Exim uses the first of them that exists.
1846
1847 There are a few other parameters that can be specified either at build time or
1848 at runtime, to enable the same binary to be used on a number of different
1849 machines. However, if the locations of Exim's spool directory and log file
1850 directory (if not within the spool directory) are fixed, it is recommended that
1851 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1852 detected early in Exim's execution (such as a malformed configuration file) can
1853 be logged.
1854
1855 .cindex "content scanning" "specifying at build time"
1856 Exim's interfaces for calling virus and spam scanning software directly from
1857 access control lists are not compiled by default. If you want to include these
1858 facilities, you need to set
1859 .code
1860 WITH_CONTENT_SCAN=yes
1861 .endd
1862 in your &_Local/Makefile_&. For details of the facilities themselves, see
1863 chapter &<<CHAPexiscan>>&.
1864
1865
1866 .cindex "&_Local/eximon.conf_&"
1867 .cindex "&_exim_monitor/EDITME_&"
1868 If you are going to build the Exim monitor, a similar configuration process is
1869 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1870 your installation and saved under the name &_Local/eximon.conf_&. If you are
1871 happy with the default settings described in &_exim_monitor/EDITME_&,
1872 &_Local/eximon.conf_& can be empty, but it must exist.
1873
1874 This is all the configuration that is needed in straightforward cases for known
1875 operating systems. However, the building process is set up so that it is easy
1876 to override options that are set by default or by operating-system-specific
1877 configuration files, for example, to change the C compiler, which
1878 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1879 do this.
1880
1881
1882
1883 .section "Support for iconv()" "SECID26"
1884 .cindex "&[iconv()]& support"
1885 .cindex "RFC 2047"
1886 The contents of header lines in messages may be encoded according to the rules
1887 described RFC 2047. This makes it possible to transmit characters that are not
1888 in the ASCII character set, and to label them as being in a particular
1889 character set. When Exim is inspecting header lines by means of the &%$h_%&
1890 mechanism, it decodes them, and translates them into a specified character set
1891 (default is set at build time). The translation is possible only if the operating system
1892 supports the &[iconv()]& function.
1893
1894 However, some of the operating systems that supply &[iconv()]& do not support
1895 very many conversions. The GNU &%libiconv%& library (available from
1896 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1897 systems to remedy this deficiency, as well as on systems that do not supply
1898 &[iconv()]& at all. After installing &%libiconv%&, you should add
1899 .code
1900 HAVE_ICONV=yes
1901 .endd
1902 to your &_Local/Makefile_& and rebuild Exim.
1903
1904
1905
1906 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1907 .cindex "TLS" "including support for TLS"
1908 .cindex "encryption" "including support for"
1909 .cindex "OpenSSL" "building Exim with"
1910 .cindex "GnuTLS" "building Exim with"
1911 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1912 command as per RFC 2487. It can also support clients that expect to
1913 start a TLS session immediately on connection to a non-standard port (see the
1914 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1915 line option).
1916
1917 If you want to build Exim with TLS support, you must first install either the
1918 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1919 implementing SSL.
1920
1921 If you do not want TLS support you should set
1922 .code
1923 DISABLE_TLS=yes
1924 .endd
1925 in &_Local/Makefile_&.
1926
1927 If OpenSSL is installed, you should set
1928 .code
1929 USE_OPENSL=yes
1930 TLS_LIBS=-lssl -lcrypto
1931 .endd
1932 in &_Local/Makefile_&. You may also need to specify the locations of the
1933 OpenSSL library and include files. For example:
1934 .code
1935 USE_OPENSSL=yes
1936 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1937 TLS_INCLUDE=-I/usr/local/openssl/include/
1938 .endd
1939 .cindex "pkg-config" "OpenSSL"
1940 If you have &'pkg-config'& available, then instead you can just use:
1941 .code
1942 USE_OPENSSL=yes
1943 USE_OPENSSL_PC=openssl
1944 .endd
1945 .cindex "USE_GNUTLS"
1946 If GnuTLS is installed, you should set
1947 .code
1948 USE_GNUTLS=yes
1949 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1950 .endd
1951 in &_Local/Makefile_&, and again you may need to specify the locations of the
1952 library and include files. For example:
1953 .code
1954 USE_GNUTLS=yes
1955 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1956 TLS_INCLUDE=-I/usr/gnu/include
1957 .endd
1958 .cindex "pkg-config" "GnuTLS"
1959 If you have &'pkg-config'& available, then instead you can just use:
1960 .code
1961 USE_GNUTLS=yes
1962 USE_GNUTLS_PC=gnutls
1963 .endd
1964
1965 You do not need to set TLS_INCLUDE if the relevant directory is already
1966 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1967 given in chapter &<<CHAPTLS>>&.
1968
1969
1970
1971
1972 .section "Use of tcpwrappers" "SECID27"
1973
1974 .cindex "tcpwrappers, building Exim to support"
1975 .cindex "USE_TCP_WRAPPERS"
1976 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1977 .cindex "tcp_wrappers_daemon_name"
1978 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1979 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1980 alternative to Exim's own checking facilities for installations that are
1981 already making use of &'tcpwrappers'& for other purposes. To do this, you
1982 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1983 &_tcpd.h_& to be available at compile time, and also ensure that the library
1984 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1985 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1986 you might have
1987 .code
1988 USE_TCP_WRAPPERS=yes
1989 CFLAGS=-O -I/usr/local/include
1990 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1991 .endd
1992 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1993 files is &"exim"&. For example, the line
1994 .code
1995 exim : LOCAL  192.168.1.  .friendly.domain.example
1996 .endd
1997 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1998 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1999 All other connections are denied. The daemon name used by &'tcpwrappers'&
2000 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2001 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2002 configure file. Consult the &'tcpwrappers'& documentation for
2003 further details.
2004
2005
2006 .section "Including support for IPv6" "SECID28"
2007 .cindex "IPv6" "including support for"
2008 Exim contains code for use on systems that have IPv6 support. Setting
2009 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2010 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2011 where the IPv6 support is not fully integrated into the normal include and
2012 library files.
2013
2014 Two different types of DNS record for handling IPv6 addresses have been
2015 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2016 currently seen as the mainstream. Another record type called A6 was proposed
2017 as better than AAAA because it had more flexibility. However, it was felt to be
2018 over-complex, and its status was reduced to &"experimental"&.
2019 Exim used to
2020 have a compile option for including A6 record support but this has now been
2021 withdrawn.
2022
2023
2024
2025 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2026 .cindex "lookup modules"
2027 .cindex "dynamic modules"
2028 .cindex ".so building"
2029 On some platforms, Exim supports not compiling all lookup types directly into
2030 the main binary, instead putting some into external modules which can be loaded
2031 on demand.
2032 This permits packagers to build Exim with support for lookups with extensive
2033 library dependencies without requiring all users to install all of those
2034 dependencies.
2035 Most, but not all, lookup types can be built this way.
2036
2037 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2038 installed; Exim will only load modules from that directory, as a security
2039 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2040 for your OS; see &_OS/Makefile-Linux_& for an example.
2041 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2042 see &_src/EDITME_& for details.
2043
2044 Then, for each module to be loaded dynamically, define the relevant
2045 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2046 For example, this will build in lsearch but load sqlite and mysql support
2047 on demand:
2048 .code
2049 LOOKUP_LSEARCH=yes
2050 LOOKUP_SQLITE=2
2051 LOOKUP_MYSQL=2
2052 .endd
2053
2054
2055 .section "The building process" "SECID29"
2056 .cindex "build directory"
2057 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2058 created, run &'make'& at the top level. It determines the architecture and
2059 operating system types, and creates a build directory if one does not exist.
2060 For example, on a Sun system running Solaris 8, the directory
2061 &_build-SunOS5-5.8-sparc_& is created.
2062 .cindex "symbolic link" "to source files"
2063 Symbolic links to relevant source files are installed in the build directory.
2064
2065 If this is the first time &'make'& has been run, it calls a script that builds
2066 a make file inside the build directory, using the configuration files from the
2067 &_Local_& directory. The new make file is then passed to another instance of
2068 &'make'&. This does the real work, building a number of utility scripts, and
2069 then compiling and linking the binaries for the Exim monitor (if configured), a
2070 number of utility programs, and finally Exim itself. The command &`make
2071 makefile`& can be used to force a rebuild of the make file in the build
2072 directory, should this ever be necessary.
2073
2074 If you have problems building Exim, check for any comments there may be in the
2075 &_README_& file concerning your operating system, and also take a look at the
2076 FAQ, where some common problems are covered.
2077
2078
2079
2080 .section 'Output from &"make"&' "SECID283"
2081 The output produced by the &'make'& process for compile lines is often very
2082 unreadable, because these lines can be very long. For this reason, the normal
2083 output is suppressed by default, and instead output similar to that which
2084 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2085 each module that is being compiled or linked. However, it is still possible to
2086 get the full output, by calling &'make'& like this:
2087 .code
2088 FULLECHO='' make -e
2089 .endd
2090 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2091 command reflection in &'make'&. When you ask for the full output, it is
2092 given in addition to the short output.
2093
2094
2095
2096 .section "Overriding build-time options for Exim" "SECToverride"
2097 .cindex "build-time options, overriding"
2098 The main make file that is created at the beginning of the building process
2099 consists of the concatenation of a number of files which set configuration
2100 values, followed by a fixed set of &'make'& instructions. If a value is set
2101 more than once, the last setting overrides any previous ones. This provides a
2102 convenient way of overriding defaults. The files that are concatenated are, in
2103 order:
2104 .display
2105 &_OS/Makefile-Default_&
2106 &_OS/Makefile-_&<&'ostype'&>
2107 &_Local/Makefile_&
2108 &_Local/Makefile-_&<&'ostype'&>
2109 &_Local/Makefile-_&<&'archtype'&>
2110 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2111 &_OS/Makefile-Base_&
2112 .endd
2113 .cindex "&_Local/Makefile_&"
2114 .cindex "building Exim" "operating system type"
2115 .cindex "building Exim" "architecture type"
2116 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2117 architecture type. &_Local/Makefile_& is required to exist, and the building
2118 process fails if it is absent. The other three &_Local_& files are optional,
2119 and are often not needed.
2120
2121 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2122 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2123 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2124 values are used, thereby providing a means of forcing particular settings.
2125 Otherwise, the scripts try to get values from the &%uname%& command. If this
2126 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2127 of &'ad hoc'& transformations are then applied, to produce the standard names
2128 that Exim expects. You can run these scripts directly from the shell in order
2129 to find out what values are being used on your system.
2130
2131
2132 &_OS/Makefile-Default_& contains comments about the variables that are set
2133 therein. Some (but not all) are mentioned below. If there is something that
2134 needs changing, review the contents of this file and the contents of the make
2135 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2136 default values are.
2137
2138
2139 .cindex "building Exim" "overriding default settings"
2140 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2141 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2142 need to change the original files. Instead, you should make the changes by
2143 putting the new values in an appropriate &_Local_& file. For example,
2144 .cindex "Tru64-Unix build-time settings"
2145 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2146 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2147 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2148 called with the option &%-std1%&, to make it recognize some of the features of
2149 Standard C that Exim uses. (Most other compilers recognize Standard C by
2150 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2151 containing the lines
2152 .code
2153 CC=cc
2154 CFLAGS=-std1
2155 .endd
2156 If you are compiling for just one operating system, it may be easier to put
2157 these lines directly into &_Local/Makefile_&.
2158
2159 Keeping all your local configuration settings separate from the distributed
2160 files makes it easy to transfer them to new versions of Exim simply by copying
2161 the contents of the &_Local_& directory.
2162
2163
2164 .cindex "NIS lookup type" "including support for"
2165 .cindex "NIS+ lookup type" "including support for"
2166 .cindex "LDAP" "including support for"
2167 .cindex "lookup" "inclusion in binary"
2168 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2169 lookup, but not all systems have these components installed, so the default is
2170 not to include the relevant code in the binary. All the different kinds of file
2171 and database lookup that Exim supports are implemented as separate code modules
2172 which are included only if the relevant compile-time options are set. In the
2173 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2174 .code
2175 LOOKUP_LDAP=yes
2176 LOOKUP_NIS=yes
2177 LOOKUP_NISPLUS=yes
2178 .endd
2179 and similar settings apply to the other lookup types. They are all listed in
2180 &_src/EDITME_&. In many cases the relevant include files and interface
2181 libraries need to be installed before compiling Exim.
2182 .cindex "cdb" "including support for"
2183 However, there are some optional lookup types (such as cdb) for which
2184 the code is entirely contained within Exim, and no external include
2185 files or libraries are required. When a lookup type is not included in the
2186 binary, attempts to configure Exim to use it cause runtime configuration
2187 errors.
2188
2189 .cindex "pkg-config" "lookups"
2190 .cindex "pkg-config" "authenticators"
2191 Many systems now use a tool called &'pkg-config'& to encapsulate information
2192 about how to compile against a library; Exim has some initial support for
2193 being able to use pkg-config for lookups and authenticators.  For any given
2194 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2195 variable with the &`_PC`& suffix in the name and assign as the value the
2196 name of the package to be queried.  The results of querying via the
2197 &'pkg-config'& command will be added to the appropriate Makefile variables
2198 with &`+=`& directives, so your version of &'make'& will need to support that
2199 syntax.  For instance:
2200 .code
2201 LOOKUP_SQLITE=yes
2202 LOOKUP_SQLITE_PC=sqlite3
2203 AUTH_GSASL=yes
2204 AUTH_GSASL_PC=libgsasl
2205 AUTH_HEIMDAL_GSSAPI=yes
2206 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2207 .endd
2208
2209 .cindex "Perl" "including support for"
2210 Exim can be linked with an embedded Perl interpreter, allowing Perl
2211 subroutines to be called during string expansion. To enable this facility,
2212 .code
2213 EXIM_PERL=perl.o
2214 .endd
2215 must be defined in &_Local/Makefile_&. Details of this facility are given in
2216 chapter &<<CHAPperl>>&.
2217
2218 .cindex "X11 libraries, location of"
2219 The location of the X11 libraries is something that varies a lot between
2220 operating systems, and there may be different versions of X11 to cope
2221 with. Exim itself makes no use of X11, but if you are compiling the Exim
2222 monitor, the X11 libraries must be available.
2223 The following three variables are set in &_OS/Makefile-Default_&:
2224 .code
2225 X11=/usr/X11R6
2226 XINCLUDE=-I$(X11)/include
2227 XLFLAGS=-L$(X11)/lib
2228 .endd
2229 These are overridden in some of the operating-system configuration files. For
2230 example, in &_OS/Makefile-SunOS5_& there is
2231 .code
2232 X11=/usr/openwin
2233 XINCLUDE=-I$(X11)/include
2234 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2235 .endd
2236 If you need to override the default setting for your operating system, place a
2237 definition of all three of these variables into your
2238 &_Local/Makefile-<ostype>_& file.
2239
2240 .cindex "EXTRALIBS"
2241 If you need to add any extra libraries to the link steps, these can be put in a
2242 variable called EXTRALIBS, which appears in all the link commands, but by
2243 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2244 command for linking the main Exim binary, and not for any associated utilities.
2245
2246 .cindex "DBM libraries" "configuration for building"
2247 There is also DBMLIB, which appears in the link commands for binaries that
2248 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2249 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2250 binary, and which can be used, for example, to include additional X11
2251 libraries.
2252
2253 .cindex "configuration file" "editing"
2254 The make file copes with rebuilding Exim correctly if any of the configuration
2255 files are edited. However, if an optional configuration file is deleted, it is
2256 necessary to touch the associated non-optional file (that is,
2257 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2258
2259
2260 .section "OS-specific header files" "SECID30"
2261 .cindex "&_os.h_&"
2262 .cindex "building Exim" "OS-specific C header files"
2263 The &_OS_& directory contains a number of files with names of the form
2264 &_os.h-<ostype>_&. These are system-specific C header files that should not
2265 normally need to be changed. There is a list of macro settings that are
2266 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2267 are porting Exim to a new operating system.
2268
2269
2270
2271 .section "Overriding build-time options for the monitor" "SECID31"
2272 .cindex "building Eximon"
2273 A similar process is used for overriding things when building the Exim monitor,
2274 where the files that are involved are
2275 .display
2276 &_OS/eximon.conf-Default_&
2277 &_OS/eximon.conf-_&<&'ostype'&>
2278 &_Local/eximon.conf_&
2279 &_Local/eximon.conf-_&<&'ostype'&>
2280 &_Local/eximon.conf-_&<&'archtype'&>
2281 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2282 .endd
2283 .cindex "&_Local/eximon.conf_&"
2284 As with Exim itself, the final three files need not exist, and in this case the
2285 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2286 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2287 variables of the same name, preceded by EXIMON_. For example, setting
2288 EXIMON_LOG_DEPTH in the environment overrides the value of
2289 LOG_DEPTH at runtime.
2290 .ecindex IIDbuex
2291
2292
2293 .section "Installing Exim binaries and scripts" "SECID32"
2294 .cindex "installing Exim"
2295 .cindex "BIN_DIRECTORY"
2296 The command &`make install`& runs the &(exim_install)& script with no
2297 arguments. The script copies binaries and utility scripts into the directory
2298 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2299 .cindex "setuid" "installing Exim with"
2300 The install script copies files only if they are newer than the files they are
2301 going to replace. The Exim binary is required to be owned by root and have the
2302 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2303 install`& as root so that it can set up the Exim binary in this way. However, in
2304 some special situations (for example, if a host is doing no local deliveries)
2305 it may be possible to run Exim without making the binary setuid root (see
2306 chapter &<<CHAPsecurity>>& for details).
2307
2308 .cindex "CONFIGURE_FILE"
2309 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2310 in &_Local/Makefile_&. If this names a single file, and the file does not
2311 exist, the default configuration file &_src/configure.default_& is copied there
2312 by the installation script. If a runtime configuration file already exists, it
2313 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2314 alternative files, no default is installed.
2315
2316 .cindex "system aliases file"
2317 .cindex "&_/etc/aliases_&"
2318 One change is made to the default configuration file when it is installed: the
2319 default configuration contains a router that references a system aliases file.
2320 The path to this file is set to the value specified by
2321 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2322 If the system aliases file does not exist, the installation script creates it,
2323 and outputs a comment to the user.
2324
2325 The created file contains no aliases, but it does contain comments about the
2326 aliases a site should normally have. Mail aliases have traditionally been
2327 kept in &_/etc/aliases_&. However, some operating systems are now using
2328 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2329 Exim's configuration if necessary.
2330
2331 The default configuration uses the local host's name as the only local domain,
2332 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2333 running as the local user. System aliases and &_.forward_& files in users' home
2334 directories are supported, but no NIS or NIS+ support is configured. Domains
2335 other than the name of the local host are routed using the DNS, with delivery
2336 over SMTP.
2337
2338 It is possible to install Exim for special purposes (such as building a binary
2339 distribution) in a private part of the file system. You can do this by a
2340 command such as
2341 .code
2342 make DESTDIR=/some/directory/ install
2343 .endd
2344 This has the effect of pre-pending the specified directory to all the file
2345 paths, except the name of the system aliases file that appears in the default
2346 configuration. (If a default alias file is created, its name &'is'& modified.)
2347 For backwards compatibility, ROOT is used if DESTDIR is not set,
2348 but this usage is deprecated.
2349
2350 .cindex "installing Exim" "what is not installed"
2351 Running &'make install'& does not copy the Exim 4 conversion script
2352 &'convert4r4'&. You will probably run this only once if you are
2353 upgrading from Exim 3. None of the documentation files in the &_doc_&
2354 directory are copied, except for the info files when you have set
2355 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2356
2357 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2358 to their names. The Exim binary itself, however, is handled differently. It is
2359 installed under a name that includes the version number and the compile number,
2360 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2361 called &_exim_& to point to the binary. If you are updating a previous version
2362 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2363 from the directory (as seen by other processes).
2364
2365 .cindex "installing Exim" "testing the script"
2366 If you want to see what the &'make install'& will do before running it for
2367 real, you can pass the &%-n%& option to the installation script by this
2368 command:
2369 .code
2370 make INSTALL_ARG=-n install
2371 .endd
2372 The contents of the variable INSTALL_ARG are passed to the installation
2373 script. You do not need to be root to run this test. Alternatively, you can run
2374 the installation script directly, but this must be from within the build
2375 directory. For example, from the top-level Exim directory you could use this
2376 command:
2377 .code
2378 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2379 .endd
2380 .cindex "installing Exim" "install script options"
2381 There are two other options that can be supplied to the installation script.
2382
2383 .ilist
2384 &%-no_chown%& bypasses the call to change the owner of the installed binary
2385 to root, and the call to make it a setuid binary.
2386 .next
2387 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2388 installed binary.
2389 .endlist
2390
2391 INSTALL_ARG can be used to pass these options to the script. For example:
2392 .code
2393 make INSTALL_ARG=-no_symlink install
2394 .endd
2395 The installation script can also be given arguments specifying which files are
2396 to be copied. For example, to install just the Exim binary, and nothing else,
2397 without creating the symbolic link, you could use:
2398 .code
2399 make INSTALL_ARG='-no_symlink exim' install
2400 .endd
2401
2402
2403
2404 .section "Installing info documentation" "SECTinsinfdoc"
2405 .cindex "installing Exim" "&'info'& documentation"
2406 Not all systems use the GNU &'info'& system for documentation, and for this
2407 reason, the Texinfo source of Exim's documentation is not included in the main
2408 distribution. Instead it is available separately from the FTP site (see section
2409 &<<SECTavail>>&).
2410
2411 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2412 source of the documentation is found in the source tree, running &`make
2413 install`& automatically builds the info files and installs them.
2414
2415
2416
2417 .section "Setting up the spool directory" "SECID33"
2418 .cindex "spool directory" "creating"
2419 When it starts up, Exim tries to create its spool directory if it does not
2420 exist. The Exim uid and gid are used for the owner and group of the spool
2421 directory. Sub-directories are automatically created in the spool directory as
2422 necessary.
2423
2424
2425
2426
2427 .section "Testing" "SECID34"
2428 .cindex "testing" "installation"
2429 Having installed Exim, you can check that the runtime configuration file is
2430 syntactically valid by running the following command, which assumes that the
2431 Exim binary directory is within your PATH environment variable:
2432 .code
2433 exim -bV
2434 .endd
2435 If there are any errors in the configuration file, Exim outputs error messages.
2436 Otherwise it outputs the version number and build date,
2437 the DBM library that is being used, and information about which drivers and
2438 other optional code modules are included in the binary.
2439 Some simple routing tests can be done by using the address testing option. For
2440 example,
2441 .display
2442 &`exim -bt`& <&'local username'&>
2443 .endd
2444 should verify that it recognizes a local mailbox, and
2445 .display
2446 &`exim -bt`& <&'remote address'&>
2447 .endd
2448 a remote one. Then try getting it to deliver mail, both locally and remotely.
2449 This can be done by passing messages directly to Exim, without going through a
2450 user agent. For example:
2451 .code
2452 exim -v postmaster@your.domain.example
2453 From: user@your.domain.example
2454 To: postmaster@your.domain.example
2455 Subject: Testing Exim
2456
2457 This is a test message.
2458 ^D
2459 .endd
2460 The &%-v%& option causes Exim to output some verification of what it is doing.
2461 In this case you should see copies of three log lines, one for the message's
2462 arrival, one for its delivery, and one containing &"Completed"&.
2463
2464 .cindex "delivery" "problems with"
2465 If you encounter problems, look at Exim's log files (&'mainlog'& and
2466 &'paniclog'&) to see if there is any relevant information there. Another source
2467 of information is running Exim with debugging turned on, by specifying the
2468 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2469 with debugging turned on by a command of the form
2470 .display
2471 &`exim -d -M`& <&'exim-message-id'&>
2472 .endd
2473 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2474 produces rather a lot of output, but you can cut this down to specific areas.
2475 For example, if you use &%-d-all+route%& only the debugging information
2476 relevant to routing is included. (See the &%-d%& option in chapter
2477 &<<CHAPcommandline>>& for more details.)
2478
2479 .cindex '&"sticky"& bit'
2480 .cindex "lock files"
2481 One specific problem that has shown up on some sites is the inability to do
2482 local deliveries into a shared mailbox directory, because it does not have the
2483 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2484 writing to a mailbox file, and if it cannot create the lock file, the delivery
2485 is deferred. You can get round this either by setting the &"sticky bit"& on the
2486 directory, or by setting a specific group for local deliveries and allowing
2487 that group to create files in the directory (see the comments above the
2488 &(local_delivery)& transport in the default configuration file). Another
2489 approach is to configure Exim not to use lock files, but just to rely on
2490 &[fcntl()]& locking instead. However, you should do this only if all user
2491 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2492 see chapter &<<CHAPappendfile>>&.
2493
2494 One thing that cannot be tested on a system that is already running an MTA is
2495 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2496 &%-oX%& option can be used to run an Exim daemon that listens on some other
2497 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2498 &'exim_checkaccess'& utility can be used to check out policy controls on
2499 incoming SMTP mail.
2500
2501 Testing a new version on a system that is already running Exim can most easily
2502 be done by building a binary with a different CONFIGURE_FILE setting. From
2503 within the runtime configuration, all other file and directory names
2504 that Exim uses can be altered, in order to keep it entirely clear of the
2505 production version.
2506
2507
2508 .section "Replacing another MTA with Exim" "SECID35"
2509 .cindex "replacing another MTA"
2510 Building and installing Exim for the first time does not of itself put it in
2511 general use. The name by which the system's MTA is called by mail user agents
2512 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2513 operating system), and it is necessary to make this name point to the &'exim'&
2514 binary in order to get the user agents to pass messages to Exim. This is
2515 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2516 or &_/usr/lib/sendmail_&
2517 .cindex "symbolic link" "to &'exim'& binary"
2518 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2519 privilege and executable status from the old MTA. It is then necessary to stop
2520 and restart the mailer daemon, if one is running.
2521
2522 .cindex "FreeBSD, MTA indirection"
2523 .cindex "&_/etc/mail/mailer.conf_&"
2524 Some operating systems have introduced alternative ways of switching MTAs. For
2525 example, if you are running FreeBSD, you need to edit the file
2526 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2527 described. A typical example of the contents of this file for running Exim is
2528 as follows:
2529 .code
2530 sendmail            /usr/exim/bin/exim
2531 send-mail           /usr/exim/bin/exim
2532 mailq               /usr/exim/bin/exim -bp
2533 newaliases          /usr/bin/true
2534 .endd
2535 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2536 your Exim installation is &"live"&. Check it by sending a message from your
2537 favourite user agent.
2538
2539 You should consider what to tell your users about the change of MTA. Exim may
2540 have different capabilities to what was previously running, and there are
2541 various operational differences such as the text of messages produced by
2542 command line options and in bounce messages. If you allow your users to make
2543 use of Exim's filtering capabilities, you should make the document entitled
2544 &'Exim's interface to mail filtering'& available to them.
2545
2546
2547
2548 .section "Running the daemon" SECTdaemonLaunch
2549 The most common command line for launching the Exim daemon looks like
2550 .code
2551 exim -bd -q5m
2552 .endd
2553 This starts a daemon which
2554 .ilist
2555 listens for incoming smtp connections, launching handler processes for
2556 each new one
2557 .next
2558 starts a queue-runner process every five minutes, to inspect queued messages
2559 and run delivery attempts on any that have arrived at their retry time
2560 .endlist
2561 Should a queue run take longer than the time between queue-runner starts,
2562 they will run in parallel.
2563 Numbers of jobs of the various types are subject to policy controls
2564 defined in the configuration.
2565
2566
2567 .section "Upgrading Exim" "SECID36"
2568 .cindex "upgrading Exim"
2569 If you are already running Exim on your host, building and installing a new
2570 version automatically makes it available to MUAs, or any other programs that
2571 call the MTA directly. However, if you are running an Exim daemon, you do need
2572 .cindex restart "on HUP signal"
2573 .cindex signal "HUP, to restart"
2574 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2575 new binary. You do not need to stop processing mail in order to install a new
2576 version of Exim. The install script does not modify an existing runtime
2577 configuration file.
2578
2579
2580
2581
2582 .section "Stopping the Exim daemon on Solaris" "SECID37"
2583 .cindex "Solaris" "stopping Exim on"
2584 The standard command for stopping the mailer daemon on Solaris is
2585 .code
2586 /etc/init.d/sendmail stop
2587 .endd
2588 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2589 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2590 for the text &"sendmail"&; this is not present because the actual program name
2591 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2592 solution is to replace the line that finds the process id with something like
2593 .code
2594 pid=`cat /var/spool/exim/exim-daemon.pid`
2595 .endd
2596 to obtain the daemon's pid directly from the file that Exim saves it in.
2597
2598 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2599 still be received from local processes, and if automatic delivery is configured
2600 (the normal case), deliveries will still occur.
2601
2602
2603
2604
2605 . ////////////////////////////////////////////////////////////////////////////
2606 . ////////////////////////////////////////////////////////////////////////////
2607
2608 .chapter "The Exim command line" "CHAPcommandline"
2609 .scindex IIDclo1 "command line" "options"
2610 .scindex IIDclo2 "options" "command line"
2611 Exim's command line takes the standard Unix form of a sequence of options,
2612 each starting with a hyphen character, followed by a number of arguments. The
2613 options are compatible with the main options of Sendmail, and there are also
2614 some additional options, some of which are compatible with Smail 3. Certain
2615 combinations of options do not make sense, and provoke an error if used.
2616 The form of the arguments depends on which options are set.
2617
2618
2619 .section "Setting options by program name" "SECID38"
2620 .cindex "&'mailq'&"
2621 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2622 were present before any other options.
2623 The &%-bp%& option requests a listing of the contents of the mail queue on the
2624 standard output.
2625 This feature is for compatibility with some systems that contain a command of
2626 that name in one of the standard libraries, symbolically linked to
2627 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2628
2629 .cindex "&'rsmtp'&"
2630 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2631 were present before any other options, for compatibility with Smail. The
2632 &%-bS%& option is used for reading in a number of messages in batched SMTP
2633 format.
2634
2635 .cindex "&'rmail'&"
2636 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2637 &%-oee%& options were present before any other options, for compatibility with
2638 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2639
2640 .cindex "&'runq'&"
2641 .cindex "queue runner"
2642 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2643 were present before any other options, for compatibility with Smail. The &%-q%&
2644 option causes a single queue runner process to be started.
2645
2646 .cindex "&'newaliases'&"
2647 .cindex "alias file" "building"
2648 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2649 If Exim is called under the name &'newaliases'& it behaves as if the option
2650 &%-bi%& were present before any other options, for compatibility with Sendmail.
2651 This option is used for rebuilding Sendmail's alias file. Exim does not have
2652 the concept of a single alias file, but can be configured to run a given
2653 command if called with the &%-bi%& option.
2654
2655
2656 .section "Trusted and admin users" "SECTtrustedadmin"
2657 Some Exim options are available only to &'trusted users'& and others are
2658 available only to &'admin users'&. In the description below, the phrases &"Exim
2659 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2660 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2661 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2662
2663 .ilist
2664 .cindex "trusted users" "definition of"
2665 .cindex "user" "trusted definition of"
2666 The trusted users are root, the Exim user, any user listed in the
2667 &%trusted_users%& configuration option, and any user whose current group or any
2668 supplementary group is one of those listed in the &%trusted_groups%&
2669 configuration option. Note that the Exim group is not automatically trusted.
2670
2671 .cindex '&"From"& line'
2672 .cindex "envelope from"
2673 .cindex "envelope sender"
2674 Trusted users are always permitted to use the &%-f%& option or a leading
2675 &"From&~"& line to specify the envelope sender of a message that is passed to
2676 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2677 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2678 users to set envelope senders.
2679
2680 .chindex From:
2681 .chindex Sender:
2682 For a trusted user, there is never any check on the contents of the &'From:'&
2683 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2684 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2685
2686 Trusted users may also specify a host name, host address, interface address,
2687 protocol name, ident value, and authentication data when submitting a message
2688 locally. Thus, they are able to insert messages into Exim's queue locally that
2689 have the characteristics of messages received from a remote host. Untrusted
2690 users may in some circumstances use &%-f%&, but can never set the other values
2691 that are available to trusted users.
2692 .next
2693 .cindex "user" "admin definition of"
2694 .cindex "admin user" "definition of"
2695 The admin users are root, the Exim user, and any user that is a member of the
2696 Exim group or of any group listed in the &%admin_groups%& configuration option.
2697 The current group does not have to be one of these groups.
2698
2699 Admin users are permitted to list the queue, and to carry out certain
2700 operations on messages, for example, to force delivery failures. It is also
2701 necessary to be an admin user in order to see the full information provided by
2702 the Exim monitor, and full debugging output.
2703
2704 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2705 Exim to attempt delivery of messages on its queue is restricted to admin users.
2706 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2707 option false (that is, specifying &%no_prod_requires_admin%&).
2708
2709 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2710 is restricted to admin users unless &%queue_list_requires_admin%& is set
2711 false.
2712 .endlist
2713
2714
2715 &*Warning*&: If you configure your system so that admin users are able to
2716 edit Exim's configuration file, you are giving those users an easy way of
2717 getting root. There is further discussion of this issue at the start of chapter
2718 &<<CHAPconf>>&.
2719
2720
2721
2722
2723 .section "Command line options" "SECID39"
2724 Exim's command line options are described in alphabetical order below. If none
2725 of the options that specifies a specific action (such as starting the daemon or
2726 a queue runner, or testing an address, or receiving a message in a specific
2727 format, or listing the queue) are present, and there is at least one argument
2728 on the command line, &%-bm%& (accept a local message on the standard input,
2729 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2730 outputs a brief message about itself and exits.
2731
2732 . ////////////////////////////////////////////////////////////////////////////
2733 . Insert a stylized XML comment here, to identify the start of the command line
2734 . options. This is for the benefit of the Perl script that automatically
2735 . creates a man page for the options.
2736 . ////////////////////////////////////////////////////////////////////////////
2737
2738 .literal xml
2739 <!-- === Start of command line options === -->
2740 .literal off
2741
2742
2743 .vlist
2744 .cmdopt "--" "--"
2745 .cindex "options" "command line; terminating"
2746 This is a pseudo-option whose only purpose is to terminate the options and
2747 therefore to cause subsequent command line items to be treated as arguments
2748 rather than options, even if they begin with hyphens.
2749
2750 .cmdopt --help
2751 This option causes Exim to output a few sentences stating what it is.
2752 The same output is generated if the Exim binary is called with no options and
2753 no arguments.
2754
2755 .cmdopt --version
2756 This option is an alias for &%-bV%& and causes version information to be
2757 displayed.
2758
2759 .vitem &%-Ac%& &&&
2760        &%-Am%&
2761 .oindex "&%-Ac%&"
2762 .oindex "&%-Am%&"
2763 These options are used by Sendmail for selecting configuration files and are
2764 ignored by Exim.
2765
2766 .cmdopt -B <&'type'&>
2767 .oindex "&%-B%&"
2768 .cindex "8-bit characters"
2769 .cindex "Sendmail compatibility" "8-bit characters"
2770 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2771 clean; it ignores this option.
2772
2773 .cmdopt -bd
2774 .cindex "daemon"
2775 .cindex "SMTP" "listener"
2776 .cindex "queue runner"
2777 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2778 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2779 that the daemon should also initiate periodic queue runs.
2780
2781 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2782 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2783 disconnect from the controlling terminal. When running this way, it can be
2784 stopped by pressing ctrl-C.
2785
2786 By default, Exim listens for incoming connections to the standard SMTP port on
2787 all the host's running interfaces. However, it is possible to listen on other
2788 ports, on multiple ports, and only on specific interfaces. Chapter
2789 &<<CHAPinterfaces>>& contains a description of the options that control this.
2790
2791 When a listening daemon
2792 .cindex "daemon" "process id (pid)"
2793 .cindex "pid (process id)" "of daemon"
2794 is started without the use of &%-oX%& (that is, without overriding the normal
2795 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2796 in Exim's spool directory. This location can be overridden by setting
2797 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2798 running as root.
2799
2800 When &%-oX%& is used on the command line to start a listening daemon, the
2801 process id is not written to the normal pid file path. However, &%-oP%& can be
2802 used to specify a path on the command line if a pid file is required.
2803
2804 The SIGHUP signal
2805 .cindex "SIGHUP"
2806 .cindex restart "on HUP signal"
2807 .cindex signal "HUP, to restart"
2808 .cindex "daemon" "restarting"
2809 .cindex signal "to reload configuration"
2810 .cindex daemon "reload configuration"
2811 .cindex reload configuration
2812 can be used to cause the daemon to re-execute itself. This should be done
2813 whenever Exim's configuration file, or any file that is incorporated into it by
2814 means of the &%.include%& facility, is changed, and also whenever a new version
2815 of Exim is installed. It is not necessary to do this when other files that are
2816 referenced from the configuration (for example, alias files) are changed,
2817 because these are reread each time they are used.
2818
2819 .new
2820 Either a SIGTERM or a SIGINT signal should be used to cause the daemon
2821 to cleanly shut down.
2822 Subprocesses handling recceiving or delivering messages,
2823 or for scanning the queue,
2824 will not be affected by the termination of the daemon process.
2825 .wen
2826
2827 .cmdopt -bdf
2828 This option has the same effect as &%-bd%& except that it never disconnects
2829 from the controlling terminal, even when no debugging is specified.
2830
2831 .cmdopt -be
2832 .cindex "testing" "string expansion"
2833 .cindex "expansion" "testing"
2834 Run Exim in expansion testing mode. Exim discards its root privilege, to
2835 prevent ordinary users from using this mode to read otherwise inaccessible
2836 files. If no arguments are given, Exim runs interactively, prompting for lines
2837 of data. Otherwise, it processes each argument in turn.
2838
2839 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2840 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2841 used without command line arguments. If successful, it uses the &[readline()]&
2842 function, which provides extensive line-editing facilities, for reading the
2843 test data. A line history is supported.
2844
2845 Long expansion expressions can be split over several lines by using backslash
2846 continuations. As in Exim's runtime configuration, white space at the start of
2847 continuation lines is ignored. Each argument or data line is passed through the
2848 string expansion mechanism, and the result is output. Variable values from the
2849 configuration file (for example, &$qualify_domain$&) are available, but no
2850 message-specific values (such as &$message_exim_id$&) are set, because no message
2851 is being processed (but see &%-bem%& and &%-Mset%&).
2852
2853 &*Note*&: If you use this mechanism to test lookups, and you change the data
2854 files or databases you are using, you must exit and restart Exim before trying
2855 the same lookup again. Otherwise, because each Exim process caches the results
2856 of lookups, you will just get the same result as before.
2857
2858 Macro processing is done on lines before string-expansion: new macros can be
2859 defined and macros will be expanded.
2860 Because macros in the config file are often used for secrets, those are only
2861 available to admin users.
2862
2863 .new
2864 The word &"set"& at the start of a line, followed by a single space,
2865 is recognised specially as defining a value for a variable.
2866 The syntax is otherwise the same as the ACL modifier &"set ="&.
2867 .wen
2868
2869 .cmdopt -bem <&'filename'&>
2870 .cindex "testing" "string expansion"
2871 .cindex "expansion" "testing"
2872 This option operates like &%-be%& except that it must be followed by the name
2873 of a file. For example:
2874 .code
2875 exim -bem /tmp/testmessage
2876 .endd
2877 The file is read as a message (as if receiving a locally-submitted non-SMTP
2878 message) before any of the test expansions are done. Thus, message-specific
2879 variables such as &$message_size$& and &$header_from:$& are available. However,
2880 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2881 recipients are read from the headers in the normal way, and are shown in the
2882 &$recipients$& variable. Note that recipients cannot be given on the command
2883 line, because further arguments are taken as strings to expand (just like
2884 &%-be%&).
2885
2886 .cmdopt -bF <&'filename'&>
2887 .cindex "system filter" "testing"
2888 .cindex "testing" "system filter"
2889 This option is the same as &%-bf%& except that it assumes that the filter being
2890 tested is a system filter. The additional commands that are available only in
2891 system filters are recognized.
2892
2893 .cmdopt -bf <&'filename'&>
2894 .cindex "filter" "testing"
2895 .cindex "testing" "filter file"
2896 .cindex "forward file" "testing"
2897 .cindex "testing" "forward file"
2898 .cindex "Sieve filter" "testing"
2899 This option runs Exim in user filter testing mode; the file is the filter file
2900 to be tested, and a test message must be supplied on the standard input. If
2901 there are no message-dependent tests in the filter, an empty file can be
2902 supplied.
2903
2904 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2905 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2906 filter and a user filter in the same run. For example:
2907 .code
2908 exim -bF /system/filter -bf /user/filter </test/message
2909 .endd
2910 This is helpful when the system filter adds header lines or sets filter
2911 variables that are used by the user filter.
2912
2913 If the test filter file does not begin with one of the special lines
2914 .code
2915 # Exim filter
2916 # Sieve filter
2917 .endd
2918 it is taken to be a normal &_.forward_& file, and is tested for validity under
2919 that interpretation. See sections &<<SECTitenonfilred>>& to
2920 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2921 redirection lists.
2922
2923 The result of an Exim command that uses &%-bf%&, provided no errors are
2924 detected, is a list of the actions that Exim would try to take if presented
2925 with the message for real. More details of filter testing are given in the
2926 separate document entitled &'Exim's interfaces to mail filtering'&.
2927
2928 When testing a filter file,
2929 .cindex "&""From""& line"
2930 .cindex "envelope from"
2931 .cindex "envelope sender"
2932 .oindex "&%-f%&" "for filter testing"
2933 the envelope sender can be set by the &%-f%& option,
2934 or by a &"From&~"& line at the start of the test message. Various parameters
2935 that would normally be taken from the envelope recipient address of the message
2936 can be set by means of additional command line options (see the next four
2937 options).
2938
2939 .cmdopt -bfd <&'domain'&>
2940 .vindex "&$qualify_domain$&"
2941 This sets the domain of the recipient address when a filter file is being
2942 tested by means of the &%-bf%& option. The default is the value of
2943 &$qualify_domain$&.
2944
2945 .cmdopt -bfl <&'local&~part'&>
2946 This sets the local part of the recipient address when a filter file is being
2947 tested by means of the &%-bf%& option. The default is the username of the
2948 process that calls Exim. A local part should be specified with any prefix or
2949 suffix stripped, because that is how it appears to the filter when a message is
2950 actually being delivered.
2951
2952 .cmdopt -bfp <&'prefix'&>
2953 .cindex affix "filter testing"
2954 This sets the prefix of the local part of the recipient address when a filter
2955 file is being tested by means of the &%-bf%& option. The default is an empty
2956 prefix.
2957
2958 .cmdopt -bfs <&'suffix'&>
2959 .cindex affix "filter testing"
2960 This sets the suffix of the local part of the recipient address when a filter
2961 file is being tested by means of the &%-bf%& option. The default is an empty
2962 suffix.
2963
2964 .cmdopt -bh <&'IP&~address'&>
2965 .cindex "testing" "incoming SMTP"
2966 .cindex "SMTP" "testing incoming"
2967 .cindex "testing" "relay control"
2968 .cindex "relaying" "testing configuration"
2969 .cindex "policy control" "testing"
2970 .cindex "debugging" "&%-bh%& option"
2971 This option runs a fake SMTP session as if from the given IP address, using the
2972 standard input and output. The IP address may include a port number at the end,
2973 after a full stop. For example:
2974 .code
2975 exim -bh 10.9.8.7.1234
2976 exim -bh fe80::a00:20ff:fe86:a061.5678
2977 .endd
2978 When an IPv6 address is given, it is converted into canonical form. In the case
2979 of the second example above, the value of &$sender_host_address$& after
2980 conversion to the canonical form is
2981 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2982
2983 Comments as to what is going on are written to the standard error file. These
2984 include lines beginning with &"LOG"& for anything that would have been logged.
2985 This facility is provided for testing configuration options for incoming
2986 messages, to make sure they implement the required policy. For example, you can
2987 test your relay controls using &%-bh%&.
2988
2989 &*Warning 1*&:
2990 .cindex "RFC 1413"
2991 You can test features of the configuration that rely on ident (RFC 1413)
2992 information by using the &%-oMt%& option. However, Exim cannot actually perform
2993 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2994 connection.
2995
2996 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2997 are also skipped when testing using &%-bh%&. If you want these callouts to
2998 occur, use &%-bhc%& instead.
2999
3000 Messages supplied during the testing session are discarded, and nothing is
3001 written to any of the real log files. There may be pauses when DNS (and other)
3002 lookups are taking place, and of course these may time out. The &%-oMi%& option
3003 can be used to specify a specific IP interface and port if this is important,
3004 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3005 session were authenticated.
3006
3007 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3008 output just states whether a given recipient address from a given host is
3009 acceptable or not. See section &<<SECTcheckaccess>>&.
3010
3011 Features such as authentication and encryption, where the client input is not
3012 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3013 specialized SMTP test program such as
3014 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3015
3016 .cmdopt -bhc <&'IP&~address'&>
3017 This option operates in the same way as &%-bh%&, except that address
3018 verification callouts are performed if required. This includes consulting and
3019 updating the callout cache database.
3020
3021 .cmdopt -bi
3022 .cindex "alias file" "building"
3023 .cindex "building alias file"
3024 .cindex "Sendmail compatibility" "&%-bi%& option"
3025 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3026 Exim does not have the concept of a single alias file, and so it cannot mimic
3027 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3028 tend to appear in various scripts such as NIS make files, so the option must be
3029 recognized.
3030
3031 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3032 configuration option is run, under the uid and gid of the caller of Exim. If
3033 the &%-oA%& option is used, its value is passed to the command as an argument.
3034 The command set by &%bi_command%& may not contain arguments. The command can
3035 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3036 if this is required. If the &%bi_command%& option is not set, calling Exim with
3037 &%-bi%& is a no-op.
3038
3039 . // Keep :help first, then the rest in alphabetical order
3040 .cmdopt -bI:help
3041 .cindex "querying exim information"
3042 We shall provide various options starting &`-bI:`& for querying Exim for
3043 information.  The output of many of these will be intended for machine
3044 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3045 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3046 options shall cause Exim to exit after producing the requested output.
3047
3048 .cmdopt -bI:dscp
3049 .cindex "DSCP" "values"
3050 This option causes Exim to emit an alphabetically sorted list of all
3051 recognised DSCP names.
3052
3053 .cmdopt -bI:sieve
3054 .cindex "Sieve filter" "capabilities"
3055 This option causes Exim to emit an alphabetically sorted list of all supported
3056 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3057 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3058 &`SIEVE`& capability response line.  As the precise list may depend upon
3059 compile-time build options, which this option will adapt to, this is the only
3060 way to guarantee a correct response.
3061
3062 .cmdopt -bm
3063 .cindex "local message reception"
3064 This option runs an Exim receiving process that accepts an incoming,
3065 locally-generated message on the standard input. The recipients are given as the
3066 command arguments (except when &%-t%& is also present &-- see below). Each
3067 argument can be a comma-separated list of RFC 2822 addresses. This is the
3068 default option for selecting the overall action of an Exim call; it is assumed
3069 if no other conflicting option is present.
3070
3071 If any addresses in the message are unqualified (have no domain), they are
3072 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3073 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3074 suppressing this for special cases.
3075
3076 Policy checks on the contents of local messages can be enforced by means of
3077 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3078
3079 .cindex "return code" "for &%-bm%&"
3080 The return code is zero if the message is successfully accepted. Otherwise, the
3081 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3082
3083 The format
3084 .cindex "message" "format"
3085 .cindex "format" "message"
3086 .cindex "&""From""& line"
3087 .cindex "UUCP" "&""From""& line"
3088 .cindex "Sendmail compatibility" "&""From""& line"
3089 of the message must be as defined in RFC 2822, except that, for
3090 compatibility with Sendmail and Smail, a line in one of the forms
3091 .code
3092 From sender Fri Jan  5 12:55 GMT 1997
3093 From sender Fri, 5 Jan 97 12:55:01
3094 .endd
3095 (with the weekday optional, and possibly with additional text after the date)
3096 is permitted to appear at the start of the message. There appears to be no
3097 authoritative specification of the format of this line. Exim recognizes it by
3098 matching against the regular expression defined by the &%uucp_from_pattern%&
3099 option, which can be changed if necessary.
3100
3101 .oindex "&%-f%&" "overriding &""From""& line"
3102 The specified sender is treated as if it were given as the argument to the
3103 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3104 preference to the address taken from the message. The caller of Exim must be a
3105 trusted user for the sender of a message to be set in this way.
3106
3107 .cmdopt -bmalware <&'filename'&>
3108 .cindex "testing", "malware"
3109 .cindex "malware scan test"
3110 This debugging option causes Exim to scan the given file or directory
3111 (depending on the used scanner interface),
3112 using the malware scanning framework.  The option of &%av_scanner%& influences
3113 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3114 the expansion should have defaults which apply to this invocation.  ACLs are
3115 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3116 will never be populated and &%-bmalware%& will fail.
3117
3118 Exim will have changed working directory before resolving the filename, so
3119 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3120 user when it tries to open the file, rather than as the invoking user.
3121 This option requires admin privileges.
3122
3123 The &%-bmalware%& option will not be extended to be more generally useful,
3124 there are better tools for file-scanning.  This option exists to help
3125 administrators verify their Exim and AV scanner configuration.
3126
3127 .cmdopt -bnq
3128 .cindex "address qualification, suppressing"
3129 By default, Exim automatically qualifies unqualified addresses (those
3130 without domains) that appear in messages that are submitted locally (that
3131 is, not over TCP/IP). This qualification applies both to addresses in
3132 envelopes, and addresses in header lines. Sender addresses are qualified using
3133 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3134 defaults to the value of &%qualify_domain%&).
3135
3136 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3137 being used to re-submit messages that originally came from remote hosts after
3138 content scanning, you probably do not want to qualify unqualified addresses in
3139 header lines. (Such lines will be present only if you have not enabled a header
3140 syntax check in the appropriate ACL.)
3141
3142 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3143 messages that originate on the local host. When this is used, unqualified
3144 addresses in the envelope provoke errors (causing message rejection) and
3145 unqualified addresses in header lines are left alone.
3146
3147
3148 .cmdopt -bP
3149 .cindex "configuration options" "extracting"
3150 .cindex "options" "configuration &-- extracting"
3151 If this option is given with no arguments, it causes the values of all Exim's
3152 main configuration options to be written to the standard output. The values
3153 of one or more specific options can be requested by giving their names as
3154 arguments, for example:
3155 .code
3156 exim -bP qualify_domain hold_domains
3157 .endd
3158 .cindex "hiding configuration option values"
3159 .cindex "configuration options" "hiding value of"
3160 .cindex "options" "hiding value of"
3161 However, any option setting that is preceded by the word &"hide"& in the
3162 configuration file is not shown in full, except to an admin user. For other
3163 users, the output is as in this example:
3164 .code
3165 mysql_servers = <value not displayable>
3166 .endd
3167 If &%config%& is given as an argument, the config is
3168 output, as it was parsed, any include file resolved, any comment removed.
3169
3170 If &%config_file%& is given as an argument, the name of the runtime
3171 configuration file is output. (&%configure_file%& works too, for
3172 backward compatibility.)
3173 If a list of configuration files was supplied, the value that is output here
3174 is the name of the file that was actually used.
3175
3176 .cindex "options" "hiding name of"
3177 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3178 name will not be output.
3179
3180 .cindex "daemon" "process id (pid)"
3181 .cindex "pid (process id)" "of daemon"
3182 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3183 directories where log files and daemon pid files are written are output,
3184 respectively. If these values are unset, log files are written in a
3185 sub-directory of the spool directory called &%log%&, and the pid file is
3186 written directly into the spool directory.
3187
3188 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3189 .code
3190 exim -bP +local_domains
3191 .endd
3192 it searches for a matching named list of any type (domain, host, address, or
3193 local part) and outputs what it finds.
3194
3195 .cindex "options" "router &-- extracting"
3196 .cindex "options" "transport &-- extracting"
3197 .cindex "options" "authenticator &-- extracting"
3198 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3199 followed by the name of an appropriate driver instance, the option settings for
3200 that driver are output. For example:
3201 .code
3202 exim -bP transport local_delivery
3203 .endd
3204 The generic driver options are output first, followed by the driver's private
3205 options. A list of the names of drivers of a particular type can be obtained by
3206 using one of the words &%router_list%&, &%transport_list%&, or
3207 &%authenticator_list%&, and a complete list of all drivers with their option
3208 settings can be obtained by using &%routers%&, &%transports%&, or
3209 &%authenticators%&.
3210
3211 .cindex "environment"
3212 If &%environment%& is given as an argument, the set of environment
3213 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3214 variables.
3215
3216 .cindex "options" "macro &-- extracting"
3217 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3218 are available, similarly to the drivers.  Because macros are sometimes used
3219 for storing passwords, this option is restricted.
3220 The output format is one item per line.
3221 For the "-bP macro <name>" form, if no such macro is found
3222 the exit status will be nonzero.
3223
3224 .cmdopt -bp
3225 .cindex "queue" "listing messages in"
3226 .cindex "listing" "messages in the queue"
3227 This option requests a listing of the contents of the mail queue on the
3228 standard output. If the &%-bp%& option is followed by a list of message ids,
3229 just those messages are listed. By default, this option can be used only by an
3230 admin user. However, the &%queue_list_requires_admin%& option can be set false
3231 to allow any user to see the queue.
3232
3233 Each message in the queue is displayed as in the following example:
3234 .code
3235 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3236           red.king@looking-glass.fict.example
3237           <other addresses>
3238 .endd
3239 .cindex "message" "size in queue listing"
3240 .cindex "size" "of message"
3241 The first line contains the length of time the message has been in the queue
3242 (in this case 25 minutes), the size of the message (2.9K), the unique local
3243 identifier for the message, and the message sender, as contained in the
3244 envelope. For bounce messages, the sender address is empty, and appears as
3245 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3246 the default sender address, the user's login name is shown in parentheses
3247 before the sender address.
3248
3249 .cindex "frozen messages" "in queue listing"
3250 If the message is frozen (attempts to deliver it are suspended) then the text
3251 &"*** frozen ***"& is displayed at the end of this line.
3252
3253 The recipients of the message (taken from the envelope, not the headers) are
3254 displayed on subsequent lines. Those addresses to which the message has already
3255 been delivered are marked with the letter D. If an original address gets
3256 expanded into several addresses via an alias or forward file, the original is
3257 displayed with a D only when deliveries for all of its child addresses are
3258 complete.
3259
3260
3261 .cmdopt -bpa
3262 This option operates like &%-bp%&, but in addition it shows delivered addresses
3263 that were generated from the original top level address(es) in each message by
3264 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3265 of just &"D"&.
3266
3267
3268 .cmdopt -bpc
3269 .cindex "queue" "count of messages on"
3270 This option counts the number of messages in the queue, and writes the total
3271 to the standard output. It is restricted to admin users, unless
3272 &%queue_list_requires_admin%& is set false.
3273
3274
3275 .cmdopt -bpi
3276 .cindex queue "list of message IDs"
3277 This option operates like &%-bp%&, but only outputs message ids
3278 (one per line).
3279
3280
3281 .cmdopt -bpr
3282 This option operates like &%-bp%&, but the output is not sorted into
3283 chronological order of message arrival. This can speed it up when there are
3284 lots of messages in the queue, and is particularly useful if the output is
3285 going to be post-processed in a way that doesn't need the sorting.
3286
3287 .cmdopt -bpra
3288 This option is a combination of &%-bpr%& and &%-bpa%&.
3289
3290 .cmdopt -bpri
3291 This option is a combination of &%-bpr%& and &%-bpi%&.
3292
3293 .cmdopt -bpru
3294 This option is a combination of &%-bpr%& and &%-bpu%&.
3295
3296
3297 .cmdopt -bpu
3298 This option operates like &%-bp%& but shows only undelivered top-level
3299 addresses for each message displayed. Addresses generated by aliasing or
3300 forwarding are not shown, unless the message was deferred after processing by a
3301 router with the &%one_time%& option set.
3302
3303
3304 .cmdopt -brt
3305 .cindex "testing" "retry configuration"
3306 .cindex "retry" "configuration testing"
3307 This option is for testing retry rules, and it must be followed by up to three
3308 arguments. It causes Exim to look for a retry rule that matches the values
3309 and to write it to the standard output. For example:
3310 .code
3311 exim -brt bach.comp.mus.example
3312 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3313 .endd
3314 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3315 argument, which is required, can be a complete address in the form
3316 &'local_part@domain'&, or it can be just a domain name. If the second argument
3317 contains a dot, it is interpreted as an optional second domain name; if no
3318 retry rule is found for the first argument, the second is tried. This ties in
3319 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3320 rule is found that matches the host, one that matches the mail domain is
3321 sought. Finally, an argument that is the name of a specific delivery error, as
3322 used in setting up retry rules, can be given. For example:
3323 .code
3324 exim -brt haydn.comp.mus.example quota_3d
3325 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3326 .endd
3327
3328 .cmdopt -brw
3329 .cindex "testing" "rewriting"
3330 .cindex "rewriting" "testing"
3331 This option is for testing address rewriting rules, and it must be followed by
3332 a single argument, consisting of either a local part without a domain, or a
3333 complete address with a fully qualified domain. Exim outputs how this address
3334 would be rewritten for each possible place it might appear. See chapter
3335 &<<CHAPrewrite>>& for further details.
3336
3337 .cmdopt -bS
3338 .cindex "SMTP" "batched incoming"
3339 .cindex "batched SMTP input"
3340 This option is used for batched SMTP input, which is an alternative interface
3341 for non-interactive local message submission. A number of messages can be
3342 submitted in a single run. However, despite its name, this is not really SMTP
3343 input. Exim reads each message's envelope from SMTP commands on the standard
3344 input, but generates no responses. If the caller is trusted, or
3345 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3346 believed; otherwise the sender is always the caller of Exim.
3347
3348 The message itself is read from the standard input, in SMTP format (leading
3349 dots doubled), terminated by a line containing just a single dot. An error is
3350 provoked if the terminating dot is missing. A further message may then follow.
3351
3352 As for other local message submissions, the contents of incoming batch SMTP
3353 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3354 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3355 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3356
3357 Some other SMTP commands are recognized in the input. HELO and EHLO act
3358 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3359 QUIT quits, ignoring the rest of the standard input.
3360
3361 .cindex "return code" "for &%-bS%&"
3362 If any error is encountered, reports are written to the standard output and
3363 error streams, and Exim gives up immediately. The return code is 0 if no error
3364 was detected; it is 1 if one or more messages were accepted before the error
3365 was detected; otherwise it is 2.
3366
3367 More details of input using batched SMTP are given in section
3368 &<<SECTincomingbatchedSMTP>>&.
3369
3370 .cmdopt -bs
3371 .cindex "SMTP" "local input"
3372 .cindex "local SMTP input"
3373 This option causes Exim to accept one or more messages by reading SMTP commands
3374 on the standard input, and producing SMTP replies on the standard output. SMTP
3375 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3376 Some user agents use this interface as a way of passing locally-generated
3377 messages to the MTA.
3378
3379 In
3380 .cindex "sender" "source of"
3381 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3382 set, the senders of messages are taken from the SMTP MAIL commands.
3383 Otherwise the content of these commands is ignored and the sender is set up as
3384 the calling user. Unqualified addresses are automatically qualified using
3385 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3386 &%-bnq%& option is used.
3387
3388 .cindex "inetd"
3389 The
3390 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3391 using a listening daemon. Exim can distinguish the two cases by checking
3392 whether the standard input is a TCP/IP socket. When Exim is called from
3393 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3394 above concerning senders and qualification do not apply. In this situation,
3395 Exim behaves in exactly the same way as it does when receiving a message via
3396 the listening daemon.
3397
3398 .cmdopt -bt
3399 .cindex "testing" "addresses"
3400 .cindex "address" "testing"
3401 This option runs Exim in address testing mode, in which each argument is taken
3402 as a recipient address to be tested for deliverability. The results are
3403 written to the standard output. If a test fails, and the caller is not an admin
3404 user, no details of the failure are output, because these might contain
3405 sensitive information such as usernames and passwords for database lookups.
3406
3407 If no arguments are given, Exim runs in an interactive manner, prompting with a
3408 right angle bracket for addresses to be tested.
3409
3410 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3411 &[readline()]& function, because it is running as &'root'& and there are
3412 security issues.
3413
3414 Each address is handled as if it were the recipient address of a message
3415 (compare the &%-bv%& option). It is passed to the routers and the result is
3416 written to the standard output. However, any router that has
3417 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3418 genuine routing tests if your first router passes everything to a scanner
3419 program.
3420
3421 .cindex "return code" "for &%-bt%&"
3422 The return code is 2 if any address failed outright; it is 1 if no address
3423 failed outright but at least one could not be resolved for some reason. Return
3424 code 0 is given only when all addresses succeed.
3425
3426 .cindex "duplicate addresses"
3427 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3428 addresses after routing is complete, so that only one delivery takes place.
3429 This does not happen when testing with &%-bt%&; the full results of routing are
3430 always shown.
3431
3432 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3433 routers in the configuration makes any tests on the sender address of a
3434 message,
3435 .oindex "&%-f%&" "for address testing"
3436 you can use the &%-f%& option to set an appropriate sender when running
3437 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3438 default qualifying domain. However, if you have set up (for example) routers
3439 whose behaviour depends on the contents of an incoming message, you cannot test
3440 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3441 doing such tests.
3442
3443 .cmdopt -bV
3444 .cindex "version number of Exim"
3445 This option causes Exim to write the current version number, compilation
3446 number, and compilation date of the &'exim'& binary to the standard output.
3447 It also lists the DBM library that is being used, the optional modules (such as
3448 specific lookup types), the drivers that are included in the binary, and the
3449 name of the runtime configuration file that is in use.
3450
3451 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3452 configuration file. However, this is a static check only. It cannot check
3453 values that are to be expanded. For example, although a misspelt ACL verb is
3454 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3455 alone to discover (for example) all the typos in the configuration; some
3456 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3457 dynamic testing facilities.
3458
3459 .cmdopt -bv
3460 .cindex "verifying address" "using &%-bv%&"
3461 .cindex "address" "verification"
3462 This option runs Exim in address verification mode, in which each argument is
3463 taken as a recipient address to be verified by the routers. (This does
3464 not involve any verification callouts). During normal operation, verification
3465 happens mostly as a consequence processing a &%verify%& condition in an ACL
3466 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3467 including callouts, see the &%-bh%& and &%-bhc%& options.
3468
3469 If verification fails, and the caller is not an admin user, no details of the
3470 failure are output, because these might contain sensitive information such as
3471 usernames and passwords for database lookups.
3472
3473 If no arguments are given, Exim runs in an interactive manner, prompting with a
3474 right angle bracket for addresses to be verified.
3475
3476 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3477 &[readline()]& function, because it is running as &'exim'& and there are
3478 security issues.
3479
3480 Verification differs from address testing (the &%-bt%& option) in that routers
3481 that have &%no_verify%& set are skipped, and if the address is accepted by a
3482 router that has &%fail_verify%& set, verification fails. The address is
3483 verified as a recipient if &%-bv%& is used; to test verification for a sender
3484 address, &%-bvs%& should be used.
3485
3486 If the &%-v%& option is not set, the output consists of a single line for each
3487 address, stating whether it was verified or not, and giving a reason in the
3488 latter case. Without &%-v%&, generating more than one address by redirection
3489 causes verification to end successfully, without considering the generated
3490 addresses. However, if just one address is generated, processing continues,
3491 and the generated address must verify successfully for the overall verification
3492 to succeed.
3493
3494 When &%-v%& is set, more details are given of how the address has been handled,
3495 and in the case of address redirection, all the generated addresses are also
3496 considered. Verification may succeed for some and fail for others.
3497
3498 The
3499 .cindex "return code" "for &%-bv%&"
3500 return code is 2 if any address failed outright; it is 1 if no address
3501 failed outright but at least one could not be resolved for some reason. Return
3502 code 0 is given only when all addresses succeed.
3503
3504 If any of the routers in the configuration makes any tests on the sender
3505 address of a message, you should use the &%-f%& option to set an appropriate
3506 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3507 calling user at the default qualifying domain.
3508
3509 .cmdopt -bvs
3510 This option acts like &%-bv%&, but verifies the address as a sender rather
3511 than a recipient address. This affects any rewriting and qualification that
3512 might happen.
3513
3514 .cmdopt -bw
3515 .cindex "daemon"
3516 .cindex "inetd"
3517 .cindex "inetd" "wait mode"
3518 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3519 similarly to the &%-bd%& option.  All port specifications on the command-line
3520 and in the configuration file are ignored.  Queue-running may not be specified.
3521
3522 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3523 listening for connections.  This permits the system to start up and have
3524 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3525 each port only when the first connection is received.
3526
3527 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3528 which the daemon will exit, which should cause inetd to listen once more.
3529
3530 .cmdopt -C <&'filelist'&>
3531 .cindex "configuration file" "alternate"
3532 .cindex "CONFIGURE_FILE"
3533 .cindex "alternate configuration file"
3534 This option causes Exim to find the runtime configuration file from the given
3535 list instead of from the list specified by the CONFIGURE_FILE
3536 compile-time setting. Usually, the list will consist of just a single filename,
3537 but it can be a colon-separated list of names. In this case, the first
3538 file that exists is used. Failure to open an existing file stops Exim from
3539 proceeding any further along the list, and an error is generated.
3540
3541 When this option is used by a caller other than root, and the list is different
3542 from the compiled-in list, Exim gives up its root privilege immediately, and
3543 runs with the real and effective uid and gid set to those of the caller.
3544 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3545 file contains a list of full pathnames, one per line, for configuration files
3546 which are trusted. Root privilege is retained for any configuration file so
3547 listed, as long as the caller is the Exim user (or the user specified in the
3548 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3549 not writeable by inappropriate users or groups.
3550
3551 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3552 configuration using &%-C%& right through message reception and delivery,
3553 even if the caller is root. The reception works, but by that time, Exim is
3554 running as the Exim user, so when it re-executes to regain privilege for the
3555 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3556 test reception and delivery using two separate commands (one to put a message
3557 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3558
3559 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3560 prefix string with which any file named in a &%-C%& command line option
3561 must start. In addition, the filename must not contain the sequence &`/../`&.
3562 However, if the value of the &%-C%& option is identical to the value of
3563 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3564 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3565 unset, any filename can be used with &%-C%&.
3566
3567 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3568 to a directory to which only root has access. This prevents someone who has
3569 broken into the Exim account from running a privileged Exim with an arbitrary
3570 configuration file.
3571
3572 The &%-C%& facility is useful for ensuring that configuration files are
3573 syntactically correct, but cannot be used for test deliveries, unless the
3574 caller is privileged, or unless it is an exotic configuration that does not
3575 require privilege. No check is made on the owner or group of the files
3576 specified by this option.
3577
3578
3579 .vitem &%-D%&<&'macro'&>=<&'value'&>
3580 .oindex "&%-D%&"
3581 .cindex "macro" "setting on command line"
3582 This option can be used to override macro definitions in the configuration file
3583 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3584 unprivileged caller, it causes Exim to give up its root privilege.
3585 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3586 completely disabled, and its use causes an immediate error exit.
3587
3588 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3589 colon-separated list of macros which are considered safe and, if &%-D%& only
3590 supplies macros from this list, and the values are acceptable, then Exim will
3591 not give up root privilege if the caller is root, the Exim run-time user, or
3592 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3593 to be removed in the future.  Acceptable values for the macros satisfy the
3594 regexp: &`^[A-Za-z0-9_/.-]*$`&
3595
3596 The entire option (including equals sign if present) must all be within one
3597 command line item. &%-D%& can be used to set the value of a macro to the empty
3598 string, in which case the equals sign is optional. These two commands are
3599 synonymous:
3600 .code
3601 exim -DABC  ...
3602 exim -DABC= ...
3603 .endd
3604 To include spaces in a macro definition item, quotes must be used. If you use
3605 quotes, spaces are permitted around the macro name and the equals sign. For
3606 example:
3607 .code
3608 exim '-D ABC = something' ...
3609 .endd
3610 &%-D%& may be repeated up to 10 times on a command line.
3611 Only macro names up to 22 letters long can be set.
3612
3613
3614 .vitem &%-d%&<&'debug&~options'&>
3615 .oindex "&%-d%&"
3616 .cindex "debugging" "list of selectors"
3617 .cindex "debugging" "&%-d%& option"
3618 This option causes debugging information to be written to the standard
3619 error stream. It is restricted to admin users because debugging output may show
3620 database queries that contain password information. Also, the details of users'
3621 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3622 writes an error message to the standard error stream and exits with a non-zero
3623 return code.
3624
3625 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3626 standard debugging data is output. This can be reduced, or increased to include
3627 some more rarely needed information, by directly following &%-d%& with a string
3628 made up of names preceded by plus or minus characters. These add or remove sets
3629 of debugging data, respectively. For example, &%-d+filter%& adds filter
3630 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3631 no spaces are allowed in the debug setting. The available debugging categories
3632 are:
3633 .itable none 0 0 2 20* left 80* left
3634 .irow acl            "ACL interpretation"
3635 .irow auth           "authenticators"
3636 .irow deliver        "general delivery logic"
3637 .irow dns            "DNS lookups (see also resolver)"
3638 .irow dnsbl          "DNS black list (aka RBL) code"
3639 .irow exec           "arguments for &[execv()]& calls"
3640 .irow expand         "detailed debugging for string expansions"
3641 .irow filter         "filter handling"
3642 .irow hints_lookup   "hints data lookups"
3643 .irow host_lookup    "all types of name-to-IP address handling"
3644 .irow ident          "ident lookup"
3645 .irow interface      "lists of local interfaces"
3646 .irow lists          "matching things in lists"
3647 .irow load           "system load checks"
3648 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3649                     &<<CHAPlocalscan>>&)"
3650 .irow lookup         "general lookup code and all lookups"
3651 .irow memory         "memory handling"
3652 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3653 .irow pid            "modifier: add pid to debug output lines"
3654 .irow process_info   "setting info for the process log"
3655 .irow queue_run      "queue runs"
3656 .irow receive        "general message reception logic"
3657 .irow resolver       "turn on the DNS resolver's debugging output"
3658 .irow retry          "retry handling"
3659 .irow rewrite        "address rewriting""
3660 .irow route          "address routing"
3661 .irow timestamp      "modifier: add timestamp to debug output lines"
3662 .irow tls            "TLS logic"
3663 .irow transport      "transports"
3664 .irow uid            "changes of uid/gid and looking up uid/gid"
3665 .irow verify         "address verification logic"
3666 .irow all            "almost all of the above (see below), and also &%-v%&"
3667 .endtable
3668 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3669 for &`-all`&. The reason for this is that &`+all`& is something that people
3670 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3671 is included, an awful lot of output that is very rarely of interest is
3672 generated, so it now has to be explicitly requested. However, &`-all`& does
3673 turn everything off.
3674
3675 .cindex "resolver, debugging output"
3676 .cindex "DNS resolver, debugging output"
3677 The &`resolver`& option produces output only if the DNS resolver was compiled
3678 with DEBUG enabled. This is not the case in some operating systems. Also,
3679 unfortunately, debugging output from the DNS resolver is written to stdout
3680 rather than stderr.
3681
3682 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3683 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3684 However, the &`pid`& selector is forced when debugging is turned on for a
3685 daemon, which then passes it on to any re-executed Exims. Exim also
3686 automatically adds the pid to debug lines when several remote deliveries are
3687 run in parallel.
3688
3689 The &`timestamp`& selector causes the current time to be inserted at the start
3690 of all debug output lines. This can be useful when trying to track down delays
3691 in processing.
3692
3693 .cindex debugging "UTF-8 in"
3694 .cindex UTF-8 "in debug output"
3695 The &`noutf8`& selector disables the use of
3696 UTF-8 line-drawing characters to group related information.
3697 When disabled. ascii-art is used instead.
3698 Using the &`+all`& option does not set this modifier,
3699
3700 If the &%debug_print%& option is set in any driver, it produces output whenever
3701 any debugging is selected, or if &%-v%& is used.
3702
3703 .vitem &%-dd%&<&'debug&~options'&>
3704 .oindex "&%-dd%&"
3705 This option behaves exactly like &%-d%& except when used on a command that
3706 starts a daemon process. In that case, debugging is turned off for the
3707 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3708 behaviour of the daemon without creating as much output as full debugging does.
3709
3710 .cmdopt -dropcr
3711 This is an obsolete option that is now a no-op. It used to affect the way Exim
3712 handled CR and LF characters in incoming messages. What happens now is
3713 described in section &<<SECTlineendings>>&.
3714
3715 .cmdopt -E
3716 .cindex "bounce message" "generating"
3717 This option specifies that an incoming message is a locally-generated delivery
3718 failure report. It is used internally by Exim when handling delivery failures
3719 and is not intended for external use. Its only effect is to stop Exim
3720 generating certain messages to the postmaster, as otherwise message cascades
3721 could occur in some situations. As part of the same option, a message id may
3722 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3723 new message contains the id, following &"R="&, as a cross-reference.
3724
3725 .vitem &%-e%&&'x'&
3726 .oindex "&%-e%&&'x'&"
3727 There are a number of Sendmail options starting with &%-oe%& which seem to be
3728 called by various programs without the leading &%o%& in the option. For
3729 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3730 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3731
3732 .cmdopt -F <&'string'&>
3733 .cindex "sender" "name"
3734 .cindex "name" "of sender"
3735 This option sets the sender's full name for use when a locally-generated
3736 message is being accepted. In the absence of this option, the user's &'gecos'&
3737 entry from the password data is used. As users are generally permitted to alter
3738 their &'gecos'& entries, no security considerations are involved. White space
3739 between &%-F%& and the <&'string'&> is optional.
3740
3741 .cmdopt -f <&'address'&>
3742 .cindex "sender" "address"
3743 .cindex "address" "sender"
3744 .cindex "trusted users"
3745 .cindex "envelope from"
3746 .cindex "envelope sender"
3747 .cindex "user" "trusted"
3748 This option sets the address of the envelope sender of a locally-generated
3749 message (also known as the return path). The option can normally be used only
3750 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3751 users to use it.
3752
3753 Processes running as root or the Exim user are always trusted. Other
3754 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3755 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3756 of a local message is set to the caller's login name at the default qualify
3757 domain.
3758
3759 There is one exception to the restriction on the use of &%-f%&: an empty sender
3760 can be specified by any user, trusted or not, to create a message that can
3761 never provoke a bounce. An empty sender can be specified either as an empty
3762 string, or as a pair of angle brackets with nothing between them, as in these
3763 examples of shell commands:
3764 .code
3765 exim -f '<>' user@domain
3766 exim -f "" user@domain
3767 .endd
3768 In addition, the use of &%-f%& is not restricted when testing a filter file
3769 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3770 &%-bv%& options.
3771
3772 Allowing untrusted users to change the sender address does not of itself make
3773 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3774 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3775 though this can be overridden by setting &%no_local_from_check%&.
3776
3777 White
3778 .cindex "&""From""& line"
3779 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3780 given as two arguments or one combined argument). The sender of a
3781 locally-generated message can also be set (when permitted) by an initial
3782 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3783 if &%-f%& is also present, it overrides &"From&~"&.
3784
3785 .cmdopt -G
3786 .cindex "submission fixups, suppressing (command-line)"
3787 This option is equivalent to an ACL applying:
3788 .code
3789 control = suppress_local_fixups
3790 .endd
3791 for every message received.  Note that Sendmail will complain about such
3792 bad formatting, where Exim silently just does not fix it up.  This may change
3793 in future.
3794
3795 As this affects audit information, the caller must be a trusted user to use
3796 this option.
3797
3798 .cmdopt -h <&'number'&>
3799 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3800 This option is accepted for compatibility with Sendmail, but has no effect. (In
3801 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3802 headers.)
3803
3804 .cmdopt -i
3805 .cindex "Solaris" "&'mail'& command"
3806 .cindex "dot" "in incoming non-SMTP message"
3807 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3808 line by itself should not terminate an incoming, non-SMTP message.
3809 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3810 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3811 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3812 by its &'mailx'& command.
3813
3814 .cmdopt -L <&'tag'&>
3815 .cindex "syslog" "process name; set with flag"
3816 This option is equivalent to setting &%syslog_processname%& in the config
3817 file and setting &%log_file_path%& to &`syslog`&.
3818 Its use is restricted to administrators.  The configuration file has to be
3819 read and parsed, to determine access rights, before this is set and takes
3820 effect, so early configuration file errors will not honour this flag.
3821
3822 The tag should not be longer than 32 characters.
3823
3824 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3825 .cindex "forcing delivery"
3826 .cindex "delivery" "forcing attempt"
3827 .cindex "frozen messages" "forcing delivery"
3828 This option requests Exim to run a delivery attempt on each message in turn. If
3829 any of the messages are frozen, they are automatically thawed before the
3830 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3831 and &%hold_domains%& are ignored.
3832
3833 Retry
3834 .cindex "hints database" "overriding retry hints"
3835 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3836 the normal retry time has not yet been reached. This option requires the caller
3837 to be an admin user. However, there is an option called &%prod_requires_admin%&
3838 which can be set false to relax this restriction (and also the same requirement
3839 for the &%-q%&, &%-R%&, and &%-S%& options).
3840
3841 The deliveries happen synchronously, that is, the original Exim process does
3842 not terminate until all the delivery attempts have finished. No output is
3843 produced unless there is a serious error. If you want to see what is happening,
3844 use the &%-v%& option as well, or inspect Exim's main log.
3845
3846 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3847 .cindex "message" "adding recipients"
3848 .cindex "recipient" "adding"
3849 This option requests Exim to add the addresses to the list of recipients of the
3850 message (&"ar"& for &"add recipients"&). The first argument must be a message
3851 id, and the remaining ones must be email addresses. However, if the message is
3852 active (in the middle of a delivery attempt), it is not altered. This option
3853 can be used only by an admin user.
3854
3855 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3856         &~<&'host&~IP'&>&&&
3857         &~<&'sequence&~number'&>&&&
3858         &~<&'message&~id'&>"
3859 .oindex "&%-MC%&"
3860 .cindex "SMTP" "passed connection"
3861 .cindex "SMTP" "multiple deliveries"
3862 .cindex "multiple SMTP deliveries"
3863 This option is not intended for use by external callers. It is used internally
3864 by Exim to invoke another instance of itself to deliver a waiting message using
3865 an existing SMTP connection, which is passed as the standard input. Details are
3866 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3867 must be root or the Exim user in order to use it.
3868
3869 .cmdopt -MCA
3870 This option is not intended for use by external callers. It is used internally
3871 by Exim in conjunction with the &%-MC%& option. It signifies that the
3872 connection to the remote host has been authenticated.
3873
3874 .cmdopt -MCD
3875 This option is not intended for use by external callers. It is used internally
3876 by Exim in conjunction with the &%-MC%& option. It signifies that the
3877 remote host supports the ESMTP &_DSN_& extension.
3878
3879 .cmdopt -MCd
3880 This option is not intended for use by external callers. It is used internally
3881 by Exim in conjunction with the &%-d%& option
3882 to pass on an information string on the purpose of the process.
3883
3884 .cmdopt -MCG <&'queue&~name'&>
3885 This option is not intended for use by external callers. It is used internally
3886 by Exim in conjunction with the &%-MC%& option. It signifies that an
3887 alternate queue is used, named by the following argument.
3888
3889 .cmdopt -MCK
3890 This option is not intended for use by external callers. It is used internally
3891 by Exim in conjunction with the &%-MC%& option. It signifies that a
3892 remote host supports the ESMTP &_CHUNKING_& extension.
3893
3894 .cmdopt -MCL
3895 This option is not intended for use by external callers. It is used internally
3896 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3897 which Exim is connected advertised limits on numbers of mails, recipients or
3898 recipient domains.
3899 The limits are given by the following three arguments.
3900
3901 .cmdopt -MCP
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3904 which Exim is connected supports pipelining.
3905
3906 .cmdopt -MCp
3907 This option is not intended for use by external callers. It is used internally
3908 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3909 t a remote server is via a SOCKS proxy, using addresses and ports given by
3910 the following four arguments.
3911
3912 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3913 This option is not intended for use by external callers. It is used internally
3914 by Exim in conjunction with the &%-MC%& option when the original delivery was
3915 started by a queue runner. It passes on the process id of the queue runner,
3916 together with the file descriptor number of an open pipe. Closure of the pipe
3917 signals the final completion of the sequence of processes that are passing
3918 messages through the same SMTP connection.
3919
3920 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3921 This option is not intended for use by external callers. It is used internally
3922 by Exim to implement quota checking for local users.
3923
3924 .cmdopt -MCS
3925 This option is not intended for use by external callers. It is used internally
3926 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3927 ESMTP SIZE option should be used on messages delivered down the existing
3928 connection.
3929
3930 .cmdopt -MCT
3931 This option is not intended for use by external callers. It is used internally
3932 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3933 host to which Exim is connected supports TLS encryption.
3934
3935 .vitem &%-MCr%&&~<&'SNI'&> &&&
3936        &%-MCs%&&~<&'SNI'&>
3937 .oindex "&%-MCs%&"
3938 .oindex "&%-MCr%&"
3939 These options are not intended for use by external callers. It is used internally
3940 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3941 a TLS Server Name Indication was sent as part of the channel establishment.
3942 The argument gives the SNI string.
3943 The "r" variant indicates a DANE-verified connection.
3944
3945 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3946 This option is not intended for use by external callers. It is used internally
3947 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3948 connection is being proxied by a parent process for handling TLS encryption.
3949 The arguments give the local address and port being proxied, and the TLS cipher.
3950
3951 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
3952 .cindex "hints database" "not overridden by &%-Mc%&"
3953 .cindex "delivery" "manually started &-- not forced"
3954 This option requests Exim to run a delivery attempt on each message, in turn,
3955 but unlike the &%-M%& option, it does check for retry hints, and respects any
3956 that are found. This option is not very useful to external callers. It is
3957 provided mainly for internal use by Exim when it needs to re-invoke itself in
3958 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3959 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3960 respects retry times and other options such as &%hold_domains%& that are
3961 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3962 If you want to run a specific delivery as if in a queue run, you should use
3963 &%-q%& with a message id argument. A distinction between queue run deliveries
3964 and other deliveries is made in one or two places.
3965
3966 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
3967 .cindex "message" "changing sender"
3968 .cindex "sender" "changing"
3969 This option requests Exim to change the sender address in the message to the
3970 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3971 &"edit sender"&). There must be exactly two arguments. The first argument must
3972 be a message id, and the second one an email address. However, if the message
3973 is active (in the middle of a delivery attempt), its status is not altered.
3974 This option can be used only by an admin user.
3975
3976 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
3977 .cindex "freezing messages"
3978 .cindex "message" "manually freezing"
3979 This option requests Exim to mark each listed message as &"frozen"&. This
3980 prevents any delivery attempts taking place until the message is &"thawed"&,
3981 either manually or as a result of the &%auto_thaw%& configuration option.
3982 However, if any of the messages are active (in the middle of a delivery
3983 attempt), their status is not altered. This option can be used only by an admin
3984 user.
3985
3986 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
3987 .cindex "giving up on messages"
3988 .cindex "message" "abandoning delivery attempts"
3989 .cindex "delivery" "abandoning further attempts"
3990 This option requests Exim to give up trying to deliver the listed messages,
3991 including any that are frozen. However, if any of the messages are active,
3992 their status is not altered. For non-bounce messages, a delivery error message
3993 is sent to the sender, containing the text &"cancelled by administrator"&.
3994 Bounce messages are just discarded. This option can be used only by an admin
3995 user.
3996
3997 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3998 .cindex queue named
3999 .cindex "named queues" "moving messages"
4000 .cindex "queue" "moving messages"
4001 This option requests that each listed message be moved from its current
4002 queue to the given named queue.
4003 The destination queue name argument is required, but can be an empty
4004 string to define the default queue.
4005 If the messages are not currently located in the default queue,
4006 a &%-qG<name>%& option will be required to define the source queue.
4007
4008 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
4009 .cindex "delivery" "cancelling all"
4010 This option requests Exim to mark all the recipient addresses in the messages
4011 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4012 message is active (in the middle of a delivery attempt), its status is not
4013 altered. This option can be used only by an admin user.
4014
4015 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4016 .cindex "delivery" "cancelling by address"
4017 .cindex "recipient" "removing"
4018 .cindex "removing recipients"
4019 This option requests Exim to mark the given addresses as already delivered
4020 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4021 the remaining ones must be email addresses. These are matched to recipient
4022 addresses in the message in a case-sensitive manner. If the message is active
4023 (in the middle of a delivery attempt), its status is not altered. This option
4024 can be used only by an admin user.
4025
4026 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4027 .cindex "removing messages"
4028 .cindex "abandoning mail"
4029 .cindex "message" "manually discarding"
4030 This option requests Exim to remove the given messages from the queue. No
4031 bounce messages are sent; each message is simply forgotten. However, if any of
4032 the messages are active, their status is not altered. This option can be used
4033 only by an admin user or by the user who originally caused the message to be
4034 placed in the queue.
4035
4036 . .new
4037 . .vitem &%-MS%&
4038 . .oindex "&%-MS%&"
4039 . .cindex REQUIRETLS
4040 . This option is used to request REQUIRETLS processing on the message.
4041 . It is used internally by Exim in conjunction with -E when generating
4042 . a bounce message.
4043 . .wen
4044
4045 .cmdopt -Mset <&'message&~id'&>
4046 .cindex "testing" "string expansion"
4047 .cindex "expansion" "testing"
4048 This option is useful only in conjunction with &%-be%& (that is, when testing
4049 string expansions). Exim loads the given message from its spool before doing
4050 the test expansions, thus setting message-specific variables such as
4051 &$message_size$& and the header variables. The &$recipients$& variable is made
4052 available. This feature is provided to make it easier to test expansions that
4053 make use of these variables. However, this option can be used only by an admin
4054 user. See also &%-bem%&.
4055
4056 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4057 .cindex "thawing messages"
4058 .cindex "unfreezing messages"
4059 .cindex "frozen messages" "thawing"
4060 .cindex "message" "thawing frozen"
4061 This option requests Exim to &"thaw"& any of the listed messages that are
4062 &"frozen"&, so that delivery attempts can resume. However, if any of the
4063 messages are active, their status is not altered. This option can be used only
4064 by an admin user.
4065
4066 .cmdopt -Mvb <&'message&~id'&>
4067 .cindex "listing" "message body"
4068 .cindex "message" "listing body of"
4069 This option causes the contents of the message body (-D) spool file to be
4070 written to the standard output. This option can be used only by an admin user.
4071
4072 .cmdopt -Mvc <&'message&~id'&>
4073 .cindex "message" "listing in RFC 2822 format"
4074 .cindex "listing" "message in RFC 2822 format"
4075 This option causes a copy of the complete message (header lines plus body) to
4076 be written to the standard output in RFC 2822 format. This option can be used
4077 only by an admin user.
4078
4079 .cmdopt -Mvh <&'message&~id'&>
4080 .cindex "listing" "message headers"
4081 .cindex "header lines" "listing"
4082 .cindex "message" "listing header lines"
4083 This option causes the contents of the message headers (-H) spool file to be
4084 written to the standard output. This option can be used only by an admin user.
4085
4086 .cmdopt -Mvl <&'message&~id'&>
4087 .cindex "listing" "message log"
4088 .cindex "message" "listing message log"
4089 This option causes the contents of the message log spool file to be written to
4090 the standard output. This option can be used only by an admin user.
4091
4092 .cmdopt -m
4093 This is a synonym for &%-om%& that is accepted by Sendmail
4094 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4095 p. 1M-258), so Exim treats it that way too.
4096
4097 .cmdopt -N
4098 .cindex "debugging" "&%-N%& option"
4099 .cindex "debugging" "suppressing delivery"
4100 This is a debugging option that inhibits delivery of a message at the transport
4101 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4102 it just doesn't actually transport the message, but instead behaves as if it
4103 had successfully done so. However, it does not make any updates to the retry
4104 database, and the log entries for deliveries are flagged with &"*>"& rather
4105 than &"=>"&.
4106
4107 Because &%-N%& discards any message to which it applies, only root or the Exim
4108 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4109 words, an ordinary user can use it only when supplying an incoming message to
4110 which it will apply. Although transportation never fails when &%-N%& is set, an
4111 address may be deferred because of a configuration problem on a transport, or a
4112 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4113 the message, and applies to any subsequent delivery attempts that may happen
4114 for that message.
4115
4116 .cmdopt -n
4117 This option is interpreted by Sendmail to mean &"no aliasing"&.
4118 For normal modes of operation, it is ignored by Exim.
4119 When combined with &%-bP%& it makes the output more terse (suppresses
4120 option names, environment values and config pretty printing).
4121
4122 .cmdopt -O <&'data'&>
4123 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4124 Exim.
4125
4126 .cmdopt -oA <&'file&~name'&>
4127 .cindex "Sendmail compatibility" "&%-oA%& option"
4128 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4129 alternative alias filename. Exim handles &%-bi%& differently; see the
4130 description above.
4131
4132 .cmdopt -oB <&'n'&>
4133 .cindex "SMTP" "passed connection"
4134 .cindex "SMTP" "multiple deliveries"
4135 .cindex "multiple SMTP deliveries"
4136 This is a debugging option which limits the maximum number of messages that can
4137 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4138 transport. If <&'n'&> is omitted, the limit is set to 1.
4139
4140 .cmdopt -odb
4141 .cindex "background delivery"
4142 .cindex "delivery" "in the background"
4143 This option applies to all modes in which Exim accepts incoming messages,
4144 including the listening daemon. It requests &"background"& delivery of such
4145 messages, which means that the accepting process automatically starts a
4146 delivery process for each message received, but does not wait for the delivery
4147 processes to finish.
4148
4149 When all the messages have been received, the reception process exits,
4150 leaving the delivery processes to finish in their own time. The standard output
4151 and error streams are closed at the start of each delivery process.
4152 This is the default action if none of the &%-od%& options are present.
4153
4154 If one of the queueing options in the configuration file
4155 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4156 overrides it if &%queue_only_override%& is set true, which is the default
4157 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4158
4159 .cmdopt -odf
4160 .cindex "foreground delivery"
4161 .cindex "delivery" "in the foreground"
4162 This option requests &"foreground"& (synchronous) delivery when Exim has
4163 accepted a locally-generated message. (For the daemon it is exactly the same as
4164 &%-odb%&.) A delivery process is automatically started to deliver the message,
4165 and Exim waits for it to complete before proceeding.
4166
4167 The original Exim reception process does not finish until the delivery
4168 process for the final message has ended. The standard error stream is left open
4169 during deliveries.
4170
4171 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4172 false and one of the queueing options in the configuration file is in effect.
4173
4174 If there is a temporary delivery error during foreground delivery, the
4175 message is left in the queue for later delivery, and the original reception
4176 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4177 restricted configuration that never queues messages.
4178
4179
4180 .cmdopt -odi
4181 This option is synonymous with &%-odf%&. It is provided for compatibility with
4182 Sendmail.
4183
4184 .cmdopt -odq
4185 .cindex "non-immediate delivery"
4186 .cindex "delivery" "suppressing immediate"
4187 .cindex "queueing incoming messages"
4188 This option applies to all modes in which Exim accepts incoming messages,
4189 including the listening daemon. It specifies that the accepting process should
4190 not automatically start a delivery process for each message received. Messages
4191 are placed in the queue, and remain there until a subsequent queue runner
4192 process encounters them. There are several configuration options (such as
4193 &%queue_only%&) that can be used to queue incoming messages under certain
4194 conditions. This option overrides all of them and also &%-odqs%&. It always
4195 forces queueing.
4196
4197 .cmdopt -odqs
4198 .cindex "SMTP" "delaying delivery"
4199 .cindex "first pass routing"
4200 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4201 However, like &%-odb%& and &%-odi%&, this option has no effect if
4202 &%queue_only_override%& is false and one of the queueing options in the
4203 configuration file is in effect.
4204
4205 When &%-odqs%& does operate, a delivery process is started for each incoming
4206 message, in the background by default, but in the foreground if &%-odi%& is
4207 also present. The recipient addresses are routed, and local deliveries are done
4208 in the normal way. However, if any SMTP deliveries are required, they are not
4209 done at this time, so the message remains in the queue until a subsequent queue
4210 runner process encounters it. Because routing was done, Exim knows which
4211 messages are waiting for which hosts, and so a number of messages for the same
4212 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4213 configuration option has the same effect for specific domains. See also the
4214 &%-qq%& option.
4215
4216 .cmdopt -oee
4217 .cindex "error" "reporting"
4218 If an error is detected while a non-SMTP message is being received (for
4219 example, a malformed address), the error is reported to the sender in a mail
4220 message.
4221
4222 .cindex "return code" "for &%-oee%&"
4223 Provided
4224 this error message is successfully sent, the Exim receiving process
4225 exits with a return code of zero. If not, the return code is 2 if the problem
4226 is that the original message has no recipients, or 1 for any other error.
4227 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4228
4229 .cmdopt -oem
4230 .cindex "error" "reporting"
4231 .cindex "return code" "for &%-oem%&"
4232 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4233 return code, whether or not the error message was successfully sent.
4234 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4235
4236 .cmdopt -oep
4237 .cindex "error" "reporting"
4238 If an error is detected while a non-SMTP message is being received, the
4239 error is reported by writing a message to the standard error file (stderr).
4240 .cindex "return code" "for &%-oep%&"
4241 The return code is 1 for all errors.
4242
4243 .cmdopt -oeq
4244 .cindex "error" "reporting"
4245 This option is supported for compatibility with Sendmail, but has the same
4246 effect as &%-oep%&.
4247
4248 .cmdopt -oew
4249 .cindex "error" "reporting"
4250 This option is supported for compatibility with Sendmail, but has the same
4251 effect as &%-oem%&.
4252
4253 .cmdopt -oi
4254 .cindex "dot" "in incoming non-SMTP message"
4255 This option, which has the same effect as &%-i%&, specifies that a dot on a
4256 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4257 single dot does terminate, though Exim does no special processing for other
4258 lines that start with a dot. This option is set by default if Exim is called as
4259 &'rmail'&. See also &%-ti%&.
4260
4261 .cmdopt -oitrue
4262 This option is treated as synonymous with &%-oi%&.
4263
4264 .cmdopt -oMa <&'host&~address'&>
4265 .cindex "sender" "host address, specifying for local message"
4266 A number of options starting with &%-oM%& can be used to set values associated
4267 with remote hosts on locally-submitted messages (that is, messages not received
4268 over TCP/IP). These options can be used by any caller in conjunction with the
4269 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4270 other circumstances, they are ignored unless the caller is trusted.
4271
4272 The &%-oMa%& option sets the sender host address. This may include a port
4273 number at the end, after a full stop (period). For example:
4274 .code
4275 exim -bs -oMa 10.9.8.7.1234
4276 .endd
4277 An alternative syntax is to enclose the IP address in square brackets,
4278 followed by a colon and the port number:
4279 .code
4280 exim -bs -oMa [10.9.8.7]:1234
4281 .endd
4282 The IP address is placed in the &$sender_host_address$& variable, and the
4283 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4284 are present on the command line, the sender host IP address is taken from
4285 whichever one is last.
4286
4287 .cmdopt -oMaa <&'name'&>
4288 .cindex "authentication" "name, specifying for local message"
4289 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4290 option sets the value of &$sender_host_authenticated$& (the authenticator
4291 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4292 This option can be used with &%-bh%& and &%-bs%& to set up an
4293 authenticated SMTP session without actually using the SMTP AUTH command.
4294
4295 .cmdopt -oMai <&'string'&>
4296 .cindex "authentication" "id, specifying for local message"
4297 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4298 option sets the value of &$authenticated_id$& (the id that was authenticated).
4299 This overrides the default value (the caller's login id, except with &%-bh%&,
4300 where there is no default) for messages from local sources. See chapter
4301 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4302
4303 .cmdopt -oMas <&'address'&>
4304 .cindex "authentication" "sender, specifying for local message"
4305 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4306 option sets the authenticated sender value in &$authenticated_sender$&. It
4307 overrides the sender address that is created from the caller's login id for
4308 messages from local sources, except when &%-bh%& is used, when there is no
4309 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4310 specified on a MAIL command overrides this value. See chapter
4311 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4312
4313 .cmdopt -oMi <&'interface&~address'&>
4314 .cindex "interface" "address, specifying for local message"
4315 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4316 option sets the IP interface address value. A port number may be included,
4317 using the same syntax as for &%-oMa%&. The interface address is placed in
4318 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4319
4320 .cmdopt -oMm <&'message&~reference'&>
4321 .cindex "message reference" "message reference, specifying for local message"
4322 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4323 option sets the message reference, e.g. message-id, and is logged during
4324 delivery. This is useful when some kind of audit trail is required to tie
4325 messages together. The format of the message reference is checked and will
4326 abort if the format is invalid. The option will only be accepted if exim is
4327 running in trusted mode, not as any regular user.
4328
4329 The best example of a message reference is when Exim sends a bounce message.
4330 The message reference is the message-id of the original message for which Exim
4331 is sending the bounce.
4332
4333 .cmdopt -oMr <&'protocol&~name'&>
4334 .cindex "protocol, specifying for local message"
4335 .vindex "&$received_protocol$&"
4336 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4337 option sets the received protocol value that is stored in
4338 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4339 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4340 SMTP protocol names (see the description of &$received_protocol$& in section
4341 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4342 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4343 be set by &%-oMr%&. Repeated use of this option is not supported.
4344
4345 .cmdopt -oMs <&'host&~name'&>
4346 .cindex "sender" "host name, specifying for local message"
4347 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4348 option sets the sender host name in &$sender_host_name$&. When this option is
4349 present, Exim does not attempt to look up a host name from an IP address; it
4350 uses the name it is given.
4351
4352 .cmdopt -oMt <&'ident&~string'&>
4353 .cindex "sender" "ident string, specifying for local message"
4354 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4355 option sets the sender ident value in &$sender_ident$&. The default setting for
4356 local callers is the login id of the calling process, except when &%-bh%& is
4357 used, when there is no default.
4358
4359 .cmdopt -om
4360 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4361 In Sendmail, this option means &"me too"&, indicating that the sender of a
4362 message should receive a copy of the message if the sender appears in an alias
4363 expansion. Exim always does this, so the option does nothing.
4364
4365 .cmdopt -oo
4366 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4367 This option is ignored. In Sendmail it specifies &"old style headers"&,
4368 whatever that means.
4369
4370 .cmdopt -oP <&'path'&>
4371 .cindex "pid (process id)" "of daemon"
4372 .cindex "daemon" "process id (pid)"
4373 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4374 value. The option specifies the file to which the process id of the daemon is
4375 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4376 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4377 because in those cases, the normal pid file is not used.
4378
4379 .cmdopt -oPX
4380 .cindex "pid (process id)" "of daemon"
4381 .cindex "daemon" "process id (pid)"
4382 This option is not intended for general use.
4383 The daemon uses it when terminating due to a SIGTEM, possibly in
4384 combination with &%-oP%&&~<&'path'&>.
4385 It causes the pid file to be removed.
4386
4387 .cmdopt -or <&'time'&>
4388 .cindex "timeout" "for non-SMTP input"
4389 This option sets a timeout value for incoming non-SMTP messages. If it is not
4390 set, Exim will wait forever for the standard input. The value can also be set
4391 by the &%receive_timeout%& option. The format used for specifying times is
4392 described in section &<<SECTtimeformat>>&.
4393
4394 .cmdopt -os <&'time'&>
4395 .cindex "timeout" "for SMTP input"
4396 .cindex "SMTP" "input timeout"
4397 This option sets a timeout value for incoming SMTP messages. The timeout
4398 applies to each SMTP command and block of data. The value can also be set by
4399 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4400 for specifying times is described in section &<<SECTtimeformat>>&.
4401
4402 .cmdopt -ov
4403 This option has exactly the same effect as &%-v%&.
4404
4405 .cmdopt -oX <&'number&~or&~string'&>
4406 .cindex "TCP/IP" "setting listening ports"
4407 .cindex "TCP/IP" "setting listening interfaces"
4408 .cindex "port" "receiving TCP/IP"
4409 This option is relevant only when the &%-bd%& (start listening daemon) option
4410 is also given. It controls which ports and interfaces the daemon uses. Details
4411 of the syntax, and how it interacts with configuration file options, are given
4412 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4413 file is written unless &%-oP%& is also present to specify a pid filename.
4414
4415 .cmdopt -oY
4416 .cindex "daemon notifier socket"
4417 This option controls the creation of an inter-process communications endpoint
4418 by the Exim daemon.
4419 It is only relevant when the &%-bd%& (start listening daemon) option is also
4420 given.
4421 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4422 option is also present.
4423 .new
4424 If this option is given then the socket will not be created.  This is required
4425 if the system is running multiple daemons, in which case it should
4426 be used on all.
4427 The features supported by the socket will not be available in such cases.
4428
4429 The socket is currently used for
4430 .ilist
4431 fast ramp-up of queue runner processes
4432 .next
4433 caching compiled regexes
4434 .next
4435 obtaining a current queue size
4436 .endlist
4437 .wen
4438
4439 .cmdopt -pd
4440 .cindex "Perl" "starting the interpreter"
4441 This option applies when an embedded Perl interpreter is linked with Exim (see
4442 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4443 option, forcing the starting of the interpreter to be delayed until it is
4444 needed.
4445
4446 .cmdopt -ps
4447 .cindex "Perl" "starting the interpreter"
4448 This option applies when an embedded Perl interpreter is linked with Exim (see
4449 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4450 option, forcing the starting of the interpreter to occur as soon as Exim is
4451 started.
4452
4453 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4454 .oindex "&%-p%&"
4455 For compatibility with Sendmail, this option is equivalent to
4456 .display
4457 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4458 .endd
4459 It sets the incoming protocol and host name (for trusted callers). The
4460 host name and its colon can be omitted when only the protocol is to be set.
4461 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4462 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4463 or &`s`& using this option (but that does not seem a real limitation).
4464 Repeated use of this option is not supported.
4465
4466 .cmdopt -q
4467 .cindex "queue runner" "starting manually"
4468 This option is normally restricted to admin users. However, there is a
4469 configuration option called &%prod_requires_admin%& which can be set false to
4470 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4471 and &%-S%& options).
4472
4473 .cindex "queue runner" "description of operation"
4474 If other commandline options do not specify an action,
4475 the &%-q%& option starts one queue runner process. This scans the queue of
4476 waiting messages, and runs a delivery process for each one in turn. It waits
4477 for each delivery process to finish before starting the next one. A delivery
4478 process may not actually do any deliveries if the retry times for the addresses
4479 have not been reached. Use &%-qf%& (see below) if you want to override this.
4480
4481 If
4482 .cindex "SMTP" "passed connection"
4483 .cindex "SMTP" "multiple deliveries"
4484 .cindex "multiple SMTP deliveries"
4485 the delivery process spawns other processes to deliver other messages down
4486 passed SMTP connections, the queue runner waits for these to finish before
4487 proceeding.
4488
4489 When all the queued messages have been considered, the original queue runner
4490 process terminates. In other words, a single pass is made over the waiting
4491 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4492 this to be repeated periodically.
4493
4494 Exim processes the waiting messages in an unpredictable order. It isn't very
4495 random, but it is likely to be different each time, which is all that matters.
4496 If one particular message screws up a remote MTA, other messages to the same
4497 MTA have a chance of getting through if they get tried first.
4498
4499 It is possible to cause the messages to be processed in lexical message id
4500 order, which is essentially the order in which they arrived, by setting the
4501 &%queue_run_in_order%& option, but this is not recommended for normal use.
4502
4503 .vitem &%-q%&<&'qflags'&>
4504 The &%-q%& option may be followed by one or more flag letters that change its
4505 behaviour. They are all optional, but if more than one is present, they must
4506 appear in the correct order. Each flag is described in a separate item below.
4507
4508 .vitem &%-qq...%&
4509 .oindex "&%-qq%&"
4510 .cindex "queue" "double scanning"
4511 .cindex "queue" "routing"
4512 .cindex "routing" "whole queue before delivery"
4513 .cindex "first pass routing"
4514 .cindex "queue runner" "two phase"
4515 An option starting with &%-qq%& requests a two-stage queue run. In the first
4516 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4517 every domain. Addresses are routed, local deliveries happen, but no remote
4518 transports are run.
4519
4520 Performance will be best if the &%queue_run_in_order%& option is false.
4521 If that is so and
4522 the &%queue_fast_ramp%& option is true
4523 and a daemon-notifier socket is available
4524 then in the first phase of the run,
4525 once a threshold number of messages are routed for a given host,
4526 a delivery process is forked in parallel with the rest of the scan.
4527
4528 .cindex "hints database" "remembering routing"
4529 The hints database that remembers which messages are waiting for specific hosts
4530 is updated, as if delivery to those hosts had been deferred.
4531
4532 After the first queue scan complete,
4533 a second, normal queue scan is done, with routing and delivery taking
4534 place as normal.
4535 Messages that are routed to the same host should mostly be
4536 delivered down a single SMTP
4537 .cindex "SMTP" "passed connection"
4538 .cindex "SMTP" "multiple deliveries"
4539 .cindex "multiple SMTP deliveries"
4540 connection because of the hints that were set up during the first queue scan.
4541
4542 .new
4543 Two-phase queue runs should be used on systems which, even intermittently,
4544 have a large queue (such as mailing-list operators).
4545 They may also be useful for hosts that are connected to the Internet
4546 intermittently.
4547 .wen
4548
4549 .vitem &%-q[q]i...%&
4550 .oindex "&%-qi%&"
4551 .cindex "queue" "initial delivery"
4552 If the &'i'& flag is present, the queue runner runs delivery processes only for
4553 those messages that haven't previously been tried. (&'i'& stands for &"initial
4554 delivery"&.) This can be helpful if you are putting messages in the queue using
4555 &%-odq%& and want a queue runner just to process the new messages.
4556
4557 .vitem &%-q[q][i]f...%&
4558 .oindex "&%-qf%&"
4559 .cindex "queue" "forcing delivery"
4560 .cindex "delivery" "forcing in queue run"
4561 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4562 message, whereas without &'f'& only those non-frozen addresses that have passed
4563 their retry times are tried.
4564
4565 .vitem &%-q[q][i]ff...%&
4566 .oindex "&%-qff%&"
4567 .cindex "frozen messages" "forcing delivery"
4568 If &'ff'& is present, a delivery attempt is forced for every message, whether
4569 frozen or not.
4570
4571 .vitem &%-q[q][i][f[f]]l%&
4572 .oindex "&%-ql%&"
4573 .cindex "queue" "local deliveries only"
4574 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4575 be done. If a message requires any remote deliveries, it remains in the queue
4576 for later delivery.
4577
4578 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4579 .oindex "&%-qG%&"
4580 .cindex queue named
4581 .cindex "named queues"  "deliver from"
4582 .cindex "queue" "delivering specific messages"
4583 If the &'G'& flag and a name is present, the queue runner operates on the
4584 queue with the given name rather than the default queue.
4585 The name should not contain a &'/'& character.
4586 For a periodic queue run (see below)
4587 append to the name a slash and a time value.
4588
4589 If other commandline options specify an action, a &'-qG<name>'& option
4590 will specify a queue to operate on.
4591 For example:
4592 .code
4593 exim -bp -qGquarantine
4594 mailq -qGquarantine
4595 exim -qGoffpeak -Rf @special.domain.example
4596 .endd
4597
4598 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4599 When scanning the queue, Exim can be made to skip over messages whose ids are
4600 lexically less than a given value by following the &%-q%& option with a
4601 starting message id. For example:
4602 .code
4603 exim -q 0t5C6f-0000c8-00
4604 .endd
4605 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4606 second message id is given, messages whose ids are lexically greater than it
4607 are also skipped. If the same id is given twice, for example,
4608 .code
4609 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4610 .endd
4611 just one delivery process is started, for that message. This differs from
4612 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4613 that it counts as a delivery from a queue run. Note that the selection
4614 mechanism does not affect the order in which the messages are scanned. There
4615 are also other ways of selecting specific sets of messages for delivery in a
4616 queue run &-- see &%-R%& and &%-S%&.
4617
4618 .vitem &%-q%&<&'qflags'&><&'time'&>
4619 .cindex "queue runner" "starting periodically"
4620 .cindex "periodic queue running"
4621 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4622 starting a queue runner process at intervals specified by the given time value
4623 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4624 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4625 single daemon process handles both functions. A common way of starting up a
4626 combined daemon at system boot time is to use a command such as
4627 .code
4628 /usr/exim/bin/exim -bd -q30m
4629 .endd
4630 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4631 process every 30 minutes.
4632
4633 .new
4634 .cindex "named queues" "queue runners"
4635 It is possible to set up runners for multiple named queues within one daemon,
4636 For example:
4637 .code
4638 exim -qGhipri/2m -q10m -qqGmailinglist/1h
4639 .endd
4640 .wen
4641
4642 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4643 pid file is written unless one is explicitly requested by the &%-oP%& option.
4644
4645 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4646 .oindex "&%-qR%&"
4647 This option is synonymous with &%-R%&. It is provided for Sendmail
4648 compatibility.
4649
4650 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4651 .oindex "&%-qS%&"
4652 This option is synonymous with &%-S%&.
4653
4654 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4655 .oindex "&%-R%&"
4656 .cindex "queue runner" "for specific recipients"
4657 .cindex "delivery" "to given domain"
4658 .cindex "domain" "delivery to"
4659 The <&'rsflags'&> may be empty, in which case the white space before the string
4660 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4661 which are the possible values for <&'rsflags'&>. White space is required if
4662 <&'rsflags'&> is not empty.
4663
4664 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4665 perform a single queue run, except that, when scanning the messages on the
4666 queue, Exim processes only those that have at least one undelivered recipient
4667 address containing the given string, which is checked in a case-independent
4668 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4669 regular expression; otherwise it is a literal string.
4670
4671 If you want to do periodic queue runs for messages with specific recipients,
4672 you can combine &%-R%& with &%-q%& and a time value. For example:
4673 .code
4674 exim -q25m -R @special.domain.example
4675 .endd
4676 This example does a queue run for messages with recipients in the given domain
4677 every 25 minutes. Any additional flags that are specified with &%-q%& are
4678 applied to each queue run.
4679
4680 Once a message is selected for delivery by this mechanism, all its addresses
4681 are processed. For the first selected message, Exim overrides any retry
4682 information and forces a delivery attempt for each undelivered address. This
4683 means that if delivery of any address in the first message is successful, any
4684 existing retry information is deleted, and so delivery attempts for that
4685 address in subsequently selected messages (which are processed without forcing)
4686 will run. However, if delivery of any address does not succeed, the retry
4687 information is updated, and in subsequently selected messages, the failing
4688 address will be skipped.
4689
4690 .cindex "frozen messages" "forcing delivery"
4691 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4692 all selected messages, not just the first; frozen messages are included when
4693 &'ff'& is present.
4694
4695 The &%-R%& option makes it straightforward to initiate delivery of all messages
4696 to a given domain after a host has been down for some time. When the SMTP
4697 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4698 effect is to run Exim with the &%-R%& option, but it can be configured to run
4699 an arbitrary command instead.
4700
4701 .cmdopt -r
4702 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4703
4704 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4705 .oindex "&%-S%&"
4706 .cindex "delivery" "from given sender"
4707 .cindex "queue runner" "for specific senders"
4708 This option acts like &%-R%& except that it checks the string against each
4709 message's sender instead of against the recipients. If &%-R%& is also set, both
4710 conditions must be met for a message to be selected. If either of the options
4711 has &'f'& or &'ff'& in its flags, the associated action is taken.
4712
4713 .cmdopt -Tqt <&'times'&>
4714 This is an option that is exclusively for use by the Exim testing suite. It is not
4715 recognized when Exim is run normally. It allows for the setting up of explicit
4716 &"queue times"& so that various warning/retry features can be tested.
4717
4718 .cmdopt -t
4719 .cindex "recipient" "extracting from header lines"
4720 .chindex Bcc:
4721 .chindex Cc:
4722 .chindex To:
4723 When Exim is receiving a locally-generated, non-SMTP message on its standard
4724 input, the &%-t%& option causes the recipients of the message to be obtained
4725 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4726 from the command arguments. The addresses are extracted before any rewriting
4727 takes place and the &'Bcc:'& header line, if present, is then removed.
4728
4729 .cindex "Sendmail compatibility" "&%-t%& option"
4730 If the command has any arguments, they specify addresses to which the message
4731 is &'not'& to be delivered. That is, the argument addresses are removed from
4732 the recipients list obtained from the headers. This is compatible with Smail 3
4733 and in accordance with the documented behaviour of several versions of
4734 Sendmail, as described in man pages on a number of operating systems (e.g.
4735 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4736 argument addresses to those obtained from the headers, and the O'Reilly
4737 Sendmail book documents it that way. Exim can be made to add argument addresses
4738 instead of subtracting them by setting the option
4739 &%extract_addresses_remove_arguments%& false.
4740
4741 .cindex "&%Resent-%& header lines" "with &%-t%&"
4742 If there are any &%Resent-%& header lines in the message, Exim extracts
4743 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4744 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4745 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4746 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4747
4748 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4749 message is resent several times). The RFC also specifies that they should be
4750 added at the front of the message, and separated by &'Received:'& lines. It is
4751 not at all clear how &%-t%& should operate in the present of multiple sets,
4752 nor indeed exactly what constitutes a &"set"&.
4753 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4754 are often added at the end of the header, and if a message is resent more than
4755 once, it is common for the original set of &%Resent-%& headers to be renamed as
4756 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4757
4758 .cmdopt -ti
4759 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4760 compatibility with Sendmail.
4761
4762 .cmdopt -tls-on-connect
4763 .cindex "TLS" "use without STARTTLS"
4764 .cindex "TLS" "automatic start"
4765 This option is available when Exim is compiled with TLS support. It forces all
4766 incoming SMTP connections to behave as if the incoming port is listed in the
4767 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4768 &<<CHAPTLS>>& for further details.
4769
4770
4771 .cmdopt -U
4772 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4773 Sendmail uses this option for &"initial message submission"&, and its
4774 documentation states that in future releases, it may complain about
4775 syntactically invalid messages rather than fixing them when this flag is not
4776 set. Exim ignores this option.
4777
4778 .cmdopt -v
4779 This option causes Exim to write information to the standard error stream,
4780 describing what it is doing. In particular, it shows the log lines for
4781 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4782 dialogue is shown. Some of the log lines shown may not actually be written to
4783 the log if the setting of &%log_selector%& discards them. Any relevant
4784 selectors are shown with each log line. If none are shown, the logging is
4785 unconditional.
4786
4787 .cmdopt -x
4788 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4789 National Language Support extended characters in the body of the mail item"&).
4790 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4791 this option.
4792
4793 .cmdopt -X <&'logfile'&>
4794 This option is interpreted by Sendmail to cause debug information to be sent
4795 to the named file.  It is ignored by Exim.
4796
4797 .cmdopt -z <&'log-line'&>
4798 This option writes its argument to Exim's logfile.
4799 Use is restricted to administrators; the intent is for operational notes.
4800 Quotes should be used to maintain a multi-word item as a single argument,
4801 under most shells.
4802 .endlist
4803
4804 .ecindex IIDclo1
4805 .ecindex IIDclo2
4806
4807
4808 . ////////////////////////////////////////////////////////////////////////////
4809 . Insert a stylized DocBook comment here, to identify the end of the command
4810 . line options. This is for the benefit of the Perl script that automatically
4811 . creates a man page for the options.
4812 . ////////////////////////////////////////////////////////////////////////////
4813
4814 .literal xml
4815 <!-- === End of command line options === -->
4816 .literal off
4817
4818
4819
4820
4821
4822 . ////////////////////////////////////////////////////////////////////////////
4823 . ////////////////////////////////////////////////////////////////////////////
4824
4825
4826 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4827          "The runtime configuration file"
4828
4829 .cindex "runtime configuration"
4830 .cindex "configuration file" "general description"
4831 .cindex "CONFIGURE_FILE"
4832 .cindex "configuration file" "errors in"
4833 .cindex "error" "in configuration file"
4834 .cindex "return code" "for bad configuration"
4835 Exim uses a single runtime configuration file that is read whenever an Exim
4836 binary is executed. Note that in normal operation, this happens frequently,
4837 because Exim is designed to operate in a distributed manner, without central
4838 control.
4839
4840 If a syntax error is detected while reading the configuration file, Exim
4841 writes a message on the standard error, and exits with a non-zero return code.
4842 The message is also written to the panic log. &*Note*&: Only simple syntax
4843 errors can be detected at this time. The values of any expanded options are
4844 not checked until the expansion happens, even when the expansion does not
4845 actually alter the string.
4846
4847 The name of the configuration file is compiled into the binary for security
4848 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4849 most configurations, this specifies a single file. However, it is permitted to
4850 give a colon-separated list of filenames, in which case Exim uses the first
4851 existing file in the list.
4852
4853 .cindex "EXIM_USER"
4854 .cindex "EXIM_GROUP"
4855 .cindex "CONFIGURE_OWNER"
4856 .cindex "CONFIGURE_GROUP"
4857 .cindex "configuration file" "ownership"
4858 .cindex "ownership" "configuration file"
4859 The runtime configuration file must be owned by root or by the user that is
4860 specified at compile time by the CONFIGURE_OWNER option (if set). The
4861 configuration file must not be world-writeable, or group-writeable unless its
4862 group is the root group or the one specified at compile time by the
4863 CONFIGURE_GROUP option.
4864
4865 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4866 to root, anybody who is able to edit the runtime configuration file has an
4867 easy way to run commands as root. If you specify a user or group in the
4868 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4869 who are members of that group will trivially be able to obtain root privileges.
4870
4871 Up to Exim version 4.72, the runtime configuration file was also permitted to
4872 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4873 since it offered a simple privilege escalation for any attacker who managed to
4874 compromise the Exim user account.
4875
4876 A default configuration file, which will work correctly in simple situations,
4877 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4878 defines just one filename, the installation process copies the default
4879 configuration to a new file of that name if it did not previously exist. If
4880 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4881 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4882 configuration.
4883
4884
4885
4886 .section "Using a different configuration file" "SECID40"
4887 .cindex "configuration file" "alternate"
4888 A one-off alternate configuration can be specified by the &%-C%& command line
4889 option, which may specify a single file or a list of files. However, when
4890 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4891 unless the argument for &%-C%& is identical to the built-in value from
4892 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4893 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4894 is useful mainly for checking the syntax of configuration files before
4895 installing them. No owner or group checks are done on a configuration file
4896 specified by &%-C%&, if root privilege has been dropped.
4897
4898 Even the Exim user is not trusted to specify an arbitrary configuration file
4899 with the &%-C%& option to be used with root privileges, unless that file is
4900 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4901 testing a configuration using &%-C%& right through message reception and
4902 delivery, even if the caller is root. The reception works, but by that time,
4903 Exim is running as the Exim user, so when it re-execs to regain privilege for
4904 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4905 can test reception and delivery using two separate commands (one to put a
4906 message in the queue, using &%-odq%&, and another to do the delivery, using
4907 &%-M%&).
4908
4909 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4910 prefix string with which any file named in a &%-C%& command line option must
4911 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4912 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4913 filename can be used with &%-C%&.
4914
4915 One-off changes to a configuration can be specified by the &%-D%& command line
4916 option, which defines and overrides values for macros used inside the
4917 configuration file. However, like &%-C%&, the use of this option by a
4918 non-privileged user causes Exim to discard its root privilege.
4919 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4920 completely disabled, and its use causes an immediate error exit.
4921
4922 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4923 to declare certain macro names trusted, such that root privilege will not
4924 necessarily be discarded.
4925 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4926 considered safe and, if &%-D%& only supplies macros from this list, and the
4927 values are acceptable, then Exim will not give up root privilege if the caller
4928 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4929 transition mechanism and is expected to be removed in the future.  Acceptable
4930 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4931
4932 Some sites may wish to use the same Exim binary on different machines that
4933 share a file system, but to use different configuration files on each machine.
4934 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4935 looks for a file whose name is the configuration filename followed by a dot
4936 and the machine's node name, as obtained from the &[uname()]& function. If this
4937 file does not exist, the standard name is tried. This processing occurs for
4938 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4939
4940 In some esoteric situations different versions of Exim may be run under
4941 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4942 help with this. See the comments in &_src/EDITME_& for details.
4943
4944
4945
4946 .section "Configuration file format" "SECTconffilfor"
4947 .cindex "configuration file" "format of"
4948 .cindex "format" "configuration file"
4949 Exim's configuration file is divided into a number of different parts. General
4950 option settings must always appear at the start of the file. The other parts
4951 are all optional, and may appear in any order. Each part other than the first
4952 is introduced by the word &"begin"& followed by at least one literal
4953 space, and the name of the part. The optional parts are:
4954
4955 .ilist
4956 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4957 &<<CHAPACL>>&).
4958 .next
4959 .cindex "AUTH" "configuration"
4960 &'authenticators'&: Configuration settings for the authenticator drivers. These
4961 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4962 .next
4963 &'routers'&: Configuration settings for the router drivers. Routers process
4964 addresses and determine how the message is to be delivered (see chapters
4965 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4966 .next
4967 &'transports'&: Configuration settings for the transport drivers. Transports
4968 define mechanisms for copying messages to destinations (see chapters
4969 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4970 .next
4971 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4972 If there is no retry section, or if it is empty (that is, no retry rules are
4973 defined), Exim will not retry deliveries. In this situation, temporary errors
4974 are treated the same as permanent errors. Retry rules are discussed in chapter
4975 &<<CHAPretry>>&.
4976 .next
4977 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4978 when new addresses are generated during delivery. Rewriting is discussed in
4979 chapter &<<CHAPrewrite>>&.
4980 .next
4981 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4982 want to use this feature, you must set
4983 .code
4984 LOCAL_SCAN_HAS_OPTIONS=yes
4985 .endd
4986 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4987 facility are given in chapter &<<CHAPlocalscan>>&.
4988 .endlist
4989
4990 .cindex "configuration file" "leading white space in"
4991 .cindex "configuration file" "trailing white space in"
4992 .cindex "white space" "in configuration file"
4993 Leading and trailing white space in configuration lines is always ignored.
4994
4995 Blank lines in the file, and lines starting with a # character (ignoring
4996 leading white space) are treated as comments and are ignored. &*Note*&: A
4997 # character other than at the beginning of a line is not treated specially,
4998 and does not introduce a comment.
4999
5000 Any non-comment line can be continued by ending it with a backslash. Note that
5001 the general rule for white space means that trailing white space after the
5002 backslash and leading white space at the start of continuation
5003 lines is ignored. Comment lines beginning with # (but not empty lines) may
5004 appear in the middle of a sequence of continuation lines.
5005
5006 A convenient way to create a configuration file is to start from the
5007 default, which is supplied in &_src/configure.default_&, and add, delete, or
5008 change settings as required.
5009
5010 The ACLs, retry rules, and rewriting rules have their own syntax which is
5011 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5012 respectively. The other parts of the configuration file have some syntactic
5013 items in common, and these are described below, from section &<<SECTcos>>&
5014 onwards. Before that, the inclusion, macro, and conditional facilities are
5015 described.
5016
5017
5018
5019 .section "File inclusions in the configuration file" "SECID41"
5020 .cindex "inclusions in configuration file"
5021 .cindex "configuration file" "including other files"
5022 .cindex "&`.include`& in configuration file"
5023 .cindex "&`.include_if_exists`& in configuration file"
5024 You can include other files inside Exim's runtime configuration file by
5025 using this syntax:
5026 .display
5027 &`.include`& <&'filename'&>
5028 &`.include_if_exists`& <&'filename'&>
5029 .endd
5030 on a line by itself. Double quotes round the filename are optional. If you use
5031 the first form, a configuration error occurs if the file does not exist; the
5032 second form does nothing for non-existent files.
5033 The first form allows a relative name. It is resolved relative to
5034 the directory of the including file. For the second form an absolute filename
5035 is required.
5036
5037 Includes may be nested to any depth, but remember that Exim reads its
5038 configuration file often, so it is a good idea to keep them to a minimum.
5039 If you change the contents of an included file, you must HUP the daemon,
5040 because an included file is read only when the configuration itself is read.
5041
5042 The processing of inclusions happens early, at a physical line level, so, like
5043 comment lines, an inclusion can be used in the middle of an option setting,
5044 for example:
5045 .code
5046 hosts_lookup = a.b.c \
5047                .include /some/file
5048 .endd
5049 Include processing happens after macro processing (see below). Its effect is to
5050 process the lines of the included file as if they occurred inline where the
5051 inclusion appears.
5052
5053
5054
5055 .section "Macros in the configuration file" "SECTmacrodefs"
5056 .cindex "macro" "description of"
5057 .cindex "configuration file" "macros"
5058 If a line in the main part of the configuration (that is, before the first
5059 &"begin"& line) begins with an upper case letter, it is taken as a macro
5060 definition, and must be of the form
5061 .display
5062 <&'name'&> = <&'rest of line'&>
5063 .endd
5064 The name must consist of letters, digits, and underscores, and need not all be
5065 in upper case, though that is recommended. The rest of the line, including any
5066 continuations, is the replacement text, and has leading and trailing white
5067 space removed. Quotes are not removed. The replacement text can never end with
5068 a backslash character, but this doesn't seem to be a serious limitation.
5069
5070 Macros may also be defined between router, transport, authenticator, or ACL
5071 definitions. They may not, however, be defined within an individual driver or
5072 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5073
5074 .section "Macro substitution" "SECID42"
5075 Once a macro is defined, all subsequent lines in the file (and any included
5076 files) are scanned for the macro name; if there are several macros, the line is
5077 scanned for each, in turn, in the order in which the macros are defined. The
5078 replacement text is not re-scanned for the current macro, though it is scanned
5079 for subsequently defined macros. For this reason, a macro name may not contain
5080 the name of a previously defined macro as a substring. You could, for example,
5081 define
5082 .display
5083 &`ABCD_XYZ = `&<&'something'&>
5084 &`ABCD = `&<&'something else'&>
5085 .endd
5086 but putting the definitions in the opposite order would provoke a configuration
5087 error. Macro expansion is applied to individual physical lines from the file,
5088 before checking for line continuation or file inclusion (see above). If a line
5089 consists solely of a macro name, and the expansion of the macro is empty, the
5090 line is ignored. A macro at the start of a line may turn the line into a
5091 comment line or a &`.include`& line.
5092
5093
5094 .section "Redefining macros" "SECID43"
5095 Once defined, the value of a macro can be redefined later in the configuration
5096 (or in an included file). Redefinition is specified by using &'=='& instead of
5097 &'='&. For example:
5098 .code
5099 MAC =  initial value
5100 ...
5101 MAC == updated value
5102 .endd
5103 Redefinition does not alter the order in which the macros are applied to the
5104 subsequent lines of the configuration file. It is still the same order in which
5105 the macros were originally defined. All that changes is the macro's value.
5106 Redefinition makes it possible to accumulate values. For example:
5107 .code
5108 MAC =  initial value
5109 ...
5110 MAC == MAC and something added
5111 .endd
5112 This can be helpful in situations where the configuration file is built
5113 from a number of other files.
5114
5115 .section "Overriding macro values" "SECID44"
5116 The values set for macros in the configuration file can be overridden by the
5117 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5118 used, unless called by root or the Exim user. A definition on the command line
5119 using the &%-D%& option causes all definitions and redefinitions within the
5120 file to be ignored.
5121
5122
5123
5124 .section "Example of macro usage" "SECID45"
5125 As an example of macro usage, consider a configuration where aliases are looked
5126 up in a MySQL database. It helps to keep the file less cluttered if long
5127 strings such as SQL statements are defined separately as macros, for example:
5128 .code
5129 ALIAS_QUERY = select mailbox from user where \
5130               login='${quote_mysql:$local_part}';
5131 .endd
5132 This can then be used in a &(redirect)& router setting like this:
5133 .code
5134 data = ${lookup mysql{ALIAS_QUERY}}
5135 .endd
5136 In earlier versions of Exim macros were sometimes used for domain, host, or
5137 address lists. In Exim 4 these are handled better by named lists &-- see
5138 section &<<SECTnamedlists>>&.
5139
5140
5141 .section "Builtin macros" "SECTbuiltinmacros"
5142 Exim defines some macros depending on facilities available, which may
5143 differ due to build-time definitions and from one release to another.
5144 All of these macros start with an underscore.
5145 They can be used to conditionally include parts of a configuration
5146 (see below).
5147
5148 The following classes of macros are defined:
5149 .display
5150 &` _HAVE_*                    `&  build-time defines
5151 &` _DRIVER_ROUTER_*           `&  router drivers
5152 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5153 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5154 &` _EXP_COND_*                `&  expansion conditions
5155 &` _EXP_ITEM_*                `&  expansion items
5156 &` _EXP_OP_*                  `&  expansion operators
5157 &` _EXP_VAR_*                 `&  expansion variables
5158 &` _LOG_*                     `&  log_selector values
5159 &` _OPT_MAIN_*                `&  main config options
5160 &` _OPT_ROUTERS_*             `&  generic router options
5161 &` _OPT_TRANSPORTS_*          `&  generic transport options
5162 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5163 &` _OPT_ROUTER_*_*            `&  private router options
5164 &` _OPT_TRANSPORT_*_*         `&  private transport options
5165 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5166 .endd
5167
5168 Use an &"exim -bP macros"& command to get the list of macros.
5169
5170
5171 .section "Conditional skips in the configuration file" "SECID46"
5172 .cindex "configuration file" "conditional skips"
5173 .cindex "&`.ifdef`&"
5174 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5175 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5176 portions of the configuration file. The processing happens whenever the file is
5177 read (that is, when an Exim binary starts to run).
5178
5179 The implementation is very simple. Instances of the first four directives must
5180 be followed by text that includes the names of one or macros. The condition
5181 that is tested is whether or not any macro substitution has taken place in the
5182 line. Thus:
5183 .code
5184 .ifdef AAA
5185 message_size_limit = 50M
5186 .else
5187 message_size_limit = 100M
5188 .endif
5189 .endd
5190 sets a message size limit of 50M if the macro &`AAA`& is defined
5191 (or &`A`& or &`AA`&), and 100M
5192 otherwise. If there is more than one macro named on the line, the condition
5193 is true if any of them are defined. That is, it is an &"or"& condition. To
5194 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5195
5196 Although you can use a macro expansion to generate one of these directives,
5197 it is not very useful, because the condition &"there was a macro substitution
5198 in this line"& will always be true.
5199
5200 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5201 to clarify complicated nestings.
5202
5203
5204
5205 .section "Common option syntax" "SECTcos"
5206 .cindex "common option syntax"
5207 .cindex "syntax of common options"
5208 .cindex "configuration file" "common option syntax"
5209 For the main set of options, driver options, and &[local_scan()]& options,
5210 each setting is on a line by itself, and starts with a name consisting of
5211 lower-case letters and underscores. Many options require a data value, and in
5212 these cases the name must be followed by an equals sign (with optional white
5213 space) and then the value. For example:
5214 .code
5215 qualify_domain = mydomain.example.com
5216 .endd
5217 .cindex "hiding configuration option values"
5218 .cindex "configuration options" "hiding value of"
5219 .cindex "options" "hiding value of"
5220 Some option settings may contain sensitive data, for example, passwords for
5221 accessing databases. To stop non-admin users from using the &%-bP%& command
5222 line option to read these values, you can precede the option settings with the
5223 word &"hide"&. For example:
5224 .code
5225 hide mysql_servers = localhost/users/admin/secret-password
5226 .endd
5227 For non-admin users, such options are displayed like this:
5228 .code
5229 mysql_servers = <value not displayable>
5230 .endd
5231 If &"hide"& is used on a driver option, it hides the value of that option on
5232 all instances of the same driver.
5233
5234 The following sections describe the syntax used for the different data types
5235 that are found in option settings.
5236
5237
5238 .section "Boolean options" "SECID47"
5239 .cindex "format" "boolean"
5240 .cindex "boolean configuration values"
5241 .oindex "&%no_%&&'xxx'&"
5242 .oindex "&%not_%&&'xxx'&"
5243 Options whose type is given as boolean are on/off switches. There are two
5244 different ways of specifying such options: with and without a data value. If
5245 the option name is specified on its own without data, the switch is turned on;
5246 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5247 boolean options may be followed by an equals sign and one of the words
5248 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5249 the following two settings have exactly the same effect:
5250 .code
5251 queue_only
5252 queue_only = true
5253 .endd
5254 The following two lines also have the same (opposite) effect:
5255 .code
5256 no_queue_only
5257 queue_only = false
5258 .endd
5259 You can use whichever syntax you prefer.
5260
5261
5262
5263
5264 .section "Integer values" "SECID48"
5265 .cindex "integer configuration values"
5266 .cindex "format" "integer"
5267 If an option's type is given as &"integer"&, the value can be given in decimal,
5268 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5269 number is assumed. Otherwise, it is treated as an octal number unless it starts
5270 with the characters &"0x"&, in which case the remainder is interpreted as a
5271 hexadecimal number.
5272
5273 If an integer value is followed by the letter K, it is multiplied by 1024; if
5274 it is followed by the letter M, it is multiplied by 1024x1024;
5275 if by the letter G, 1024x1024x1024.
5276 When the values
5277 of integer option settings are output, values which are an exact multiple of
5278 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5279 and M. The printing style is independent of the actual input format that was
5280 used.
5281
5282
5283 .section "Octal integer values" "SECID49"
5284 .cindex "integer format"
5285 .cindex "format" "octal integer"
5286 If an option's type is given as &"octal integer"&, its value is always
5287 interpreted as an octal number, whether or not it starts with the digit zero.
5288 Such options are always output in octal.
5289
5290
5291 .section "Fixed point numbers" "SECID50"
5292 .cindex "fixed point configuration values"
5293 .cindex "format" "fixed point"
5294 If an option's type is given as &"fixed-point"&, its value must be a decimal
5295 integer, optionally followed by a decimal point and up to three further digits.
5296
5297
5298
5299 .section "Time intervals" "SECTtimeformat"
5300 .cindex "time interval" "specifying in configuration"
5301 .cindex "format" "time interval"
5302 A time interval is specified as a sequence of numbers, each followed by one of
5303 the following letters, with no intervening white space:
5304
5305 .table2 30pt
5306 .irow &%s%& seconds
5307 .irow &%m%& minutes
5308 .irow &%h%& hours
5309 .irow &%d%& days
5310 .irow &%w%& weeks
5311 .endtable
5312
5313 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5314 intervals are output in the same format. Exim does not restrict the values; it
5315 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5316
5317
5318
5319 .section "String values" "SECTstrings"
5320 .cindex "string" "format of configuration values"
5321 .cindex "format" "string"
5322 If an option's type is specified as &"string"&, the value can be specified with
5323 or without double-quotes. If it does not start with a double-quote, the value
5324 consists of the remainder of the line plus any continuation lines, starting at
5325 the first character after any leading white space, with trailing white space
5326 removed, and with no interpretation of the characters in the string. Because
5327 Exim removes comment lines (those beginning with #) at an early stage, they can
5328 appear in the middle of a multi-line string. The following two settings are
5329 therefore equivalent:
5330 .code
5331 trusted_users = uucp:mail
5332 trusted_users = uucp:\
5333                 # This comment line is ignored
5334                 mail
5335 .endd
5336 .cindex "string" "quoted"
5337 .cindex "escape characters in quoted strings"
5338 If a string does start with a double-quote, it must end with a closing
5339 double-quote, and any backslash characters other than those used for line
5340 continuation are interpreted as escape characters, as follows:
5341
5342 .table2 100pt
5343 .irow &`\\`&                     "single backslash"
5344 .irow &`\n`&                     "newline"
5345 .irow &`\r`&                     "carriage return"
5346 .irow &`\t`&                     "tab"
5347 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5348 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5349                                    character"
5350 .endtable
5351
5352 If a backslash is followed by some other character, including a double-quote
5353 character, that character replaces the pair.
5354
5355 Quoting is necessary only if you want to make use of the backslash escapes to
5356 insert special characters, or if you need to specify a value with leading or
5357 trailing spaces. These cases are rare, so quoting is almost never needed in
5358 current versions of Exim. In versions of Exim before 3.14, quoting was required
5359 in order to continue lines, so you may come across older configuration files
5360 and examples that apparently quote unnecessarily.
5361
5362
5363 .section "Expanded strings" "SECID51"
5364 .cindex "expansion" "definition of"
5365 Some strings in the configuration file are subjected to &'string expansion'&,
5366 by which means various parts of the string may be changed according to the
5367 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5368 is as just described; in particular, the handling of backslashes in quoted
5369 strings is done as part of the input process, before expansion takes place.
5370 However, backslash is also an escape character for the expander, so any
5371 backslashes that are required for that reason must be doubled if they are
5372 within a quoted configuration string.
5373
5374
5375 .section "User and group names" "SECID52"
5376 .cindex "user name" "format of"
5377 .cindex "format" "user name"
5378 .cindex "groups" "name format"
5379 .cindex "format" "group name"
5380 User and group names are specified as strings, using the syntax described
5381 above, but the strings are interpreted specially. A user or group name must
5382 either consist entirely of digits, or be a name that can be looked up using the
5383 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5384
5385
5386 .section "List construction" "SECTlistconstruct"
5387 .cindex "list" "syntax of in configuration"
5388 .cindex "format" "list item in configuration"
5389 .cindex "string" "list, definition of"
5390 The data for some configuration options is a list of items, with colon as the
5391 default separator. Many of these options are shown with type &"string list"& in
5392 the descriptions later in this document. Others are listed as &"domain list"&,
5393 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5394 are all the same; however, those other than &"string list"& are subject to
5395 particular kinds of interpretation, as described in chapter
5396 &<<CHAPdomhosaddlists>>&.
5397
5398 In all these cases, the entire list is treated as a single string as far as the
5399 input syntax is concerned. The &%trusted_users%& setting in section
5400 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5401 in a list, it must be entered as two colons. Leading and trailing white space
5402 on each item in a list is ignored. This makes it possible to include items that
5403 start with a colon, and in particular, certain forms of IPv6 address. For
5404 example, the list
5405 .code
5406 local_interfaces = 127.0.0.1 : ::::1
5407 .endd
5408 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5409
5410 &*Note*&: Although leading and trailing white space is ignored in individual
5411 list items, it is not ignored when parsing the list. The spaces around the first
5412 colon in the example above are necessary. If they were not there, the list would
5413 be interpreted as the two items 127.0.0.1:: and 1.
5414
5415 .section "Changing list separators" "SECTlistsepchange"
5416 .cindex "list separator" "changing"
5417 .cindex "IPv6" "addresses in lists"
5418 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5419 introduced to allow the separator character to be changed. If a list begins
5420 with a left angle bracket, followed by any punctuation character, that
5421 character is used instead of colon as the list separator. For example, the list
5422 above can be rewritten to use a semicolon separator like this:
5423 .code
5424 local_interfaces = <; 127.0.0.1 ; ::1
5425 .endd
5426 This facility applies to all lists, with the exception of the list in
5427 &%log_file_path%&. It is recommended that the use of non-colon separators be
5428 confined to circumstances where they really are needed.
5429
5430 .cindex "list separator" "newline as"
5431 .cindex "newline" "as list separator"
5432 It is also possible to use newline and other control characters (those with
5433 code values less than 32, plus DEL) as separators in lists. Such separators
5434 must be provided literally at the time the list is processed. For options that
5435 are string-expanded, you can write the separator using a normal escape
5436 sequence. This will be processed by the expander before the string is
5437 interpreted as a list. For example, if a newline-separated list of domains is
5438 generated by a lookup, you can process it directly by a line such as this:
5439 .code
5440 domains = <\n ${lookup mysql{.....}}
5441 .endd
5442 This avoids having to change the list separator in such data. You are unlikely
5443 to want to use a control character as a separator in an option that is not
5444 expanded, because the value is literal text. However, it can be done by giving
5445 the value in quotes. For example:
5446 .code
5447 local_interfaces = "<\n 127.0.0.1 \n ::1"
5448 .endd
5449 Unlike printing character separators, which can be included in list items by
5450 doubling, it is not possible to include a control character as data when it is
5451 set as the separator. Two such characters in succession are interpreted as
5452 enclosing an empty list item.
5453
5454
5455
5456 .section "Empty items in lists" "SECTempitelis"
5457 .cindex "list" "empty item in"
5458 An empty item at the end of a list is always ignored. In other words, trailing
5459 separator characters are ignored. Thus, the list in
5460 .code
5461 senders = user@domain :
5462 .endd
5463 contains only a single item. If you want to include an empty string as one item
5464 in a list, it must not be the last item. For example, this list contains three
5465 items, the second of which is empty:
5466 .code
5467 senders = user1@domain : : user2@domain
5468 .endd
5469 &*Note*&: There must be white space between the two colons, as otherwise they
5470 are interpreted as representing a single colon data character (and the list
5471 would then contain just one item). If you want to specify a list that contains
5472 just one, empty item, you can do it as in this example:
5473 .code
5474 senders = :
5475 .endd
5476 In this case, the first item is empty, and the second is discarded because it
5477 is at the end of the list.
5478
5479
5480
5481
5482 .section "Format of driver configurations" "SECTfordricon"
5483 .cindex "drivers" "configuration format"
5484 There are separate parts in the configuration for defining routers, transports,
5485 and authenticators. In each part, you are defining a number of driver
5486 instances, each with its own set of options. Each driver instance is defined by
5487 a sequence of lines like this:
5488 .display
5489 <&'instance name'&>:
5490   <&'option'&>
5491   ...
5492   <&'option'&>
5493 .endd
5494 In the following example, the instance name is &(localuser)&, and it is
5495 followed by three options settings:
5496 .code
5497 localuser:
5498   driver = accept
5499   check_local_user
5500   transport = local_delivery
5501 .endd
5502 For each driver instance, you specify which Exim code module it uses &-- by the
5503 setting of the &%driver%& option &-- and (optionally) some configuration
5504 settings. For example, in the case of transports, if you want a transport to
5505 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5506 a local file you would use the &(appendfile)& driver. Each of the drivers is
5507 described in detail in its own separate chapter later in this manual.
5508
5509 You can have several routers, transports, or authenticators that are based on
5510 the same underlying driver (each must have a different instance name).
5511
5512 The order in which routers are defined is important, because addresses are
5513 passed to individual routers one by one, in order. The order in which
5514 transports are defined does not matter at all. The order in which
5515 authenticators are defined is used only when Exim, as a client, is searching
5516 them to find one that matches an authentication mechanism offered by the
5517 server.
5518
5519 .cindex "generic options"
5520 .cindex "options" "generic &-- definition of"
5521 Within a driver instance definition, there are two kinds of option: &'generic'&
5522 and &'private'&. The generic options are those that apply to all drivers of the
5523 same type (that is, all routers, all transports or all authenticators). The
5524 &%driver%& option is a generic option that must appear in every definition.
5525 .cindex "private options"
5526 The private options are special for each driver, and none need appear, because
5527 they all have default values.
5528
5529 The options may appear in any order, except that the &%driver%& option must
5530 precede any private options, since these depend on the particular driver. For
5531 this reason, it is recommended that &%driver%& always be the first option.
5532
5533 Driver instance names, which are used for reference in log entries and
5534 elsewhere, can be any sequence of letters, digits, and underscores (starting
5535 with a letter) and must be unique among drivers of the same type. A router and
5536 a transport (for example) can each have the same name, but no two router
5537 instances can have the same name. The name of a driver instance should not be
5538 confused with the name of the underlying driver module. For example, the
5539 configuration lines:
5540 .code
5541 remote_smtp:
5542   driver = smtp
5543 .endd
5544 create an instance of the &(smtp)& transport driver whose name is
5545 &(remote_smtp)&. The same driver code can be used more than once, with
5546 different instance names and different option settings each time. A second
5547 instance of the &(smtp)& transport, with different options, might be defined
5548 thus:
5549 .code
5550 special_smtp:
5551   driver = smtp
5552   port = 1234
5553   command_timeout = 10s
5554 .endd
5555 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5556 these transport instances from routers, and these names would appear in log
5557 lines.
5558
5559 Comment lines may be present in the middle of driver specifications. The full
5560 list of option settings for any particular driver instance, including all the
5561 defaulted values, can be extracted by making use of the &%-bP%& command line
5562 option.
5563
5564
5565
5566
5567
5568
5569 . ////////////////////////////////////////////////////////////////////////////
5570 . ////////////////////////////////////////////////////////////////////////////
5571
5572 .chapter "The default configuration file" "CHAPdefconfil"
5573 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5574 .cindex "default" "configuration file &""walk through""&"
5575 The default configuration file supplied with Exim as &_src/configure.default_&
5576 is sufficient for a host with simple mail requirements. As an introduction to
5577 the way Exim is configured, this chapter &"walks through"& the default
5578 configuration, giving brief explanations of the settings. Detailed descriptions
5579 of the options are given in subsequent chapters. The default configuration file
5580 itself contains extensive comments about ways you might want to modify the
5581 initial settings. However, note that there are many options that are not
5582 mentioned at all in the default configuration.
5583
5584
5585
5586 .section "Macros" "SECTdefconfmacros"
5587 All macros should be defined before any options.
5588
5589 One macro is specified, but commented out, in the default configuration:
5590 .code
5591 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5592 .endd
5593 If all off-site mail is expected to be delivered to a "smarthost", then set the
5594 hostname here and uncomment the macro.  This will affect which router is used
5595 later on.  If this is left commented out, then Exim will perform direct-to-MX
5596 deliveries using a &(dnslookup)& router.
5597
5598 In addition to macros defined here, Exim includes a number of built-in macros
5599 to enable configuration to be guarded by a binary built with support for a
5600 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5601
5602
5603 .section "Main configuration settings" "SECTdefconfmain"
5604 The main (global) configuration option settings section must always come first
5605 in the file, after the macros.
5606 The first thing you'll see in the file, after some initial comments, is the line
5607 .code
5608 # primary_hostname =
5609 .endd
5610 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5611 to know the official, fully qualified name of your host, and this is where you
5612 can specify it. However, in most cases you do not need to set this option. When
5613 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5614
5615 The first three non-comment configuration lines are as follows:
5616 .code
5617 domainlist local_domains    = @
5618 domainlist relay_to_domains =
5619 hostlist   relay_from_hosts = 127.0.0.1
5620 .endd
5621 These are not, in fact, option settings. They are definitions of two named
5622 domain lists and one named host list. Exim allows you to give names to lists of
5623 domains, hosts, and email addresses, in order to make it easier to manage the
5624 configuration file (see section &<<SECTnamedlists>>&).
5625
5626 The first line defines a domain list called &'local_domains'&; this is used
5627 later in the configuration to identify domains that are to be delivered
5628 on the local host.
5629
5630 .cindex "@ in a domain list"
5631 There is just one item in this list, the string &"@"&. This is a special form
5632 of entry which means &"the name of the local host"&. Thus, if the local host is
5633 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5634 be delivered locally. Because the local host's name is referenced indirectly,
5635 the same configuration file can be used on different hosts.
5636
5637 The second line defines a domain list called &'relay_to_domains'&, but the
5638 list itself is empty. Later in the configuration we will come to the part that
5639 controls mail relaying through the local host; it allows relaying to any
5640 domains in this list. By default, therefore, no relaying on the basis of a mail
5641 domain is permitted.
5642
5643 The third line defines a host list called &'relay_from_hosts'&. This list is
5644 used later in the configuration to permit relaying from any host or IP address
5645 that matches the list. The default contains just the IP address of the IPv4
5646 loopback interface, which means that processes on the local host are able to
5647 submit mail for relaying by sending it over TCP/IP to that interface. No other
5648 hosts are permitted to submit messages for relaying.
5649
5650 Just to be sure there's no misunderstanding: at this point in the configuration
5651 we aren't actually setting up any controls. We are just defining some domains
5652 and hosts that will be used in the controls that are specified later.
5653
5654 The next two configuration lines are genuine option settings:
5655 .code
5656 acl_smtp_rcpt = acl_check_rcpt
5657 acl_smtp_data = acl_check_data
5658 .endd
5659 These options specify &'Access Control Lists'& (ACLs) that are to be used
5660 during an incoming SMTP session for every recipient of a message (every RCPT
5661 command), and after the contents of the message have been received,
5662 respectively. The names of the lists are &'acl_check_rcpt'& and
5663 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5664 section of the configuration. The RCPT ACL controls which recipients are
5665 accepted for an incoming message &-- if a configuration does not provide an ACL
5666 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5667 contents of a message to be checked.
5668
5669 Two commented-out option settings are next:
5670 .code
5671 # av_scanner = clamd:/tmp/clamd
5672 # spamd_address = 127.0.0.1 783
5673 .endd
5674 These are example settings that can be used when Exim is compiled with the
5675 content-scanning extension. The first specifies the interface to the virus
5676 scanner, and the second specifies the interface to SpamAssassin. Further
5677 details are given in chapter &<<CHAPexiscan>>&.
5678
5679 Three more commented-out option settings follow:
5680 .code
5681 # tls_advertise_hosts = *
5682 # tls_certificate = /etc/ssl/exim.crt
5683 # tls_privatekey = /etc/ssl/exim.pem
5684 .endd
5685 These are example settings that can be used when Exim is compiled with
5686 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5687 first one specifies the list of clients that are allowed to use TLS when
5688 connecting to this server; in this case, the wildcard means all clients. The
5689 other options specify where Exim should find its TLS certificate and private
5690 key, which together prove the server's identity to any clients that connect.
5691 More details are given in chapter &<<CHAPTLS>>&.
5692
5693 Another two commented-out option settings follow:
5694 .code
5695 # daemon_smtp_ports = 25 : 465 : 587
5696 # tls_on_connect_ports = 465
5697 .endd
5698 .cindex "port" "465 and 587"
5699 .cindex "port" "for message submission"
5700 .cindex "message" "submission, ports for"
5701 .cindex "submissions protocol"
5702 .cindex "smtps protocol"
5703 .cindex "ssmtp protocol"
5704 .cindex "SMTP" "submissions protocol"
5705 .cindex "SMTP" "ssmtp protocol"
5706 .cindex "SMTP" "smtps protocol"
5707 These options provide better support for roaming users who wish to use this
5708 server for message submission. They are not much use unless you have turned on
5709 TLS (as described in the previous paragraph) and authentication (about which
5710 more in section &<<SECTdefconfauth>>&).
5711 Mail submission from mail clients (MUAs) should be separate from inbound mail
5712 to your domain (MX delivery) for various good reasons (eg, ability to impose
5713 much saner TLS protocol and ciphersuite requirements without unintended
5714 consequences).
5715 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5716 which uses STARTTLS, so this is the &"submission"& port.
5717 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5718 which should be used in preference to 587.
5719 You should also consider deploying SRV records to help clients find
5720 these ports.
5721 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5722
5723 Two more commented-out options settings follow:
5724 .code
5725 # qualify_domain =
5726 # qualify_recipient =
5727 .endd
5728 The first of these specifies a domain that Exim uses when it constructs a
5729 complete email address from a local login name. This is often needed when Exim
5730 receives a message from a local process. If you do not set &%qualify_domain%&,
5731 the value of &%primary_hostname%& is used. If you set both of these options,
5732 you can have different qualification domains for sender and recipient
5733 addresses. If you set only the first one, its value is used in both cases.
5734
5735 .cindex "domain literal" "recognizing format"
5736 The following line must be uncommented if you want Exim to recognize
5737 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5738 (an IP address within square brackets) instead of a named domain.
5739 .code
5740 # allow_domain_literals
5741 .endd
5742 The RFCs still require this form, but many people think that in the modern
5743 Internet it makes little sense to permit mail to be sent to specific hosts by
5744 quoting their IP addresses. This ancient format has been used by people who
5745 try to abuse hosts by using them for unwanted relaying. However, some
5746 people believe there are circumstances (for example, messages addressed to
5747 &'postmaster'&) where domain literals are still useful.
5748
5749 The next configuration line is a kind of trigger guard:
5750 .code
5751 never_users = root
5752 .endd
5753 It specifies that no delivery must ever be run as the root user. The normal
5754 convention is to set up &'root'& as an alias for the system administrator. This
5755 setting is a guard against slips in the configuration.
5756 The list of users specified by &%never_users%& is not, however, the complete
5757 list; the build-time configuration in &_Local/Makefile_& has an option called
5758 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5759 contents of &%never_users%& are added to this list. By default
5760 FIXED_NEVER_USERS also specifies root.
5761
5762 When a remote host connects to Exim in order to send mail, the only information
5763 Exim has about the host's identity is its IP address. The next configuration
5764 line,
5765 .code
5766 host_lookup = *
5767 .endd
5768 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5769 in order to get a host name. This improves the quality of the logging
5770 information, but if you feel it is too expensive, you can remove it entirely,
5771 or restrict the lookup to hosts on &"nearby"& networks.
5772 Note that it is not always possible to find a host name from an IP address,
5773 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5774 unreachable.
5775
5776 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5777 1413 (hence their names):
5778 .code
5779 rfc1413_hosts = *
5780 rfc1413_query_timeout = 0s
5781 .endd
5782 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5783 Few hosts offer RFC1413 service these days; calls have to be
5784 terminated by a timeout and this needlessly delays the startup
5785 of an incoming SMTP connection.
5786 If you have hosts for which you trust RFC1413 and need this
5787 information, you can change this.
5788
5789 This line enables an efficiency SMTP option.  It is negotiated by clients
5790 and not expected to cause problems but can be disabled if needed.
5791 .code
5792 prdr_enable = true
5793 .endd
5794
5795 When Exim receives messages over SMTP connections, it expects all addresses to
5796 be fully qualified with a domain, as required by the SMTP definition. However,
5797 if you are running a server to which simple clients submit messages, you may
5798 find that they send unqualified addresses. The two commented-out options:
5799 .code
5800 # sender_unqualified_hosts =
5801 # recipient_unqualified_hosts =
5802 .endd
5803 show how you can specify hosts that are permitted to send unqualified sender
5804 and recipient addresses, respectively.
5805
5806 The &%log_selector%& option is used to increase the detail of logging
5807 over the default:
5808 .code
5809 log_selector = +smtp_protocol_error +smtp_syntax_error \
5810                +tls_certificate_verified
5811 .endd
5812
5813 The &%percent_hack_domains%& option is also commented out:
5814 .code
5815 # percent_hack_domains =
5816 .endd
5817 It provides a list of domains for which the &"percent hack"& is to operate.
5818 This is an almost obsolete form of explicit email routing. If you do not know
5819 anything about it, you can safely ignore this topic.
5820
5821 The next two settings in the main part of the default configuration are
5822 concerned with messages that have been &"frozen"& on Exim's queue. When a
5823 message is frozen, Exim no longer continues to try to deliver it. Freezing
5824 occurs when a bounce message encounters a permanent failure because the sender
5825 address of the original message that caused the bounce is invalid, so the
5826 bounce cannot be delivered. This is probably the most common case, but there
5827 are also other conditions that cause freezing, and frozen messages are not
5828 always bounce messages.
5829 .code
5830 ignore_bounce_errors_after = 2d
5831 timeout_frozen_after = 7d
5832 .endd
5833 The first of these options specifies that failing bounce messages are to be
5834 discarded after 2 days in the queue. The second specifies that any frozen
5835 message (whether a bounce message or not) is to be timed out (and discarded)
5836 after a week. In this configuration, the first setting ensures that no failing
5837 bounce message ever lasts a week.
5838
5839 Exim queues it's messages in a spool directory. If you expect to have
5840 large queues, you may consider using this option. It splits the spool
5841 directory into subdirectories to avoid file system degradation from
5842 many files in a single directory, resulting in better performance.
5843 Manual manipulation of queued messages becomes more complex (though fortunately
5844 not often needed).
5845 .code
5846 # split_spool_directory = true
5847 .endd
5848
5849 In an ideal world everybody follows the standards. For non-ASCII
5850 messages RFC 2047 is a standard, allowing a maximum line length of 76
5851 characters. Exim adheres that standard and won't process messages which
5852 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5853 In particular, the Exim maintainers have had multiple reports of
5854 problems from Russian administrators of issues until they disable this
5855 check, because of some popular, yet buggy, mail composition software.
5856 .code
5857 # check_rfc2047_length = false
5858 .endd
5859
5860 If you need to be strictly RFC compliant you may wish to disable the
5861 8BITMIME advertisement. Use this, if you exchange mails with systems
5862 that are not 8-bit clean.
5863 .code
5864 # accept_8bitmime = false
5865 .endd
5866
5867 Libraries you use may depend on specific environment settings.  This
5868 imposes a security risk (e.g. PATH). There are two lists:
5869 &%keep_environment%& for the variables to import as they are, and
5870 &%add_environment%& for variables we want to set to a fixed value.
5871 Note that TZ is handled separately, by the &%timezone%& runtime
5872 option and by the TIMEZONE_DEFAULT buildtime option.
5873 .code
5874 # keep_environment = ^LDAP
5875 # add_environment = PATH=/usr/bin::/bin
5876 .endd
5877
5878
5879 .section "ACL configuration" "SECID54"
5880 .cindex "default" "ACLs"
5881 .cindex "&ACL;" "default configuration"
5882 In the default configuration, the ACL section follows the main configuration.
5883 It starts with the line
5884 .code
5885 begin acl
5886 .endd
5887 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5888 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5889 and &%acl_smtp_data%& above.
5890
5891 .cindex "RCPT" "ACL for"
5892 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5893 RCPT command specifies one of the message's recipients. The ACL statements
5894 are considered in order, until the recipient address is either accepted or
5895 rejected. The RCPT command is then accepted or rejected, according to the
5896 result of the ACL processing.
5897 .code
5898 acl_check_rcpt:
5899 .endd
5900 This line, consisting of a name terminated by a colon, marks the start of the
5901 ACL, and names it.
5902 .code
5903 accept  hosts = :
5904 .endd
5905 This ACL statement accepts the recipient if the sending host matches the list.
5906 But what does that strange list mean? It doesn't actually contain any host
5907 names or IP addresses. The presence of the colon puts an empty item in the
5908 list; Exim matches this only if the incoming message did not come from a remote
5909 host, because in that case, the remote hostname is empty. The colon is
5910 important. Without it, the list itself is empty, and can never match anything.
5911
5912 What this statement is doing is to accept unconditionally all recipients in
5913 messages that are submitted by SMTP from local processes using the standard
5914 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5915 manner.
5916 .code
5917 deny    domains       = +local_domains
5918         local_parts   = ^[.] : ^.*[@%!/|]
5919         message       = Restricted characters in address
5920
5921 deny    domains       = !+local_domains
5922         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5923         message       = Restricted characters in address
5924 .endd
5925 These statements are concerned with local parts that contain any of the
5926 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5927 Although these characters are entirely legal in local parts (in the case of
5928 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5929 in Internet mail addresses.
5930
5931 The first three have in the past been associated with explicitly routed
5932 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5933 option). Addresses containing these characters are regularly tried by spammers
5934 in an attempt to bypass relaying restrictions, and also by open relay testing
5935 programs. Unless you really need them it is safest to reject these characters
5936 at this early stage. This configuration is heavy-handed in rejecting these
5937 characters for all messages it accepts from remote hosts. This is a deliberate
5938 policy of being as safe as possible.
5939
5940 The first rule above is stricter, and is applied to messages that are addressed
5941 to one of the local domains handled by this host. This is implemented by the
5942 first condition, which restricts it to domains that are listed in the
5943 &'local_domains'& domain list. The &"+"& character is used to indicate a
5944 reference to a named list. In this configuration, there is just one domain in
5945 &'local_domains'&, but in general there may be many.
5946
5947 The second condition on the first statement uses two regular expressions to
5948 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5949 or &"|"&. If you have local accounts that include these characters, you will
5950 have to modify this rule.
5951
5952 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5953 allows them because they have been encountered in practice. (Consider the
5954 common convention of local parts constructed as
5955 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5956 the author of Exim, who has no second initial.) However, a local part starting
5957 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5958 filename (for example, for a mailing list). This is also true for local parts
5959 that contain slashes. A pipe symbol can also be troublesome if the local part
5960 is incorporated unthinkingly into a shell command line.
5961
5962 The second rule above applies to all other domains, and is less strict. This
5963 allows your own users to send outgoing messages to sites that use slashes
5964 and vertical bars in their local parts. It blocks local parts that begin
5965 with a dot, slash, or vertical bar, but allows these characters within the
5966 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5967 and &"!"& is blocked, as before. The motivation here is to prevent your users
5968 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5969 .code
5970 accept  local_parts   = postmaster
5971         domains       = +local_domains
5972 .endd
5973 This statement, which has two conditions, accepts an incoming address if the
5974 local part is &'postmaster'& and the domain is one of those listed in the
5975 &'local_domains'& domain list. The &"+"& character is used to indicate a
5976 reference to a named list. In this configuration, there is just one domain in
5977 &'local_domains'&, but in general there may be many.
5978
5979 The presence of this statement means that mail to postmaster is never blocked
5980 by any of the subsequent tests. This can be helpful while sorting out problems
5981 in cases where the subsequent tests are incorrectly denying access.
5982 .code
5983 require verify        = sender
5984 .endd
5985 This statement requires the sender address to be verified before any subsequent
5986 ACL statement can be used. If verification fails, the incoming recipient
5987 address is refused. Verification consists of trying to route the address, to
5988 see if a bounce message could be delivered to it. In the case of remote
5989 addresses, basic verification checks only the domain, but &'callouts'& can be
5990 used for more verification if required. Section &<<SECTaddressverification>>&
5991 discusses the details of address verification.
5992 .code
5993 accept  hosts         = +relay_from_hosts
5994         control       = submission
5995 .endd
5996 This statement accepts the address if the message is coming from one of the
5997 hosts that are defined as being allowed to relay through this host. Recipient
5998 verification is omitted here, because in many cases the clients are dumb MUAs
5999 that do not cope well with SMTP error responses. For the same reason, the
6000 second line specifies &"submission mode"& for messages that are accepted. This
6001 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6002 messages that are deficient in some way, for example, because they lack a
6003 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6004 probably add recipient verification here, and disable submission mode.
6005 .code
6006 accept  authenticated = *
6007         control       = submission
6008 .endd
6009 This statement accepts the address if the client host has authenticated itself.
6010 Submission mode is again specified, on the grounds that such messages are most
6011 likely to come from MUAs. The default configuration does not define any
6012 authenticators, though it does include some nearly complete commented-out
6013 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6014 fact authenticate until you complete the authenticator definitions.
6015 .code
6016 require message = relay not permitted
6017         domains = +local_domains : +relay_to_domains
6018 .endd
6019 This statement rejects the address if its domain is neither a local domain nor
6020 one of the domains for which this host is a relay.
6021 .code
6022 require verify = recipient
6023 .endd
6024 This statement requires the recipient address to be verified; if verification
6025 fails, the address is rejected.
6026 .code
6027 # deny    dnslists    = black.list.example
6028 #         message     = rejected because $sender_host_address \
6029 #                       is in a black list at $dnslist_domain\n\
6030 #                       $dnslist_text
6031 #
6032 # warn    dnslists    = black.list.example
6033 #         add_header  = X-Warning: $sender_host_address is in \
6034 #                       a black list at $dnslist_domain
6035 #         log_message = found in $dnslist_domain
6036 .endd
6037 These commented-out lines are examples of how you could configure Exim to check
6038 sending hosts against a DNS black list. The first statement rejects messages
6039 from blacklisted hosts, whereas the second just inserts a warning header
6040 line.
6041 .code
6042 # require verify = csa
6043 .endd
6044 This commented-out line is an example of how you could turn on client SMTP
6045 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6046 records.
6047 .code
6048 accept
6049 .endd
6050 The final statement in the first ACL unconditionally accepts any recipient
6051 address that has successfully passed all the previous tests.
6052 .code
6053 acl_check_data:
6054 .endd
6055 This line marks the start of the second ACL, and names it. Most of the contents
6056 of this ACL are commented out:
6057 .code
6058 # deny    malware   = *
6059 #         message   = This message contains a virus \
6060 #                     ($malware_name).
6061 .endd
6062 These lines are examples of how to arrange for messages to be scanned for
6063 viruses when Exim has been compiled with the content-scanning extension, and a
6064 suitable virus scanner is installed. If the message is found to contain a
6065 virus, it is rejected with the given custom error message.
6066 .code
6067 # warn    spam      = nobody
6068 #         message   = X-Spam_score: $spam_score\n\
6069 #                     X-Spam_score_int: $spam_score_int\n\
6070 #                     X-Spam_bar: $spam_bar\n\
6071 #                     X-Spam_report: $spam_report
6072 .endd
6073 These lines are an example of how to arrange for messages to be scanned by
6074 SpamAssassin when Exim has been compiled with the content-scanning extension,
6075 and SpamAssassin has been installed. The SpamAssassin check is run with
6076 &`nobody`& as its user parameter, and the results are added to the message as a
6077 series of extra header line. In this case, the message is not rejected,
6078 whatever the spam score.
6079 .code
6080 accept
6081 .endd
6082 This final line in the DATA ACL accepts the message unconditionally.
6083
6084
6085 .section "Router configuration" "SECID55"
6086 .cindex "default" "routers"
6087 .cindex "routers" "default"
6088 The router configuration comes next in the default configuration, introduced
6089 by the line
6090 .code
6091 begin routers
6092 .endd
6093 Routers are the modules in Exim that make decisions about where to send
6094 messages. An address is passed to each router, in turn, until it is either
6095 accepted, or failed. This means that the order in which you define the routers
6096 matters. Each router is fully described in its own chapter later in this
6097 manual. Here we give only brief overviews.
6098 .code
6099 # domain_literal:
6100 #   driver = ipliteral
6101 #   domains = !+local_domains
6102 #   transport = remote_smtp
6103 .endd
6104 .cindex "domain literal" "default router"
6105 This router is commented out because the majority of sites do not want to
6106 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6107 you uncomment this router, you also need to uncomment the setting of
6108 &%allow_domain_literals%& in the main part of the configuration.
6109
6110 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6111 macro has been defined, per
6112 .code
6113 .ifdef ROUTER_SMARTHOST
6114 smarthost:
6115 #...
6116 .else
6117 dnslookup:
6118 #...
6119 .endif
6120 .endd
6121
6122 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6123 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6124 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6125 skip these routers because of the &%domains%& option.
6126
6127 .code
6128 smarthost:
6129   driver = manualroute
6130   domains = ! +local_domains
6131   transport = smarthost_smtp
6132   route_data = ROUTER_SMARTHOST
6133   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6134   no_more
6135 .endd
6136 This router only handles mail which is not to any local domains; this is
6137 specified by the line
6138 .code
6139 domains = ! +local_domains
6140 .endd
6141 The &%domains%& option lists the domains to which this router applies, but the
6142 exclamation mark is a negation sign, so the router is used only for domains
6143 that are not in the domain list called &'local_domains'& (which was defined at
6144 the start of the configuration). The plus sign before &'local_domains'&
6145 indicates that it is referring to a named list. Addresses in other domains are
6146 passed on to the following routers.
6147
6148 The name of the router driver is &(manualroute)& because we are manually
6149 specifying how mail should be routed onwards, instead of using DNS MX.
6150 While the name of this router instance is arbitrary, the &%driver%& option must
6151 be one of the driver modules that is in the Exim binary.
6152
6153 With no pre-conditions other than &%domains%&, all mail for non-local domains
6154 will be handled by this router, and the &%no_more%& setting will ensure that no
6155 other routers will be used for messages matching the pre-conditions.  See
6156 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6157 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6158 and the macro supplies the value; the address is then queued for the
6159 &(smarthost_smtp)& transport.
6160
6161 .code
6162 dnslookup:
6163   driver = dnslookup
6164   domains = ! +local_domains
6165   transport = remote_smtp
6166   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6167   no_more
6168 .endd
6169 The &%domains%& option behaves as per smarthost, above.
6170
6171 The name of the router driver is &(dnslookup)&,
6172 and is specified by the &%driver%& option. Do not be confused by the fact that
6173 the name of this router instance is the same as the name of the driver. The
6174 instance name is arbitrary, but the name set in the &%driver%& option must be
6175 one of the driver modules that is in the Exim binary.
6176
6177 The &(dnslookup)& router routes addresses by looking up their domains in the
6178 DNS in order to obtain a list of hosts to which the address is routed. If the
6179 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6180 specified by the &%transport%& option. If the router does not find the domain
6181 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6182 the address fails and is bounced.
6183
6184 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6185 be entirely ignored. This option is present because a number of cases have been
6186 encountered where MX records in the DNS point to host names
6187 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6188 Completely ignoring these IP addresses causes Exim to fail to route the
6189 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6190 continue to try to deliver the message periodically until the address timed
6191 out.
6192 .code
6193 system_aliases:
6194   driver = redirect
6195   allow_fail
6196   allow_defer
6197   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6198 # user = exim
6199   file_transport = address_file
6200   pipe_transport = address_pipe
6201 .endd
6202 Control reaches this and subsequent routers only for addresses in the local
6203 domains. This router checks to see whether the local part is defined as an
6204 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6205 data that it looks up from that file. If no data is found for the local part,
6206 the value of the &%data%& option is empty, causing the address to be passed to
6207 the next router.
6208
6209 &_/etc/aliases_& is a conventional name for the system aliases file that is
6210 often used. That is why it is referenced by from the default configuration
6211 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6212 &_Local/Makefile_& before building Exim.
6213 .code
6214 userforward:
6215   driver = redirect
6216   check_local_user
6217 # local_part_suffix = +* : -*
6218 # local_part_suffix_optional
6219   file = $home/.forward
6220 # allow_filter
6221   no_verify
6222   no_expn
6223   check_ancestor
6224   file_transport = address_file
6225   pipe_transport = address_pipe
6226   reply_transport = address_reply
6227 .endd
6228 This is the most complicated router in the default configuration. It is another
6229 redirection router, but this time it is looking for forwarding data set up by
6230 individual users. The &%check_local_user%& setting specifies a check that the
6231 local part of the address is the login name of a local user. If it is not, the
6232 router is skipped. The two commented options that follow &%check_local_user%&,
6233 namely:
6234 .code
6235 # local_part_suffix = +* : -*
6236 # local_part_suffix_optional
6237 .endd
6238 .vindex "&$local_part_suffix$&"
6239 show how you can specify the recognition of local part suffixes. If the first
6240 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6241 by any sequence of characters, is removed from the local part and placed in the
6242 variable &$local_part_suffix$&. The second suffix option specifies that the
6243 presence of a suffix in the local part is optional. When a suffix is present,
6244 the check for a local login uses the local part with the suffix removed.
6245
6246 When a local user account is found, the file called &_.forward_& in the user's
6247 home directory is consulted. If it does not exist, or is empty, the router
6248 declines. Otherwise, the contents of &_.forward_& are interpreted as
6249 redirection data (see chapter &<<CHAPredirect>>& for more details).
6250
6251 .cindex "Sieve filter" "enabling in default router"
6252 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6253 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6254 is commented out by default), the contents of the file are interpreted as a set
6255 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6256 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6257 separate document entitled &'Exim's interfaces to mail filtering'&.
6258
6259 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6260 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6261 There are two reasons for doing this:
6262
6263 .olist
6264 Whether or not a local user has a &_.forward_& file is not really relevant when
6265 checking an address for validity; it makes sense not to waste resources doing
6266 unnecessary work.
6267 .next
6268 More importantly, when Exim is verifying addresses or handling an EXPN
6269 command during an SMTP session, it is running as the Exim user, not as root.
6270 The group is the Exim group, and no additional groups are set up.
6271 It may therefore not be possible for Exim to read users' &_.forward_& files at
6272 this time.
6273 .endlist
6274
6275 The setting of &%check_ancestor%& prevents the router from generating a new
6276 address that is the same as any previous address that was redirected. (This
6277 works round a problem concerning a bad interaction between aliasing and
6278 forwarding &-- see section &<<SECTredlocmai>>&).
6279
6280 The final three option settings specify the transports that are to be used when
6281 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6282 auto-reply, respectively. For example, if a &_.forward_& file contains
6283 .code
6284 a.nother@elsewhere.example, /home/spqr/archive
6285 .endd
6286 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6287 transport.
6288 .code
6289 localuser:
6290   driver = accept
6291   check_local_user
6292 # local_part_suffix = +* : -*
6293 # local_part_suffix_optional
6294   transport = local_delivery
6295 .endd
6296 The final router sets up delivery into local mailboxes, provided that the local
6297 part is the name of a local login, by accepting the address and assigning it to
6298 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6299 routers, so the address is bounced. The commented suffix settings fulfil the
6300 same purpose as they do for the &(userforward)& router.
6301
6302
6303 .section "Transport configuration" "SECID56"
6304 .cindex "default" "transports"
6305 .cindex "transports" "default"
6306 Transports define mechanisms for actually delivering messages. They operate
6307 only when referenced from routers, so the order in which they are defined does
6308 not matter. The transports section of the configuration starts with
6309 .code
6310 begin transports
6311 .endd
6312 Two remote transports and four local transports are defined.
6313 .code
6314 remote_smtp:
6315   driver = smtp
6316   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6317 .ifdef _HAVE_PRDR
6318   hosts_try_prdr = *
6319 .endif
6320 .endd
6321 This transport is used for delivering messages over SMTP connections.
6322 The list of remote hosts comes from the router.
6323 The &%message_size_limit%& usage is a hack to avoid sending on messages
6324 with over-long lines.
6325
6326 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6327 negotiated between client and server and not expected to cause problems
6328 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6329 use of the &%hosts_try_prdr%& configuration option.
6330
6331 The other remote transport is used when delivering to a specific smarthost
6332 with whom there must be some kind of existing relationship, instead of the
6333 usual federated system.
6334
6335 .code
6336 smarthost_smtp:
6337   driver = smtp
6338   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6339   multi_domain
6340   #
6341 .ifdef _HAVE_TLS
6342   # Comment out any of these which you have to, then file a Support
6343   # request with your smarthost provider to get things fixed:
6344   hosts_require_tls = *
6345   tls_verify_hosts = *
6346   # As long as tls_verify_hosts is enabled, this this will have no effect,
6347   # but if you have to comment it out then this will at least log whether
6348   # you succeed or not:
6349   tls_try_verify_hosts = *
6350   #
6351   # The SNI name should match the name which we'll expect to verify;
6352   # many mail systems don't use SNI and this doesn't matter, but if it does,
6353   # we need to send a name which the remote site will recognize.
6354   # This _should_ be the name which the smarthost operators specified as
6355   # the hostname for sending your mail to.
6356   tls_sni = ROUTER_SMARTHOST
6357   #
6358 .ifdef _HAVE_OPENSSL
6359   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6360 .endif
6361 .ifdef _HAVE_GNUTLS
6362   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6363 .endif
6364 .endif
6365 .ifdef _HAVE_PRDR
6366   hosts_try_prdr = *
6367 .endif
6368 .endd
6369 After the same &%message_size_limit%& hack, we then specify that this Transport
6370 can handle messages to multiple domains in one run.  The assumption here is
6371 that you're routing all non-local mail to the same place and that place is
6372 happy to take all messages from you as quickly as possible.
6373 All other options depend upon built-in macros; if Exim was built without TLS support
6374 then no other options are defined.
6375 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6376 and versions using the &%tls_require_ciphers%& option, where the value to be
6377 used depends upon the library providing TLS.
6378 Beyond that, the options adopt the stance that you should have TLS support available
6379 from your smarthost on today's Internet, so we turn on requiring TLS for the
6380 mail to be delivered, and requiring that the certificate be valid, and match
6381 the expected hostname.  The &%tls_sni%& option can be used by service providers
6382 to select an appropriate certificate to present to you and here we re-use the
6383 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6384 You want to specify the hostname which you'll expect to validate for, and that
6385 should not be subject to insecure tampering via DNS results.
6386
6387 For the &%hosts_try_prdr%& option see the previous transport.
6388
6389 All other options are defaulted.
6390 .code
6391 local_delivery:
6392   driver = appendfile
6393   file = /var/mail/$local_part_data
6394   delivery_date_add
6395   envelope_to_add
6396   return_path_add
6397 # group = mail
6398 # mode = 0660
6399 .endd
6400 This &(appendfile)& transport is used for local delivery to user mailboxes in
6401 traditional BSD mailbox format.
6402
6403 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6404 as it is provided by a potential bad actor.
6405 Instead we use &$local_part_data$&,
6406 the result of looking up &$local_part$& in the user database
6407 (done by using &%check_local_user%& in the the router).
6408
6409 By default &(appendfile)& runs under the uid and gid of the
6410 local user, which requires the sticky bit to be set on the &_/var/mail_&
6411 directory. Some systems use the alternative approach of running mail deliveries
6412 under a particular group instead of using the sticky bit. The commented options
6413 show how this can be done.
6414
6415 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6416 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6417 similarly-named options above.
6418 .code
6419 address_pipe:
6420   driver = pipe
6421   return_output
6422 .endd
6423 This transport is used for handling deliveries to pipes that are generated by
6424 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6425 option specifies that any output on stdout or stderr generated by the pipe is to
6426 be returned to the sender.
6427 .code
6428 address_file:
6429   driver = appendfile
6430   delivery_date_add
6431   envelope_to_add
6432   return_path_add
6433 .endd
6434 This transport is used for handling deliveries to files that are generated by
6435 redirection. The name of the file is not specified in this instance of
6436 &(appendfile)&, because it comes from the &(redirect)& router.
6437 .code
6438 address_reply:
6439   driver = autoreply
6440 .endd
6441 This transport is used for handling automatic replies generated by users'
6442 filter files.
6443
6444
6445
6446 .section "Default retry rule" "SECID57"
6447 .cindex "retry" "default rule"
6448 .cindex "default" "retry rule"
6449 The retry section of the configuration file contains rules which affect the way
6450 Exim retries deliveries that cannot be completed at the first attempt. It is
6451 introduced by the line
6452 .code
6453 begin retry
6454 .endd
6455 In the default configuration, there is just one rule, which applies to all
6456 errors:
6457 .code
6458 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6459 .endd
6460 This causes any temporarily failing address to be retried every 15 minutes for
6461 2 hours, then at intervals starting at one hour and increasing by a factor of
6462 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6463 is not delivered after 4 days of temporary failure, it is bounced. The time is
6464 measured from first failure, not from the time the message was received.
6465
6466 If the retry section is removed from the configuration, or is empty (that is,
6467 if no retry rules are defined), Exim will not retry deliveries. This turns
6468 temporary errors into permanent errors.
6469
6470
6471 .section "Rewriting configuration" "SECID58"
6472 The rewriting section of the configuration, introduced by
6473 .code
6474 begin rewrite
6475 .endd
6476 contains rules for rewriting addresses in messages as they arrive. There are no
6477 rewriting rules in the default configuration file.
6478
6479
6480
6481 .section "Authenticators configuration" "SECTdefconfauth"
6482 .cindex "AUTH" "configuration"
6483 The authenticators section of the configuration, introduced by
6484 .code
6485 begin authenticators
6486 .endd
6487 defines mechanisms for the use of the SMTP AUTH command. The default
6488 configuration file contains two commented-out example authenticators
6489 which support plaintext username/password authentication using the
6490 standard PLAIN mechanism and the traditional but non-standard LOGIN
6491 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6492 to support most MUA software.
6493
6494 The example PLAIN authenticator looks like this:
6495 .code
6496 #PLAIN:
6497 #  driver                  = plaintext
6498 #  server_set_id           = $auth2
6499 #  server_prompts          = :
6500 #  server_condition        = Authentication is not yet configured
6501 #  server_advertise_condition = ${if def:tls_in_cipher }
6502 .endd
6503 And the example LOGIN authenticator looks like this:
6504 .code
6505 #LOGIN:
6506 #  driver                  = plaintext
6507 #  server_set_id           = $auth1
6508 #  server_prompts          = <| Username: | Password:
6509 #  server_condition        = Authentication is not yet configured
6510 #  server_advertise_condition = ${if def:tls_in_cipher }
6511 .endd
6512
6513 The &%server_set_id%& option makes Exim remember the authenticated username
6514 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6515 &%server_prompts%& option configures the &(plaintext)& authenticator so
6516 that it implements the details of the specific authentication mechanism,
6517 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6518 when Exim offers authentication to clients; in the examples, this is only
6519 when TLS or SSL has been started, so to enable the authenticators you also
6520 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6521
6522 The &%server_condition%& setting defines how to verify that the username and
6523 password are correct. In the examples it just produces an error message.
6524 To make the authenticators work, you can use a string expansion
6525 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6526
6527 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6528 usercode and password are in different positions.
6529 Chapter &<<CHAPplaintext>>& covers both.
6530
6531 .ecindex IIDconfiwal
6532
6533
6534
6535 . ////////////////////////////////////////////////////////////////////////////
6536 . ////////////////////////////////////////////////////////////////////////////
6537
6538 .chapter "Regular expressions" "CHAPregexp"
6539
6540 .cindex "regular expressions" "library"
6541 .cindex "PCRE2"
6542 Exim supports the use of regular expressions in many of its options. It
6543 uses the PCRE2 regular expression library; this provides regular expression
6544 matching that is compatible with Perl 5. The syntax and semantics of
6545 regular expressions is discussed in
6546 online Perl manpages, in
6547 many Perl reference books, and also in
6548 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6549 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6550 . --- the http: URL here redirects to another page with the ISBN in the URL
6551 . --- where trying to use https: just redirects back to http:, so sticking
6552 . --- to the old URL for now.  2018-09-07.
6553
6554 The documentation for the syntax and semantics of the regular expressions that
6555 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6556 description is included here. The PCRE2 functions are called from Exim using
6557 the default option settings (that is, with no PCRE2 options set), except that
6558 the PCRE2_CASELESS option is set when the matching is required to be
6559 case-insensitive.
6560
6561 In most cases, when a regular expression is required in an Exim configuration,
6562 it has to start with a circumflex, in order to distinguish it from plain text
6563 or an &"ends with"& wildcard. In this example of a configuration setting, the
6564 second item in the colon-separated list is a regular expression.
6565 .code
6566 domains = a.b.c : ^\\d{3} : *.y.z : ...
6567 .endd
6568 The doubling of the backslash is required because of string expansion that
6569 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6570 of this issue, and a way of avoiding the need for doubling backslashes. The
6571 regular expression that is eventually used in this example contains just one
6572 backslash. The circumflex is included in the regular expression, and has the
6573 normal effect of &"anchoring"& it to the start of the string that is being
6574 matched.
6575
6576 There are, however, two cases where a circumflex is not required for the
6577 recognition of a regular expression: these are the &%match%& condition in a
6578 string expansion, and the &%matches%& condition in an Exim filter file. In
6579 these cases, the relevant string is always treated as a regular expression; if
6580 it does not start with a circumflex, the expression is not anchored, and can
6581 match anywhere in the subject string.
6582
6583 In all cases, if you want a regular expression to match at the end of a string,
6584 you must code the $ metacharacter to indicate this. For example:
6585 .code
6586 domains = ^\\d{3}\\.example
6587 .endd
6588 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6589 You need to use:
6590 .code
6591 domains = ^\\d{3}\\.example\$
6592 .endd
6593 if you want &'example'& to be the top-level domain. The backslash before the
6594 $ is needed because string expansion also interprets dollar characters.
6595
6596
6597
6598 . ////////////////////////////////////////////////////////////////////////////
6599 . ////////////////////////////////////////////////////////////////////////////
6600
6601 .chapter "File and database lookups" "CHAPfdlookup"
6602 .scindex IIDfidalo1 "file" "lookups"
6603 .scindex IIDfidalo2 "database" "lookups"
6604 .cindex "lookup" "description of"
6605 Exim can be configured to look up data in files or databases as it processes
6606 messages. Two different kinds of syntax are used:
6607
6608 .olist
6609 A string that is to be expanded may contain explicit lookup requests. These
6610 cause parts of the string to be replaced by data that is obtained from the
6611 lookup. Lookups of this type are conditional expansion items. Different results
6612 can be defined for the cases of lookup success and failure. See chapter
6613 &<<CHAPexpand>>&, where string expansions are described in detail.
6614 The key for the lookup is &*specified*& as part of the string to be expanded.
6615 .next
6616 Lists of domains, hosts, and email addresses can contain lookup requests as a
6617 way of avoiding excessively long linear lists. In this case, the data that is
6618 returned by the lookup is often (but not always) discarded; whether the lookup
6619 succeeds or fails is what really counts. These kinds of list are described in
6620 chapter &<<CHAPdomhosaddlists>>&.
6621 Depending on the lookup type (see below)
6622 the key for the lookup may need to be &*specified*& as above
6623 or may be &*implicit*&,
6624 given by the context in which the list is being checked.
6625 .endlist
6626
6627 String expansions, lists, and lookups interact with each other in such a way
6628 that there is no order in which to describe any one of them that does not
6629 involve references to the others. Each of these three chapters makes more sense
6630 if you have read the other two first. If you are reading this for the first
6631 time, be aware that some of it will make a lot more sense after you have read
6632 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6633
6634 .section "Examples of different lookup syntax" "SECID60"
6635 It is easy to confuse the two different kinds of lookup, especially as the
6636 lists that may contain the second kind are always expanded before being
6637 processed as lists. Therefore, they may also contain lookups of the first kind.
6638 Be careful to distinguish between the following two examples:
6639 .code
6640 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6641 domains = lsearch;/some/file
6642 .endd
6643 .ilist
6644 The first uses a string expansion, the result of which must be a domain list.
6645 The key for an expansion-style lookup must be given explicitly.
6646 No strings have been specified for a successful or a failing lookup; the
6647 defaults in this case are the looked-up data and an empty string, respectively.
6648 The expansion takes place before the string is processed as a list, and the
6649 file that is searched could contain lines like this:
6650 .code
6651 192.168.3.4: domain1:domain2:...
6652 192.168.1.9: domain3:domain4:...
6653 .endd
6654 When the lookup succeeds, the result of the expansion is a list of domains (and
6655 possibly other types of item that are allowed in domain lists).
6656 .cindex "tainted data" "de-tainting"
6657 .cindex "de-tainting" "using a lookup expansion"
6658 The result of the expansion is not tainted.
6659
6660 .next
6661 In the second example, the lookup is a single item in a domain list. It causes
6662 Exim to use a lookup to see if the domain that is being processed can be found
6663 in the file.
6664 The file could contains lines like this:
6665 .code
6666 domain1:
6667 domain2:
6668 .endd
6669 Any data that follows the keys is not relevant when checking that the domain
6670 matches the list item.
6671
6672 The key for a list-style lookup is implicit, from the lookup context, if
6673 the lookup is a single-key type (see below).
6674 For query-style lookup types the query must be given explicitly.
6675 .endlist
6676
6677 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6678 Consider a file containing lines like this:
6679 .code
6680 192.168.5.6: lsearch;/another/file
6681 .endd
6682 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6683 first &%domains%& setting above generates the second setting, which therefore
6684 causes a second lookup to occur.
6685
6686 The lookup type may optionally be followed by a comma
6687 and a comma-separated list of options.
6688 Each option is a &"name=value"& pair.
6689 Whether an option is meaningful depends on the lookup type.
6690
6691 All lookups support the option &"cache=no_rd"&.
6692 If this is given then the cache that Exim manages for lookup results
6693 is not checked before doing the lookup.
6694 The result of the lookup is still written to the cache.
6695
6696 The rest of this chapter describes the different lookup types that are
6697 available. Any of them can be used in any part of the configuration where a
6698 lookup is permitted.
6699
6700
6701 .section "Lookup types" "SECID61"
6702 .cindex "lookup" "types of"
6703 .cindex "single-key lookup" "definition of"
6704 Two different types of data lookup are implemented:
6705
6706 .ilist
6707 The &'single-key'& type requires the specification of a file in which to look,
6708 and a single key to search for. The key must be a non-empty string for the
6709 lookup to succeed. The lookup type determines how the file is searched.
6710 .cindex "tainted data" "single-key lookups"
6711 The file string may not be tainted.
6712
6713 .cindex "tainted data" "de-tainting"
6714 .cindex "de-tainting" "using a single-key lookup"
6715 All single-key lookups support the option &"ret=key"&.
6716 If this is given and the lookup
6717 (either underlying implementation or cached value)
6718 returns data, the result is replaced with a non-tainted
6719 version of the lookup key.
6720
6721 .next
6722 .cindex "query-style lookup" "definition of"
6723 The &'query-style'& type accepts a generalized database query. No particular
6724 key value is assumed by Exim for query-style lookups. You can use whichever
6725 Exim variables you need to construct the database query.
6726 .cindex "tainted data" "quoting for lookups"
6727 If tainted data is used in the query then it should be quuted by
6728 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6729 appropriate for the lookup.
6730 .endlist
6731
6732 The code for each lookup type is in a separate source file that is included in
6733 the binary of Exim only if the corresponding compile-time option is set. The
6734 default settings in &_src/EDITME_& are:
6735 .code
6736 LOOKUP_DBM=yes
6737 LOOKUP_LSEARCH=yes
6738 .endd
6739 which means that only linear searching and DBM lookups are included by default.
6740 For some types of lookup (e.g. SQL databases), you need to install appropriate
6741 libraries and header files before building Exim.
6742
6743
6744
6745
6746 .section "Single-key lookup types" "SECTsinglekeylookups"
6747 .cindex "lookup" "single-key types"
6748 .cindex "single-key lookup" "list of types"
6749 The following single-key lookup types are implemented:
6750
6751 .subsection cdb
6752 .cindex "cdb" "description of"
6753 .cindex "lookup" "cdb"
6754 .cindex "binary zero" "in lookup key"
6755 The given file is searched as a Constant DataBase file, using the key
6756 string without a terminating binary zero. The cdb format is designed for
6757 indexed files that are read frequently and never updated, except by total
6758 re-creation. As such, it is particularly suitable for large files containing
6759 aliases or other indexed data referenced by an MTA. Information about cdb and
6760 tools for building the files can be found in several places:
6761 .display
6762 &url(https://cr.yp.to/cdb.html)
6763 &url(https://www.corpit.ru/mjt/tinycdb.html)
6764 &url(https://packages.debian.org/stable/utils/freecdb)
6765 &url(https://github.com/philpennock/cdbtools) (in Go)
6766 .endd
6767 A cdb distribution is not needed in order to build Exim with cdb support,
6768 because the code for reading cdb files is included directly in Exim itself.
6769 However, no means of building or testing cdb files is provided with Exim, so
6770 you need to obtain a cdb distribution in order to do this.
6771
6772 .subsection dbm
6773 .cindex "DBM" "lookup type"
6774 .cindex "lookup" "dbm"
6775 .cindex "binary zero" "in lookup key"
6776 Calls to DBM library functions are used to extract data from the given
6777 DBM file by looking up the record with the given key. A terminating binary
6778 zero is included in the key that is passed to the DBM library. See section
6779 &<<SECTdb>>& for a discussion of DBM libraries.
6780
6781 .cindex "Berkeley DB library" "file format"
6782 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6783 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6784 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6785 the DB_UNKNOWN option. This enables it to handle any of the types of database
6786 that the library supports, and can be useful for accessing DBM files created by
6787 other applications. (For earlier DB versions, DB_HASH is always used.)
6788
6789 .subsection dbmjz
6790 .cindex "lookup" "dbmjz"
6791 .cindex "lookup" "dbm &-- embedded NULs"
6792 .cindex "sasldb2"
6793 .cindex "dbmjz lookup type"
6794 This is the same as &(dbm)&, except that the lookup key is
6795 interpreted as an Exim list; the elements of the list are joined together with
6796 ASCII NUL characters to form the lookup key.  An example usage would be to
6797 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6798 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6799 &(cram_md5)& authenticator.
6800
6801 .subsection dbmnz
6802 .cindex "lookup" "dbmnz"
6803 .cindex "lookup" "dbm &-- terminating zero"
6804 .cindex "binary zero" "in lookup key"
6805 .cindex "Courier"
6806 .cindex "&_/etc/userdbshadow.dat_&"
6807 .cindex "dbmnz lookup type"
6808 This is the same as &(dbm)&, except that a terminating binary zero
6809 is not included in the key that is passed to the DBM library. You may need this
6810 if you want to look up data in files that are created by or shared with some
6811 other application that does not use terminating zeros. For example, you need to
6812 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6813 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6814 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6815 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6816
6817 .subsection dsearch
6818 .cindex "lookup" "dsearch"
6819 .cindex "dsearch lookup type"
6820 The given file must be an absolute directory path; this is searched for an entry
6821 whose name is the key by calling the &[lstat()]& function.
6822 The key may not contain any forward slash characters.
6823 If &[lstat()]& succeeds then so does the lookup.
6824 .cindex "tainted data" "dsearch result"
6825 The result is regarded as untainted.
6826
6827 Options for the lookup can be given by appending them after the word "dsearch",
6828 separated by a comma.  Options, if present, are a comma-separated list having
6829 each element starting with a tag name and an equals.
6830
6831 Two options are supported, for the return value and for filtering match
6832 candidates.
6833 The "ret" option requests an alternate result value of
6834 the entire path for the entry. Example:
6835 .code
6836 ${lookup {passwd} dsearch,ret=full {/etc}}
6837 .endd
6838 The default result is just the requested entry.
6839 The "filter" option requests that only directory entries of a given type
6840 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6841 not matching "." or ".."). Example:
6842 .code
6843 ${lookup {passwd} dsearch,filter=file {/etc}}
6844 .endd
6845 The default matching is for any entry type, including directories
6846 and symlinks.
6847
6848 An example of how this
6849 lookup can be used to support virtual domains is given in section
6850 &<<SECTvirtualdomains>>&.
6851
6852 .subsection iplsearch
6853 .cindex "lookup" "iplsearch"
6854 .cindex "iplsearch lookup type"
6855 The given file is a text file containing keys and data. A key is
6856 terminated by a colon or white space or the end of the line. The keys in the
6857 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6858 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6859 being interpreted as a key terminator. For example:
6860 .code
6861 1.2.3.4:           data for 1.2.3.4
6862 192.168.0.0/16:    data for 192.168.0.0/16
6863 "abcd::cdab":      data for abcd::cdab
6864 "abcd:abcd::/32"   data for abcd:abcd::/32
6865 .endd
6866 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6867 file is searched linearly, using the CIDR masks where present, until a matching
6868 key is found. The first key that matches is used; there is no attempt to find a
6869 &"best"& match. Apart from the way the keys are matched, the processing for
6870 &(iplsearch)& is the same as for &(lsearch)&.
6871
6872 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6873 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6874 lookup types support only literal keys.
6875
6876 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6877 the implicit key is the host's IP address rather than its name (see section
6878 &<<SECThoslispatsikey>>&).
6879
6880 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6881 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6882 notation before executing the lookup.)
6883
6884 One option is supported, "ret=full", to request the return of the entire line
6885 rather than omitting the key portion.
6886 Note however that the key portion will have been de-quoted.
6887
6888 .subsection json
6889 .cindex lookup json
6890 .cindex json "lookup type"
6891 .cindex JSON expansions
6892 The given file is a text file with a JSON structure.
6893 An element of the structure is extracted, defined by the search key.
6894 The key is a list of subelement selectors
6895 (colon-separated by default but changeable in the usual way)
6896 which are applied in turn to select smaller and smaller portions
6897 of the JSON structure.
6898 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6899 nunbered array element is selected.
6900 Otherwise it must apply to a JSON object; the named element is selected.
6901 The final resulting element can be a simple JSON type or a JSON object
6902 or array; for the latter two a string-representation of the JSON
6903 is returned.
6904 For elements of type string, the returned value is de-quoted.
6905
6906
6907 .subsection lmdb
6908 .cindex LMDB
6909 .cindex lookup lmdb
6910 .cindex database lmdb
6911 The given file is an LMDB database.
6912 LMDB is a memory-mapped key-value store,
6913 with API modeled loosely on that of BerkeleyDB.
6914 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6915 for the feature set and operation modes.
6916
6917 Exim provides read-only access via the LMDB C library.
6918 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6919 or your operating system package repository.
6920 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6921
6922 You will need to separately create the LMDB database file,
6923 possibly using the &"mdb_load"& utility.
6924
6925
6926 .subsection lsearch
6927 .cindex "linear search"
6928 .cindex "lookup" "lsearch"
6929 .cindex "lsearch lookup type"
6930 .cindex "case sensitivity" "in lsearch lookup"
6931 The given file is a text file that is searched linearly for a
6932 line beginning with the search key, terminated by a colon or white space or the
6933 end of the line. The search is case-insensitive; that is, upper and lower case
6934 letters are treated as the same. The first occurrence of the key that is found
6935 in the file is used.
6936
6937 White space between the key and the colon is permitted. The remainder of the
6938 line, with leading and trailing white space removed, is the data. This can be
6939 continued onto subsequent lines by starting them with any amount of white
6940 space, but only a single space character is included in the data at such a
6941 junction. If the data begins with a colon, the key must be terminated by a
6942 colon, for example:
6943 .code
6944 baduser:  :fail:
6945 .endd
6946 Empty lines and lines beginning with # are ignored, even if they occur in the
6947 middle of an item. This is the traditional textual format of alias files. Note
6948 that the keys in an &(lsearch)& file are literal strings. There is no
6949 wildcarding of any kind.
6950
6951 .cindex "lookup" "lsearch &-- colons in keys"
6952 .cindex "white space" "in lsearch key"
6953 In most &(lsearch)& files, keys are not required to contain colons or #
6954 characters, or white space. However, if you need this feature, it is available.
6955 If a key begins with a doublequote character, it is terminated only by a
6956 matching quote (or end of line), and the normal escaping rules apply to its
6957 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6958 quoted keys (exactly as for unquoted keys). There is no special handling of
6959 quotes for the data part of an &(lsearch)& line.
6960
6961 .subsection nis
6962 .cindex "NIS lookup type"
6963 .cindex "lookup" "NIS"
6964 .cindex "binary zero" "in lookup key"
6965 The given file is the name of a NIS map, and a NIS lookup is done with
6966 the given key, without a terminating binary zero. There is a variant called
6967 &(nis0)& which does include the terminating binary zero in the key. This is
6968 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6969 aliases; the full map names must be used.
6970
6971 .subsection (n)wildlsearch
6972 .cindex "wildlsearch lookup type"
6973 .cindex "lookup" "wildlsearch"
6974 .cindex "nwildlsearch lookup type"
6975 .cindex "lookup" "nwildlsearch"
6976 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6977 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6978 the file may be wildcarded. The difference between these two lookup types is
6979 that for &(wildlsearch)&, each key in the file is string-expanded before being
6980 used, whereas for &(nwildlsearch)&, no expansion takes place.
6981
6982 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6983 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6984 file that are regular expressions can be made case-sensitive by the use of
6985 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6986
6987 .olist
6988 The string may begin with an asterisk to mean &"ends with"&. For example:
6989 .code
6990 *.a.b.c       data for anything.a.b.c
6991 *fish         data for anythingfish
6992 .endd
6993 .next
6994 The string may begin with a circumflex to indicate a regular expression. For
6995 example, for &(wildlsearch)&:
6996 .code
6997 ^\N\d+\.a\.b\N    data for <digits>.a.b
6998 .endd
6999 Note the use of &`\N`& to disable expansion of the contents of the regular
7000 expression. If you are using &(nwildlsearch)&, where the keys are not
7001 string-expanded, the equivalent entry is:
7002 .code
7003 ^\d+\.a\.b        data for <digits>.a.b
7004 .endd
7005 The case-insensitive flag is set at the start of compiling the regular
7006 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7007 For example, to make the entire pattern case-sensitive:
7008 .code
7009 ^(?-i)\d+\.a\.b        data for <digits>.a.b
7010 .endd
7011
7012 If the regular expression contains white space or colon characters, you must
7013 either quote it (see &(lsearch)& above), or represent these characters in other
7014 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7015 colon. This may be easier than quoting, because if you quote, you have to
7016 escape all the backslashes inside the quotes.
7017
7018 &*Note*&: It is not possible to capture substrings in a regular expression
7019 match for later use, because the results of all lookups are cached. If a lookup
7020 is repeated, the result is taken from the cache, and no actual pattern matching
7021 takes place. The values of all the numeric variables are unset after a
7022 &((n)wildlsearch)& match.
7023
7024 .next
7025 Although I cannot see it being of much use, the general matching function that
7026 is used to implement &((n)wildlsearch)& means that the string may begin with a
7027 lookup name terminated by a semicolon, and followed by lookup data. For
7028 example:
7029 .code
7030 cdb;/some/file  data for keys that match the file
7031 .endd
7032 The data that is obtained from the nested lookup is discarded.
7033 .endlist olist
7034
7035 Keys that do not match any of these patterns are interpreted literally. The
7036 continuation rules for the data are the same as for &(lsearch)&, and keys may
7037 be followed by optional colons.
7038
7039 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7040 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7041 lookup types support only literal keys.
7042
7043 .subsection spf
7044 .cindex "spf lookup type"
7045 .cindex "lookup" "spf"
7046 If Exim is built with SPF support, manual lookups can be done
7047 (as opposed to the standard ACL condition method).
7048 For details see section &<<SECSPF>>&.
7049
7050
7051 .section "Query-style lookup types" "SECTquerystylelookups"
7052 .cindex "lookup" "query-style types"
7053 .cindex "query-style lookup" "list of types"
7054 The supported query-style lookup types are listed below. Further details about
7055 many of them are given in later sections.
7056
7057 .subsection dnsdb
7058 .cindex "DNS" "as a lookup type"
7059 .cindex "lookup" "DNS"
7060 This does a DNS search for one or more records whose domain names
7061 are given in the supplied query. The resulting data is the contents of the
7062 records. See section &<<SECTdnsdb>>&.
7063
7064 .subsection ibase
7065 .cindex "InterBase lookup type"
7066 .cindex "lookup" "InterBase"
7067 This does a lookup in an InterBase database.
7068
7069 .subsection ldap
7070 .cindex "LDAP" "lookup type"
7071 .cindex "lookup" "LDAP"
7072 This does an LDAP lookup using a query in the form of a URL, and
7073 returns attributes from a single entry. There is a variant called &(ldapm)&
7074 that permits values from multiple entries to be returned. A third variant
7075 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7076 any attribute values. See section &<<SECTldap>>&.
7077
7078 .subsection mysql
7079 .cindex "MySQL" "lookup type"
7080 .cindex "lookup" "MySQL"
7081 The format of the query is an SQL statement that is passed to a
7082 MySQL database. See section &<<SECTsql>>&.
7083
7084 .subsection nisplus
7085 .cindex "NIS+ lookup type"
7086 .cindex "lookup" "NIS+"
7087 This does a NIS+ lookup using a query that can specify the name of
7088 the field to be returned. See section &<<SECTnisplus>>&.
7089
7090 .subsection oracle
7091 .cindex "Oracle" "lookup type"
7092 .cindex "lookup" "Oracle"
7093 The format of the query is an SQL statement that is passed to an
7094 Oracle database. See section &<<SECTsql>>&.
7095
7096 .subsection passwd
7097 .cindex "lookup" "passwd"
7098 .cindex "passwd lookup type"
7099 .cindex "&_/etc/passwd_&"
7100 This is a query-style lookup with queries that are just user names. The
7101 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7102 success, the result string is the same as you would get from an &(lsearch)&
7103 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7104 password value. For example:
7105 .code
7106 *:42:42:King Rat:/home/kr:/bin/bash
7107 .endd
7108
7109 .subsection pgsql
7110 .cindex "PostgreSQL lookup type"
7111 .cindex "lookup" "PostgreSQL"
7112 The format of the query is an SQL statement that is passed to a
7113 PostgreSQL database. See section &<<SECTsql>>&.
7114
7115 .subsection redis
7116 .cindex "Redis lookup type"
7117 .cindex lookup Redis
7118 The format of the query is either a simple get or simple set,
7119 passed to a Redis database. See section &<<SECTsql>>&.
7120
7121 .subsection sqlite
7122 .cindex "sqlite lookup type"
7123 .cindex "lookup" "sqlite"
7124 The format of the query is
7125 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7126
7127 .subsection testdb
7128 This is a lookup type that is used for testing Exim. It is
7129 not likely to be useful in normal operation.
7130
7131 .subsection whoson
7132 .cindex "whoson lookup type"
7133 .cindex "lookup" "whoson"
7134 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7135 allows a server to check whether a particular (dynamically allocated) IP
7136 address is currently allocated to a known (trusted) user and, optionally, to
7137 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7138 at one time for &"POP before SMTP"& authentication, but that approach has been
7139 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7140 &"POP before SMTP"& checking using ACL statements such as
7141 .code
7142 require condition = \
7143   ${lookup whoson {$sender_host_address}{yes}{no}}
7144 .endd
7145 The query consists of a single IP address. The value returned is the name of
7146 the authenticated user, which is stored in the variable &$value$&. However, in
7147 this example, the data in &$value$& is not used; the result of the lookup is
7148 one of the fixed strings &"yes"& or &"no"&.
7149
7150
7151
7152 .section "Temporary errors in lookups" "SECID63"
7153 .cindex "lookup" "temporary error in"
7154 Lookup functions can return temporary error codes if the lookup cannot be
7155 completed. For example, an SQL or LDAP database might be unavailable. For this
7156 reason, it is not advisable to use a lookup that might do this for critical
7157 options such as a list of local domains.
7158
7159 When a lookup cannot be completed in a router or transport, delivery
7160 of the message (to the relevant address) is deferred, as for any other
7161 temporary error. In other circumstances Exim may assume the lookup has failed,
7162 or may give up altogether.
7163
7164
7165
7166 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7167 .cindex "wildcard lookups"
7168 .cindex "lookup" "default values"
7169 .cindex "lookup" "wildcard"
7170 .cindex "lookup" "* added to type"
7171 .cindex "default" "in single-key lookups"
7172 In this context, a &"default value"& is a value specified by the administrator
7173 that is to be used if a lookup fails.
7174
7175 &*Note:*& This section applies only to single-key lookups. For query-style
7176 lookups, the facilities of the query language must be used. An attempt to
7177 specify a default for a query-style lookup provokes an error.
7178
7179 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7180 and the initial lookup fails, the key &"*"& is looked up in the file to
7181 provide a default value. See also the section on partial matching below.
7182
7183 .cindex "*@ with single-key lookup"
7184 .cindex "lookup" "*@ added to type"
7185 .cindex "alias file" "per-domain default"
7186 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7187 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7188 character, a second lookup is done with everything before the last @ replaced
7189 by *. This makes it possible to provide per-domain defaults in alias files
7190 that include the domains in the keys. If the second lookup fails (or doesn't
7191 take place because there is no @ in the key), &"*"& is looked up.
7192 For example, a &(redirect)& router might contain:
7193 .code
7194 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7195 .endd
7196 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7197 looks up these keys, in this order:
7198 .code
7199 jane@eyre.example
7200 *@eyre.example
7201 *
7202 .endd
7203 The data is taken from whichever key it finds first. &*Note*&: In an
7204 &(lsearch)& file, this does not mean the first of these keys in the file. A
7205 complete scan is done for each key, and only if it is not found at all does
7206 Exim move on to try the next key.
7207
7208
7209
7210 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7211 .cindex "partial matching"
7212 .cindex "wildcard lookups"
7213 .cindex "lookup" "partial matching"
7214 .cindex "lookup" "wildcard"
7215 .cindex "asterisk" "in search type"
7216 The normal operation of a single-key lookup is to search the file for an exact
7217 match with the given key. However, in a number of situations where domains are
7218 being looked up, it is useful to be able to do partial matching. In this case,
7219 information in the file that has a key starting with &"*."& is matched by any
7220 domain that ends with the components that follow the full stop. For example, if
7221 a key in a DBM file is
7222 .code
7223 *.dates.fict.example
7224 .endd
7225 then when partial matching is enabled this is matched by (amongst others)
7226 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7227 by &'dates.fict.example'&, if that does not appear as a separate key in the
7228 file.
7229
7230 &*Note*&: Partial matching is not available for query-style lookups. It is
7231 also not available for any lookup items in address lists (see section
7232 &<<SECTaddresslist>>&).
7233
7234 Partial matching is implemented by doing a series of separate lookups using
7235 keys constructed by modifying the original subject key. This means that it can
7236 be used with any of the single-key lookup types, provided that
7237 partial matching keys
7238 beginning with a special prefix (default &"*."&) are included in the data file.
7239 Keys in the file that do not begin with the prefix are matched only by
7240 unmodified subject keys when partial matching is in use.
7241
7242 Partial matching is requested by adding the string &"partial-"& to the front of
7243 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7244 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7245 is added at the start of the subject key, and it is looked up again. If that
7246 fails, further lookups are tried with dot-separated components removed from the
7247 start of the subject key, one-by-one, and &"*."& added on the front of what
7248 remains.
7249
7250 A minimum number of two non-* components are required. This can be adjusted
7251 by including a number before the hyphen in the search type. For example,
7252 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7253 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7254 subject key is &'2250.dates.fict.example'& then the following keys are looked
7255 up when the minimum number of non-* components is two:
7256 .code
7257 2250.dates.fict.example
7258 *.2250.dates.fict.example
7259 *.dates.fict.example
7260 *.fict.example
7261 .endd
7262 As soon as one key in the sequence is successfully looked up, the lookup
7263 finishes.
7264
7265 .cindex "lookup" "partial matching &-- changing prefix"
7266 .cindex "prefix" "for partial matching"
7267 The use of &"*."& as the partial matching prefix is a default that can be
7268 changed. The motivation for this feature is to allow Exim to operate with file
7269 formats that are used by other MTAs. A different prefix can be supplied in
7270 parentheses instead of the hyphen after &"partial"&. For example:
7271 .code
7272 domains = partial(.)lsearch;/some/file
7273 .endd
7274 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7275 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7276 components is unchanged). The prefix may consist of any punctuation characters
7277 other than a closing parenthesis. It may be empty, for example:
7278 .code
7279 domains = partial1()cdb;/some/file
7280 .endd
7281 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7282 &`a.b.c`&, &`b.c`&, and &`c`&.
7283
7284 If &"partial0"& is specified, what happens at the end (when the lookup with
7285 just one non-wild component has failed, and the original key is shortened right
7286 down to the null string) depends on the prefix:
7287
7288 .ilist
7289 If the prefix has zero length, the whole lookup fails.
7290 .next
7291 If the prefix has length 1, a lookup for just the prefix is done. For
7292 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7293 .next
7294 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7295 remainder is looked up. With the default prefix, therefore, the final lookup is
7296 for &"*"& on its own.
7297 .next
7298 Otherwise, the whole prefix is looked up.
7299 .endlist
7300
7301
7302 If the search type ends in &"*"& or &"*@"& (see section
7303 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7304 this implies happens after all partial lookups have failed. If &"partial0"& is
7305 specified, adding &"*"& to the search type has no effect with the default
7306 prefix, because the &"*"& key is already included in the sequence of partial
7307 lookups. However, there might be a use for lookup types such as
7308 &"partial0(.)lsearch*"&.
7309
7310 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7311 in domain lists and the like. Partial matching works only in terms of
7312 dot-separated components; a key such as &`*fict.example`&
7313 in a database file is useless, because the asterisk in a partial matching
7314 subject key is always followed by a dot.
7315
7316
7317
7318
7319 .section "Lookup caching" "SECID64"
7320 .cindex "lookup" "caching"
7321 .cindex "caching" "lookup data"
7322 Exim caches all lookup results in order to avoid needless repetition of
7323 lookups. However, because (apart from the daemon) Exim operates as a collection
7324 of independent, short-lived processes, this caching applies only within a
7325 single Exim process. There is no inter-process lookup caching facility.
7326
7327 If an option &"cache=no_rd"& is used on the lookup then
7328 the cache is only written to, cached data is not used for the operation
7329 and a real lookup is done.
7330
7331 For single-key lookups, Exim keeps the relevant files open in case there is
7332 another lookup that needs them. In some types of configuration this can lead to
7333 many files being kept open for messages with many recipients. To avoid hitting
7334 the operating system limit on the number of simultaneously open files, Exim
7335 closes the least recently used file when it needs to open more files than its
7336 own internal limit, which can be changed via the &%lookup_open_max%& option.
7337
7338 The single-key lookup files are closed and the lookup caches are flushed at
7339 strategic points during delivery &-- for example, after all routing is
7340 complete.
7341
7342
7343
7344
7345 .section "Quoting lookup data" "SECID65"
7346 .cindex "lookup" "quoting"
7347 .cindex "quoting" "in lookups"
7348 When data from an incoming message is included in a query-style lookup, there
7349 is the possibility of special characters in the data messing up the syntax of
7350 the query. For example, a NIS+ query that contains
7351 .code
7352 [name=$local_part]
7353 .endd
7354 will be broken if the local part happens to contain a closing square bracket.
7355 For NIS+, data can be enclosed in double quotes like this:
7356 .code
7357 [name="$local_part"]
7358 .endd
7359 but this still leaves the problem of a double quote in the data. The rule for
7360 NIS+ is that double quotes must be doubled. Other lookup types have different
7361 rules, and to cope with the differing requirements, an expansion operator
7362 of the following form is provided:
7363 .code
7364 ${quote_<lookup-type>:<string>}
7365 .endd
7366 For example, the safest way to write the NIS+ query is
7367 .code
7368 [name="${quote_nisplus:$local_part}"]
7369 .endd
7370 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7371 operator can be used for all lookup types, but has no effect for single-key
7372 lookups, since no quoting is ever needed in their key strings.
7373
7374
7375
7376
7377 .section "More about dnsdb" "SECTdnsdb"
7378 .cindex "dnsdb lookup"
7379 .cindex "lookup" "dnsdb"
7380 .cindex "DNS" "as a lookup type"
7381 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7382 of a record type and a domain name, separated by an equals sign. For example,
7383 an expansion string could contain:
7384 .code
7385 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7386 .endd
7387 If the lookup succeeds, the result is placed in &$value$&, which in this case
7388 is used on its own as the result. If the lookup does not succeed, the
7389 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7390 &<<SECTforexpfai>>& for an explanation of what this means.
7391
7392 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7393 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7394 If no type is given, TXT is assumed.
7395
7396 For any record type, if multiple records are found, the data is returned as a
7397 concatenation, with newline as the default separator. The order, of course,
7398 depends on the DNS resolver. You can specify a different separator character
7399 between multiple records by putting a right angle-bracket followed immediately
7400 by the new separator at the start of the query. For example:
7401 .code
7402 ${lookup dnsdb{>: a=host1.example}}
7403 .endd
7404 It is permitted to specify a space as the separator character. Further
7405 white space is ignored.
7406 For lookup types that return multiple fields per record,
7407 an alternate field separator can be specified using a comma after the main
7408 separator character, followed immediately by the field separator.
7409
7410 .cindex "PTR record" "in &(dnsdb)& lookup"
7411 When the type is PTR,
7412 the data can be an IP address, written as normal; inversion and the addition of
7413 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7414 .code
7415 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7416 .endd
7417 If the data for a PTR record is not a syntactically valid IP address, it is not
7418 altered and nothing is added.
7419
7420 .cindex "MX record" "in &(dnsdb)& lookup"
7421 .cindex "SRV record" "in &(dnsdb)& lookup"
7422 For an MX lookup, both the preference value and the host name are returned for
7423 each record, separated by a space. For an SRV lookup, the priority, weight,
7424 port, and host name are returned for each record, separated by spaces.
7425 The field separator can be modified as above.
7426
7427 .cindex "TXT record" "in &(dnsdb)& lookup"
7428 .cindex "SPF record" "in &(dnsdb)& lookup"
7429 For TXT records with multiple items of data, only the first item is returned,
7430 unless a field separator is specified.
7431 To concatenate items without a separator, use a semicolon instead.
7432 For SPF records the
7433 default behaviour is to concatenate multiple items without using a separator.
7434 .code
7435 ${lookup dnsdb{>\n,: txt=a.b.example}}
7436 ${lookup dnsdb{>\n; txt=a.b.example}}
7437 ${lookup dnsdb{spf=example.org}}
7438 .endd
7439 It is permitted to specify a space as the separator character. Further
7440 white space is ignored.
7441
7442 .cindex "SOA record" "in &(dnsdb)& lookup"
7443 For an SOA lookup, while no result is obtained the lookup is redone with
7444 successively more leading components dropped from the given domain.
7445 Only the primary-nameserver field is returned unless a field separator is
7446 specified.
7447 .code
7448 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7449 .endd
7450
7451 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7452 .cindex "dnsdb modifiers"
7453 .cindex "modifiers" "dnsdb"
7454 .cindex "options" "dnsdb"
7455 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7456 each followed by a comma,
7457 that may appear before the record type.
7458
7459 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7460 temporary DNS error for any of them, the behaviour is controlled by
7461 a defer-option modifier.
7462 The possible keywords are
7463 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7464 With &"strict"& behaviour, any temporary DNS error causes the
7465 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7466 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7467 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7468 error causes the whole lookup to defer only if none of the other lookups
7469 succeed. The default is &"lax"&, so the following lookups are equivalent:
7470 .code
7471 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7472 ${lookup dnsdb{a=one.host.com:two.host.com}}
7473 .endd
7474 Thus, in the default case, as long as at least one of the DNS lookups
7475 yields some data, the lookup succeeds.
7476
7477 .cindex "DNSSEC" "dns lookup"
7478 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7479 The possible keywords are
7480 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7481 With &"strict"& or &"lax"& DNSSEC information is requested
7482 with the lookup.
7483 With &"strict"& a response from the DNS resolver that
7484 is not labelled as authenticated data
7485 is treated as equivalent to a temporary DNS error.
7486 The default is &"lax"&.
7487
7488 See also the &$lookup_dnssec_authenticated$& variable.
7489
7490 .cindex timeout "dns lookup"
7491 .cindex "DNS" timeout
7492 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7493 The form is &"retrans_VAL"& where VAL is an Exim time specification
7494 (e.g. &"5s"&).
7495 The default value is set by the main configuration option &%dns_retrans%&.
7496
7497 Retries for the dnsdb lookup can be controlled by a retry modifier.
7498 The form if &"retry_VAL"& where VAL is an integer.
7499 The default count is set by the main configuration option &%dns_retry%&.
7500
7501 .cindex caching "of dns lookup"
7502 .cindex TTL "of dns lookup"
7503 .cindex DNS TTL
7504 Dnsdb lookup results are cached within a single process (and its children).
7505 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7506 value of the set of returned DNS records.
7507
7508
7509 .subsection "Pseudo dnsdb record types" SECID66
7510 .cindex "MX record" "in &(dnsdb)& lookup"
7511 By default, both the preference value and the host name are returned for
7512 each MX record, separated by a space. If you want only host names, you can use
7513 the pseudo-type MXH:
7514 .code
7515 ${lookup dnsdb{mxh=a.b.example}}
7516 .endd
7517 In this case, the preference values are omitted, and just the host names are
7518 returned.
7519
7520 .cindex "name server for enclosing domain"
7521 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7522 records on the given domain, but if none are found, it removes the first
7523 component of the domain name, and tries again. This process continues until NS
7524 records are found or there are no more components left (or there is a DNS
7525 error). In other words, it may return the name servers for a top-level domain,
7526 but it never returns the root name servers. If there are no NS records for the
7527 top-level domain, the lookup fails. Consider these examples:
7528 .code
7529 ${lookup dnsdb{zns=xxx.quercite.com}}
7530 ${lookup dnsdb{zns=xxx.edu}}
7531 .endd
7532 Assuming that in each case there are no NS records for the full domain name,
7533 the first returns the name servers for &%quercite.com%&, and the second returns
7534 the name servers for &%edu%&.
7535
7536 You should be careful about how you use this lookup because, unless the
7537 top-level domain does not exist, the lookup always returns some host names. The
7538 sort of use to which this might be put is for seeing if the name servers for a
7539 given domain are on a blacklist. You can probably assume that the name servers
7540 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7541 such a list.
7542
7543 .cindex "CSA" "in &(dnsdb)& lookup"
7544 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7545 records according to the CSA rules, which are described in section
7546 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7547 not sufficient because of the extra parent domain search behaviour of CSA. The
7548 result of a successful lookup such as:
7549 .code
7550 ${lookup dnsdb {csa=$sender_helo_name}}
7551 .endd
7552 has two space-separated fields: an authorization code and a target host name.
7553 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7554 authorization required but absent, or &"?"& for unknown.
7555
7556 .cindex "A+" "in &(dnsdb)& lookup"
7557 The pseudo-type A+ performs an AAAA
7558 and then an A lookup.  All results are returned; defer processing
7559 (see below) is handled separately for each lookup.  Example:
7560 .code
7561 ${lookup dnsdb {>; a+=$sender_helo_name}}
7562 .endd
7563
7564
7565 .subsection "Multiple dnsdb lookups" SECID67
7566 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7567 However, you can specify a list of domains or IP addresses in a single
7568 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7569 the default separator, but with the ability to change this. For example:
7570 .code
7571 ${lookup dnsdb{one.domain.com:two.domain.com}}
7572 ${lookup dnsdb{a=one.host.com:two.host.com}}
7573 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7574 .endd
7575 In order to retain backwards compatibility, there is one special case: if
7576 the lookup type is PTR and no change of separator is specified, Exim looks
7577 to see if the rest of the string is precisely one IPv6 address. In this
7578 case, it does not treat it as a list.
7579
7580 The data from each lookup is concatenated, with newline separators by default,
7581 in the same way that multiple DNS records for a single item are handled. A
7582 different separator can be specified, as described above.
7583
7584
7585
7586
7587 .section "More about LDAP" "SECTldap"
7588 .cindex "LDAP" "lookup, more about"
7589 .cindex "lookup" "LDAP"
7590 .cindex "Solaris" "LDAP"
7591 The original LDAP implementation came from the University of Michigan; this has
7592 become &"Open LDAP"&, and there are now two different releases. Another
7593 implementation comes from Netscape, and Solaris 7 and subsequent releases
7594 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7595 the lookup function level, their error handling is different. For this reason
7596 it is necessary to set a compile-time variable when building Exim with LDAP, to
7597 indicate which LDAP library is in use. One of the following should appear in
7598 your &_Local/Makefile_&:
7599 .code
7600 LDAP_LIB_TYPE=UMICHIGAN
7601 LDAP_LIB_TYPE=OPENLDAP1
7602 LDAP_LIB_TYPE=OPENLDAP2
7603 LDAP_LIB_TYPE=NETSCAPE
7604 LDAP_LIB_TYPE=SOLARIS
7605 .endd
7606 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7607 same interface as the University of Michigan version.
7608
7609 There are three LDAP lookup types in Exim. These behave slightly differently in
7610 the way they handle the results of a query:
7611
7612 .ilist
7613 &(ldap)& requires the result to contain just one entry; if there are more, it
7614 gives an error.
7615 .next
7616 &(ldapdn)& also requires the result to contain just one entry, but it is the
7617 Distinguished Name that is returned rather than any attribute values.
7618 .next
7619 &(ldapm)& permits the result to contain more than one entry; the attributes
7620 from all of them are returned.
7621 .endlist
7622
7623
7624 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7625 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7626 the data returned by a successful lookup is described in the next section.
7627 First we explain how LDAP queries are coded.
7628
7629
7630 .subsection "Format of LDAP queries" SECTforldaque
7631 .cindex "LDAP" "query format"
7632 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7633 the configuration of a &(redirect)& router one might have this setting:
7634 .code
7635 data = ${lookup ldap \
7636   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7637   c=UK?mailbox?base?}}
7638 .endd
7639 .cindex "LDAP" "with TLS"
7640 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7641 secure (encrypted) LDAP connections. The second of these ensures that an
7642 encrypted TLS connection is used.
7643
7644 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7645 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7646 See the &%ldap_start_tls%& option.
7647
7648 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7649 controlled. Every part of the TLS configuration can be configured by settings in
7650 &_exim.conf_&. Depending on the version of the client libraries installed on
7651 your system, some of the initialization may have required setting options in
7652 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7653 certificates. This revealed a nuance where the current UID that exim was
7654 running as could affect which config files it read. With Exim 4.83, these
7655 methods become optional, only taking effect if not specifically set in
7656 &_exim.conf_&.
7657
7658
7659 .subsection "LDAP quoting" SECID68
7660 .cindex "LDAP" "quoting"
7661 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7662 and the second because the LDAP query is represented as a URL. Furthermore,
7663 within an LDAP query, two different kinds of quoting are required. For this
7664 reason, there are two different LDAP-specific quoting operators.
7665
7666 The &%quote_ldap%& operator is designed for use on strings that are part of
7667 filter specifications. Conceptually, it first does the following conversions on
7668 the string:
7669 .code
7670 *   =>   \2A
7671 (   =>   \28
7672 )   =>   \29
7673 \   =>   \5C
7674 .endd
7675 in accordance with RFC 2254. The resulting string is then quoted according
7676 to the rules for URLs, that is, all non-alphanumeric characters except
7677 .code
7678 ! $ ' - . _ ( ) * +
7679 .endd
7680 are converted to their hex values, preceded by a percent sign. For example:
7681 .code
7682 ${quote_ldap: a(bc)*, a<yz>; }
7683 .endd
7684 yields
7685 .code
7686 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7687 .endd
7688 Removing the URL quoting, this is (with a leading and a trailing space):
7689 .code
7690 a\28bc\29\2A, a<yz>;
7691 .endd
7692 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7693 base DN specifications in queries. Conceptually, it first converts the string
7694 by inserting a backslash in front of any of the following characters:
7695 .code
7696 , + " \ < > ;
7697 .endd
7698 It also inserts a backslash before any leading spaces or # characters, and
7699 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7700 is then quoted according to the rules for URLs. For example:
7701 .code
7702 ${quote_ldap_dn: a(bc)*, a<yz>; }
7703 .endd
7704 yields
7705 .code
7706 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7707 .endd
7708 Removing the URL quoting, this is (with a trailing space):
7709 .code
7710 \ a(bc)*\, a\<yz\>\;\
7711 .endd
7712 There are some further comments about quoting in the section on LDAP
7713 authentication below.
7714
7715
7716 .subsection "LDAP connections" SECID69
7717 .cindex "LDAP" "connections"
7718 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7719 is in use, via a Unix domain socket. The example given above does not specify
7720 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7721 by starting it with
7722 .code
7723 ldap://<hostname>:<port>/...
7724 .endd
7725 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7726 used. When no server is specified in a query, a list of default servers is
7727 taken from the &%ldap_default_servers%& configuration option. This supplies a
7728 colon-separated list of servers which are tried in turn until one successfully
7729 handles a query, or there is a serious error. Successful handling either
7730 returns the requested data, or indicates that it does not exist. Serious errors
7731 are syntactical, or multiple values when only a single value is expected.
7732 Errors which cause the next server to be tried are connection failures, bind
7733 failures, and timeouts.
7734
7735 For each server name in the list, a port number can be given. The standard way
7736 of specifying a host and port is to use a colon separator (RFC 1738). Because
7737 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7738 doubled. For example
7739 .code
7740 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7741 .endd
7742 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7743 to the LDAP library with no server name, and the library's default (normally
7744 the local host) is used.
7745
7746 If you are using the OpenLDAP library, you can connect to an LDAP server using
7747 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7748 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7749 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7750 not available.
7751
7752 For this type of connection, instead of a host name for the server, a pathname
7753 for the socket is required, and the port number is not relevant. The pathname
7754 can be specified either as an item in &%ldap_default_servers%&, or inline in
7755 the query. In the former case, you can have settings such as
7756 .code
7757 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7758 .endd
7759 When the pathname is given in the query, you have to escape the slashes as
7760 &`%2F`& to fit in with the LDAP URL syntax. For example:
7761 .code
7762 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7763 .endd
7764 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7765 a pathname, it uses the Unix domain socket code, even if the query actually
7766 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7767 socket connection. This behaviour means that you can use a setting of
7768 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7769 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7770 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7771 backup host.
7772
7773 If an explicit &`ldapi`& type is given in a query when a host name is
7774 specified, an error is diagnosed. However, if there are more items in
7775 &%ldap_default_servers%&, they are tried. In other words:
7776
7777 .ilist
7778 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7779 interface.
7780 .next
7781 Using &`ldapi`& with a host name causes an error.
7782 .endlist
7783
7784
7785 Using &`ldapi`& with no host or path in the query, and no setting of
7786 &%ldap_default_servers%&, does whatever the library does by default.
7787
7788
7789
7790 .subsection "LDAP authentication and control information" SECID70
7791 .cindex "LDAP" "authentication"
7792 The LDAP URL syntax provides no way of passing authentication and other control
7793 information to the server. To make this possible, the URL in an LDAP query may
7794 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7795 spaces. If a value contains spaces it must be enclosed in double quotes, and
7796 when double quotes are used, backslash is interpreted in the usual way inside
7797 them. The following names are recognized:
7798 .itable none 0 0 2 20* left 80* left
7799 .irow DEREFERENCE "set the dereferencing parameter"
7800 .irow NETTIME     "set a timeout for a network operation"
7801 .irow USER        "set the DN, for authenticating the LDAP bind"
7802 .irow PASS        "set the password, likewise"
7803 .irow REFERRALS   "set the referrals parameter"
7804 .irow SERVERS     "set alternate server list for this query only"
7805 .irow SIZE        "set the limit for the number of entries returned"
7806 .irow TIME        "set the maximum waiting time for a query"
7807 .endtable
7808 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7809 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7810 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7811 library from trying to follow referrals issued by the LDAP server.
7812
7813 .cindex LDAP timeout
7814 .cindex timeout "LDAP lookup"
7815 The name CONNECT is an obsolete name for NETTIME, retained for
7816 backwards compatibility. This timeout (specified as a number of seconds) is
7817 enforced from the client end for operations that can be carried out over a
7818 network. Specifically, it applies to network connections and calls to the
7819 &'ldap_result()'& function. If the value is greater than zero, it is used if
7820 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7821 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7822 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7823 Netscape SDK; for OpenLDAP no action is taken.
7824
7825 The TIME parameter (also a number of seconds) is passed to the server to
7826 set a server-side limit on the time taken to complete a search.
7827
7828 The SERVERS parameter allows you to specify an alternate list of ldap servers
7829 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7830 default list of ldap servers, and a single lookup can specify a single ldap
7831 server to use.  But when you need to do a lookup with a list of servers that is
7832 different than the default list (maybe different order, maybe a completely
7833 different set of servers), the SERVERS parameter allows you to specify this
7834 alternate list (colon-separated).
7835
7836 Here is an example of an LDAP query in an Exim lookup that uses some of these
7837 values. This is a single line, folded to fit on the page:
7838 .code
7839 ${lookup ldap
7840   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7841   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7842   {$value}fail}
7843 .endd
7844 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7845 any of the auxiliary data. Exim configuration settings that include lookups
7846 which contain password information should be preceded by &"hide"& to prevent
7847 non-admin users from using the &%-bP%& option to see their values.
7848
7849 The auxiliary data items may be given in any order. The default is no
7850 connection timeout (the system timeout is used), no user or password, no limit
7851 on the number of entries returned, and no time limit on queries.
7852
7853 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7854 removes any URL quoting that it may contain before passing it to the LDAP library.
7855 Apparently
7856 some libraries do this for themselves, but some do not. Removing the URL
7857 quoting has two advantages:
7858
7859 .ilist
7860 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7861 DNs as with DNs inside actual queries.
7862 .next
7863 It permits spaces inside USER= DNs.
7864 .endlist
7865
7866 For example, a setting such as
7867 .code
7868 USER=cn=${quote_ldap_dn:$1}
7869 .endd
7870 should work even if &$1$& contains spaces.
7871
7872 Expanded data for the PASS= value should be quoted using the &%quote%&
7873 expansion operator, rather than the LDAP quote operators. The only reason this
7874 field needs quoting is to ensure that it conforms to the Exim syntax, which
7875 does not allow unquoted spaces. For example:
7876 .code
7877 PASS=${quote:$3}
7878 .endd
7879 The LDAP authentication mechanism can be used to check passwords as part of
7880 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7881 &<<CHAPexpand>>&.
7882
7883
7884
7885 .subsection "Format of data returned by LDAP" SECID71
7886 .cindex "LDAP" "returned data formats"
7887 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7888 as a sequence of values, for example
7889 .code
7890 cn=manager,o=University of Cambridge,c=UK
7891 .endd
7892 The &(ldap)& lookup type generates an error if more than one entry matches the
7893 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7894 the result between the data from different entries. It is possible for multiple
7895 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7896 you know that whatever values are returned all came from a single entry in the
7897 directory.
7898
7899 In the common case where you specify a single attribute in your LDAP query, the
7900 result is not quoted, and does not contain the attribute name. If the attribute
7901 has multiple values, they are separated by commas. Any comma that is
7902 part of an attribute's value is doubled.
7903
7904 If you specify multiple attributes, the result contains space-separated, quoted
7905 strings, each preceded by the attribute name and an equals sign. Within the
7906 quotes, the quote character, backslash, and newline are escaped with
7907 backslashes, and commas are used to separate multiple values for the attribute.
7908 Any commas in attribute values are doubled
7909 (permitting treatment of the values as a comma-separated list).
7910 Apart from the escaping, the string within quotes takes the same form as the
7911 output when a single attribute is requested. Specifying no attributes is the
7912 same as specifying all of an entry's attributes.
7913
7914 Here are some examples of the output format. The first line of each pair is an
7915 LDAP query, and the second is the data that is returned. The attribute called
7916 &%attr1%& has two values, one of them with an embedded comma, whereas
7917 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7918 (they have SUP &%attr%& in their schema definitions).
7919
7920 .code
7921 ldap:///o=base?attr1?sub?(uid=fred)
7922 value1.1,value1,,2
7923
7924 ldap:///o=base?attr2?sub?(uid=fred)
7925 value two
7926
7927 ldap:///o=base?attr?sub?(uid=fred)
7928 value1.1,value1,,2,value two
7929
7930 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7931 attr1="value1.1,value1,,2" attr2="value two"
7932
7933 ldap:///o=base??sub?(uid=fred)
7934 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7935 .endd
7936 You can
7937 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7938 results of LDAP lookups.
7939 The &%extract%& operator in string expansions can be used to pick out
7940 individual fields from data that consists of &'key'&=&'value'& pairs.
7941 The &%listextract%& operator should be used to pick out individual values
7942 of attributes, even when only a single value is expected.
7943 The doubling of embedded commas allows you to use the returned data as a
7944 comma separated list (using the "<," syntax for changing the input list separator).
7945
7946
7947
7948
7949 .section "More about NIS+" "SECTnisplus"
7950 .cindex "NIS+ lookup type"
7951 .cindex "lookup" "NIS+"
7952 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7953 and field name. If this is given, the result of a successful query is the
7954 contents of the named field; otherwise the result consists of a concatenation
7955 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7956 values containing spaces are quoted. For example, the query
7957 .code
7958 [name=mg1456],passwd.org_dir
7959 .endd
7960 might return the string
7961 .code
7962 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7963 home=/home/mg1456 shell=/bin/bash shadow=""
7964 .endd
7965 (split over two lines here to fit on the page), whereas
7966 .code
7967 [name=mg1456],passwd.org_dir:gcos
7968 .endd
7969 would just return
7970 .code
7971 Martin Guerre
7972 .endd
7973 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7974 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7975 operator is to double any quote characters within the text.
7976
7977
7978
7979 .section "SQL lookups" "SECTsql"
7980 .cindex "SQL lookup types"
7981 .cindex "MySQL" "lookup type"
7982 .cindex "PostgreSQL lookup type"
7983 .cindex "lookup" "MySQL"
7984 .cindex "lookup" "PostgreSQL"
7985 .cindex "Oracle" "lookup type"
7986 .cindex "lookup" "Oracle"
7987 .cindex "InterBase lookup type"
7988 .cindex "lookup" "InterBase"
7989 .cindex "Redis lookup type"
7990 .cindex lookup Redis
7991 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7992 and SQLite
7993 databases. Queries for these databases contain SQL statements, so an example
7994 might be
7995 .code
7996 ${lookup mysql{select mailbox from users where id='userx'}\
7997   {$value}fail}
7998 .endd
7999 If the result of the query contains more than one field, the data for each
8000 field in the row is returned, preceded by its name, so the result of
8001 .code
8002 ${lookup pgsql{select home,name from users where id='userx'}\
8003   {$value}}
8004 .endd
8005 might be
8006 .code
8007 home=/home/userx name="Mister X"
8008 .endd
8009 Empty values and values containing spaces are double quoted, with embedded
8010 quotes escaped by a backslash. If the result of the query contains just one
8011 field, the value is passed back verbatim, without a field name, for example:
8012 .code
8013 Mister X
8014 .endd
8015 If the result of the query yields more than one row, it is all concatenated,
8016 with a newline between the data for each row.
8017
8018
8019 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
8020 .cindex "MySQL" "lookup type"
8021 .cindex "PostgreSQL lookup type"
8022 .cindex "lookup" "MySQL"
8023 .cindex "lookup" "PostgreSQL"
8024 .cindex "Oracle" "lookup type"
8025 .cindex "lookup" "Oracle"
8026 .cindex "InterBase lookup type"
8027 .cindex "lookup" "InterBase"
8028 .cindex "Redis lookup type"
8029 .cindex lookup Redis
8030 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8031 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8032 or &%redis_servers%&
8033 option (as appropriate) must be set to a colon-separated list of server
8034 information.
8035 .oindex &%mysql_servers%&
8036 .oindex &%pgsql_servers%&
8037 .oindex &%oracle_servers%&
8038 .oindex &%ibase_servers%&
8039 .oindex &%redis_servers%&
8040 (For MySQL and PostgreSQL, the global option need not be set if all
8041 queries contain their own server information &-- see section
8042 &<<SECTspeserque>>&.)
8043 For all but Redis
8044 each item in the list is a slash-separated list of four
8045 items: host name, database name, user name, and password. In the case of
8046 Oracle, the host name field is used for the &"service name"&, and the database
8047 name field is not used and should be empty. For example:
8048 .code
8049 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8050 .endd
8051 Because password data is sensitive, you should always precede the setting with
8052 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8053 option. Here is an example where two MySQL servers are listed:
8054 .code
8055 hide mysql_servers = localhost/users/root/secret:\
8056                      otherhost/users/root/othersecret
8057 .endd
8058 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8059 because this is a colon-separated list, the colon has to be doubled. For each
8060 query, these parameter groups are tried in order until a connection is made and
8061 a query is successfully processed. The result of a query may be that no data is
8062 found, but that is still a successful query. In other words, the list of
8063 servers provides a backup facility, not a list of different places to look.
8064
8065 For Redis the global option need not be specified if all queries contain their
8066 own server information &-- see section &<<SECTspeserque>>&.
8067 If specified, the option must be set to a colon-separated list of server
8068 information.
8069 Each item in the list is a slash-separated list of three items:
8070 host, database number, and password.
8071 .olist
8072 The host is required and may be either an IPv4 address and optional
8073 port number (separated by a colon, which needs doubling due to the
8074 higher-level list), or a Unix socket pathname enclosed in parentheses
8075 .next
8076 The database number is optional; if present that number is selected in the backend
8077 .next
8078 The password is optional; if present it is used to authenticate to the backend
8079 .endlist
8080
8081 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8082 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8083 respectively, and the characters single-quote, double-quote, and backslash
8084 itself are escaped with backslashes.
8085
8086 The &%quote_redis%& expansion operator
8087 escapes whitespace and backslash characters with a backslash.
8088
8089 .subsection "Specifying the server in the query" SECTspeserque
8090 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8091 it is possible to specify a list of servers with an individual query. This is
8092 done by appending a comma-separated option to the query type:
8093 .display
8094 &`,servers=`&&'server1:server2:server3:...'&
8095 .endd
8096 Each item in the list may take one of two forms:
8097 .olist
8098 If it contains no slashes it is assumed to be just a host name. The appropriate
8099 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8100 of the same name, and the remaining parameters (database, user, password) are
8101 taken from there.
8102 .next
8103 If it contains any slashes, it is taken as a complete parameter set.
8104 .endlist
8105 The list of servers is used in exactly the same way as the global list.
8106 Once a connection to a server has happened and a query has been
8107 successfully executed, processing of the lookup ceases.
8108
8109 This feature is intended for use in master/slave situations where updates
8110 are occurring and you want to update the master rather than a slave. If the
8111 master is in the list as a backup for reading, you might have a global setting
8112 like this:
8113 .code
8114 mysql_servers = slave1/db/name/pw:\
8115                 slave2/db/name/pw:\
8116                 master/db/name/pw
8117 .endd
8118 In an updating lookup, you could then write:
8119 .code
8120 ${lookup mysql,servers=master {UPDATE ...} }
8121 .endd
8122 That query would then be sent only to the master server. If, on the other hand,
8123 the master is not to be used for reading, and so is not present in the global
8124 option, you can still update it by a query of this form:
8125 .code
8126 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8127 .endd
8128
8129 An older syntax places the servers specification before the query,
8130 semicolon separated:
8131 .code
8132 ${lookup mysql{servers=master; UPDATE ...} }
8133 .endd
8134 The new version avoids potential issues with tainted
8135 arguments in the query, for explicit expansion.
8136 &*Note*&: server specifications in list-style lookups are still problematic.
8137
8138
8139 .subsection "Special MySQL features" SECID73
8140 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8141 causes a connection to the server on the local host by means of a Unix domain
8142 socket. An alternate socket can be specified in parentheses.
8143 An option group name for MySQL option files can be specified in square brackets;
8144 the default value is &"exim"&.
8145 The full syntax of each item in &%mysql_servers%& is:
8146 .display
8147 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8148   <&'database'&>/<&'user'&>/<&'password'&>
8149 .endd
8150 Any of the four sub-parts of the first field can be omitted. For normal use on
8151 the local host it can be left blank or set to just &"localhost"&.
8152
8153 No database need be supplied &-- but if it is absent here, it must be given in
8154 the queries.
8155
8156 If a MySQL query is issued that does not request any data (an insert, update,
8157 or delete command), the result of the lookup is the number of rows affected.
8158
8159 &*Warning*&: This can be misleading. If an update does not actually change
8160 anything (for example, setting a field to the value it already has), the result
8161 is zero because no rows are affected.
8162
8163
8164 .subsection "Special PostgreSQL features" SECID74
8165 PostgreSQL lookups can also use Unix domain socket connections to the database.
8166 This is usually faster and costs less CPU time than a TCP/IP connection.
8167 However it can be used only if the mail server runs on the same machine as the
8168 database server. A configuration line for PostgreSQL via Unix domain sockets
8169 looks like this:
8170 .code
8171 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8172 .endd
8173 In other words, instead of supplying a host name, a path to the socket is
8174 given. The path name is enclosed in parentheses so that its slashes aren't
8175 visually confused with the delimiters for the other server parameters.
8176
8177 If a PostgreSQL query is issued that does not request any data (an insert,
8178 update, or delete command), the result of the lookup is the number of rows
8179 affected.
8180
8181 .subsection "More about SQLite" SECTsqlite
8182 .cindex "lookup" "SQLite"
8183 .cindex "sqlite lookup type"
8184 SQLite is different to the other SQL lookups because a filename is required in
8185 addition to the SQL query. An SQLite database is a single file, and there is no
8186 daemon as in the other SQL databases.
8187
8188 .oindex &%sqlite_dbfile%&
8189 There are two ways of
8190 specifying the file.
8191 The first is is by using the &%sqlite_dbfile%& main option.
8192 The second, which allows separate files for each query,
8193 is to use an option appended, comma-separated, to the &"sqlite"&
8194 lookup type word.  The option is the word &"file"&, then an equals,
8195 then the filename.
8196 The filename in this case cannot contain whitespace or open-brace charachters.
8197
8198 A deprecated method is available, prefixing the query with the filename
8199 separated by white space.
8200 This means that
8201 .cindex "tainted data" "sqlite file"
8202 the query cannot use any tainted values, as that taints
8203 the entire query including the filename - resulting in a refusal to open
8204 the file.
8205
8206 In all the above cases the filename must be an absolute path.
8207
8208 Here is a lookup expansion example:
8209 .code
8210 sqlite_dbfile = /some/thing/sqlitedb
8211 ...
8212 ${lookup sqlite {select name from aliases where id='userx';}}
8213 .endd
8214 In a list, the syntax is similar. For example:
8215 .code
8216 domainlist relay_to_domains = sqlite;\
8217    select * from relays where ip='$sender_host_address';
8218 .endd
8219 The only character affected by the &%quote_sqlite%& operator is a single
8220 quote, which it doubles.
8221
8222 .cindex timeout SQLite
8223 .cindex sqlite "lookup timeout"
8224 The SQLite library handles multiple simultaneous accesses to the database
8225 internally. Multiple readers are permitted, but only one process can
8226 update at once. Attempts to access the database while it is being updated
8227 are rejected after a timeout period, during which the SQLite library
8228 waits for the lock to be released. In Exim, the default timeout is set
8229 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8230 option.
8231
8232 .subsection "More about Redis" SECTredis
8233 .cindex "lookup" "Redis"
8234 .cindex "redis lookup type"
8235 Redis is a non-SQL database. Commands are simple get and set.
8236 Examples:
8237 .code
8238 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8239 ${lookup redis{get keyname}}
8240 .endd
8241
8242 As of release 4.91, "lightweight" support for Redis Cluster is available.
8243 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8244 of which must be reachable from the running exim instance. If the cluster has
8245 master/slave replication, the list must contain all the master and slave
8246 servers.
8247
8248 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8249 immediately follow the redirection but treats the response as a DEFER, moving on
8250 to the next server in the &%redis_servers%& list until the correct server is
8251 reached.
8252
8253 .ecindex IIDfidalo1
8254 .ecindex IIDfidalo2
8255
8256
8257 . ////////////////////////////////////////////////////////////////////////////
8258 . ////////////////////////////////////////////////////////////////////////////
8259
8260 .chapter "Domain, host, address, and local part lists" &&&
8261          "CHAPdomhosaddlists" &&&
8262          "Domain, host, and address lists"
8263 .scindex IIDdohoadli "lists of domains; hosts; etc."
8264 A number of Exim configuration options contain lists of domains, hosts,
8265 email addresses, or local parts. For example, the &%hold_domains%& option
8266 contains a list of domains whose delivery is currently suspended. These lists
8267 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8268 arguments to expansion conditions such as &%match_domain%&.
8269
8270 Each item in one of these lists is a pattern to be matched against a domain,
8271 host, email address, or local part, respectively. In the sections below, the
8272 different types of pattern for each case are described, but first we cover some
8273 general facilities that apply to all four kinds of list.
8274
8275 Note that other parts of Exim use a &'string list'& which does not
8276 support all the complexity available in
8277 domain, host, address and local part lists.
8278
8279
8280
8281 .section "Results of list checking" SECTlistresults
8282 The primary result of doing a list check is a truth value.
8283 In some contexts additional information is stored
8284 about the list element that matched:
8285 .vlist
8286 .vitem hosts
8287 A &%hosts%& ACL condition
8288 will store a result in the &$host_data$& variable.
8289 .vitem local_parts
8290 A &%local_parts%& router option or &%local_parts%& ACL condition
8291 will store a result in the &$local_part_data$& variable.
8292 .vitem domains
8293 A &%domains%& router option or &%domains%& ACL condition
8294 will store a result in the &$domain_data$& variable.
8295 .vitem senders
8296 A &%senders%& router option or &%senders%& ACL condition
8297 will store a result in the &$sender_data$& variable.
8298 .vitem recipients
8299 A &%recipients%& ACL condition
8300 will store a result in the &$recipient_data$& variable.
8301 .endlist
8302
8303 The detail of the additional information depends on the
8304 type of match and is given below as the &*value*& information.
8305
8306
8307
8308
8309 .section "Expansion of lists" "SECTlistexpand"
8310 .cindex "expansion" "of lists"
8311 Each list is expanded as a single string before it is used.
8312
8313 &'Exception: the router headers_remove option, where list-item
8314 splitting is done before string-expansion.'&
8315
8316 The result of
8317 expansion must be a list, possibly containing empty items, which is split up
8318 into separate items for matching. By default, colon is the separator character,
8319 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8320 &<<SECTempitelis>>& for details of the list syntax; the second of these
8321 discusses the way to specify empty list items.
8322
8323
8324 If the string expansion is forced to fail, Exim behaves as if the item it is
8325 testing (domain, host, address, or local part) is not in the list. Other
8326 expansion failures cause temporary errors.
8327
8328 If an item in a list is a regular expression, backslashes, dollars and possibly
8329 other special characters in the expression must be protected against
8330 misinterpretation by the string expander. The easiest way to do this is to use
8331 the &`\N`& expansion feature to indicate that the contents of the regular
8332 expression should not be expanded. For example, in an ACL you might have:
8333 .code
8334 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8335                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8336 .endd
8337 The first item is a regular expression that is protected from expansion by
8338 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8339 senders based on the receiving domain.
8340
8341
8342
8343
8344 .subsection "Negated items in lists" SECID76
8345 .cindex "list" "negation"
8346 .cindex "negation" "in lists"
8347 Items in a list may be positive or negative. Negative items are indicated by a
8348 leading exclamation mark, which may be followed by optional white space. A list
8349 defines a set of items (domains, etc). When Exim processes one of these lists,
8350 it is trying to find out whether a domain, host, address, or local part
8351 (respectively) is in the set that is defined by the list. It works like this:
8352
8353 The list is scanned from left to right. If a positive item is matched, the
8354 subject that is being checked is in the set; if a negative item is matched, the
8355 subject is not in the set. If the end of the list is reached without the
8356 subject having matched any of the patterns, it is in the set if the last item
8357 was a negative one, but not if it was a positive one. For example, the list in
8358 .code
8359 domainlist relay_to_domains = !a.b.c : *.b.c
8360 .endd
8361 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8362 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8363 list is positive. However, if the setting were
8364 .code
8365 domainlist relay_to_domains = !a.b.c
8366 .endd
8367 then all domains other than &'a.b.c'& would match because the last item in the
8368 list is negative. In other words, a list that ends with a negative item behaves
8369 as if it had an extra item &`:*`& on the end.
8370
8371 Another way of thinking about positive and negative items in lists is to read
8372 the connector as &"or"& after a positive item and as &"and"& after a negative
8373 item.
8374
8375
8376
8377 .subsection "File names in lists" SECTfilnamlis
8378 .cindex "list" "filename in"
8379 If an item in a domain, host, address, or local part list is an absolute
8380 filename (beginning with a slash character), each line of the file is read and
8381 processed as if it were an independent item in the list, except that further
8382 filenames are not allowed,
8383 and no expansion of the data from the file takes place.
8384 Empty lines in the file are ignored, and the file may also contain comment
8385 lines:
8386
8387 .ilist
8388 For domain and host lists, if a # character appears anywhere in a line of the
8389 file, it and all following characters are ignored.
8390 .next
8391 Because local parts may legitimately contain # characters, a comment in an
8392 address list or local part list file is recognized only if # is preceded by
8393 white space or the start of the line. For example:
8394 .code
8395 not#comment@x.y.z   # but this is a comment
8396 .endd
8397 .endlist
8398
8399 Putting a filename in a list has the same effect as inserting each line of the
8400 file as an item in the list (blank lines and comments excepted). However, there
8401 is one important difference: the file is read each time the list is processed,
8402 so if its contents vary over time, Exim's behaviour changes.
8403
8404 If a filename is preceded by an exclamation mark, the sense of any match
8405 within the file is inverted. For example, if
8406 .code
8407 hold_domains = !/etc/nohold-domains
8408 .endd
8409 and the file contains the lines
8410 .code
8411 !a.b.c
8412 *.b.c
8413 .endd
8414 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8415 any domain matching &`*.b.c`& is not.
8416
8417
8418
8419 .subsection "An lsearch file is not an out-of-line list" SECID77
8420 As will be described in the sections that follow, lookups can be used in lists
8421 to provide indexed methods of checking list membership. There has been some
8422 confusion about the way &(lsearch)& lookups work in lists. Because
8423 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8424 sometimes thought that it is allowed to contain wild cards and other kinds of
8425 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8426 always fixed strings, just as for any other single-key lookup type.
8427
8428 If you want to use a file to contain wild-card patterns that form part of a
8429 list, just give the filename on its own, without a search type, as described
8430 in the previous section. You could also use the &(wildlsearch)& or
8431 &(nwildlsearch)&, but there is no advantage in doing this.
8432
8433
8434
8435
8436 .subsection "Named lists" SECTnamedlists
8437 .cindex "named lists"
8438 .cindex "list" "named"
8439 A list of domains, hosts, email addresses, or local parts can be given a name
8440 which is then used to refer to the list elsewhere in the configuration. This is
8441 particularly convenient if the same list is required in several different
8442 places. It also allows lists to be given meaningful names, which can improve
8443 the readability of the configuration. For example, it is conventional to define
8444 a domain list called &'local_domains'& for all the domains that are handled
8445 locally on a host, using a configuration line such as
8446 .code
8447 domainlist local_domains = localhost:my.dom.example
8448 .endd
8449 Named lists are referenced by giving their name preceded by a plus sign, so,
8450 for example, a router that is intended to handle local domains would be
8451 configured with the line
8452 .code
8453 domains = +local_domains
8454 .endd
8455 The first router in a configuration is often one that handles all domains
8456 except the local ones, using a configuration with a negated item like this:
8457 .code
8458 dnslookup:
8459   driver = dnslookup
8460   domains = ! +local_domains
8461   transport = remote_smtp
8462   no_more
8463 .endd
8464 The four kinds of named list are created by configuration lines starting with
8465 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8466 respectively. Then there follows the name that you are defining, followed by an
8467 equals sign and the list itself. For example:
8468 .code
8469 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8470 addresslist bad_senders = cdb;/etc/badsenders
8471 .endd
8472 A named list may refer to other named lists:
8473 .code
8474 domainlist  dom1 = first.example : second.example
8475 domainlist  dom2 = +dom1 : third.example
8476 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8477 .endd
8478 &*Warning*&: If the last item in a referenced list is a negative one, the
8479 effect may not be what you intended, because the negation does not propagate
8480 out to the higher level. For example, consider:
8481 .code
8482 domainlist  dom1 = !a.b
8483 domainlist  dom2 = +dom1 : *.b
8484 .endd
8485 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8486 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8487 means it matches the second list as well. The effect is not the same as
8488 .code
8489 domainlist  dom2 = !a.b : *.b
8490 .endd
8491 where &'x.y'& does not match. It's best to avoid negation altogether in
8492 referenced lists if you can.
8493
8494 .cindex "hiding named list values"
8495 .cindex "named lists" "hiding value of"
8496 Some named list definitions may contain sensitive data, for example, passwords for
8497 accessing databases. To stop non-admin users from using the &%-bP%& command
8498 line option to read these values, you can precede the definition with the
8499 word &"hide"&. For example:
8500 .code
8501 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8502 .endd
8503
8504
8505 Named lists may have a performance advantage. When Exim is routing an
8506 address or checking an incoming message, it caches the result of tests on named
8507 lists. So, if you have a setting such as
8508 .code
8509 domains = +local_domains
8510 .endd
8511 on several of your routers
8512 or in several ACL statements,
8513 the actual test is done only for the first one. However, the caching works only
8514 if there are no expansions within the list itself or any sublists that it
8515 references. In other words, caching happens only for lists that are known to be
8516 the same each time they are referenced.
8517
8518 By default, there may be up to 16 named lists of each type. This limit can be
8519 extended by changing a compile-time variable. The use of domain and host lists
8520 is recommended for concepts such as local domains, relay domains, and relay
8521 hosts. The default configuration is set up like this.
8522
8523
8524
8525 .subsection "Named lists compared with macros" SECID78
8526 .cindex "list" "named compared with macro"
8527 .cindex "macro" "compared with named list"
8528 At first sight, named lists might seem to be no different from macros in the
8529 configuration file. However, macros are just textual substitutions. If you
8530 write
8531 .code
8532 ALIST = host1 : host2
8533 auth_advertise_hosts = !ALIST
8534 .endd
8535 it probably won't do what you want, because that is exactly the same as
8536 .code
8537 auth_advertise_hosts = !host1 : host2
8538 .endd
8539 Notice that the second host name is not negated. However, if you use a host
8540 list, and write
8541 .code
8542 hostlist alist = host1 : host2
8543 auth_advertise_hosts = ! +alist
8544 .endd
8545 the negation applies to the whole list, and so that is equivalent to
8546 .code
8547 auth_advertise_hosts = !host1 : !host2
8548 .endd
8549
8550
8551 .subsection "Named list caching" SECID79
8552 .cindex "list" "caching of named"
8553 .cindex "caching" "named lists"
8554 While processing a message, Exim caches the result of checking a named list if
8555 it is sure that the list is the same each time. In practice, this means that
8556 the cache operates only if the list contains no $ characters, which guarantees
8557 that it will not change when it is expanded. Sometimes, however, you may have
8558 an expanded list that you know will be the same each time within a given
8559 message. For example:
8560 .code
8561 domainlist special_domains = \
8562            ${lookup{$sender_host_address}cdb{/some/file}}
8563 .endd
8564 This provides a list of domains that depends only on the sending host's IP
8565 address. If this domain list is referenced a number of times (for example,
8566 in several ACL lines, or in several routers) the result of the check is not
8567 cached by default, because Exim does not know that it is going to be the
8568 same list each time.
8569
8570 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8571 cache the result anyway. For example:
8572 .code
8573 domainlist_cache special_domains = ${lookup{...
8574 .endd
8575 If you do this, you should be absolutely sure that caching is going to do
8576 the right thing in all cases. When in doubt, leave it out.
8577
8578
8579
8580 .section "Domain lists" "SECTdomainlist"
8581 .cindex "domain list" "patterns for"
8582 .cindex "list" "domain list"
8583 Domain lists contain patterns that are to be matched against a mail domain.
8584 The following types of item may appear in domain lists:
8585
8586 .ilist
8587 .cindex "primary host name"
8588 .cindex "host name" "matched in domain list"
8589 .oindex "&%primary_hostname%&"
8590 .cindex "domain list" "matching primary host name"
8591 .cindex "@ in a domain list"
8592 If a pattern consists of a single @ character, it matches the local host name,
8593 as set by the &%primary_hostname%& option (or defaulted). This makes it
8594 possible to use the same configuration file on several different hosts that
8595 differ only in their names.
8596
8597 The value for a match will be the primary host name.
8598
8599
8600 .next
8601 .cindex "@[] in a domain list"
8602 .cindex "domain list" "matching local IP interfaces"
8603 .cindex "domain literal"
8604 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8605 in square brackets (as in an email address that contains a domain literal), but
8606 only if that IP address is recognized as local for email routing purposes. The
8607 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8608 control which of a host's several IP addresses are treated as local.
8609 In today's Internet, the use of domain literals is controversial;
8610 see the &%allow_domain_literals%& main option.
8611
8612 The value for a match will be the string &`@[]`&.
8613
8614
8615 .next
8616 .cindex "@mx_any"
8617 .cindex "@mx_primary"
8618 .cindex "@mx_secondary"
8619 .cindex "domain list" "matching MX pointers to local host"
8620 If a pattern consists of the string &`@mx_any`& it matches any domain that
8621 has an MX record pointing to the local host or to any host that is listed in
8622 .oindex "&%hosts_treat_as_local%&"
8623 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8624 are similar, except that the first matches only when a primary MX target is the
8625 local host, and the second only when no primary MX target is the local host,
8626 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8627 preference value &-- there may of course be more than one of them.
8628
8629 The MX lookup that takes place when matching a pattern of this type is
8630 performed with the resolver options for widening names turned off. Thus, for
8631 example, a single-component domain will &'not'& be expanded by adding the
8632 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8633 options of the &(dnslookup)& router for a discussion of domain widening.
8634
8635 Sometimes you may want to ignore certain IP addresses when using one of these
8636 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8637 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8638 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8639 on a router). For example:
8640 .code
8641 domains = @mx_any/ignore=127.0.0.1
8642 .endd
8643 This example matches any domain that has an MX record pointing to one of
8644 the local host's IP addresses other than 127.0.0.1.
8645
8646 The list of IP addresses is in fact processed by the same code that processes
8647 host lists, so it may contain CIDR-coded network specifications and it may also
8648 contain negative items.
8649
8650 Because the list of IP addresses is a sublist within a domain list, you have to
8651 be careful about delimiters if there is more than one address. Like any other
8652 list, the default delimiter can be changed. Thus, you might have:
8653 .code
8654 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8655           an.other.domain : ...
8656 .endd
8657 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8658 involved, it is easiest to change the delimiter for the main list as well:
8659 .code
8660 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8661           an.other.domain ? ...
8662 .endd
8663 The value for a match will be the list element string (starting &`@mx_`&).
8664
8665
8666 .next
8667 .cindex "asterisk" "in domain list"
8668 .cindex "domain list" "asterisk in"
8669 .cindex "domain list" "matching &""ends with""&"
8670 If a pattern starts with an asterisk, the remaining characters of the pattern
8671 are compared with the terminating characters of the domain. The use of &"*"& in
8672 domain lists differs from its use in partial matching lookups. In a domain
8673 list, the character following the asterisk need not be a dot, whereas partial
8674 matching works only in terms of dot-separated components. For example, a domain
8675 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8676 &'cipher.key.ex'&.
8677
8678 The value for a match will be the list element string (starting with the asterisk).
8679 Additionally, &$0$& will be set to the matched string
8680 and &$1$& to the variable portion which the asterisk matched.
8681
8682 .next
8683 .cindex "regular expressions" "in domain list"
8684 .cindex "domain list" "matching regular expression"
8685 If a pattern starts with a circumflex character, it is treated as a regular
8686 expression, and matched against the domain using a regular expression matching
8687 function. The circumflex is treated as part of the regular expression.
8688 Email domains are case-independent, so this regular expression match is by
8689 default case-independent, but you can make it case-dependent by starting it
8690 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8691 are given in chapter &<<CHAPregexp>>&.
8692
8693 &*Warning*&: Because domain lists are expanded before being processed, you
8694 must escape any backslash and dollar characters in the regular expression, or
8695 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8696 it is not to be expanded (unless you really do want to build a regular
8697 expression by expansion, of course).
8698
8699 The value for a match will be the list element string (starting with the circumflex).
8700 Additionally, &$0$& will be set to the string matching the regular expression,
8701 and &$1$& (onwards) to any submatches identified by parentheses.
8702
8703
8704
8705 .next
8706 .cindex "lookup" "in domain list"
8707 .cindex "domain list" "matching by lookup"
8708 If a pattern starts with the name of a single-key lookup type followed by a
8709 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8710 must be a filename in a suitable format for the lookup type. For example, for
8711 &"cdb;"& it must be an absolute path:
8712 .code
8713 domains = cdb;/etc/mail/local_domains.cdb
8714 .endd
8715 The appropriate type of lookup is done on the file using the domain name as the
8716 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8717 only in whether or not the key is present in the file. However, when a lookup
8718 is used for the &%domains%& option on a router
8719 or a &%domains%& condition in an ACL statement, the value is preserved in the
8720 &$domain_data$& variable and can be referred to in other router options or
8721 other statements in the same ACL.
8722 .cindex "tainted data" "de-tainting"
8723 .cindex "de-tainting" "using ACL domains condition"
8724 The value will be untainted.
8725
8726 &*Note*&: If the data result of the lookup (as opposed to the key)
8727 is empty, then this empty value is stored in &$domain_data$&.
8728 The option to return the key for the lookup, as the value,
8729 may be what is wanted.
8730
8731
8732 .next
8733 Any of the single-key lookup type names may be preceded by
8734 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8735 .code
8736 domains = partial-dbm;/partial/domains
8737 .endd
8738 This causes partial matching logic to be invoked; a description of how this
8739 works is given in section &<<SECTpartiallookup>>&.
8740
8741 .next
8742 .cindex "asterisk" "in lookup type"
8743 Any of the single-key lookup types may be followed by an asterisk. This causes
8744 a default lookup for a key consisting of a single asterisk to be done if the
8745 original lookup fails. This is not a useful feature when using a domain list to
8746 select particular domains (because any domain would match), but it might have
8747 value if the result of the lookup is being used via the &$domain_data$&
8748 expansion variable.
8749
8750 .next
8751 If the pattern starts with the name of a query-style lookup type followed by a
8752 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8753 pattern must be an appropriate query for the lookup type, as described in
8754 chapter &<<CHAPfdlookup>>&. For example:
8755 .code
8756 hold_domains = mysql;select domain from holdlist \
8757   where domain = '${quote_mysql:$domain}';
8758 .endd
8759 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8760 example, it doesn't matter what field you select). Exim is interested only in
8761 whether or not the query succeeds. However, when a lookup is used for the
8762 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8763 variable and can be referred to in other options.
8764 .cindex "tainted data" "de-tainting"
8765 .cindex "de-tainting" "using router domains option"
8766 The value will be untainted.
8767
8768 .next
8769 If the pattern starts with the name of a lookup type
8770 of either kind (single-key or query-style) it may be
8771 followed by a comma and options,
8772 The options are lookup-type specific and consist of a comma-separated list.
8773 Each item starts with a tag and and equals "=" sign.
8774
8775 .next
8776 .cindex "domain list" "matching literal domain name"
8777 If none of the above cases apply, a caseless textual comparison is made
8778 between the pattern and the domain.
8779
8780 The value for a match will be the list element string.
8781 .cindex "tainted data" "de-tainting"
8782 Note that this is commonly untainted
8783 (depending on the way the list was created).
8784 Specifically, explicit text in the configuration file in not tainted.
8785 This is a useful way of obtaining an untainted equivalent to
8786 the domain, for later operations.
8787
8788 However if the list (including one-element lists)
8789 is created by expanding a variable containing tainted data,
8790 it is tainted and so will the match value be.
8791 .endlist
8792
8793
8794 Here is an example that uses several different kinds of pattern:
8795 .code
8796 domainlist funny_domains = \
8797   @ : \
8798   lib.unseen.edu : \
8799   *.foundation.fict.example : \
8800   \N^[1-2]\d{3}\.fict\.example$\N : \
8801   partial-dbm;/opt/data/penguin/book : \
8802   nis;domains.byname : \
8803   nisplus;[name=$domain,status=local],domains.org_dir
8804 .endd
8805 There are obvious processing trade-offs among the various matching modes. Using
8806 an asterisk is faster than a regular expression, and listing a few names
8807 explicitly probably is too. The use of a file or database lookup is expensive,
8808 but may be the only option if hundreds of names are required. Because the
8809 patterns are tested in order, it makes sense to put the most commonly matched
8810 patterns earlier.
8811
8812
8813
8814 .section "Host lists" "SECThostlist"
8815 .cindex "host list" "patterns in"
8816 .cindex "list" "host list"
8817 Host lists are used to control what remote hosts are allowed to do. For
8818 example, some hosts may be allowed to use the local host as a relay, and some
8819 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8820 two different ways, by name or by IP address. In a host list, some types of
8821 pattern are matched to a host name, and some are matched to an IP address.
8822 You need to be particularly careful with this when single-key lookups are
8823 involved, to ensure that the right value is being used as the key.
8824
8825
8826 .subsection "Special host list patterns" SECID80
8827 .cindex "empty item in hosts list"
8828 .cindex "host list" "empty string in"
8829 If a host list item is the empty string, it matches only when no remote host is
8830 involved. This is the case when a message is being received from a local
8831 process using SMTP on the standard input, that is, when a TCP/IP connection is
8832 not used.
8833
8834 .cindex "asterisk" "in host list"
8835 The special pattern &"*"& in a host list matches any host or no host. Neither
8836 the IP address nor the name is actually inspected.
8837
8838
8839
8840 .subsection "Host list patterns that match by IP address" SECThoslispatip
8841 .cindex "host list" "matching IP addresses"
8842 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8843 the incoming address actually appears in the IPv6 host as
8844 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8845 list, it is converted into a traditional IPv4 address first. (Not all operating
8846 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8847 concerns.)
8848
8849 The following types of pattern in a host list check the remote host by
8850 inspecting its IP address:
8851
8852 .ilist
8853 If the pattern is a plain domain name (not a regular expression, not starting
8854 with *, not a lookup of any kind), Exim calls the operating system function
8855 to find the associated IP address(es). Exim uses the newer
8856 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8857 This typically causes a forward DNS lookup of the name. The result is compared
8858 with the IP address of the subject host.
8859
8860 If there is a temporary problem (such as a DNS timeout) with the host name
8861 lookup, a temporary error occurs. For example, if the list is being used in an
8862 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8863 temporary SMTP error code. If no IP address can be found for the host name,
8864 what happens is described in section &<<SECTbehipnot>>& below.
8865
8866 .next
8867 .cindex "@ in a host list"
8868 If the pattern is &"@"&, the primary host name is substituted and used as a
8869 domain name, as just described.
8870
8871 .next
8872 If the pattern is an IP address, it is matched against the IP address of the
8873 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8874 IPv6 addresses can be given in colon-separated format, but the colons have to
8875 be doubled so as not to be taken as item separators when the default list
8876 separator is used. IPv6 addresses are recognized even when Exim is compiled
8877 without IPv6 support. This means that if they appear in a host list on an
8878 IPv4-only host, Exim will not treat them as host names. They are just addresses
8879 that can never match a client host.
8880
8881 .next
8882 .cindex "@[] in a host list"
8883 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8884 the local host. For example, if the local host is an IPv4 host with one
8885 interface address 10.45.23.56, these two ACL statements have the same effect:
8886 .code
8887 accept hosts = 127.0.0.1 : 10.45.23.56
8888 accept hosts = @[]
8889 .endd
8890 .next
8891 .cindex "CIDR notation"
8892 If the pattern is an IP address followed by a slash and a mask length, for
8893 example
8894 .code
8895 10.11.42.0/24
8896 .endd
8897 , it is matched against the IP address of the subject
8898 host under the given mask. This allows an entire network of hosts to be
8899 included (or excluded) by a single item. The mask uses CIDR notation; it
8900 specifies the number of address bits that must match, starting from the most
8901 significant end of the address.
8902
8903 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8904 of a range of addresses. It is the number of bits in the network portion of the
8905 address. The above example specifies a 24-bit netmask, so it matches all 256
8906 addresses in the 10.11.42.0 network. An item such as
8907 .code
8908 192.168.23.236/31
8909 .endd
8910 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8911 32 for an IPv4 address is the same as no mask at all; just a single address
8912 matches.
8913
8914 Here is another example which shows an IPv4 and an IPv6 network:
8915 .code
8916 recipient_unqualified_hosts = 192.168.0.0/16: \
8917                               3ffe::ffff::836f::::/48
8918 .endd
8919 The doubling of list separator characters applies only when these items
8920 appear inline in a host list. It is not required when indirecting via a file.
8921 For example:
8922 .code
8923 recipient_unqualified_hosts = /opt/exim/unqualnets
8924 .endd
8925 could make use of a file containing
8926 .code
8927 172.16.0.0/12
8928 3ffe:ffff:836f::/48
8929 .endd
8930 to have exactly the same effect as the previous example. When listing IPv6
8931 addresses inline, it is usually more convenient to use the facility for
8932 changing separator characters. This list contains the same two networks:
8933 .code
8934 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8935                                  3ffe:ffff:836f::/48
8936 .endd
8937 The separator is changed to semicolon by the leading &"<;"& at the start of the
8938 list.
8939 .endlist
8940
8941
8942
8943 .subsection "Host list patterns for single-key lookups by host address" &&&
8944          SECThoslispatsikey
8945 .cindex "host list" "lookup of IP address"
8946 When a host is to be identified by a single-key lookup of its complete IP
8947 address, the pattern takes this form:
8948 .display
8949 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8950 .endd
8951 For example:
8952 .code
8953 hosts_lookup = net-cdb;/hosts-by-ip.db
8954 .endd
8955 The text form of the IP address of the subject host is used as the lookup key.
8956 IPv6 addresses are converted to an unabbreviated form, using lower case
8957 letters, with dots as separators because colon is the key terminator in
8958 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8959 quoting the keys, but this is a facility that was added later.] The data
8960 returned by the lookup is not used.
8961
8962 .cindex "IP address" "masking"
8963 .cindex "host list" "masked IP address"
8964 Single-key lookups can also be performed using masked IP addresses, using
8965 patterns of this form:
8966 .display
8967 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8968 .endd
8969 For example:
8970 .code
8971 net24-dbm;/networks.db
8972 .endd
8973 The IP address of the subject host is masked using <&'number'&> as the mask
8974 length. A textual string is constructed from the masked value, followed by the
8975 mask, and this is used as the lookup key. For example, if the host's IP address
8976 is 192.168.34.6, the key that is looked up for the above example is
8977 &"192.168.34.0/24"&.
8978
8979 When an IPv6 address is converted to a string, dots are normally used instead
8980 of colons, so that keys in &(lsearch)& files need not contain colons (which
8981 terminate &(lsearch)& keys). This was implemented some time before the ability
8982 to quote keys was made available in &(lsearch)& files. However, the more
8983 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8984 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8985 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8986 converted using colons and not dots.
8987 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8988 addresses are always used.
8989 The latter are converted to IPv4 addresses, in dotted-quad form.
8990
8991 Ideally, it would be nice to tidy up this anomalous situation by changing to
8992 colons in all cases, given that quoting is now available for &(lsearch)&.
8993 However, this would be an incompatible change that might break some existing
8994 configurations.
8995
8996 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8997 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8998 the former case the key strings include the mask value, whereas in the latter
8999 case the IP address is used on its own.
9000
9001
9002
9003 .subsection "Host list patterns that match by host name" SECThoslispatnam
9004 .cindex "host" "lookup failures"
9005 .cindex "unknown host name"
9006 .cindex "host list" "matching host name"
9007 There are several types of pattern that require Exim to know the name of the
9008 remote host. These are either wildcard patterns or lookups by name. (If a
9009 complete hostname is given without any wildcarding, it is used to find an IP
9010 address to match against, as described in section &<<SECThoslispatip>>&
9011 above.)
9012
9013 If the remote host name is not already known when Exim encounters one of these
9014 patterns, it has to be found from the IP address.
9015 Although many sites on the Internet are conscientious about maintaining reverse
9016 DNS data for their hosts, there are also many that do not do this.
9017 Consequently, a name cannot always be found, and this may lead to unwanted
9018 effects. Take care when configuring host lists with wildcarded name patterns.
9019 Consider what will happen if a name cannot be found.
9020
9021 Because of the problems of determining host names from IP addresses, matching
9022 against host names is not as common as matching against IP addresses.
9023
9024 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9025 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9026 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9027 are done can be changed by setting the &%host_lookup_order%& option. For
9028 security, once Exim has found one or more names, it looks up the IP addresses
9029 for these names and compares them with the IP address that it started with.
9030 Only those names whose IP addresses match are accepted. Any other names are
9031 discarded. If no names are left, Exim behaves as if the host name cannot be
9032 found. In the most common case there is only one name and one IP address.
9033
9034 There are some options that control what happens if a host name cannot be
9035 found. These are described in section &<<SECTbehipnot>>& below.
9036
9037 .cindex "host" "alias for"
9038 .cindex "alias for host"
9039 As a result of aliasing, hosts may have more than one name. When processing any
9040 of the following types of pattern, all the host's names are checked:
9041
9042 .ilist
9043 .cindex "asterisk" "in host list"
9044 If a pattern starts with &"*"& the remainder of the item must match the end of
9045 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9046 &'.b.c'&. This special simple form is provided because this is a very common
9047 requirement. Other kinds of wildcarding require the use of a regular
9048 expression.
9049 .next
9050 .cindex "regular expressions" "in host list"
9051 .cindex "host list" "regular expression in"
9052 If the item starts with &"^"& it is taken to be a regular expression which is
9053 matched against the host name. Host names are case-independent, so this regular
9054 expression match is by default case-independent, but you can make it
9055 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9056 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9057 example,
9058 .code
9059 ^(a|b)\.c\.d$
9060 .endd
9061 is a regular expression that matches either of the two hosts &'a.c.d'& or
9062 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9063 that backslash and dollar characters are not misinterpreted as part of the
9064 string expansion. The simplest way to do this is to use &`\N`& to mark that
9065 part of the string as non-expandable. For example:
9066 .code
9067 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9068 .endd
9069 &*Warning*&: If you want to match a complete host name, you must include the
9070 &`$`& terminating metacharacter in the regular expression, as in the above
9071 example. Without it, a match at the start of the host name is all that is
9072 required.
9073 .endlist
9074
9075
9076
9077
9078 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9079 .cindex "host" "lookup failures, permanent"
9080 While processing a host list, Exim may need to look up an IP address from a
9081 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9082 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9083 behaviour when it fails to find the information it is seeking is the same.
9084
9085 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9086 apply to temporary DNS errors, whose handling is described in the next section.
9087
9088 .cindex "&`+include_unknown`&"
9089 .cindex "&`+ignore_unknown`&"
9090 Exim parses a host list from left to right. If it encounters a permanent
9091 lookup failure in any item in the host list before it has found a match,
9092 Exim treats it as a failure and the default behavior is as if the host
9093 does not match the list. This may not always be what you want to happen.
9094 To change Exim's behaviour, the special items &`+include_unknown`& or
9095 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9096 not recognized in an indirected file).
9097
9098 .ilist
9099 If any item that follows &`+include_unknown`& requires information that
9100 cannot found, Exim behaves as if the host does match the list. For example,
9101 .code
9102 host_reject_connection = +include_unknown:*.enemy.ex
9103 .endd
9104 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9105 any hosts whose name it cannot find.
9106
9107 .next
9108 If any item that follows &`+ignore_unknown`& requires information that cannot
9109 be found, Exim ignores that item and proceeds to the rest of the list. For
9110 example:
9111 .code
9112 accept hosts = +ignore_unknown : friend.example : \
9113                192.168.4.5
9114 .endd
9115 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9116 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9117 name can be found for 192.168.4.5, it is rejected.
9118 .endlist
9119
9120 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9121 list. The effect of each one lasts until the next, or until the end of the
9122 list.
9123
9124 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9125          SECTmixwilhos
9126 .cindex "host list" "mixing names and addresses in"
9127
9128 This section explains the host/ip processing logic with the same concepts
9129 as the previous section, but specifically addresses what happens when a
9130 wildcarded hostname is one of the items in the hostlist.
9131
9132 .ilist
9133 If you have name lookups or wildcarded host names and
9134 IP addresses in the same host list, you should normally put the IP
9135 addresses first. For example, in an ACL you could have:
9136 .code
9137 accept hosts = 10.9.8.7 : *.friend.example
9138 .endd
9139 The reason you normally would order it this way lies in the
9140 left-to-right way that Exim processes lists.  It can test IP addresses
9141 without doing any DNS lookups, but when it reaches an item that requires
9142 a host name, it fails if it cannot find a host name to compare with the
9143 pattern. If the above list is given in the opposite order, the
9144 &%accept%& statement fails for a host whose name cannot be found, even
9145 if its IP address is 10.9.8.7.
9146
9147 .next
9148 If you really do want to do the name check first, and still recognize the IP
9149 address, you can rewrite the ACL like this:
9150 .code
9151 accept hosts = *.friend.example
9152 accept hosts = 10.9.8.7
9153 .endd
9154 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9155 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9156 &`+ignore_unknown`&, which was discussed in depth in the first example in
9157 this section.
9158 .endlist
9159
9160
9161 .subsection "Temporary DNS errors when looking up host information" &&&
9162          SECTtemdnserr
9163 .cindex "host" "lookup failures, temporary"
9164 .cindex "&`+include_defer`&"
9165 .cindex "&`+ignore_defer`&"
9166 A temporary DNS lookup failure normally causes a defer action (except when
9167 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9168 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9169 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9170 section. These options should be used with care, probably only in non-critical
9171 host lists such as whitelists.
9172
9173
9174
9175 .subsection "Host list patterns for single-key lookups by host name" &&&
9176          SECThoslispatnamsk
9177 .cindex "unknown host name"
9178 .cindex "host list" "matching host name"
9179 If a pattern is of the form
9180 .display
9181 <&'single-key-search-type'&>;<&'search-data'&>
9182 .endd
9183 for example
9184 .code
9185 dbm;/host/accept/list
9186 .endd
9187 a single-key lookup is performed, using the host name as its key. If the
9188 lookup succeeds, the host matches the item. The actual data that is looked up
9189 is not used.
9190
9191 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9192 keys in the file, not IP addresses. If you want to do lookups based on IP
9193 addresses, you must precede the search type with &"net-"& (see section
9194 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9195 two items in the same list, one doing an address lookup and one doing a name
9196 lookup, both using the same file.
9197
9198
9199
9200 .subsection "Host list patterns for query-style lookups" SECID81
9201 If a pattern is of the form
9202 .display
9203 <&'query-style-search-type'&>;<&'query'&>
9204 .endd
9205 the query is obeyed, and if it succeeds, the host matches the item. The actual
9206 data that is looked up is not used. The variables &$sender_host_address$& and
9207 &$sender_host_name$& can be used in the query. For example:
9208 .code
9209 hosts_lookup = pgsql;\
9210   select ip from hostlist where ip='$sender_host_address'
9211 .endd
9212 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9213 can use the &%sg%& expansion item to change this if you need to. If you want to
9214 use masked IP addresses in database queries, you can use the &%mask%& expansion
9215 operator.
9216
9217 If the query contains a reference to &$sender_host_name$&, Exim automatically
9218 looks up the host name if it has not already done so. (See section
9219 &<<SECThoslispatnam>>& for comments on finding host names.)
9220
9221 Historical note: prior to release 4.30, Exim would always attempt to find a
9222 host name before running the query, unless the search type was preceded by
9223 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9224 still recognized for query-style lookups, but its presence or absence has no
9225 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9226 See section &<<SECThoslispatsikey>>&.)
9227
9228
9229
9230
9231
9232 .section "Address lists" "SECTaddresslist"
9233 .cindex "list" "address list"
9234 .cindex "address list" "empty item"
9235 .cindex "address list" "patterns"
9236 Address lists contain patterns that are matched against mail addresses. There
9237 is one special case to be considered: the sender address of a bounce message is
9238 always empty. You can test for this by providing an empty item in an address
9239 list. For example, you can set up a router to process bounce messages by
9240 using this option setting:
9241 .code
9242 senders = :
9243 .endd
9244 The presence of the colon creates an empty item. If you do not provide any
9245 data, the list is empty and matches nothing. The empty sender can also be
9246 detected by a regular expression that matches an empty string,
9247 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9248
9249 Non-empty items in an address list can be straightforward email addresses. For
9250 example:
9251 .code
9252 senders = jbc@askone.example : hs@anacreon.example
9253 .endd
9254 A certain amount of wildcarding is permitted. If a pattern contains an @
9255 character, but is not a regular expression and does not begin with a
9256 semicolon-terminated lookup type (described below), the local part of the
9257 subject address is compared with the local part of the pattern, which may start
9258 with an asterisk. If the local parts match, the domain is checked in exactly
9259 the same way as for a pattern in a domain list. For example, the domain can be
9260 wildcarded, refer to a named list, or be a lookup:
9261 .code
9262 deny senders = *@*.spamming.site:\
9263                *@+hostile_domains:\
9264                bozo@partial-lsearch;/list/of/dodgy/sites:\
9265                *@dbm;/bad/domains.db
9266 .endd
9267 .cindex "local part" "starting with !"
9268 .cindex "address list" "local part starting with !"
9269 If a local part that begins with an exclamation mark is required, it has to be
9270 specified using a regular expression, because otherwise the exclamation mark is
9271 treated as a sign of negation, as is standard in lists.
9272
9273 If a non-empty pattern that is not a regular expression or a lookup does not
9274 contain an @ character, it is matched against the domain part of the subject
9275 address. The only two formats that are recognized this way are a literal
9276 domain, or a domain pattern that starts with *. In both these cases, the effect
9277 is the same as if &`*@`& preceded the pattern. For example:
9278 .code
9279 deny senders = enemy.domain : *.enemy.domain
9280 .endd
9281
9282 The following kinds of more complicated address list pattern can match any
9283 address, including the empty address that is characteristic of bounce message
9284 senders:
9285
9286 .ilist
9287 .cindex "regular expressions" "in address list"
9288 .cindex "address list" "regular expression in"
9289 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9290 done against the complete address, with the pattern as the regular expression.
9291 You must take care that backslash and dollar characters are not misinterpreted
9292 as part of the string expansion. The simplest way to do this is to use &`\N`&
9293 to mark that part of the string as non-expandable. For example:
9294 .code
9295 deny senders = \N^.*this.*@example\.com$\N : \
9296                \N^\d{8}.+@spamhaus.example$\N : ...
9297 .endd
9298 The &`\N`& sequences are removed by the expansion, so these items do indeed
9299 start with &"^"& by the time they are being interpreted as address patterns.
9300
9301 .next
9302 .cindex "address list" "lookup for complete address"
9303 Complete addresses can be looked up by using a pattern that starts with a
9304 lookup type terminated by a semicolon, followed by the data for the lookup. For
9305 example:
9306 .code
9307 deny senders = cdb;/etc/blocked.senders : \
9308   mysql;select address from blocked where \
9309   address='${quote_mysql:$sender_address}'
9310 .endd
9311 Both query-style and single-key lookup types can be used. For a single-key
9312 lookup type, Exim uses the complete address as the key. However, empty keys are
9313 not supported for single-key lookups, so a match against the empty address
9314 always fails. This restriction does not apply to query-style lookups.
9315
9316 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9317 cannot be used, and is ignored if specified, with an entry being written to the
9318 panic log.
9319 .cindex "*@ with single-key lookup"
9320 However, you can configure lookup defaults, as described in section
9321 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9322 default. For example, with this lookup:
9323 .code
9324 accept senders = lsearch*@;/some/file
9325 .endd
9326 the file could contains lines like this:
9327 .code
9328 user1@domain1.example
9329 *@domain2.example
9330 .endd
9331 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9332 that are tried is:
9333 .code
9334 nimrod@jaeger.example
9335 *@jaeger.example
9336 *
9337 .endd
9338 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9339 would mean that every address matches, thus rendering the test useless.
9340
9341 &*Warning 2*&: Do not confuse these two kinds of item:
9342 .code
9343 deny recipients = dbm*@;/some/file
9344 deny recipients = *@dbm;/some/file
9345 .endd
9346 The first does a whole address lookup, with defaulting, as just described,
9347 because it starts with a lookup type. The second matches the local part and
9348 domain independently, as described in a bullet point below.
9349 .endlist
9350
9351
9352 The following kinds of address list pattern can match only non-empty addresses.
9353 If the subject address is empty, a match against any of these pattern types
9354 always fails.
9355
9356
9357 .ilist
9358 .cindex "@@ with single-key lookup"
9359 .cindex "address list" "@@ lookup type"
9360 .cindex "address list" "split local part and domain"
9361 If a pattern starts with &"@@"& followed by a single-key lookup item
9362 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9363 split into a local part and a domain. The domain is looked up in the file. If
9364 it is not found, there is no match. If it is found, the data that is looked up
9365 from the file is treated as a colon-separated list of local part patterns, each
9366 of which is matched against the subject local part in turn.
9367
9368 .cindex "asterisk" "in address list"
9369 The lookup may be a partial one, and/or one involving a search for a default
9370 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9371 patterns that are looked up can be regular expressions or begin with &"*"&, or
9372 even be further lookups. They may also be independently negated. For example,
9373 with
9374 .code
9375 deny senders = @@dbm;/etc/reject-by-domain
9376 .endd
9377 the data from which the DBM file is built could contain lines like
9378 .code
9379 baddomain.com:  !postmaster : *
9380 .endd
9381 to reject all senders except &%postmaster%& from that domain.
9382
9383 .cindex "local part" "starting with !"
9384 If a local part that actually begins with an exclamation mark is required, it
9385 has to be specified using a regular expression. In &(lsearch)& files, an entry
9386 may be split over several lines by indenting the second and subsequent lines,
9387 but the separating colon must still be included at line breaks. White space
9388 surrounding the colons is ignored. For example:
9389 .code
9390 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9391   spammer3 : spammer4
9392 .endd
9393 As in all colon-separated lists in Exim, a colon can be included in an item by
9394 doubling.
9395
9396 If the last item in the list starts with a right angle-bracket, the remainder
9397 of the item is taken as a new key to look up in order to obtain a continuation
9398 list of local parts. The new key can be any sequence of characters. Thus one
9399 might have entries like
9400 .code
9401 aol.com: spammer1 : spammer 2 : >*
9402 xyz.com: spammer3 : >*
9403 *:       ^\d{8}$
9404 .endd
9405 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9406 local parts for all domains, in addition to the specific local parts listed for
9407 each domain. Of course, using this feature costs another lookup each time a
9408 chain is followed, but the effort needed to maintain the data is reduced.
9409
9410 .cindex "loop" "in lookups"
9411 It is possible to construct loops using this facility, and in order to catch
9412 them, the chains may be no more than fifty items long.
9413
9414 .next
9415 The @@<&'lookup'&> style of item can also be used with a query-style
9416 lookup, but in this case, the chaining facility is not available. The lookup
9417 can only return a single list of local parts.
9418 .endlist
9419
9420 &*Warning*&: There is an important difference between the address list items
9421 in these two examples:
9422 .code
9423 senders = +my_list
9424 senders = *@+my_list
9425 .endd
9426 In the first one, &`my_list`& is a named address list, whereas in the second
9427 example it is a named domain list.
9428
9429
9430
9431
9432 .subsection "Case of letters in address lists" SECTcasletadd
9433 .cindex "case of local parts"
9434 .cindex "address list" "case forcing"
9435 .cindex "case forcing in address lists"
9436 Domains in email addresses are always handled caselessly, but for local parts
9437 case may be significant on some systems (see &%caseful_local_part%& for how
9438 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9439 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9440 blocking lists should be done in a case-independent manner. Since most address
9441 lists in Exim are used for this kind of control, Exim attempts to do this by
9442 default.
9443
9444 The domain portion of an address is always lowercased before matching it to an
9445 address list. The local part is lowercased by default, and any string
9446 comparisons that take place are done caselessly. This means that the data in
9447 the address list itself, in files included as plain filenames, and in any file
9448 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9449 keys in files that are looked up by a search type other than &(lsearch)& (which
9450 works caselessly) must be in lower case, because these lookups are not
9451 case-independent.
9452
9453 .cindex "&`+caseful`&"
9454 To allow for the possibility of caseful address list matching, if an item in
9455 an address list is the string &"+caseful"&, the original case of the local
9456 part is restored for any comparisons that follow, and string comparisons are no
9457 longer case-independent. This does not affect the domain, which remains in
9458 lower case. However, although independent matches on the domain alone are still
9459 performed caselessly, regular expressions that match against an entire address
9460 become case-sensitive after &"+caseful"& has been seen.
9461
9462
9463
9464 .section "Local part lists" "SECTlocparlis"
9465 .cindex "list" "local part list"
9466 .cindex "local part" "list"
9467 These behave in the same way as domain and host lists, with the following
9468 changes:
9469
9470 Case-sensitivity in local part lists is handled in the same way as for address
9471 lists, as just described. The &"+caseful"& item can be used if required. In a
9472 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9473 set false, the subject is lowercased and the matching is initially
9474 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9475 matching in the local part list, but not elsewhere in the router. If
9476 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9477 option is case-sensitive from the start.
9478
9479 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9480 comments are handled in the same way as address lists &-- they are recognized
9481 only if the # is preceded by white space or the start of the line.
9482 Otherwise, local part lists are matched in the same way as domain lists, except
9483 that the special items that refer to the local host (&`@`&, &`@[]`&,
9484 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9485 Refer to section &<<SECTdomainlist>>& for details of the other available item
9486 types.
9487 .ecindex IIDdohoadli
9488
9489
9490
9491
9492 . ////////////////////////////////////////////////////////////////////////////
9493 . ////////////////////////////////////////////////////////////////////////////
9494
9495 .chapter "String expansions" "CHAPexpand"
9496 .scindex IIDstrexp "expansion" "of strings"
9497 Many strings in Exim's runtime configuration are expanded before use. Some of
9498 them are expanded every time they are used; others are expanded only once.
9499
9500 When a string is being expanded it is copied verbatim from left to right except
9501 .cindex expansion "string concatenation"
9502 when a dollar or backslash character is encountered. A dollar specifies the
9503 start of a portion of the string that is interpreted and replaced as described
9504 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9505 escape character, as described in the following section.
9506
9507 Whether a string is expanded depends upon the context.  Usually this is solely
9508 dependent upon the option for which a value is sought; in this documentation,
9509 options for which string expansion is performed are marked with &dagger; after
9510 the data type.  ACL rules always expand strings.  A couple of expansion
9511 conditions do not expand some of the brace-delimited branches, for security
9512 reasons,
9513 .cindex "tainted data" expansion
9514 .cindex "tainted data" definition
9515 .cindex expansion "tainted data"
9516 and expansion of data deriving from the sender (&"tainted data"&)
9517 is not permitted (including acessing a file using a tainted name).
9518
9519 Common ways of obtaining untainted equivalents of variables with
9520 tainted values
9521 .cindex "tainted data" "de-tainting"
9522 come down to using the tainted value as a lookup key in a trusted database.
9523 This database could be the filesystem structure,
9524 or the password file,
9525 or accessed via a DBMS.
9526 Specific methods are indexed under &"de-tainting"&.
9527
9528
9529
9530 .section "Literal text in expanded strings" "SECTlittext"
9531 .cindex "expansion" "including literal text"
9532 An uninterpreted dollar can be included in an expanded string by putting a
9533 backslash in front of it. A backslash can be used to prevent any special
9534 character being treated specially in an expansion, including backslash itself.
9535 If the string appears in quotes in the configuration file, two backslashes are
9536 required because the quotes themselves cause interpretation of backslashes when
9537 the string is read in (see section &<<SECTstrings>>&).
9538
9539 .cindex "expansion" "non-expandable substrings"
9540 A portion of the string can specified as non-expandable by placing it between
9541 two occurrences of &`\N`&. This is particularly useful for protecting regular
9542 expressions, which often contain backslashes and dollar signs. For example:
9543 .code
9544 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9545 .endd
9546 On encountering the first &`\N`&, the expander copies subsequent characters
9547 without interpretation until it reaches the next &`\N`& or the end of the
9548 string.
9549
9550
9551
9552 .section "Character escape sequences in expanded strings" "SECID82"
9553 .cindex "expansion" "escape sequences"
9554 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9555 expanded string is recognized as an escape sequence for the character newline,
9556 carriage return, or tab, respectively. A backslash followed by up to three
9557 octal digits is recognized as an octal encoding for a single character, and a
9558 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9559 encoding.
9560
9561 These escape sequences are also recognized in quoted strings when they are read
9562 in. Their interpretation in expansions as well is useful for unquoted strings,
9563 and for other cases such as looked-up strings that are then expanded.
9564
9565
9566 .section "Testing string expansions" "SECID83"
9567 .cindex "expansion" "testing"
9568 .cindex "testing" "string expansion"
9569 .oindex "&%-be%&"
9570 Many expansions can be tested by calling Exim with the &%-be%& option. This
9571 takes the command arguments, or lines from the standard input if there are no
9572 arguments, runs them through the string expansion code, and writes the results
9573 to the standard output. Variables based on configuration values are set up, but
9574 since no message is being processed, variables such as &$local_part$& have no
9575 value. Nevertheless the &%-be%& option can be useful for checking out file and
9576 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9577 and &%nhash%&.
9578
9579 .new
9580 When reading lines from the standard input,
9581 macros can be defined and ACL variables can be set.
9582 For example:
9583 .code
9584 MY_MACRO = foo
9585 set acl_m_myvar = bar
9586 .endd
9587 Such macros and variables can then be used in later input lines.
9588 .wen
9589
9590 Exim gives up its root privilege when it is called with the &%-be%& option, and
9591 instead runs under the uid and gid it was called with, to prevent users from
9592 using &%-be%& for reading files to which they do not have access.
9593
9594 .oindex "&%-bem%&"
9595 If you want to test expansions that include variables whose values are taken
9596 from a message, there are two other options that can be used. The &%-bem%&
9597 option is like &%-be%& except that it is followed by a filename. The file is
9598 read as a message before doing the test expansions. For example:
9599 .code
9600 exim -bem /tmp/test.message '$h_subject:'
9601 .endd
9602 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9603 Exim message identifier. For example:
9604 .code
9605 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9606 .endd
9607 This loads the message from Exim's spool before doing the test expansions, and
9608 is therefore restricted to admin users.
9609
9610
9611 .section "Forced expansion failure" "SECTforexpfai"
9612 .cindex "expansion" "forced failure"
9613 A number of expansions that are described in the following section have
9614 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9615 (which are sometimes called &"curly brackets"&). Which of the two strings is
9616 used depends on some condition that is evaluated as part of the expansion. If,
9617 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9618 the entire string expansion fails in a way that can be detected by the code
9619 that requested the expansion. This is called &"forced expansion failure"&, and
9620 its consequences depend on the circumstances. In some cases it is no different
9621 from any other expansion failure, but in others a different action may be
9622 taken. Such variations are mentioned in the documentation of the option that is
9623 being expanded.
9624
9625
9626
9627
9628 .section "Expansion items" "SECTexpansionitems"
9629 The following items are recognized in expanded strings. White space may be used
9630 between sub-items that are keywords or substrings enclosed in braces inside an
9631 outer set of braces, to improve readability. &*Warning*&: Within braces,
9632 white space is significant.
9633
9634 .vlist
9635 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9636 .cindex "expansion" "variables"
9637 Substitute the contents of the named variable, for example:
9638 .code
9639 $local_part
9640 ${domain}
9641 .endd
9642 The second form can be used to separate the name from subsequent alphanumeric
9643 characters. This form (using braces) is available only for variables; it does
9644 &'not'& apply to message headers. The names of the variables are given in
9645 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9646 given, the expansion fails.
9647
9648 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9649 .cindex "expansion" "operators"
9650 The string is first itself expanded, and then the operation specified by
9651 <&'op'&> is applied to it. For example:
9652 .code
9653 ${lc:$local_part}
9654 .endd
9655 The string starts with the first character after the colon, which may be
9656 leading white space. A list of operators is given in section &<<SECTexpop>>&
9657 below. The operator notation is used for simple expansion items that have just
9658 one argument, because it reduces the number of braces and therefore makes the
9659 string easier to understand.
9660
9661 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9662 This item inserts &"basic"& header lines. It is described with the &%header%&
9663 expansion item below.
9664
9665
9666 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9667 .cindex "expansion" "calling an acl"
9668 .cindex "&%acl%&" "call from expansion"
9669 The name and zero to nine argument strings are first expanded separately.  The expanded
9670 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9671 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9672 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9673 and may use the variables; if another acl expansion is used the values
9674 are restored after it returns.  If the ACL sets
9675 a value using a "message =" modifier and returns accept or deny, the value becomes
9676 the result of the expansion.
9677 If no message is set and the ACL returns accept or deny
9678 the expansion result is an empty string.
9679 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9680
9681
9682 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9683 .cindex authentication "results header"
9684 .chindex Authentication-Results:
9685 .cindex authentication "expansion item"
9686 This item returns a string suitable for insertion as an
9687 &'Authentication-Results:'&
9688 header line.
9689 The given <&'authserv-id'&> is included in the result; typically this
9690 will be a domain name identifying the system performing the authentications.
9691 Methods that might be present in the result include:
9692 .code
9693 none
9694 iprev
9695 auth
9696 spf
9697 dkim
9698 .endd
9699
9700 Example use (as an ACL modifier):
9701 .code
9702       add_header = :at_start:${authresults {$primary_hostname}}
9703 .endd
9704 This is safe even if no authentication results are available
9705 .new
9706 and would generally be placed in the DATA ACL.
9707 .wen
9708
9709
9710 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9711        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9712 .cindex "expansion" "extracting certificate fields"
9713 .cindex "&%certextract%&" "certificate fields"
9714 .cindex "certificate" "extracting fields"
9715 The <&'certificate'&> must be a variable of type certificate.
9716 The field name is expanded and used to retrieve the relevant field from
9717 the certificate.  Supported fields are:
9718 .display
9719 &`version        `&
9720 &`serial_number  `&
9721 &`subject        `& RFC4514 DN
9722 &`issuer         `& RFC4514 DN
9723 &`notbefore      `& time
9724 &`notafter       `& time
9725 &`sig_algorithm  `&
9726 &`signature      `&
9727 &`subj_altname   `& tagged list
9728 &`ocsp_uri       `& list
9729 &`crl_uri        `& list
9730 .endd
9731 If the field is found,
9732 <&'string2'&> is expanded, and replaces the whole item;
9733 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9734 variable &$value$& contains the value that has been extracted. Afterwards, it
9735 is restored to any previous value it might have had.
9736
9737 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9738 key is not found. If {<&'string2'&>} is also omitted, the value that was
9739 extracted is used.
9740
9741 Some field names take optional modifiers, appended and separated by commas.
9742
9743 The field selectors marked as "RFC4514" above
9744 output a Distinguished Name string which is
9745 not quite
9746 parseable by Exim as a comma-separated tagged list
9747 (the exceptions being elements containing commas).
9748 RDN elements of a single type may be selected by
9749 a modifier of the type label; if so the expansion
9750 result is a list (newline-separated by default).
9751 The separator may be changed by another modifier of
9752 a right angle-bracket followed immediately by the new separator.
9753 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9754
9755 The field selectors marked as "time" above
9756 take an optional modifier of "int"
9757 for which the result is the number of seconds since epoch.
9758 Otherwise the result is a human-readable string
9759 in the timezone selected by the main "timezone" option.
9760
9761 The field selectors marked as "list" above return a list,
9762 newline-separated by default,
9763 (embedded separator characters in elements are doubled).
9764 The separator may be changed by a modifier of
9765 a right angle-bracket followed immediately by the new separator.
9766
9767 The field selectors marked as "tagged" above
9768 prefix each list element with a type string and an equals sign.
9769 Elements of only one type may be selected by a modifier
9770 which is one of "dns", "uri" or "mail";
9771 if so the element tags are omitted.
9772
9773 If not otherwise noted field values are presented in human-readable form.
9774
9775 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9776        {*&<&'arg'&>&*}...}*&"
9777 .cindex &%dlfunc%&
9778 This expansion dynamically loads and then calls a locally-written C function.
9779 This functionality is available only if Exim is compiled with
9780 .code
9781 EXPAND_DLFUNC=yes
9782 .endd
9783 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9784 object so that it doesn't reload the same object file in the same Exim process
9785 (but of course Exim does start new processes frequently).
9786
9787 There may be from zero to eight arguments to the function.
9788
9789 When compiling
9790 a local function that is to be called in this way,
9791 first &_DLFUNC_IMPL_& should be defined,
9792 and second &_local_scan.h_& should be included.
9793 The Exim variables and functions that are defined by that API
9794 are also available for dynamically loaded functions. The function itself
9795 must have the following type:
9796 .code
9797 int dlfunction(uschar **yield, int argc, uschar *argv[])
9798 .endd
9799 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9800 function should return one of the following values:
9801
9802 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9803 into the expanded string that is being built.
9804
9805 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9806 from &'yield'&, if it is set.
9807
9808 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9809 taken from &'yield'& if it is set.
9810
9811 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9812
9813 When compiling a function that is to be used in this way with gcc,
9814 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9815 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9816
9817
9818 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9819 .cindex "expansion" "extracting value from environment"
9820 .cindex "environment" "values from"
9821 The key is first expanded separately, and leading and trailing white space
9822 removed.
9823 This is then searched for as a name in the environment.
9824 If a variable is found then its value is placed in &$value$&
9825 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9826
9827 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9828 appear, for example:
9829 .code
9830 ${env{USER}{$value} fail }
9831 .endd
9832 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9833 {<&'string1'&>} must be present for &"fail"& to be recognized.
9834
9835 If {<&'string2'&>} is omitted an empty string is substituted on
9836 search failure.
9837 If {<&'string1'&>} is omitted the search result is substituted on
9838 search success.
9839
9840 The environment is adjusted by the &%keep_environment%& and
9841 &%add_environment%& main section options.
9842
9843
9844 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9845        {*&<&'string3'&>&*}}*&"
9846 .cindex "expansion" "extracting substrings by key"
9847 .cindex "&%extract%&" "substrings by key"
9848 The key and <&'string1'&> are first expanded separately. Leading and trailing
9849 white space is removed from the key (but not from any of the strings). The key
9850 must not be empty and must not consist entirely of digits.
9851 The expanded <&'string1'&> must be of the form:
9852 .display
9853 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9854 .endd
9855 .vindex "&$value$&"
9856 where the equals signs and spaces (but not both) are optional. If any of the
9857 values contain white space, they must be enclosed in double quotes, and any
9858 values that are enclosed in double quotes are subject to escape processing as
9859 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9860 for the value that corresponds to the key. The search is case-insensitive. If
9861 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9862 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9863 variable &$value$& contains the value that has been extracted. Afterwards, it
9864 is restored to any previous value it might have had.
9865
9866 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9867 key is not found. If {<&'string2'&>} is also omitted, the value that was
9868 extracted is used. Thus, for example, these two expansions are identical, and
9869 yield &"2001"&:
9870 .code
9871 ${extract{gid}{uid=1984 gid=2001}}
9872 ${extract{gid}{uid=1984 gid=2001}{$value}}
9873 .endd
9874 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9875 appear, for example:
9876 .code
9877 ${extract{Z}{A=... B=...}{$value} fail }
9878 .endd
9879 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9880 {<&'string2'&>} must be present for &"fail"& to be recognized.
9881
9882 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9883        {*&<&'string3'&>&*}}*&" &&&
9884        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9885        {*&<&'string3'&>&*}}*&"
9886 .cindex "expansion" "extracting from JSON object"
9887 .cindex JSON expansions
9888 The key and <&'string1'&> are first expanded separately. Leading and trailing
9889 white space is removed from the key (but not from any of the strings). The key
9890 must not be empty and must not consist entirely of digits.
9891 The expanded <&'string1'&> must be of the form:
9892 .display
9893 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9894 .endd
9895 .vindex "&$value$&"
9896 The braces, commas and colons, and the quoting of the member name are required;
9897 the spaces are optional.
9898 Matching of the key against the member names is done case-sensitively.
9899 For the &"json"& variant,
9900 if a returned value is a JSON string, it retains its leading and
9901 trailing quotes.
9902 For the &"jsons"& variant, which is intended for use with JSON strings, the
9903 leading and trailing quotes are removed from the returned value.
9904 . XXX should be a UTF-8 compare
9905
9906 The results of matching are handled as above.
9907
9908
9909 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9910         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9911 .cindex "expansion" "extracting substrings by number"
9912 .cindex "&%extract%&" "substrings by number"
9913 The <&'number'&> argument must consist entirely of decimal digits,
9914 apart from leading and trailing white space, which is ignored.
9915 This is what distinguishes this form of &%extract%& from the previous kind. It
9916 behaves in the same way, except that, instead of extracting a named field, it
9917 extracts from <&'string1'&> the field whose number is given as the first
9918 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9919 <&'string3'&> as before.
9920
9921 The fields in the string are separated by any one of the characters in the
9922 separator string. These may include space or tab characters.
9923 The first field is numbered one. If the number is negative, the fields are
9924 counted from the end of the string, with the rightmost one numbered -1. If the
9925 number given is zero, the entire string is returned. If the modulus of the
9926 number is greater than the number of fields in the string, the result is the
9927 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9928 provided. For example:
9929 .code
9930 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9931 .endd
9932 yields &"42"&, and
9933 .code
9934 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9935 .endd
9936 yields &"99"&. Two successive separators mean that the field between them is
9937 empty (for example, the fifth field above).
9938
9939
9940 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9941         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9942        "&*${extract jsons{*&<&'number'&>&*}}&&&
9943         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9944 .cindex "expansion" "extracting from JSON array"
9945 .cindex JSON expansions
9946 The <&'number'&> argument must consist entirely of decimal digits,
9947 apart from leading and trailing white space, which is ignored.
9948
9949 Field selection and result handling is as above;
9950 there is no choice of field separator.
9951 For the &"json"& variant,
9952 if a returned value is a JSON string, it retains its leading and
9953 trailing quotes.
9954 For the &"jsons"& variant, which is intended for use with JSON strings, the
9955 leading and trailing quotes are removed from the returned value.
9956
9957
9958 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9959 .cindex "list" "selecting by condition"
9960 .cindex "expansion" "selecting from list by condition"
9961 .vindex "&$item$&"
9962 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9963 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9964 For each item
9965 in this list, its value is placed in &$item$&, and then the condition is
9966 evaluated.
9967 .new
9968 Any modification of &$value$& by this evaluation is discarded.
9969 .wen
9970 If the condition is true, &$item$& is added to the output as an
9971 item in a new list; if the condition is false, the item is discarded. The
9972 separator used for the output list is the same as the one used for the
9973 input, but a separator setting is not included in the output. For example:
9974 .code
9975 ${filter{a:b:c}{!eq{$item}{b}}}
9976 .endd
9977 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9978 to what it was before.
9979 See also the &%map%& and &%reduce%& expansion items.
9980
9981
9982 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9983 .cindex "hash function" "textual"
9984 .cindex "expansion" "textual hash"
9985 This is a textual hashing function, and was the first to be implemented in
9986 early versions of Exim. In current releases, there are other hashing functions
9987 (numeric, MD5, and SHA-1), which are described below.
9988
9989 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9990 <&'n'&>. If you are using fixed values for these numbers, that is, if
9991 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9992 use the simpler operator notation that avoids some of the braces:
9993 .code
9994 ${hash_<n>_<m>:<string>}
9995 .endd
9996 The second number is optional (in both notations). If <&'n'&> is greater than
9997 or equal to the length of the string, the expansion item returns the string.
9998 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9999 function to the string. The new string consists of characters taken from the
10000 first <&'m'&> characters of the string
10001 .code
10002 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10003 .endd
10004 If <&'m'&> is not present the value 26 is used, so that only lower case
10005 letters appear. For example:
10006 .display
10007 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10008 &`$hash{5}{monty}}           `&   yields  &`monty`&
10009 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10010 .endd
10011
10012 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10013         &*$h_*&<&'header&~name'&>&*:*&" &&&
10014        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10015         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10016        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10017         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10018        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10019         &*$rh_*&<&'header&~name'&>&*:*&"
10020 .cindex "expansion" "header insertion"
10021 .vindex "&$header_$&"
10022 .vindex "&$bheader_$&"
10023 .vindex "&$lheader_$&"
10024 .vindex "&$rheader_$&"
10025 .cindex "header lines" "in expansion strings"
10026 .cindex "header lines" "character sets"
10027 .cindex "header lines" "decoding"
10028 Substitute the contents of the named message header line, for example
10029 .code
10030 $header_reply-to:
10031 .endd
10032 The newline that terminates a header line is not included in the expansion, but
10033 internal newlines (caused by splitting the header line over several physical
10034 lines) may be present.
10035
10036 The difference between the four pairs of expansions is in the way
10037 the data in the header line is interpreted.
10038
10039 .ilist
10040 .cindex "white space" "in header lines"
10041 &%rheader%& gives the original &"raw"& content of the header line, with no
10042 processing at all, and without the removal of leading and trailing white space.
10043
10044 .next
10045 .cindex "list" "of header lines"
10046 &%lheader%& gives a colon-separated list, one element per header when there
10047 are multiple headers with a given name.
10048 Any embedded colon characters within an element are doubled, so normal Exim
10049 list-processing facilities can be used.
10050 The terminating newline of each element is removed; in other respects
10051 the content is &"raw"&.
10052
10053 .next
10054 .cindex "base64 encoding" "in header lines"
10055 &%bheader%& removes leading and trailing white space, and then decodes base64
10056 or quoted-printable MIME &"words"& within the header text, but does no
10057 character set translation. If decoding of what looks superficially like a MIME
10058 &"word"& fails, the raw string is returned. If decoding
10059 .cindex "binary zero" "in header line"
10060 produces a binary zero character, it is replaced by a question mark &-- this is
10061 what Exim does for binary zeros that are actually received in header lines.
10062
10063 .next
10064 &%header%& tries to translate the string as decoded by &%bheader%& to a
10065 standard character set. This is an attempt to produce the same string as would
10066 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10067 returned. Translation is attempted only on operating systems that support the
10068 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10069 a system Makefile or in &_Local/Makefile_&.
10070 .endlist ilist
10071
10072 In a filter file, the target character set for &%header%& can be specified by a
10073 command of the following form:
10074 .code
10075 headers charset "UTF-8"
10076 .endd
10077 This command affects all references to &$h_$& (or &$header_$&) expansions in
10078 subsequently obeyed filter commands. In the absence of this command, the target
10079 character set in a filter is taken from the setting of the &%headers_charset%&
10080 option in the runtime configuration. The value of this option defaults to the
10081 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10082 ISO-8859-1.
10083
10084 Header names follow the syntax of RFC 2822, which states that they may contain
10085 any printing characters except space and colon. Consequently, curly brackets
10086 &'do not'& terminate header names, and should not be used to enclose them as
10087 if they were variables. Attempting to do so causes a syntax error.
10088
10089 Only header lines that are common to all copies of a message are visible to
10090 this mechanism. These are the original header lines that are received with the
10091 message, and any that are added by an ACL statement or by a system
10092 filter. Header lines that are added to a particular copy of a message by a
10093 router or transport are not accessible.
10094
10095 For incoming SMTP messages, no header lines are visible in
10096 ACLs that are obeyed before the data phase completes,
10097 because the header structure is not set up until the message is received.
10098 They are visible in DKIM, PRDR and DATA ACLs.
10099 Header lines that are added in a RCPT ACL (for example)
10100 are saved until the message's incoming header lines are available, at which
10101 point they are added.
10102 When any of the above ACLs are
10103 running, however, header lines added by earlier ACLs are visible.
10104
10105 Upper case and lower case letters are synonymous in header names. If the
10106 following character is white space, the terminating colon may be omitted, but
10107 this is not recommended, because you may then forget it when it is needed. When
10108 white space terminates the header name, this white space is included in the
10109 expanded string.  If the message does not contain the given header, the
10110 expansion item is replaced by an empty string. (See the &%def%& condition in
10111 section &<<SECTexpcond>>& for a means of testing for the existence of a
10112 header.)
10113
10114 If there is more than one header with the same name, they are all concatenated
10115 to form the substitution string, up to a maximum length of 64K. Unless
10116 &%rheader%& is being used, leading and trailing white space is removed from
10117 each header before concatenation, and a completely empty header is ignored. A
10118 newline character is then inserted between non-empty headers, but there is no
10119 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10120 those headers that contain lists of addresses, a comma is also inserted at the
10121 junctions between headers. This does not happen for the &%rheader%& expansion.
10122
10123 .cindex "tainted data" "message headers"
10124 When the headers are from an incoming message,
10125 the result of expanding any of these variables is tainted.
10126
10127
10128 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10129 .cindex "expansion" "hmac hashing"
10130 .cindex &%hmac%&
10131 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10132 shared secret and some text into a message authentication code, as specified in
10133 RFC 2104. This differs from &`${md5:secret_text...}`& or
10134 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10135 cryptographic hash, allowing for authentication that is not possible with MD5
10136 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10137 present. For example:
10138 .code
10139 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10140 .endd
10141 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10142 produces:
10143 .code
10144 dd97e3ba5d1a61b5006108f8c8252953
10145 .endd
10146 As an example of how this might be used, you might put in the main part of
10147 an Exim configuration:
10148 .code
10149 SPAMSCAN_SECRET=cohgheeLei2thahw
10150 .endd
10151 In a router or a transport you could then have:
10152 .code
10153 headers_add = \
10154   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10155   ${hmac{md5}{SPAMSCAN_SECRET}\
10156   {${primary_hostname},${message_exim_id},$h_message-id:}}
10157 .endd
10158 Then given a message, you can check where it was scanned by looking at the
10159 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10160 this header line is authentic by recomputing the authentication code from the
10161 host name, message ID and the &'Message-id:'& header line. This can be done
10162 using Exim's &%-be%& option, or by other means, for example, by using the
10163 &'hmac_md5_hex()'& function in Perl.
10164
10165
10166 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10167 .cindex "expansion" "conditional"
10168 .cindex "&%if%&, expansion item"
10169 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10170 item; otherwise <&'string2'&> is used. The available conditions are described
10171 in section &<<SECTexpcond>>& below. For example:
10172 .code
10173 ${if eq {$local_part}{postmaster} {yes}{no} }
10174 .endd
10175 The second string need not be present; if it is not and the condition is not
10176 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10177 be present instead of the second string (without any curly brackets). In this
10178 case, the expansion is forced to fail if the condition is not true (see section
10179 &<<SECTforexpfai>>&).
10180
10181 If both strings are omitted, the result is the string &`true`& if the condition
10182 is true, and the empty string if the condition is false. This makes it less
10183 cumbersome to write custom ACL and router conditions. For example, instead of
10184 .code
10185 condition = ${if >{$acl_m4}{3}{true}{false}}
10186 .endd
10187 you can use
10188 .code
10189 condition = ${if >{$acl_m4}{3}}
10190 .endd
10191
10192
10193
10194 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10195 .cindex expansion "imap folder"
10196 .cindex "&%imapfolder%& expansion item"
10197 This item converts a (possibly multilevel, or with non-ASCII characters)
10198 folder specification to a Maildir name for filesystem use.
10199 For information on internationalisation support see &<<SECTi18nMDA>>&.
10200
10201
10202
10203 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10204 .cindex "expansion" "string truncation"
10205 .cindex "&%length%& expansion item"
10206 The &%length%& item is used to extract the initial portion of a string. Both
10207 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10208 you are using a fixed value for the number, that is, if <&'string1'&> does not
10209 change when expanded, you can use the simpler operator notation that avoids
10210 some of the braces:
10211 .code
10212 ${length_<n>:<string>}
10213 .endd
10214 The result of this item is either the first <&'n'&> bytes or the whole
10215 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10216 &%strlen%&, which gives the length of a string.
10217 All measurement is done in bytes and is not UTF-8 aware.
10218
10219
10220 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10221         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10222 .cindex "expansion" "extracting list elements by number"
10223 .cindex "&%listextract%&" "extract list elements by number"
10224 .cindex "list" "extracting elements by number"
10225 The <&'number'&> argument must consist entirely of decimal digits,
10226 apart from an optional leading minus,
10227 and leading and trailing white space (which is ignored).
10228
10229 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10230 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10231
10232 The first field of the list is numbered one.
10233 If the number is negative, the fields are
10234 counted from the end of the list, with the rightmost one numbered -1.
10235 The numbered element of the list is extracted and placed in &$value$&,
10236 then <&'string2'&> is expanded as the result.
10237
10238 If the modulus of the
10239 number is zero or greater than the number of fields in the string,
10240 the result is the expansion of <&'string3'&>.
10241
10242 For example:
10243 .code
10244 ${listextract{2}{x:42:99}}
10245 .endd
10246 yields &"42"&, and
10247 .code
10248 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10249 .endd
10250 yields &"result: 42"&.
10251
10252 If {<&'string3'&>} is omitted, an empty string is used for string3.
10253 If {<&'string2'&>} is also omitted, the value that was
10254 extracted is used.
10255 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10256
10257
10258 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10259 .cindex quoting "for list"
10260 .cindex list quoting
10261 This item doubles any occurrence of the separator character
10262 in the given string.
10263 An empty string is replaced with a single space.
10264 This converts the string into a safe form for use as a list element,
10265 in a list using the given separator.
10266
10267
10268 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10269         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10270        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10271         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10272 .cindex "expansion" "lookup in"
10273 .cindex "file" "lookups"
10274 .cindex "lookup" "in expanded string"
10275 The two forms of lookup item specify data lookups in files and databases, as
10276 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10277 lookups, and the second is used for query-style lookups. The <&'key'&>,
10278 <&'file'&>, and <&'query'&> strings are expanded before use.
10279
10280 If there is any white space in a lookup item which is part of a filter command,
10281 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10282 other place where white space is significant, the lookup item must be enclosed
10283 in double quotes. The use of data lookups in users' filter files may be locked
10284 out by the system administrator.
10285
10286 .vindex "&$value$&"
10287 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10288 During its expansion, the variable &$value$& contains the data returned by the
10289 lookup. Afterwards it reverts to the value it had previously (at the outer
10290 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10291 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10292 string on failure. If <&'string2'&> is provided, it can itself be a nested
10293 lookup, thus providing a mechanism for looking up a default value when the
10294 original lookup fails.
10295
10296 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10297 data for the outer lookup while the parameters of the second lookup are
10298 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10299 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10300 appear, and in this case, if the lookup fails, the entire expansion is forced
10301 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10302 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10303 successful lookup, and nothing in the case of failure.
10304
10305 For single-key lookups, the string &"partial"& is permitted to precede the
10306 search type in order to do partial matching, and * or *@ may follow a search
10307 type to request default lookups if the key does not match (see sections
10308 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10309
10310 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10311 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10312 and non-wild parts of the key during the expansion of the replacement text.
10313 They return to their previous values at the end of the lookup item.
10314
10315 This example looks up the postmaster alias in the conventional alias file:
10316 .code
10317 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10318 .endd
10319 This example uses NIS+ to look up the full name of the user corresponding to
10320 the local part of an address, forcing the expansion to fail if it is not found:
10321 .code
10322 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10323   {$value}fail}
10324 .endd
10325
10326
10327 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10328 .cindex "expansion" "list creation"
10329 .vindex "&$item$&"
10330 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10331 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10332 For each item
10333 in this list, its value is place in &$item$&, and then <&'string2'&> is
10334 expanded and added to the output as an item in a new list. The separator used
10335 for the output list is the same as the one used for the input, but a separator
10336 setting is not included in the output. For example:
10337 .code
10338 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10339 .endd
10340 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10341 value of &$item$& is restored to what it was before. See also the &%filter%&
10342 and &%reduce%& expansion items.
10343
10344 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10345 .cindex "expansion" "numeric hash"
10346 .cindex "hash function" "numeric"
10347 The three strings are expanded; the first two must yield numbers. Call them
10348 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10349 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10350 can use the simpler operator notation that avoids some of the braces:
10351 .code
10352 ${nhash_<n>_<m>:<string>}
10353 .endd
10354 The second number is optional (in both notations). If there is only one number,
10355 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10356 processed by a div/mod hash function that returns two numbers, separated by a
10357 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10358 example,
10359 .code
10360 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10361 .endd
10362 returns the string &"6/33"&.
10363
10364
10365
10366 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10367 .cindex "Perl" "use in expanded string"
10368 .cindex "expansion" "calling Perl from"
10369 This item is available only if Exim has been built to include an embedded Perl
10370 interpreter. The subroutine name and the arguments are first separately
10371 expanded, and then the Perl subroutine is called with those arguments. No
10372 additional arguments need be given; the maximum number permitted, including the
10373 name of the subroutine, is nine.
10374
10375 The return value of the subroutine is inserted into the expanded string, unless
10376 the return value is &%undef%&. In that case, the entire expansion is
10377 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10378 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10379 in a scalar context, thus the return value is a scalar.  For example, if you
10380 return a Perl vector, the return value is the size of the vector,
10381 not its contents.
10382
10383 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10384 with the error message that was passed to &%die%&. More details of the embedded
10385 Perl facility are given in chapter &<<CHAPperl>>&.
10386
10387 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10388 out the use of this expansion item in filter files.
10389
10390
10391 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10392 .cindex "&%prvs%& expansion item"
10393 The first argument is a complete email address and the second is secret
10394 keystring. The third argument, specifying a key number, is optional. If absent,
10395 it defaults to 0. The result of the expansion is a prvs-signed email address,
10396 to be typically used with the &%return_path%& option on an &(smtp)& transport
10397 as part of a bounce address tag validation (BATV) scheme. For more discussion
10398 and an example, see section &<<SECTverifyPRVS>>&.
10399
10400 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10401         {*&<&'string'&>&*}}*&"
10402 .cindex "&%prvscheck%& expansion item"
10403 This expansion item is the complement of the &%prvs%& item. It is used for
10404 checking prvs-signed addresses. If the expansion of the first argument does not
10405 yield a syntactically valid prvs-signed address, the whole item expands to the
10406 empty string. When the first argument does expand to a syntactically valid
10407 prvs-signed address, the second argument is expanded, with the prvs-decoded
10408 version of the address and the key number extracted from the address in the
10409 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10410
10411 These two variables can be used in the expansion of the second argument to
10412 retrieve the secret. The validity of the prvs-signed address is then checked
10413 against the secret. The result is stored in the variable &$prvscheck_result$&,
10414 which is empty for failure or &"1"& for success.
10415
10416 The third argument is optional; if it is missing, it defaults to an empty
10417 string. This argument is now expanded. If the result is an empty string, the
10418 result of the expansion is the decoded version of the address. This is the case
10419 whether or not the signature was valid. Otherwise, the result of the expansion
10420 is the expansion of the third argument.
10421
10422 All three variables can be used in the expansion of the third argument.
10423 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10424 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10425
10426 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10427 .cindex "expansion" "inserting an entire file"
10428 .cindex "file" "inserting into expansion"
10429 .cindex "&%readfile%& expansion item"
10430 The filename and end-of-line (eol) string are first expanded separately. The file is
10431 then read, and its contents replace the entire item. All newline characters in
10432 the file are replaced by the end-of-line string if it is present. Otherwise,
10433 newlines are left in the string.
10434 String expansion is not applied to the contents of the file. If you want this,
10435 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10436 the string expansion fails.
10437
10438 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10439 locks out the use of this expansion item in filter files.
10440
10441
10442
10443 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10444         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10445 .cindex "expansion" "inserting from a socket"
10446 .cindex "socket, use of in expansion"
10447 .cindex "&%readsocket%& expansion item"
10448 This item inserts data from a Unix domain or TCP socket into the expanded
10449 string. The minimal way of using it uses just two arguments, as in these
10450 examples:
10451 .code
10452 ${readsocket{/socket/name}{request string}}
10453 ${readsocket{inet:some.host:1234}{request string}}
10454 .endd
10455 For a Unix domain socket, the first substring must be the path to the socket.
10456 For an Internet socket, the first substring must contain &`inet:`& followed by
10457 a host name or IP address, followed by a colon and a port, which can be a
10458 number or the name of a TCP port in &_/etc/services_&. An IP address may
10459 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10460 example:
10461 .code
10462 ${readsocket{inet:[::1]:1234}{request string}}
10463 .endd
10464 Only a single host name may be given, but if looking it up yields more than
10465 one IP address, they are each tried in turn until a connection is made. For
10466 both kinds of socket, Exim makes a connection, writes the request string
10467 (unless it is an empty string; no terminating NUL is ever sent)
10468 and reads from the socket until an end-of-file
10469 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10470 extend what can be done. Firstly, you can vary the timeout. For example:
10471 .code
10472 ${readsocket{/socket/name}{request string}{3s}}
10473 .endd
10474
10475 The third argument is a list of options, of which the first element is the timeout
10476 and must be present if any options are given.
10477 Further elements are options of form &'name=value'&.
10478 Example:
10479 .code
10480 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10481 .endd
10482
10483 The following option names are recognised:
10484 .ilist
10485 &*cache*&
10486 Defines if the result data can be cached for use by a later identical
10487 request in the same process.
10488 Values are &"yes"& or &"no"& (the default).
10489 If not, all cached results for this connection specification
10490 will be invalidated.
10491
10492 .next
10493 &*shutdown*&
10494 Defines whether or not a write-shutdown is done on the connection after
10495 sending the request. Values are &"yes"& (the default) or &"no"&
10496 (preferred, eg. by some webservers).
10497
10498 .next
10499 &*sni*&
10500 Controls the use of Server Name Identification on the connection.
10501 Any nonempty value will be the SNI sent; TLS will be forced.
10502
10503 .next
10504 &*tls*&
10505 Controls the use of TLS on the connection.
10506 Values are &"yes"& or &"no"& (the default).
10507 If it is enabled, a shutdown as described above is never done.
10508 .endlist
10509
10510
10511 A fourth argument allows you to change any newlines that are in the data
10512 that is read, in the same way as for &%readfile%& (see above). This example
10513 turns them into spaces:
10514 .code
10515 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10516 .endd
10517 As with all expansions, the substrings are expanded before the processing
10518 happens. Errors in these sub-expansions cause the expansion to fail. In
10519 addition, the following errors can occur:
10520
10521 .ilist
10522 Failure to create a socket file descriptor;
10523 .next
10524 Failure to connect the socket;
10525 .next
10526 Failure to write the request string;
10527 .next
10528 Timeout on reading from the socket.
10529 .endlist
10530
10531 By default, any of these errors causes the expansion to fail. However, if
10532 you supply a fifth substring, it is expanded and used when any of the above
10533 errors occurs. For example:
10534 .code
10535 ${readsocket{/socket/name}{request string}{3s}{\n}\
10536   {socket failure}}
10537 .endd
10538 You can test for the existence of a Unix domain socket by wrapping this
10539 expansion in &`${if exists`&, but there is a race condition between that test
10540 and the actual opening of the socket, so it is safer to use the fifth argument
10541 if you want to be absolutely sure of avoiding an expansion error for a
10542 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10543
10544 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10545 locks out the use of this expansion item in filter files.
10546
10547
10548 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10549 .cindex "expansion" "reducing a list to a scalar"
10550 .cindex "list" "reducing to a scalar"
10551 .vindex "&$value$&"
10552 .vindex "&$item$&"
10553 This operation reduces a list to a single, scalar string. After expansion,
10554 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10555 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10556 Then <&'string2'&> is expanded and
10557 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10558 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10559 them. The result of that expansion is assigned to &$value$& before the next
10560 iteration. When the end of the list is reached, the final value of &$value$& is
10561 added to the expansion output. The &%reduce%& expansion item can be used in a
10562 number of ways. For example, to add up a list of numbers:
10563 .code
10564 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10565 .endd
10566 The result of that expansion would be &`6`&. The maximum of a list of numbers
10567 can be found:
10568 .code
10569 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10570 .endd
10571 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10572 restored to what they were before. See also the &%filter%& and &%map%&
10573 expansion items.
10574
10575 . A bit of a special-case logic error in writing an expansion;
10576 . probably not worth including in the mainline of documentation.
10577 . If only we had footnotes (the html output variant is the problem).
10578 .
10579 . .new
10580 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10581 . and that condition modifies &$value$&,
10582 . then the string expansions dependent on the condition cannot use
10583 . the &$value$& of the reduce iteration.
10584 . .wen
10585
10586 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10587 This item inserts &"raw"& header lines. It is described with the &%header%&
10588 expansion item in section &<<SECTexpansionitems>>& above.
10589
10590 .vitem "&*${run<&'options'&> {*&<&'command&~arg&~list'&>&*}{*&<&'string1'&>&*}&&&
10591         {*&<&'string2'&>&*}}*&"
10592 .cindex "expansion" "running a command"
10593 .cindex "&%run%& expansion item"
10594 This item runs an external command, as a subprocess.
10595 One option is supported after the word &'run'&, comma-separated
10596 and without whitespace.
10597
10598 If the option &'preexpand'& is not used,
10599 the command string is split into individual arguments by spaces
10600 and then each argument is expanded.
10601 Then the command is run
10602 in a separate process, but under the same uid and gid.  As in other command
10603 executions from Exim, a shell is not used by default. If the command requires
10604 a shell, you must explicitly code it.
10605 The command name may not be tainted, but the remaining arguments can be.
10606
10607 &*Note*&: if tainted arguments are used, they are supplied by a
10608 potential attacker;
10609 a careful assessment for security vulnerabilities should be done.
10610
10611 If the option &'preexpand'& is used,
10612 the command and its arguments are first expanded as one string. The result is
10613 split apart into individual arguments by spaces, and then the command is run
10614 as above.
10615 Since the arguments are split by spaces, when there is a variable expansion
10616 which has an empty result, it will cause the situation that the argument will
10617 simply be omitted when the program is actually executed by Exim. If the
10618 script/program requires a specific number of arguments and the expanded
10619 variable could possibly result in this empty expansion, the variable must be
10620 quoted. This is more difficult if the expanded variable itself could result
10621 in a string containing quotes, because it would interfere with the quotes
10622 around the command arguments. A possible guard against this is to wrap the
10623 variable in the &%sg%& operator to change any quote marks to some other
10624 character.
10625 Neither the command nor any argument may be tainted.
10626
10627 The standard input for the command exists, but is empty. The standard output
10628 and standard error are set to the same file descriptor.
10629 .cindex "return code" "from &%run%& expansion"
10630 .vindex "&$value$&"
10631 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10632 and replaces the entire item; during this expansion, the standard output/error
10633 from the command is in the variable &$value$&. If the command fails,
10634 <&'string2'&>, if present, is expanded and used. Once again, during the
10635 expansion, the standard output/error from the command is in the variable
10636 &$value$&.
10637
10638 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10639 can be the word &"fail"& (not in braces) to force expansion failure if the
10640 command does not succeed. If both strings are omitted, the result is contents
10641 of the standard output/error on success, and nothing on failure.
10642
10643 .vindex "&$run_in_acl$&"
10644 The standard output/error of the command is put in the variable &$value$&.
10645 In this ACL example, the output of a command is logged for the admin to
10646 troubleshoot:
10647 .code
10648 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10649       log_message  = Output of id: $value
10650 .endd
10651 If the command requires shell idioms, such as the > redirect operator, the
10652 shell must be invoked directly, such as with:
10653 .code
10654 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10655 .endd
10656
10657 .vindex "&$runrc$&"
10658 The return code from the command is put in the variable &$runrc$&, and this
10659 remains set afterwards, so in a filter file you can do things like this:
10660 .code
10661 if "${run{x y z}{}}$runrc" is 1 then ...
10662   elif $runrc is 2 then ...
10663   ...
10664 endif
10665 .endd
10666 If execution of the command fails (for example, the command does not exist),
10667 the return code is 127 &-- the same code that shells use for non-existent
10668 commands.
10669
10670 &*Warning*&: In a router or transport, you cannot assume the order in which
10671 option values are expanded, except for those preconditions whose order of
10672 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10673 by the expansion of one option, and use it in another.
10674
10675 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10676 out the use of this expansion item in filter files.
10677
10678
10679 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10680 .cindex "expansion" "string substitution"
10681 .cindex "&%sg%& expansion item"
10682 This item works like Perl's substitution operator (s) with the global (/g)
10683 option; hence its name. However, unlike the Perl equivalent, Exim does not
10684 modify the subject string; instead it returns the modified string for insertion
10685 into the overall expansion. The item takes three arguments: the subject string,
10686 a regular expression, and a substitution string. For example:
10687 .code
10688 ${sg{abcdefabcdef}{abc}{xyz}}
10689 .endd
10690 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10691 if any $, } or \ characters are required in the regular expression or in the
10692 substitution string, they have to be escaped. For example:
10693 .code
10694 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10695 .endd
10696 yields &"defabc"&, and
10697 .code
10698 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10699 .endd
10700 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10701 the regular expression from string expansion.
10702
10703 The regular expression is compiled in 8-bit mode, working against bytes
10704 rather than any Unicode-aware character handling.
10705
10706
10707 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10708 .cindex sorting "a list"
10709 .cindex list sorting
10710 .cindex expansion "list sorting"
10711 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10712 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10713 The <&'comparator'&> argument is interpreted as the operator
10714 of a two-argument expansion condition.
10715 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10716 The comparison should return true when applied to two values
10717 if the first value should sort before the second value.
10718 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10719 the element being placed in &$item$&,
10720 to give values for comparison.
10721
10722 The item result is a sorted list,
10723 with the original list separator,
10724 of the list elements (in full) of the original.
10725
10726 Examples:
10727 .code
10728 ${sort{3:2:1:4}{<}{$item}}
10729 .endd
10730 sorts a list of numbers, and
10731 .code
10732 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10733 .endd
10734 will sort an MX lookup into priority order.
10735
10736
10737
10738 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10739 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10740
10741
10742
10743 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10744 .cindex "&%substr%& expansion item"
10745 .cindex "substring extraction"
10746 .cindex "expansion" "substring extraction"
10747 The three strings are expanded; the first two must yield numbers. Call them
10748 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10749 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10750 can use the simpler operator notation that avoids some of the braces:
10751 .code
10752 ${substr_<n>_<m>:<subject>}
10753 .endd
10754 The second number is optional (in both notations).
10755 If it is absent in the simpler format, the preceding underscore must also be
10756 omitted.
10757
10758 The &%substr%& item can be used to extract more general substrings than
10759 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10760 length required. For example
10761 .code
10762 ${substr{3}{2}{$local_part}}
10763 .endd
10764 If the starting offset is greater than the string length the result is the
10765 null string; if the length plus starting offset is greater than the string
10766 length, the result is the right-hand part of the string, starting from the
10767 given offset. The first byte (character) in the string has offset zero.
10768
10769 The &%substr%& expansion item can take negative offset values to count
10770 from the right-hand end of its operand. The last byte (character) is offset -1,
10771 the second-last is offset -2, and so on. Thus, for example,
10772 .code
10773 ${substr{-5}{2}{1234567}}
10774 .endd
10775 yields &"34"&. If the absolute value of a negative offset is greater than the
10776 length of the string, the substring starts at the beginning of the string, and
10777 the length is reduced by the amount of overshoot. Thus, for example,
10778 .code
10779 ${substr{-5}{2}{12}}
10780 .endd
10781 yields an empty string, but
10782 .code
10783 ${substr{-3}{2}{12}}
10784 .endd
10785 yields &"1"&.
10786
10787 When the second number is omitted from &%substr%&, the remainder of the string
10788 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10789 string preceding the offset point are taken. For example, an offset of -1 and
10790 no length, as in these semantically identical examples:
10791 .code
10792 ${substr_-1:abcde}
10793 ${substr{-1}{abcde}}
10794 .endd
10795 yields all but the last character of the string, that is, &"abcd"&.
10796
10797 All measurement is done in bytes and is not UTF-8 aware.
10798
10799
10800
10801 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10802         {*&<&'replacements'&>&*}}*&"
10803 .cindex "expansion" "character translation"
10804 .cindex "&%tr%& expansion item"
10805 This item does single-character (in bytes) translation on its subject string. The second
10806 argument is a list of characters to be translated in the subject string. Each
10807 matching character is replaced by the corresponding character from the
10808 replacement list. For example
10809 .code
10810 ${tr{abcdea}{ac}{13}}
10811 .endd
10812 yields &`1b3de1`&. If there are duplicates in the second character string, the
10813 last occurrence is used. If the third string is shorter than the second, its
10814 last character is replicated. However, if it is empty, no translation takes
10815 place.
10816
10817 All character handling is done in bytes and is not UTF-8 aware.
10818
10819 .endlist
10820
10821
10822
10823 .section "Expansion operators" "SECTexpop"
10824 .cindex "expansion" "operators"
10825 For expansion items that perform transformations on a single argument string,
10826 the &"operator"& notation is used because it is simpler and uses fewer braces.
10827 The substring is first expanded before the operation is applied to it. The
10828 following operations can be performed:
10829
10830 .vlist
10831 .vitem &*${address:*&<&'string'&>&*}*&
10832 .cindex "expansion" "RFC 2822 address handling"
10833 .cindex "&%address%& expansion item"
10834 The string is interpreted as an RFC 2822 address, as it might appear in a
10835 header line, and the effective address is extracted from it. If the string does
10836 not parse successfully, the result is empty.
10837
10838 The parsing correctly handles SMTPUTF8 Unicode in the string.
10839
10840
10841 .vitem &*${addresses:*&<&'string'&>&*}*&
10842 .cindex "expansion" "RFC 2822 address handling"
10843 .cindex "&%addresses%& expansion item"
10844 The string (after expansion) is interpreted as a list of addresses in RFC
10845 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10846 operative address (&'local-part@domain'&) is extracted from each item, and the
10847 result of the expansion is a colon-separated list, with appropriate
10848 doubling of colons should any happen to be present in the email addresses.
10849 Syntactically invalid RFC2822 address items are omitted from the output.
10850
10851 It is possible to specify a character other than colon for the output
10852 separator by starting the string with > followed by the new separator
10853 character. For example:
10854 .code
10855 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10856 .endd
10857 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10858 first, so if the expanded string starts with >, it may change the output
10859 separator unintentionally. This can be avoided by setting the output
10860 separator explicitly:
10861 .code
10862 ${addresses:>:$h_from:}
10863 .endd
10864
10865 Compare the &%address%& (singular)
10866 expansion item, which extracts the working address from a single RFC2822
10867 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10868 processing lists.
10869
10870 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10871 a strict interpretation of header line formatting.  Exim parses the bare,
10872 unquoted portion of an email address and if it finds a comma, treats it as an
10873 email address separator. For the example header line:
10874 .code
10875 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10876 .endd
10877 The first example below demonstrates that Q-encoded email addresses are parsed
10878 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10879 It does not see the comma because it's still encoded as "=2C".  The second
10880 example below is passed the contents of &`$header_from:`&, meaning it gets
10881 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10882 The third example shows that the presence of a comma is skipped when it is
10883 quoted.  The fourth example shows SMTPUTF8 handling.
10884 .code
10885 # exim -be '${addresses:From: \
10886 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10887 user@example.com
10888 # exim -be '${addresses:From: Last, First <user@example.com>}'
10889 Last:user@example.com
10890 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10891 user@example.com
10892 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10893 フィリップ@example.jp
10894 .endd
10895
10896 .vitem &*${base32:*&<&'digits'&>&*}*&
10897 .cindex "&%base32%& expansion item"
10898 .cindex "expansion" "conversion to base 32"
10899 The string must consist entirely of decimal digits. The number is converted to
10900 base 32 and output as a (empty, for zero) string of characters.
10901 Only lowercase letters are used.
10902
10903 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10904 .cindex "&%base32d%& expansion item"
10905 .cindex "expansion" "conversion to base 32"
10906 The string must consist entirely of base-32 digits.
10907 The number is converted to decimal and output as a string.
10908
10909 .vitem &*${base62:*&<&'digits'&>&*}*&
10910 .cindex "&%base62%& expansion item"
10911 .cindex "expansion" "conversion to base 62"
10912 The string must consist entirely of decimal digits. The number is converted to
10913 base 62 and output as a string of six characters, including leading zeros. In
10914 the few operating environments where Exim uses base 36 instead of base 62 for
10915 its message identifiers (because those systems do not have case-sensitive
10916 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10917 to be absolutely clear: this is &'not'& base64 encoding.
10918
10919 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10920 .cindex "&%base62d%& expansion item"
10921 .cindex "expansion" "conversion to base 62"
10922 The string must consist entirely of base-62 digits, or, in operating
10923 environments where Exim uses base 36 instead of base 62 for its message
10924 identifiers, base-36 digits. The number is converted to decimal and output as a
10925 string.
10926
10927 .vitem &*${base64:*&<&'string'&>&*}*&
10928 .cindex "expansion" "base64 encoding"
10929 .cindex "base64 encoding" "in string expansion"
10930 .cindex "&%base64%& expansion item"
10931 .cindex certificate "base64 of DER"
10932 This operator converts a string into one that is base64 encoded.
10933
10934 If the string is a single variable of type certificate,
10935 returns the base64 encoding of the DER form of the certificate.
10936
10937
10938 .vitem &*${base64d:*&<&'string'&>&*}*&
10939 .cindex "expansion" "base64 decoding"
10940 .cindex "base64 decoding" "in string expansion"
10941 .cindex "&%base64d%& expansion item"
10942 This operator converts a base64-encoded string into the un-coded form.
10943
10944
10945 .vitem &*${domain:*&<&'string'&>&*}*&
10946 .cindex "domain" "extraction"
10947 .cindex "expansion" "domain extraction"
10948 The string is interpreted as an RFC 2822 address and the domain is extracted
10949 from it. If the string does not parse successfully, the result is empty.
10950
10951
10952 .vitem &*${escape:*&<&'string'&>&*}*&
10953 .cindex "expansion" "escaping non-printing characters"
10954 .cindex "&%escape%& expansion item"
10955 If the string contains any non-printing characters, they are converted to
10956 escape sequences starting with a backslash. Whether characters with the most
10957 significant bit set (so-called &"8-bit characters"&) count as printing or not
10958 is controlled by the &%print_topbitchars%& option.
10959
10960 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10961 .cindex "expansion" "escaping 8-bit characters"
10962 .cindex "&%escape8bit%& expansion item"
10963 If the string contains any characters with the most significant bit set,
10964 they are converted to escape sequences starting with a backslash.
10965 Backslashes and DEL characters are also converted.
10966
10967
10968 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10969 .cindex "expansion" "expression evaluation"
10970 .cindex "expansion" "arithmetic expression"
10971 .cindex "&%eval%& expansion item"
10972 These items supports simple arithmetic and bitwise logical operations in
10973 expansion strings. The string (after expansion) must be a conventional
10974 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10975 logical operators, and parentheses. All operations are carried out using
10976 integer arithmetic. The operator priorities are as follows (the same as in the
10977 C programming language):
10978 .table2 70pt 300pt
10979 .irow &'highest:'& "not (~), negate (-)"
10980 .irow ""   "multiply (*), divide (/), remainder (%)"
10981 .irow ""   "plus (+), minus (-)"
10982 .irow ""   "shift-left (<<), shift-right (>>)"
10983 .irow ""   "and (&&)"
10984 .irow ""   "xor (^)"
10985 .irow &'lowest:'&  "or (|)"
10986 .endtable
10987 Binary operators with the same priority are evaluated from left to right. White
10988 space is permitted before or after operators.
10989
10990 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10991 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10992 decimal, even if they start with a leading zero; hexadecimal numbers are not
10993 permitted. This can be useful when processing numbers extracted from dates or
10994 times, which often do have leading zeros.
10995
10996 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10997 or 1024*1024*1024,
10998 respectively. Negative numbers are supported. The result of the computation is
10999 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11000
11001 .display
11002 &`${eval:1+1}            `&  yields 2
11003 &`${eval:1+2*3}          `&  yields 7
11004 &`${eval:(1+2)*3}        `&  yields 9
11005 &`${eval:2+42%5}         `&  yields 4
11006 &`${eval:0xc&amp;5}          `&  yields 4
11007 &`${eval:0xc|5}          `&  yields 13
11008 &`${eval:0xc^5}          `&  yields 9
11009 &`${eval:0xc>>1}         `&  yields 6
11010 &`${eval:0xc<<1}         `&  yields 24
11011 &`${eval:~255&amp;0x1234}    `&  yields 4608
11012 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11013 .endd
11014
11015 As a more realistic example, in an ACL you might have
11016 .code
11017 deny   condition =                    \
11018          ${if and {                   \
11019            {>{$rcpt_count}{10}}       \
11020            {                          \
11021            <                          \
11022              {$recipients_count}      \
11023              {${eval:$rcpt_count/2}}  \
11024            }                          \
11025          }{yes}{no}}
11026        message = Too many bad recipients
11027 .endd
11028 The condition is true if there have been more than 10 RCPT commands and
11029 fewer than half of them have resulted in a valid recipient.
11030
11031
11032 .vitem &*${expand:*&<&'string'&>&*}*&
11033 .cindex "expansion" "re-expansion of substring"
11034 The &%expand%& operator causes a string to be expanded for a second time. For
11035 example,
11036 .code
11037 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11038 .endd
11039 first looks up a string in a file while expanding the operand for &%expand%&,
11040 and then re-expands what it has found.
11041
11042
11043 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11044 .cindex "Unicode"
11045 .cindex "UTF-8" "conversion from"
11046 .cindex "expansion" "UTF-8 conversion"
11047 .cindex "&%from_utf8%& expansion item"
11048 The world is slowly moving towards Unicode, although there are no standards for
11049 email yet. However, other applications (including some databases) are starting
11050 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11051 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11052 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11053 the result is an undefined sequence of bytes.
11054
11055 Unicode code points with values less than 256 are compatible with ASCII and
11056 ISO-8859-1 (also known as Latin-1).
11057 For example, character 169 is the copyright symbol in both cases, though the
11058 way it is encoded is different. In UTF-8, more than one byte is needed for
11059 characters with code values greater than 127, whereas ISO-8859-1 is a
11060 single-byte encoding (but thereby limited to 256 characters). This makes
11061 translation from UTF-8 to ISO-8859-1 straightforward.
11062
11063
11064 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11065 .cindex "hash function" "textual"
11066 .cindex "expansion" "textual hash"
11067 The &%hash%& operator is a simpler interface to the hashing function that can
11068 be used when the two parameters are fixed numbers (as opposed to strings that
11069 change when expanded). The effect is the same as
11070 .code
11071 ${hash{<n>}{<m>}{<string>}}
11072 .endd
11073 See the description of the general &%hash%& item above for details. The
11074 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11075
11076
11077
11078 .new
11079 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11080 .cindex header "wrapping operator"
11081 .cindex expansion "header wrapping"
11082 This operator line-wraps its argument in a way useful for headers.
11083 The &'cols'& value gives the column number to wrap after,
11084 the &'limit'& gives a limit number of result characters to truncate at.
11085 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11086 the defaults are 80 and 998.
11087 Wrapping will be inserted at a space if possible before the
11088 column number is reached.
11089 Whitespace at a chosen wrap point is removed.
11090 A line-wrap consists of a newline followed by a tab,
11091 and the tab is counted as 8 columns.
11092 .wen
11093
11094
11095
11096 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11097 .cindex "base64 encoding" "conversion from hex"
11098 .cindex "expansion" "hex to base64"
11099 .cindex "&%hex2b64%& expansion item"
11100 This operator converts a hex string into one that is base64 encoded. This can
11101 be useful for processing the output of the various hashing functions.
11102
11103
11104
11105 .vitem &*${hexquote:*&<&'string'&>&*}*&
11106 .cindex "quoting" "hex-encoded unprintable characters"
11107 .cindex "&%hexquote%& expansion item"
11108 This operator converts non-printable characters in a string into a hex
11109 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11110 as is, and other byte values are converted to &`\xNN`&, for example, a
11111 byte value 127 is converted to &`\x7f`&.
11112
11113
11114 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11115 .cindex "&%ipv6denorm%& expansion item"
11116 .cindex "IP address" normalisation
11117 This expands an IPv6 address to a full eight-element colon-separated set
11118 of hex digits including leading zeroes.
11119 A trailing ipv4-style dotted-decimal set is converted to hex.
11120 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11121
11122 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11123 .cindex "&%ipv6norm%& expansion item"
11124 .cindex "IP address" normalisation
11125 .cindex "IP address" "canonical form"
11126 This converts an IPv6 address to canonical form.
11127 Leading zeroes of groups are omitted, and the longest
11128 set of zero-valued groups is replaced with a double colon.
11129 A trailing ipv4-style dotted-decimal set is converted to hex.
11130 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11131
11132
11133 .vitem &*${lc:*&<&'string'&>&*}*&
11134 .cindex "case forcing in strings"
11135 .cindex "string" "case forcing"
11136 .cindex "lower casing"
11137 .cindex "expansion" "case forcing"
11138 .cindex "&%lc%& expansion item"
11139 This forces the letters in the string into lower-case, for example:
11140 .code
11141 ${lc:$local_part}
11142 .endd
11143 Case is defined per the system C locale.
11144
11145 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11146 .cindex "expansion" "string truncation"
11147 .cindex "&%length%& expansion item"
11148 The &%length%& operator is a simpler interface to the &%length%& function that
11149 can be used when the parameter is a fixed number (as opposed to a string that
11150 changes when expanded). The effect is the same as
11151 .code
11152 ${length{<number>}{<string>}}
11153 .endd
11154 See the description of the general &%length%& item above for details. Note that
11155 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11156 when &%length%& is used as an operator.
11157 All measurement is done in bytes and is not UTF-8 aware.
11158
11159
11160 .vitem &*${listcount:*&<&'string'&>&*}*&
11161 .cindex "expansion" "list item count"
11162 .cindex "list" "item count"
11163 .cindex "list" "count of items"
11164 .cindex "&%listcount%& expansion item"
11165 The string is interpreted as a list and the number of items is returned.
11166
11167
11168 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11169 .cindex "expansion" "named list"
11170 .cindex "&%listnamed%& expansion item"
11171 The name is interpreted as a named list and the content of the list is returned,
11172 expanding any referenced lists, re-quoting as needed for colon-separation.
11173 If the optional type is given it must be one of "a", "d", "h" or "l"
11174 and selects address-, domain-, host- or localpart- lists to search among respectively.
11175 Otherwise all types are searched in an undefined order and the first
11176 matching list is returned.
11177 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11178 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11179
11180
11181 .vitem &*${local_part:*&<&'string'&>&*}*&
11182 .cindex "expansion" "local part extraction"
11183 .cindex "&%local_part%& expansion item"
11184 The string is interpreted as an RFC 2822 address and the local part is
11185 extracted from it. If the string does not parse successfully, the result is
11186 empty.
11187 The parsing correctly handles SMTPUTF8 Unicode in the string.
11188
11189
11190 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11191        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11192 .cindex "masked IP address"
11193 .cindex "IP address" "masking"
11194 .cindex "CIDR notation"
11195 .cindex "expansion" "IP address masking"
11196 .cindex "&%mask%& expansion item"
11197 If the form of the string to be operated on is not an IP address followed by a
11198 slash and an integer (that is, a network address in CIDR notation), the
11199 expansion fails. Otherwise, this operator converts the IP address to binary,
11200 masks off the least significant bits according to the bit count, and converts
11201 the result back to text, with mask appended. For example,
11202 .code
11203 ${mask:10.111.131.206/28}
11204 .endd
11205 returns the string &"10.111.131.192/28"&.
11206
11207 Since this operation is expected to
11208 be mostly used for looking up masked addresses in files, the
11209 normal
11210 result for an IPv6
11211 address uses dots to separate components instead of colons, because colon
11212 terminates a key string in lsearch files. So, for example,
11213 .code
11214 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11215 .endd
11216 returns the string
11217 .code
11218 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11219 .endd
11220 If the optional form &*mask_n*& is used, IPv6 address result are instead
11221 returned in normailsed form, using colons and with zero-compression.
11222 Letters in IPv6 addresses are always output in lower case.
11223
11224
11225 .vitem &*${md5:*&<&'string'&>&*}*&
11226 .cindex "MD5 hash"
11227 .cindex "expansion" "MD5 hash"
11228 .cindex certificate fingerprint
11229 .cindex "&%md5%& expansion item"
11230 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11231 as a 32-digit hexadecimal number, in which any letters are in lower case.
11232
11233 If the string is a single variable of type certificate,
11234 returns the MD5 hash fingerprint of the certificate.
11235
11236
11237 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11238 .cindex "expansion" "numeric hash"
11239 .cindex "hash function" "numeric"
11240 The &%nhash%& operator is a simpler interface to the numeric hashing function
11241 that can be used when the two parameters are fixed numbers (as opposed to
11242 strings that change when expanded). The effect is the same as
11243 .code
11244 ${nhash{<n>}{<m>}{<string>}}
11245 .endd
11246 See the description of the general &%nhash%& item above for details.
11247
11248
11249 .vitem &*${quote:*&<&'string'&>&*}*&
11250 .cindex "quoting" "in string expansions"
11251 .cindex "expansion" "quoting"
11252 .cindex "&%quote%& expansion item"
11253 The &%quote%& operator puts its argument into double quotes if it
11254 is an empty string or
11255 contains anything other than letters, digits, underscores, dots, and hyphens.
11256 Any occurrences of double quotes and backslashes are escaped with a backslash.
11257 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11258 respectively For example,
11259 .code
11260 ${quote:ab"*"cd}
11261 .endd
11262 becomes
11263 .code
11264 "ab\"*\"cd"
11265 .endd
11266 The place where this is useful is when the argument is a substitution from a
11267 variable or a message header.
11268
11269 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11270 .cindex "&%quote_local_part%& expansion item"
11271 This operator is like &%quote%&, except that it quotes the string only if
11272 required to do so by the rules of RFC 2822 for quoting local parts. For
11273 example, a plus sign would not cause quoting (but it would for &%quote%&).
11274 If you are creating a new email address from the contents of &$local_part$&
11275 (or any other unknown data), you should always use this operator.
11276
11277 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11278 will likely use the quoting form.
11279 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11280
11281
11282 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11283 .cindex "quoting" "lookup-specific"
11284 This operator applies lookup-specific quoting rules to the string. Each
11285 query-style lookup type has its own quoting rules which are described with
11286 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11287 .code
11288 ${quote_ldap:two * two}
11289 .endd
11290 returns
11291 .code
11292 two%20%5C2A%20two
11293 .endd
11294 For single-key lookup types, no quoting is ever necessary and this operator
11295 yields an unchanged string.
11296
11297
11298 .vitem &*${randint:*&<&'n'&>&*}*&
11299 .cindex "random number"
11300 This operator returns a somewhat random number which is less than the
11301 supplied number and is at least 0.  The quality of this randomness depends
11302 on how Exim was built; the values are not suitable for keying material.
11303 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11304 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11305 for versions of GnuTLS with that function.
11306 Otherwise, the implementation may be arc4random(), random() seeded by
11307 srandomdev() or srandom(), or a custom implementation even weaker than
11308 random().
11309
11310
11311 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11312 .cindex "expansion" "IP address"
11313 This operator reverses an IP address; for IPv4 addresses, the result is in
11314 dotted-quad decimal form, while for IPv6 addresses the result is in
11315 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11316 for DNS.  For example,
11317 .code
11318 ${reverse_ip:192.0.2.4}
11319 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11320 .endd
11321 returns
11322 .code
11323 4.2.0.192
11324 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
11325 .endd
11326
11327
11328 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11329 .cindex "expansion" "RFC 2047"
11330 .cindex "RFC 2047" "expansion operator"
11331 .cindex "&%rfc2047%& expansion item"
11332 This operator encodes text according to the rules of RFC 2047. This is an
11333 encoding that is used in header lines to encode non-ASCII characters. It is
11334 assumed that the input string is in the encoding specified by the
11335 &%headers_charset%& option, which gets its default at build time. If the string
11336 contains only characters in the range 33&--126, and no instances of the
11337 characters
11338 .code
11339 ? = ( ) < > @ , ; : \ " . [ ] _
11340 .endd
11341 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11342 string, using as many &"encoded words"& as necessary to encode all the
11343 characters.
11344
11345
11346 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11347 .cindex "expansion" "RFC 2047"
11348 .cindex "RFC 2047" "decoding"
11349 .cindex "&%rfc2047d%& expansion item"
11350 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11351 bytes are replaced by question marks. Characters are converted into the
11352 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11353 not recognized unless &%check_rfc2047_length%& is set false.
11354
11355 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11356 access a header line, RFC 2047 decoding is done automatically. You do not need
11357 to use this operator as well.
11358
11359
11360
11361 .vitem &*${rxquote:*&<&'string'&>&*}*&
11362 .cindex "quoting" "in regular expressions"
11363 .cindex "regular expressions" "quoting"
11364 .cindex "&%rxquote%& expansion item"
11365 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11366 characters in its argument. This is useful when substituting the values of
11367 variables or headers inside regular expressions.
11368
11369
11370 .vitem &*${sha1:*&<&'string'&>&*}*&
11371 .cindex "SHA-1 hash"
11372 .cindex "expansion" "SHA-1 hashing"
11373 .cindex certificate fingerprint
11374 .cindex "&%sha1%& expansion item"
11375 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11376 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11377
11378 If the string is a single variable of type certificate,
11379 returns the SHA-1 hash fingerprint of the certificate.
11380
11381
11382 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11383        &*${sha2:*&<&'string'&>&*}*& &&&
11384        &*${sha2_<n>:*&<&'string'&>&*}*&
11385 .cindex "SHA-256 hash"
11386 .cindex "SHA-2 hash"
11387 .cindex certificate fingerprint
11388 .cindex "expansion" "SHA-256 hashing"
11389 .cindex "&%sha256%& expansion item"
11390 .cindex "&%sha2%& expansion item"
11391 The &%sha256%& operator computes the SHA-256 hash value of the string
11392 and returns
11393 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11394
11395 If the string is a single variable of type certificate,
11396 returns the SHA-256 hash fingerprint of the certificate.
11397
11398 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11399 (except for certificates, which are not supported).
11400 Finally, if an underbar
11401 and a number is appended it specifies the output length, selecting a
11402 member of the SHA-2 family of hash functions.
11403 Values of 256, 384 and 512 are accepted, with 256 being the default.
11404
11405
11406 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11407        &*${sha3_<n>:*&<&'string'&>&*}*&
11408 .cindex "SHA3 hash"
11409 .cindex "expansion" "SHA3 hashing"
11410 .cindex "&%sha3%& expansion item"
11411 The &%sha3%& operator computes the SHA3-256 hash value of the string
11412 and returns
11413 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11414
11415 If a number is appended, separated by an underbar, it specifies
11416 the output length.  Values of 224, 256, 384 and 512 are accepted;
11417 with 256 being the default.
11418
11419 The &%sha3%& expansion item is only supported if Exim has been
11420 compiled with GnuTLS 3.5.0 or later,
11421 or OpenSSL 1.1.1 or later.
11422 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11423
11424
11425 .vitem &*${stat:*&<&'string'&>&*}*&
11426 .cindex "expansion" "statting a file"
11427 .cindex "file" "extracting characteristics"
11428 .cindex "&%stat%& expansion item"
11429 The string, after expansion, must be a file path. A call to the &[stat()]&
11430 function is made for this path. If &[stat()]& fails, an error occurs and the
11431 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11432 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11433 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11434 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11435 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11436 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11437 can extract individual fields using the &%extract%& expansion item.
11438
11439 The use of the &%stat%& expansion in users' filter files can be locked out by
11440 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11441 systems for files larger than 2GB.
11442
11443 .vitem &*${str2b64:*&<&'string'&>&*}*&
11444 .cindex "&%str2b64%& expansion item"
11445 Now deprecated, a synonym for the &%base64%& expansion operator.
11446
11447
11448
11449 .vitem &*${strlen:*&<&'string'&>&*}*&
11450 .cindex "expansion" "string length"
11451 .cindex "string" "length in expansion"
11452 .cindex "&%strlen%& expansion item"
11453 The item is replaced by the length of the expanded string, expressed as a
11454 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11455 All measurement is done in bytes and is not UTF-8 aware.
11456
11457
11458 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11459 .cindex "&%substr%& expansion item"
11460 .cindex "substring extraction"
11461 .cindex "expansion" "substring expansion"
11462 The &%substr%& operator is a simpler interface to the &%substr%& function that
11463 can be used when the two parameters are fixed numbers (as opposed to strings
11464 that change when expanded). The effect is the same as
11465 .code
11466 ${substr{<start>}{<length>}{<string>}}
11467 .endd
11468 See the description of the general &%substr%& item above for details. The
11469 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11470 All measurement is done in bytes and is not UTF-8 aware.
11471
11472 .vitem &*${time_eval:*&<&'string'&>&*}*&
11473 .cindex "&%time_eval%& expansion item"
11474 .cindex "time interval" "decoding"
11475 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11476 seconds.
11477
11478 .vitem &*${time_interval:*&<&'string'&>&*}*&
11479 .cindex "&%time_interval%& expansion item"
11480 .cindex "time interval" "formatting"
11481 The argument (after sub-expansion) must be a sequence of decimal digits that
11482 represents an interval of time as a number of seconds. It is converted into a
11483 number of larger units and output in Exim's normal time format, for example,
11484 &`1w3d4h2m6s`&.
11485
11486 .vitem &*${uc:*&<&'string'&>&*}*&
11487 .cindex "case forcing in strings"
11488 .cindex "string" "case forcing"
11489 .cindex "upper casing"
11490 .cindex "expansion" "case forcing"
11491 .cindex "&%uc%& expansion item"
11492 This forces the letters in the string into upper-case.
11493 Case is defined per the system C locale.
11494
11495 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11496 .cindex "correction of invalid utf-8 sequences in strings"
11497 .cindex "utf-8" "utf-8 sequences"
11498 .cindex "incorrect utf-8"
11499 .cindex "expansion" "utf-8 forcing"
11500 .cindex "&%utf8clean%& expansion item"
11501 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11502 In versions of Exim before 4.92, this did not correctly do so for a truncated
11503 final codepoint's encoding, and the character would be silently dropped.
11504 If you must handle detection of this scenario across both sets of Exim behavior,
11505 the complexity will depend upon the task.
11506 For instance, to detect if the first character is multibyte and a 1-byte
11507 extraction can be successfully used as a path component (as is common for
11508 dividing up delivery folders), you might use:
11509 .code
11510 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11511 .endd
11512 (which will false-positive if the first character of the local part is a
11513 literal question mark).
11514
11515 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11516        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11517        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11518        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11519 .cindex expansion UTF-8
11520 .cindex UTF-8 expansion
11521 .cindex EAI
11522 .cindex internationalisation
11523 .cindex "&%utf8_domain_to_alabel%& expansion item"
11524 .cindex "&%utf8_domain_from_alabel%& expansion item"
11525 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11526 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11527 These convert EAI mail name components between UTF-8 and a-label forms.
11528 For information on internationalisation support see &<<SECTi18nMTA>>&.
11529 .endlist
11530
11531
11532
11533
11534
11535
11536 .section "Expansion conditions" "SECTexpcond"
11537 .scindex IIDexpcond "expansion" "conditions"
11538 The following conditions are available for testing by the &%${if%& construct
11539 while expanding strings:
11540
11541 .vlist
11542 .vitem &*!*&<&'condition'&>
11543 .cindex "expansion" "negating a condition"
11544 .cindex "negation" "in expansion condition"
11545 Preceding any condition with an exclamation mark negates the result of the
11546 condition.
11547
11548 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11549 .cindex "numeric comparison"
11550 .cindex "expansion" "numeric comparison"
11551 There are a number of symbolic operators for doing numeric comparisons. They
11552 are:
11553 .itable none 0 0 2 10* left 90* left
11554 .irow "=   " "equal"
11555 .irow "==  " "equal"
11556 .irow ">   " "greater"
11557 .irow ">=  " "greater or equal"
11558 .irow "<   " "less"
11559 .irow "<=  " "less or equal"
11560 .endtable
11561 For example:
11562 .code
11563 ${if >{$message_size}{10M} ...
11564 .endd
11565 Note that the general negation operator provides for inequality testing. The
11566 two strings must take the form of optionally signed decimal integers,
11567 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11568 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11569 As a special case, the numerical value of an empty string is taken as
11570 zero.
11571
11572 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11573 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11574 10M, not if 10M is larger than &$message_size$&.
11575
11576
11577 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11578         {*&<&'arg2'&>&*}...}*&
11579 .cindex "expansion" "calling an acl"
11580 .cindex "&%acl%&" "expansion condition"
11581 The name and zero to nine argument strings are first expanded separately.  The expanded
11582 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11583 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11584 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11585 and may use the variables; if another acl expansion is used the values
11586 are restored after it returns.  If the ACL sets
11587 a value using a "message =" modifier the variable $value becomes
11588 the result of the expansion, otherwise it is empty.
11589 If the ACL returns accept the condition is true; if deny, false.
11590 If the ACL returns defer the result is a forced-fail.
11591
11592 .vitem &*bool&~{*&<&'string'&>&*}*&
11593 .cindex "expansion" "boolean parsing"
11594 .cindex "&%bool%& expansion condition"
11595 This condition turns a string holding a true or false representation into
11596 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11597 (case-insensitively); also integer numbers map to true if non-zero,
11598 false if zero.
11599 An empty string is treated as false.
11600 Leading and trailing whitespace is ignored;
11601 thus a string consisting only of whitespace is false.
11602 All other string values will result in expansion failure.
11603
11604 When combined with ACL variables, this expansion condition will let you
11605 make decisions in one place and act on those decisions in another place.
11606 For example:
11607 .code
11608 ${if bool{$acl_m_privileged_sender} ...
11609 .endd
11610
11611
11612 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11613 .cindex "expansion" "boolean parsing"
11614 .cindex "&%bool_lax%& expansion condition"
11615 Like &%bool%&, this condition turns a string into a boolean state.  But
11616 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11617 loose definition that the Router &%condition%& option uses.  The empty string
11618 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11619 true.  Leading and trailing whitespace is ignored.
11620
11621 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11622
11623 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11624 .cindex "expansion" "encrypted comparison"
11625 .cindex "encrypted strings, comparing"
11626 .cindex "&%crypteq%& expansion condition"
11627 This condition is included in the Exim binary if it is built to support any
11628 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11629 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11630 included in the binary.
11631
11632 The &%crypteq%& condition has two arguments. The first is encrypted and
11633 compared against the second, which is already encrypted. The second string may
11634 be in the LDAP form for storing encrypted strings, which starts with the
11635 encryption type in curly brackets, followed by the data. If the second string
11636 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11637 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11638 Typically this will be a field from a password file. An example of an encrypted
11639 string in LDAP form is:
11640 .code
11641 {md5}CY9rzUYh03PK3k6DJie09g==
11642 .endd
11643 If such a string appears directly in an expansion, the curly brackets have to
11644 be quoted, because they are part of the expansion syntax. For example:
11645 .code
11646 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11647 .endd
11648 The following encryption types (whose names are matched case-independently) are
11649 supported:
11650
11651 .ilist
11652 .cindex "MD5 hash"
11653 .cindex "base64 encoding" "in encrypted password"
11654 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11655 printable characters to compare with the remainder of the second string. If the
11656 length of the comparison string is 24, Exim assumes that it is base64 encoded
11657 (as in the above example). If the length is 32, Exim assumes that it is a
11658 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11659 comparison fails.
11660
11661 .next
11662 .cindex "SHA-1 hash"
11663 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11664 printable characters to compare with the remainder of the second string. If the
11665 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11666 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11667 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11668
11669 .next
11670 .cindex "&[crypt()]&"
11671 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11672 only the first eight characters of the password. However, in modern operating
11673 systems this is no longer true, and in many cases the entire password is used,
11674 whatever its length.
11675
11676 .next
11677 .cindex "&[crypt16()]&"
11678 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11679 use up to 16 characters of the password in some operating systems. Again, in
11680 modern operating systems, more characters may be used.
11681 .endlist
11682 Exim has its own version of &[crypt16()]&, which is just a double call to
11683 &[crypt()]&. For operating systems that have their own version, setting
11684 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11685 operating system version instead of its own. This option is set by default in
11686 the OS-dependent &_Makefile_& for those operating systems that are known to
11687 support &[crypt16()]&.
11688
11689 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11690 it was not using the same algorithm as some operating systems' versions. It
11691 turns out that as well as &[crypt16()]& there is a function called
11692 &[bigcrypt()]& in some operating systems. This may or may not use the same
11693 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11694
11695 However, since there is now a move away from the traditional &[crypt()]&
11696 functions towards using SHA1 and other algorithms, tidying up this area of
11697 Exim is seen as very low priority.
11698
11699 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11700 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11701 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11702 default is &`{crypt}`&. Whatever the default, you can always use either
11703 function by specifying it explicitly in curly brackets.
11704
11705 .vitem &*def:*&<&'variable&~name'&>
11706 .cindex "expansion" "checking for empty variable"
11707 .cindex "&%def%& expansion condition"
11708 The &%def%& condition must be followed by the name of one of the expansion
11709 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11710 variable does not contain the empty string. For example:
11711 .code
11712 ${if def:sender_ident {from $sender_ident}}
11713 .endd
11714 Note that the variable name is given without a leading &%$%& character. If the
11715 variable does not exist, the expansion fails.
11716
11717 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11718         &~&*def:h_*&<&'header&~name'&>&*:*&"
11719 .cindex "expansion" "checking header line existence"
11720 This condition is true if a message is being processed and the named header
11721 exists in the message. For example,
11722 .code
11723 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11724 .endd
11725 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11726 the header name must be terminated by a colon if white space does not follow.
11727
11728 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11729        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11730 .cindex "string" "comparison"
11731 .cindex "expansion" "string comparison"
11732 .cindex "&%eq%& expansion condition"
11733 .cindex "&%eqi%& expansion condition"
11734 The two substrings are first expanded. The condition is true if the two
11735 resulting strings are identical. For &%eq%& the comparison includes the case of
11736 letters, whereas for &%eqi%& the comparison is case-independent, where
11737 case is defined per the system C locale.
11738
11739 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11740 .cindex "expansion" "file existence test"
11741 .cindex "file" "existence test"
11742 .cindex "&%exists%&, expansion condition"
11743 The substring is first expanded and then interpreted as an absolute path. The
11744 condition is true if the named file (or directory) exists. The existence test
11745 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11746 users' filter files may be locked out by the system administrator.
11747
11748 &*Note:*& Testing a path using this condition is not a sufficient way of
11749 de-tainting it.
11750 Consider using a dsearch lookup.
11751
11752 .vitem &*first_delivery*&
11753 .cindex "delivery" "first"
11754 .cindex "first delivery"
11755 .cindex "expansion" "first delivery test"
11756 .cindex "&%first_delivery%& expansion condition"
11757 .cindex retry condition
11758 This condition, which has no data, is true during a message's first delivery
11759 attempt. It is false during any subsequent delivery attempts.
11760
11761
11762 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11763        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11764 .cindex "list" "iterative conditions"
11765 .cindex "expansion" "&*forall*& condition"
11766 .cindex "expansion" "&*forany*& condition"
11767 .vindex "&$item$&"
11768 These conditions iterate over a list. The first argument is expanded to form
11769 the list. By default, the list separator is a colon, but it can be changed by
11770 the normal method (&<<SECTlistsepchange>>&).
11771 The second argument is interpreted as a condition that is to
11772 be applied to each item in the list in turn. During the interpretation of the
11773 condition, the current list item is placed in a variable called &$item$&.
11774 .ilist
11775 For &*forany*&, interpretation stops if the condition is true for any item, and
11776 the result of the whole condition is true. If the condition is false for all
11777 items in the list, the overall condition is false.
11778 .next
11779 For &*forall*&, interpretation stops if the condition is false for any item,
11780 and the result of the whole condition is false. If the condition is true for
11781 all items in the list, the overall condition is true.
11782 .endlist
11783 Note that negation of &*forany*& means that the condition must be false for all
11784 items for the overall condition to succeed, and negation of &*forall*& means
11785 that the condition must be false for at least one item. In this example, the
11786 list separator is changed to a comma:
11787 .code
11788 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11789 .endd
11790 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11791 being processed, to enable these expansion items to be nested.
11792
11793 To scan a named list, expand it with the &*listnamed*& operator.
11794
11795 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11796        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11797        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11798        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11799 .cindex JSON "iterative conditions"
11800 .cindex JSON expansions
11801 .cindex expansion "&*forall_json*& condition"
11802 .cindex expansion "&*forany_json*& condition"
11803 .cindex expansion "&*forall_jsons*& condition"
11804 .cindex expansion "&*forany_jsons*& condition"
11805 As for the above, except that the first argument must, after expansion,
11806 be a JSON array.
11807 The array separator is not changeable.
11808 For the &"jsons"& variants the elements are expected to be JSON strings
11809 and have their quotes removed before the evaluation of the condition.
11810
11811
11812
11813 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11814        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11815 .cindex "string" "comparison"
11816 .cindex "expansion" "string comparison"
11817 .cindex "&%ge%& expansion condition"
11818 .cindex "&%gei%& expansion condition"
11819 The two substrings are first expanded. The condition is true if the first
11820 string is lexically greater than or equal to the second string. For &%ge%& the
11821 comparison includes the case of letters, whereas for &%gei%& the comparison is
11822 case-independent.
11823 Case and collation order are defined per the system C locale.
11824
11825 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11826        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11827 .cindex "string" "comparison"
11828 .cindex "expansion" "string comparison"
11829 .cindex "&%gt%& expansion condition"
11830 .cindex "&%gti%& expansion condition"
11831 The two substrings are first expanded. The condition is true if the first
11832 string is lexically greater than the second string. For &%gt%& the comparison
11833 includes the case of letters, whereas for &%gti%& the comparison is
11834 case-independent.
11835 Case and collation order are defined per the system C locale.
11836
11837
11838 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11839 SRS decode.  See SECT &<<SECTSRS>>& for details.
11840
11841
11842 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11843        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11844 .cindex "string" "comparison"
11845 .cindex "list" "iterative conditions"
11846 Both strings are expanded; the second string is treated as a list of simple
11847 strings; if the first string is a member of the second, then the condition
11848 is true.
11849 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11850
11851 These are simpler to use versions of the more powerful &*forany*& condition.
11852 Examples, and the &*forany*& equivalents:
11853 .code
11854 ${if inlist{needle}{foo:needle:bar}}
11855   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11856 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11857   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11858 .endd
11859
11860 The variable &$value$& will be set for a successful match and can be
11861 used in the success clause of an &%if%& expansion item using the condition.
11862 .cindex "tainted data" "de-tainting"
11863 .cindex "de-tainting" "using an inlist expansion condition"
11864 It will have the same taint status as the list; expansions such as
11865 .code
11866 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11867 .endd
11868 can be used for de-tainting.
11869 Any previous &$value$& is restored after the if.
11870
11871
11872 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11873        &*isip4&~{*&<&'string'&>&*}*& &&&
11874        &*isip6&~{*&<&'string'&>&*}*&
11875 .cindex "IP address" "testing string format"
11876 .cindex "string" "testing for IP address"
11877 .cindex "&%isip%& expansion condition"
11878 .cindex "&%isip4%& expansion condition"
11879 .cindex "&%isip6%& expansion condition"
11880 The substring is first expanded, and then tested to see if it has the form of
11881 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11882 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11883
11884 For an IPv4 address, the test is for four dot-separated components, each of
11885 which consists of from one to three digits. For an IPv6 address, up to eight
11886 colon-separated components are permitted, each containing from one to four
11887 hexadecimal digits. There may be fewer than eight components if an empty
11888 component (adjacent colons) is present. Only one empty component is permitted.
11889
11890 &*Note*&: The checks used to be just on the form of the address; actual numerical
11891 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11892 check.
11893 This is no longer the case.
11894
11895 The main use of these tests is to distinguish between IP addresses and
11896 host names, or between IPv4 and IPv6 addresses. For example, you could use
11897 .code
11898 ${if isip4{$sender_host_address}...
11899 .endd
11900 to test which IP version an incoming SMTP connection is using.
11901
11902 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11903 .cindex "LDAP" "use for authentication"
11904 .cindex "expansion" "LDAP authentication test"
11905 .cindex "&%ldapauth%& expansion condition"
11906 This condition supports user authentication using LDAP. See section
11907 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11908 queries. For this use, the query must contain a user name and password. The
11909 query itself is not used, and can be empty. The condition is true if the
11910 password is not empty, and the user name and password are accepted by the LDAP
11911 server. An empty password is rejected without calling LDAP because LDAP binds
11912 with an empty password are considered anonymous regardless of the username, and
11913 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11914 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11915 this can be used.
11916
11917
11918 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11919        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11920 .cindex "string" "comparison"
11921 .cindex "expansion" "string comparison"
11922 .cindex "&%le%& expansion condition"
11923 .cindex "&%lei%& expansion condition"
11924 The two substrings are first expanded. The condition is true if the first
11925 string is lexically less than or equal to the second string. For &%le%& the
11926 comparison includes the case of letters, whereas for &%lei%& the comparison is
11927 case-independent.
11928 Case and collation order are defined per the system C locale.
11929
11930 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11931        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11932 .cindex "string" "comparison"
11933 .cindex "expansion" "string comparison"
11934 .cindex "&%lt%& expansion condition"
11935 .cindex "&%lti%& expansion condition"
11936 The two substrings are first expanded. The condition is true if the first
11937 string is lexically less than the second string. For &%lt%& the comparison
11938 includes the case of letters, whereas for &%lti%& the comparison is
11939 case-independent.
11940 Case and collation order are defined per the system C locale.
11941
11942
11943 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11944 .cindex "expansion" "regular expression comparison"
11945 .cindex "regular expressions" "match in expanded string"
11946 .cindex "&%match%& expansion condition"
11947 The two substrings are first expanded. The second is then treated as a regular
11948 expression and applied to the first. Because of the pre-expansion, if the
11949 regular expression contains dollar, or backslash characters, they must be
11950 escaped. Care must also be taken if the regular expression contains braces
11951 (curly brackets). A closing brace must be escaped so that it is not taken as a
11952 premature termination of <&'string2'&>. The easiest approach is to use the
11953 &`\N`& feature to disable expansion of the regular expression.
11954 For example,
11955 .code
11956 ${if match {$local_part}{\N^\d{3}\N} ...
11957 .endd
11958 If the whole expansion string is in double quotes, further escaping of
11959 backslashes is also required.
11960
11961 The condition is true if the regular expression match succeeds.
11962 The regular expression is not required to begin with a circumflex
11963 metacharacter, but if there is no circumflex, the expression is not anchored,
11964 and it may match anywhere in the subject, not just at the start. If you want
11965 the pattern to match at the end of the subject, you must include the &`$`&
11966 metacharacter at an appropriate point.
11967 All character handling is done in bytes and is not UTF-8 aware,
11968 but we might change this in a future Exim release.
11969
11970 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11971 At the start of an &%if%& expansion the values of the numeric variable
11972 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11973 succeeds causes them to be reset to the substrings of that condition and they
11974 will have these values during the expansion of the success string. At the end
11975 of the &%if%& expansion, the previous values are restored. After testing a
11976 combination of conditions using &%or%&, the subsequent values of the numeric
11977 variables are those of the condition that succeeded.
11978
11979 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11980 .cindex "&%match_address%& expansion condition"
11981 See &*match_local_part*&.
11982
11983 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11984 .cindex "&%match_domain%& expansion condition"
11985 See &*match_local_part*&.
11986
11987 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11988 .cindex "&%match_ip%& expansion condition"
11989 This condition matches an IP address to a list of IP address patterns. It must
11990 be followed by two argument strings. The first (after expansion) must be an IP
11991 address or an empty string. The second (not expanded) is a restricted host
11992 list that can match only an IP address, not a host name. For example:
11993 .code
11994 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11995 .endd
11996 The specific types of host list item that are permitted in the list are:
11997
11998 .ilist
11999 An IP address, optionally with a CIDR mask.
12000 .next
12001 A single asterisk, which matches any IP address.
12002 .next
12003 An empty item, which matches only if the IP address is empty. This could be
12004 useful for testing for a locally submitted message or one from specific hosts
12005 in a single test such as
12006 . ==== As this is a nested list, any displays it contains must be indented
12007 . ==== as otherwise they are too far to the left. This comment applies to
12008 . ==== the use of xmlto plus fop. There's no problem when formatting with
12009 . ==== sdop, with or without the extra indent.
12010 .code
12011   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12012 .endd
12013 where the first item in the list is the empty string.
12014 .next
12015 The item @[] matches any of the local host's interface addresses.
12016 .next
12017 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12018 even if &`net-`& is not specified. There is never any attempt to turn the IP
12019 address into a host name. The most common type of linear search for
12020 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12021 masks. For example:
12022 .code
12023   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12024 .endd
12025 It is of course possible to use other kinds of lookup, and in such a case, you
12026 do need to specify the &`net-`& prefix if you want to specify a specific
12027 address mask, for example:
12028 .code
12029   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12030 .endd
12031 However, unless you are combining a &%match_ip%& condition with others, it is
12032 just as easy to use the fact that a lookup is itself a condition, and write:
12033 .code
12034   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12035 .endd
12036 .endlist ilist
12037
12038 Note that <&'string2'&> is not itself subject to string expansion, unless
12039 Exim was built with the EXPAND_LISTMATCH_RHS option.
12040
12041 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12042
12043 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12044 .cindex "domain list" "in expansion condition"
12045 .cindex "address list" "in expansion condition"
12046 .cindex "local part" "list, in expansion condition"
12047 .cindex "&%match_local_part%& expansion condition"
12048 This condition, together with &%match_address%& and &%match_domain%&, make it
12049 possible to test domain, address, and local part lists within expansions. Each
12050 condition requires two arguments: an item and a list to match. A trivial
12051 example is:
12052 .code
12053 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12054 .endd
12055 In each case, the second argument may contain any of the allowable items for a
12056 list of the appropriate type. Also, because the second argument
12057 is a standard form of list, it is possible to refer to a named list.
12058 Thus, you can use conditions like this:
12059 .code
12060 ${if match_domain{$domain}{+local_domains}{...
12061 .endd
12062 .cindex "&`+caseful`&"
12063 For address lists, the matching starts off caselessly, but the &`+caseful`&
12064 item can be used, as in all address lists, to cause subsequent items to
12065 have their local parts matched casefully. Domains are always matched
12066 caselessly.
12067
12068 The variable &$value$& will be set for a successful match and can be
12069 used in the success clause of an &%if%& expansion item using the condition.
12070 .cindex "tainted data" "de-tainting"
12071 .cindex "de-tainting" "using a match_local_part expansion condition"
12072 It will have the same taint status as the list; expansions such as
12073 .code
12074 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12075 .endd
12076 can be used for de-tainting.
12077 Any previous &$value$& is restored after the if.
12078
12079 Note that <&'string2'&> is not itself subject to string expansion, unless
12080 Exim was built with the EXPAND_LISTMATCH_RHS option.
12081
12082 &*Note*&: Host lists are &'not'& supported in this way. This is because
12083 hosts have two identities: a name and an IP address, and it is not clear
12084 how to specify cleanly how such a test would work. However, IP addresses can be
12085 matched using &%match_ip%&.
12086
12087 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12088 .cindex "PAM authentication"
12089 .cindex "AUTH" "with PAM"
12090 .cindex "Solaris" "PAM support"
12091 .cindex "expansion" "PAM authentication test"
12092 .cindex "&%pam%& expansion condition"
12093 &'Pluggable Authentication Modules'&
12094 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12095 available in Solaris
12096 and in some GNU/Linux distributions.
12097 The Exim support, which is intended for use in conjunction with
12098 the SMTP AUTH command, is available only if Exim is compiled with
12099 .code
12100 SUPPORT_PAM=yes
12101 .endd
12102 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12103 in some releases of GNU/Linux &%-ldl%& is also needed.
12104
12105 The argument string is first expanded, and the result must be a
12106 colon-separated list of strings. Leading and trailing white space is ignored.
12107 The PAM module is initialized with the service name &"exim"& and the user name
12108 taken from the first item in the colon-separated data string (<&'string1'&>).
12109 The remaining items in the data string are passed over in response to requests
12110 from the authentication function. In the simple case there will only be one
12111 request, for a password, so the data consists of just two strings.
12112
12113 There can be problems if any of the strings are permitted to contain colon
12114 characters. In the usual way, these have to be doubled to avoid being taken as
12115 separators.
12116 The &%listquote%& expansion item can be used for this.
12117 For example, the configuration
12118 of a LOGIN authenticator might contain this setting:
12119 .code
12120 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12121 .endd
12122 In some operating systems, PAM authentication can be done only from a process
12123 running as root. Since Exim is running as the Exim user when receiving
12124 messages, this means that PAM cannot be used directly in those systems.
12125 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12126
12127
12128 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12129 .cindex "&'pwcheck'& daemon"
12130 .cindex "Cyrus"
12131 .cindex "expansion" "&'pwcheck'& authentication test"
12132 .cindex "&%pwcheck%& expansion condition"
12133 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12134 This is one way of making it possible for passwords to be checked by a process
12135 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12136 deprecated. Its replacement is &'saslauthd'& (see below).
12137
12138 The pwcheck support is not included in Exim by default. You need to specify
12139 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12140 building Exim. For example:
12141 .code
12142 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12143 .endd
12144 You do not need to install the full Cyrus software suite in order to use
12145 the pwcheck daemon. You can compile and install just the daemon alone
12146 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12147 access to the &_/var/pwcheck_& directory.
12148
12149 The &%pwcheck%& condition takes one argument, which must be the user name and
12150 password, separated by a colon. For example, in a LOGIN authenticator
12151 configuration, you might have this:
12152 .code
12153 server_condition = ${if pwcheck{$auth1:$auth2}}
12154 .endd
12155 Again, for a PLAIN authenticator configuration, this would be:
12156 .code
12157 server_condition = ${if pwcheck{$auth2:$auth3}}
12158 .endd
12159 .vitem &*queue_running*&
12160 .cindex "queue runner" "detecting when delivering from"
12161 .cindex "expansion" "queue runner test"
12162 .cindex "&%queue_running%& expansion condition"
12163 This condition, which has no data, is true during delivery attempts that are
12164 initiated by queue runner processes, and false otherwise.
12165
12166
12167 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12168 .cindex "Radius"
12169 .cindex "expansion" "Radius authentication"
12170 .cindex "&%radius%& expansion condition"
12171 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12172 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12173 the Radius client configuration file in order to build Exim with Radius
12174 support.
12175
12176 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12177 library, using the original API. If you are using release 0.4.0 or later of
12178 this library, you need to set
12179 .code
12180 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12181 .endd
12182 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12183 &%libradius%& library that comes with FreeBSD. To do this, set
12184 .code
12185 RADIUS_LIB_TYPE=RADLIB
12186 .endd
12187 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12188 You may also have to supply a suitable setting in EXTRALIBS so that the
12189 Radius library can be found when Exim is linked.
12190
12191 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12192 Radius client library, which calls the Radius server. The condition is true if
12193 the authentication is successful. For example:
12194 .code
12195 server_condition = ${if radius{<arguments>}}
12196 .endd
12197
12198
12199 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12200         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12201 .cindex "&'saslauthd'& daemon"
12202 .cindex "Cyrus"
12203 .cindex "expansion" "&'saslauthd'& authentication test"
12204 .cindex "&%saslauthd%& expansion condition"
12205 This condition supports user authentication using the Cyrus &'saslauthd'&
12206 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12207 Using this daemon is one way of making it possible for passwords to be checked
12208 by a process that is not running as root.
12209
12210 The saslauthd support is not included in Exim by default. You need to specify
12211 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12212 building Exim. For example:
12213 .code
12214 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12215 .endd
12216 You do not need to install the full Cyrus software suite in order to use
12217 the saslauthd daemon. You can compile and install just the daemon alone
12218 from the Cyrus SASL library.
12219
12220 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12221 two are mandatory. For example:
12222 .code
12223 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12224 .endd
12225 The service and the realm are optional (which is why the arguments are enclosed
12226 in their own set of braces). For details of the meaning of the service and
12227 realm, and how to run the daemon, consult the Cyrus documentation.
12228 .endlist vlist
12229
12230
12231
12232 .section "Combining expansion conditions" "SECID84"
12233 .cindex "expansion" "combining conditions"
12234 Several conditions can be tested at once by combining them using the &%and%&
12235 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12236 conditions on their own, and precede their lists of sub-conditions. Each
12237 sub-condition must be enclosed in braces within the overall braces that contain
12238 the list. No repetition of &%if%& is used.
12239
12240
12241 .vlist
12242 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12243 .cindex "&""or""& expansion condition"
12244 .cindex "expansion" "&""or""& of conditions"
12245 The sub-conditions are evaluated from left to right. The condition is true if
12246 any one of the sub-conditions is true.
12247 For example,
12248 .code
12249 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12250 .endd
12251 When a true sub-condition is found, the following ones are parsed but not
12252 evaluated. If there are several &"match"& sub-conditions the values of the
12253 numeric variables afterwards are taken from the first one that succeeds.
12254
12255 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12256 .cindex "&""and""& expansion condition"
12257 .cindex "expansion" "&""and""& of conditions"
12258 The sub-conditions are evaluated from left to right. The condition is true if
12259 all of the sub-conditions are true. If there are several &"match"&
12260 sub-conditions, the values of the numeric variables afterwards are taken from
12261 the last one. When a false sub-condition is found, the following ones are
12262 parsed but not evaluated.
12263 .endlist
12264 .ecindex IIDexpcond
12265
12266
12267
12268
12269 .section "Expansion variables" "SECTexpvar"
12270 .cindex "expansion" "variables, list of"
12271 This section contains an alphabetical list of all the expansion variables. Some
12272 of them are available only when Exim is compiled with specific options such as
12273 support for TLS or the content scanning extension.
12274 .cindex "tainted data"
12275 Variables marked as &'tainted'& are likely to carry data supplied by
12276 a potential attacker.
12277 Variables without such marking may also, depending on how their
12278 values are created.
12279 Such variables should not be further expanded,
12280 used as filenames
12281 or used as command-line arguments for external commands.
12282
12283 .vlist
12284 .vitem "&$0$&, &$1$&, etc"
12285 .cindex "numerical variables (&$1$& &$2$& etc)"
12286 When a &%match%& expansion condition succeeds, these variables contain the
12287 captured substrings identified by the regular expression during subsequent
12288 processing of the success string of the containing &%if%& expansion item.
12289 In the expansion condition case
12290 they do not retain their values afterwards; in fact, their previous
12291 values are restored at the end of processing an &%if%& item. The numerical
12292 variables may also be set externally by some other matching process which
12293 precedes the expansion of the string. For example, the commands available in
12294 Exim filter files include an &%if%& command with its own regular expression
12295 matching condition.
12296 If the subject string was tainted then any captured substring will also be.
12297
12298 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12299 Within an acl condition, expansion condition or expansion item
12300 any arguments are copied to these variables,
12301 any unused variables being made empty.
12302
12303 .vitem "&$acl_c...$&"
12304 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12305 can be given any name that starts with &$acl_c$& and is at least six characters
12306 long, but the sixth character must be either a digit or an underscore. For
12307 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12308 variables persist throughout the lifetime of an SMTP connection. They can be
12309 used to pass information between ACLs and between different invocations of the
12310 same ACL. When a message is received, the values of these variables are saved
12311 with the message, and can be accessed by filters, routers, and transports
12312 during subsequent delivery.
12313
12314 .vitem "&$acl_m...$&"
12315 These variables are like the &$acl_c...$& variables, except that their values
12316 are reset after a message has been received. Thus, if several messages are
12317 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12318 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12319 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12320 message is received, the values of these variables are saved with the message,
12321 and can be accessed by filters, routers, and transports during subsequent
12322 delivery.
12323
12324 .vitem &$acl_narg$&
12325 Within an acl condition, expansion condition or expansion item
12326 this variable has the number of arguments.
12327
12328 .vitem &$acl_verify_message$&
12329 .vindex "&$acl_verify_message$&"
12330 After an address verification has failed, this variable contains the failure
12331 message. It retains its value for use in subsequent modifiers of the verb.
12332 The message can be preserved by coding like this:
12333 .code
12334 warn !verify = sender
12335      set acl_m0 = $acl_verify_message
12336 .endd
12337 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12338 &%log_message%& modifiers, to include information about the verification
12339 failure.
12340 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12341
12342 .vitem &$address_data$&
12343 .vindex "&$address_data$&"
12344 This variable is set by means of the &%address_data%& option in routers. The
12345 value then remains with the address while it is processed by subsequent routers
12346 and eventually a transport. If the transport is handling multiple addresses,
12347 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12348 for more details. &*Note*&: The contents of &$address_data$& are visible in
12349 user filter files.
12350
12351 If &$address_data$& is set when the routers are called from an ACL to verify
12352 a recipient address, the final value is still in the variable for subsequent
12353 conditions and modifiers of the ACL statement. If routing the address caused it
12354 to be redirected to just one address, the child address is also routed as part
12355 of the verification, and in this case the final value of &$address_data$& is
12356 from the child's routing.
12357
12358 If &$address_data$& is set when the routers are called from an ACL to verify a
12359 sender address, the final value is also preserved, but this time in
12360 &$sender_address_data$&, to distinguish it from data from a recipient
12361 address.
12362
12363 In both cases (recipient and sender verification), the value does not persist
12364 after the end of the current ACL statement. If you want to preserve
12365 these values for longer, you can save them in ACL variables.
12366
12367 .vitem &$address_file$&
12368 .vindex "&$address_file$&"
12369 When, as a result of aliasing, forwarding, or filtering, a message is directed
12370 to a specific file, this variable holds the name of the file when the transport
12371 is running. At other times, the variable is empty. For example, using the
12372 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12373 .code
12374 /home/r2d2/savemail
12375 .endd
12376 then when the &(address_file)& transport is running, &$address_file$&
12377 contains the text string &`/home/r2d2/savemail`&.
12378 .cindex "Sieve filter" "value of &$address_file$&"
12379 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12380 then up to the transport configuration to generate an appropriate absolute path
12381 to the relevant file.
12382
12383 .vitem &$address_pipe$&
12384 .vindex "&$address_pipe$&"
12385 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12386 this variable holds the pipe command when the transport is running.
12387
12388 .vitem "&$auth1$& &-- &$auth4$&"
12389 .vindex "&$auth1$&, &$auth2$&, etc"
12390 These variables are used in SMTP authenticators (see chapters
12391 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12392
12393 .vitem &$authenticated_id$&
12394 .cindex "authentication" "id"
12395 .vindex "&$authenticated_id$&"
12396 When a server successfully authenticates a client it may be configured to
12397 preserve some of the authentication information in the variable
12398 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12399 user/password authenticator configuration might preserve the user name for use
12400 in the routers. Note that this is not the same information that is saved in
12401 &$sender_host_authenticated$&.
12402
12403 When a message is submitted locally (that is, not over a TCP connection)
12404 the value of &$authenticated_id$& is normally the login name of the calling
12405 process. However, a trusted user can override this by means of the &%-oMai%&
12406 command line option.
12407 This second case also sets up information used by the
12408 &$authresults$& expansion item.
12409
12410 .vitem &$authenticated_fail_id$&
12411 .cindex "authentication" "fail" "id"
12412 .vindex "&$authenticated_fail_id$&"
12413 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12414 will contain the failed authentication id. If more than one authentication
12415 id is attempted, it will contain only the last one. The variable is
12416 available for processing in the ACL's, generally the quit or notquit ACL.
12417 A message to a local recipient could still be accepted without requiring
12418 authentication, which means this variable could also be visible in all of
12419 the ACL's as well.
12420
12421
12422 .tvar &$authenticated_sender$&
12423 .cindex "sender" "authenticated"
12424 .cindex "authentication" "sender"
12425 .cindex "AUTH" "on MAIL command"
12426 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12427 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12428 described in section &<<SECTauthparamail>>&. Unless the data is the string
12429 &"<>"&, it is set as the authenticated sender of the message, and the value is
12430 available during delivery in the &$authenticated_sender$& variable. If the
12431 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12432
12433 .vindex "&$qualify_domain$&"
12434 When a message is submitted locally (that is, not over a TCP connection), the
12435 value of &$authenticated_sender$& is an address constructed from the login
12436 name of the calling process and &$qualify_domain$&, except that a trusted user
12437 can override this by means of the &%-oMas%& command line option.
12438
12439
12440 .vitem &$authentication_failed$&
12441 .cindex "authentication" "failure"
12442 .vindex "&$authentication_failed$&"
12443 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12444 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12445 possible to distinguish between &"did not try to authenticate"&
12446 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12447 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12448 is empty and &$authentication_failed$& is set to &"1"&).
12449 Failure includes cancellation of a authentication attempt,
12450 and any negative response to an AUTH command,
12451 (including, for example, an attempt to use an undefined mechanism).
12452
12453 .vitem &$av_failed$&
12454 .cindex "content scanning" "AV scanner failure"
12455 This variable is available when Exim is compiled with the content-scanning
12456 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12457 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12458 the ACL malware condition.
12459
12460 .vitem &$body_linecount$&
12461 .cindex "message body" "line count"
12462 .cindex "body of message" "line count"
12463 .vindex "&$body_linecount$&"
12464 When a message is being received or delivered, this variable contains the
12465 number of lines in the message's body. See also &$message_linecount$&.
12466
12467 .vitem &$body_zerocount$&
12468 .cindex "message body" "binary zero count"
12469 .cindex "body of message" "binary zero count"
12470 .cindex "binary zero" "in message body"
12471 .vindex "&$body_zerocount$&"
12472 When a message is being received or delivered, this variable contains the
12473 number of binary zero bytes (ASCII NULs) in the message's body.
12474
12475 .vitem &$bounce_recipient$&
12476 .vindex "&$bounce_recipient$&"
12477 This is set to the recipient address of a bounce message while Exim is creating
12478 it. It is useful if a customized bounce message text file is in use (see
12479 chapter &<<CHAPemsgcust>>&).
12480
12481 .vitem &$bounce_return_size_limit$&
12482 .vindex "&$bounce_return_size_limit$&"
12483 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12484 up to a multiple of 1000. It is useful when a customized error message text
12485 file is in use (see chapter &<<CHAPemsgcust>>&).
12486
12487 .vitem &$caller_gid$&
12488 .cindex "gid (group id)" "caller"
12489 .vindex "&$caller_gid$&"
12490 The real group id under which the process that called Exim was running. This is
12491 not the same as the group id of the originator of a message (see
12492 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12493 incarnation normally contains the Exim gid.
12494
12495 .vitem &$caller_uid$&
12496 .cindex "uid (user id)" "caller"
12497 .vindex "&$caller_uid$&"
12498 The real user id under which the process that called Exim was running. This is
12499 not the same as the user id of the originator of a message (see
12500 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12501 incarnation normally contains the Exim uid.
12502
12503 .vitem &$callout_address$&
12504 .vindex "&$callout_address$&"
12505 After a callout for verification, spamd or malware daemon service, the
12506 address that was connected to.
12507
12508 .vitem &$compile_number$&
12509 .vindex "&$compile_number$&"
12510 The building process for Exim keeps a count of the number
12511 of times it has been compiled. This serves to distinguish different
12512 compilations of the same version of Exim.
12513
12514 .vitem &$config_dir$&
12515 .vindex "&$config_dir$&"
12516 The directory name of the main configuration file. That is, the content of
12517 &$config_file$& with the last component stripped. The value does not
12518 contain the trailing slash. If &$config_file$& does not contain a slash,
12519 &$config_dir$& is ".".
12520
12521 .vitem &$config_file$&
12522 .vindex "&$config_file$&"
12523 The name of the main configuration file Exim is using.
12524
12525 .vitem &$dkim_verify_status$&
12526 Results of DKIM verification.
12527 For details see section &<<SECDKIMVFY>>&.
12528
12529 .vitem &$dkim_cur_signer$& &&&
12530        &$dkim_verify_reason$& &&&
12531        &$dkim_domain$& &&&
12532        &$dkim_identity$& &&&
12533        &$dkim_selector$& &&&
12534        &$dkim_algo$& &&&
12535        &$dkim_canon_body$& &&&
12536        &$dkim_canon_headers$& &&&
12537        &$dkim_copiedheaders$& &&&
12538        &$dkim_bodylength$& &&&
12539        &$dkim_created$& &&&
12540        &$dkim_expires$& &&&
12541        &$dkim_headernames$& &&&
12542        &$dkim_key_testing$& &&&
12543        &$dkim_key_nosubdomains$& &&&
12544        &$dkim_key_srvtype$& &&&
12545        &$dkim_key_granularity$& &&&
12546        &$dkim_key_notes$& &&&
12547        &$dkim_key_length$&
12548 These variables are only available within the DKIM ACL.
12549 For details see section &<<SECDKIMVFY>>&.
12550
12551 .vitem &$dkim_signers$&
12552 .vindex &$dkim_signers$&
12553 When a message has been received this variable contains
12554 a colon-separated list of signer domains and identities for the message.
12555 For details see section &<<SECDKIMVFY>>&.
12556
12557 .vitem &$dmarc_domain_policy$& &&&
12558        &$dmarc_status$& &&&
12559        &$dmarc_status_text$& &&&
12560        &$dmarc_used_domains$&
12561 Results of DMARC verification.
12562 For details see section &<<SECDMARC>>&.
12563
12564 .vitem &$dnslist_domain$& &&&
12565        &$dnslist_matched$& &&&
12566        &$dnslist_text$& &&&
12567        &$dnslist_value$&
12568 .vindex "&$dnslist_domain$&"
12569 .vindex "&$dnslist_matched$&"
12570 .vindex "&$dnslist_text$&"
12571 .vindex "&$dnslist_value$&"
12572 .cindex "black list (DNS)"
12573 When a DNS (black) list lookup succeeds, these variables are set to contain
12574 the following data from the lookup: the list's domain name, the key that was
12575 looked up, the contents of any associated TXT record, and the value from the
12576 main A record. See section &<<SECID204>>& for more details.
12577
12578 .tvar &$domain$&
12579 When an address is being routed, or delivered on its own, this variable
12580 contains the domain. Uppercase letters in the domain are converted into lower
12581 case for &$domain$&.
12582
12583 Global address rewriting happens when a message is received, so the value of
12584 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12585 is set during user filtering, but not during system filtering, because a
12586 message may have many recipients and the system filter is called just once.
12587
12588 When more than one address is being delivered at once (for example, several
12589 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12590 have the same domain. Transports can be restricted to handling only one domain
12591 at a time if the value of &$domain$& is required at transport time &-- this is
12592 the default for local transports. For further details of the environment in
12593 which local transports are run, see chapter &<<CHAPenvironment>>&.
12594
12595 .oindex "&%delay_warning_condition%&"
12596 At the end of a delivery, if all deferred addresses have the same domain, it is
12597 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12598
12599 The &$domain$& variable is also used in some other circumstances:
12600
12601 .ilist
12602 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12603 the recipient address. The domain of the &'sender'& address is in
12604 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12605 normally set during the running of the MAIL ACL. However, if the sender address
12606 is verified with a callout during the MAIL ACL, the sender domain is placed in
12607 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12608 the &(smtp)& transport.
12609
12610 .next
12611 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12612 &$domain$& contains the domain portion of the address that is being rewritten;
12613 it can be used in the expansion of the replacement address, for example, to
12614 rewrite domains by file lookup.
12615
12616 .next
12617 With one important exception, whenever a domain list is being scanned,
12618 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12619 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12620 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12621 that, in a RCPT ACL, the sender domain list can be dependent on the
12622 recipient domain (which is what is in &$domain$& at this time).
12623
12624 .next
12625 .cindex "ETRN" "value of &$domain$&"
12626 .oindex "&%smtp_etrn_command%&"
12627 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12628 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12629 .endlist
12630
12631 .cindex "tainted data"
12632 If the origin of the data is an incoming message,
12633 the result of expanding this variable is tainted and may not
12634 be further expanded or used as a filename.
12635 When an untainted version is needed, one should be obtained from
12636 looking up the value in a local (therefore trusted) database.
12637 Often &$domain_data$& is usable in this role.
12638
12639
12640 .vitem &$domain_data$&
12641 .vindex "&$domain_data$&"
12642 When the &%domains%& condition on a router
12643 or an ACL
12644 matches a domain
12645 against a list, the match value is copied to &$domain_data$&.
12646 This is an enhancement over previous versions of Exim, when it only
12647 applied to the data read by a lookup.
12648 For details on match values see section &<<SECTlistresults>>& et. al.
12649
12650 If the router routes the
12651 address to a transport, the value is available in that transport. If the
12652 transport is handling multiple addresses, the value from the first address is
12653 used.
12654
12655 &$domain_data$& set in an ACL is available during
12656 the rest of the ACL statement.
12657
12658 .vitem &$exim_gid$&
12659 .vindex "&$exim_gid$&"
12660 This variable contains the numerical value of the Exim group id.
12661
12662 .vitem &$exim_path$&
12663 .vindex "&$exim_path$&"
12664 This variable contains the path to the Exim binary.
12665
12666 .vitem &$exim_uid$&
12667 .vindex "&$exim_uid$&"
12668 This variable contains the numerical value of the Exim user id.
12669
12670 .vitem &$exim_version$&
12671 .vindex "&$exim_version$&"
12672 This variable contains the version string of the Exim build.
12673 The first character is a major version number, currently 4.
12674 Then after a dot, the next group of digits is a minor version number.
12675 There may be other characters following the minor version.
12676 This value may be overridden by the &%exim_version%& main config option.
12677
12678 .vitem &$header_$&<&'name'&>
12679 .tmark
12680 This is not strictly an expansion variable. It is expansion syntax for
12681 inserting the message header line with the given name. Note that the name must
12682 be terminated by colon or white space, because it may contain a wide variety of
12683 characters. Note also that braces must &'not'& be used.
12684 See the full description in section &<<SECTexpansionitems>>& above.
12685
12686 .vitem &$headers_added$&
12687 .vindex "&$headers_added$&"
12688 Within an ACL this variable contains the headers added so far by
12689 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12690 The headers are a newline-separated list.
12691
12692 .vitem &$home$&
12693 .vindex "&$home$&"
12694 When the &%check_local_user%& option is set for a router, the user's home
12695 directory is placed in &$home$& when the check succeeds. In particular, this
12696 means it is set during the running of users' filter files. A router may also
12697 explicitly set a home directory for use by a transport; this can be overridden
12698 by a setting on the transport itself.
12699
12700 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12701 of the environment variable HOME, which is subject to the
12702 &%keep_environment%& and &%add_environment%& main config options.
12703
12704 .vitem &$host$&
12705 .vindex "&$host$&"
12706 If a router assigns an address to a transport (any transport), and passes a
12707 list of hosts with the address, the value of &$host$& when the transport starts
12708 to run is the name of the first host on the list. Note that this applies both
12709 to local and remote transports.
12710
12711 .cindex "transport" "filter"
12712 .cindex "filter" "transport filter"
12713 For the &(smtp)& transport, if there is more than one host, the value of
12714 &$host$& changes as the transport works its way through the list. In
12715 particular, when the &(smtp)& transport is expanding its options for encryption
12716 using TLS, or for specifying a transport filter (see chapter
12717 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12718 is connected.
12719
12720 When used in the client part of an authenticator configuration (see chapter
12721 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12722 client is connected.
12723
12724
12725 .vitem &$host_address$&
12726 .vindex "&$host_address$&"
12727 This variable is set to the remote host's IP address whenever &$host$& is set
12728 for a remote connection. It is also set to the IP address that is being checked
12729 when the &%ignore_target_hosts%& option is being processed.
12730
12731 .vitem &$host_data$&
12732 .vindex "&$host_data$&"
12733 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12734 result of the lookup is made available in the &$host_data$& variable. This
12735 allows you, for example, to do things like this:
12736 .code
12737 deny  hosts = net-lsearch;/some/file
12738       message = $host_data
12739 .endd
12740
12741 .vitem &$host_lookup_deferred$&
12742 .cindex "host name" "lookup, failure of"
12743 .vindex "&$host_lookup_deferred$&"
12744 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12745 message comes from a remote host and there is an attempt to look up the host's
12746 name from its IP address, and the attempt is not successful, one of these
12747 variables is set to &"1"&.
12748
12749 .ilist
12750 If the lookup receives a definite negative response (for example, a DNS lookup
12751 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12752
12753 .next
12754 If there is any kind of problem during the lookup, such that Exim cannot
12755 tell whether or not the host name is defined (for example, a timeout for a DNS
12756 lookup), &$host_lookup_deferred$& is set to &"1"&.
12757 .endlist ilist
12758
12759 Looking up a host's name from its IP address consists of more than just a
12760 single reverse lookup. Exim checks that a forward lookup of at least one of the
12761 names it receives from a reverse lookup yields the original IP address. If this
12762 is not the case, Exim does not accept the looked up name(s), and
12763 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12764 IP address (for example, the existence of a PTR record in the DNS) is not
12765 sufficient on its own for the success of a host name lookup. If the reverse
12766 lookup succeeds, but there is a lookup problem such as a timeout when checking
12767 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12768 &"1"&. See also &$sender_host_name$&.
12769
12770 .cindex authentication "expansion item"
12771 Performing these checks sets up information used by the
12772 &%authresults%& expansion item.
12773
12774
12775 .vitem &$host_lookup_failed$&
12776 .vindex "&$host_lookup_failed$&"
12777 See &$host_lookup_deferred$&.
12778
12779 .vitem &$host_port$&
12780 .vindex "&$host_port$&"
12781 This variable is set to the remote host's TCP port whenever &$host$& is set
12782 for an outbound connection.
12783
12784 .vitem &$initial_cwd$&
12785 .vindex "&$initial_cwd$&
12786 This variable contains the full path name of the initial working
12787 directory of the current Exim process. This may differ from the current
12788 working directory, as Exim changes this to "/" during early startup, and
12789 to &$spool_directory$& later.
12790
12791 .vitem &$inode$&
12792 .vindex "&$inode$&"
12793 The only time this variable is set is while expanding the &%directory_file%&
12794 option in the &(appendfile)& transport. The variable contains the inode number
12795 of the temporary file which is about to be renamed. It can be used to construct
12796 a unique name for the file.
12797
12798 .vitem &$interface_address$& &&&
12799        &$interface_port$&
12800 .vindex "&$interface_address$&"
12801 .vindex "&$interface_port$&"
12802 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12803
12804 .vitem &$item$&
12805 .vindex "&$item$&"
12806 This variable is used during the expansion of &*forall*& and &*forany*&
12807 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12808 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12809 empty.
12810
12811 .vitem &$ldap_dn$&
12812 .vindex "&$ldap_dn$&"
12813 This variable, which is available only when Exim is compiled with LDAP support,
12814 contains the DN from the last entry in the most recently successful LDAP
12815 lookup.
12816
12817 .vitem &$load_average$&
12818 .vindex "&$load_average$&"
12819 This variable contains the system load average, multiplied by 1000 so that it
12820 is an integer. For example, if the load average is 0.21, the value of the
12821 variable is 210. The value is recomputed every time the variable is referenced.
12822
12823 .tvar &$local_part$&
12824 When an address is being routed, or delivered on its own, this
12825 variable contains the local part. When a number of addresses are being
12826 delivered together (for example, multiple RCPT commands in an SMTP
12827 session), &$local_part$& is not set.
12828
12829 Global address rewriting happens when a message is received, so the value of
12830 &$local_part$& during routing and delivery is the value after rewriting.
12831 &$local_part$& is set during user filtering, but not during system filtering,
12832 because a message may have many recipients and the system filter is called just
12833 once.
12834
12835 .cindex "tainted data"
12836 If the origin of the data is an incoming message,
12837 the result of expanding this variable is tainted and
12838 may not be further expanded or used as a filename.
12839
12840 &*Warning*&: the content of this variable is usually provided by a potential
12841 attacker.
12842 Consider carefully the implications of using it unvalidated as a name
12843 for file access.
12844 This presents issues for users' &_.forward_& and filter files.
12845 For traditional full user accounts, use &%check_local_users%& and the
12846 &$local_part_data$& variable rather than this one.
12847 For virtual users, store a suitable pathname component in the database
12848 which is used for account name validation, and use that retrieved value
12849 rather than this variable.
12850 Often &$local_part_data$& is usable in this role.
12851 If needed, use a router &%address_data%& or &%set%& option for
12852 the retrieved data.
12853
12854 When a message is being delivered to a file, pipe, or autoreply transport as a
12855 result of aliasing or forwarding, &$local_part$& is set to the local part of
12856 the parent address, not to the filename or command (see &$address_file$& and
12857 &$address_pipe$&).
12858
12859 When an ACL is running for a RCPT command, &$local_part$& contains the
12860 local part of the recipient address.
12861
12862 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12863 &$local_part$& contains the local part of the address that is being rewritten;
12864 it can be used in the expansion of the replacement address, for example.
12865
12866 In all cases, all quoting is removed from the local part. For example, for both
12867 the addresses
12868 .code
12869 "abc:xyz"@test.example
12870 abc\:xyz@test.example
12871 .endd
12872 the value of &$local_part$& is
12873 .code
12874 abc:xyz
12875 .endd
12876 If you use &$local_part$& to create another address, you should always wrap it
12877 inside a quoting operator. For example, in a &(redirect)& router you could
12878 have:
12879 .code
12880 data = ${quote_local_part:$local_part}@new.domain.example
12881 .endd
12882 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12883 to process local parts in a case-dependent manner in a router, you can set the
12884 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12885
12886 .vitem &$local_part_data$&
12887 .vindex "&$local_part_data$&"
12888 When the &%local_parts%& condition on a router or ACL
12889 matches a local part list
12890 the match value is copied to &$local_part_data$&.
12891 This is an enhancement over previous versions of Exim, when it only
12892 applied to the data read by a lookup.
12893 For details on match values see section &<<SECTlistresults>>& et. al.
12894
12895 The &%check_local_user%& router option also sets this variable.
12896
12897 .vindex &$local_part_prefix$& &&&
12898         &$local_part_prefix_v$& &&&
12899         &$local_part_suffix$& &&&
12900         &$local_part_suffix_v$&
12901 .cindex affix variables
12902 If a local part prefix or suffix has been recognized, it is not included in the
12903 value of &$local_part$& during routing and subsequent delivery. The values of
12904 any prefix or suffix are in &$local_part_prefix$& and
12905 &$local_part_suffix$&, respectively.
12906 .cindex "tainted data"
12907 If the specification did not include a wildcard then
12908 the affix variable value is not tainted.
12909
12910 If the affix specification included a wildcard then the portion of
12911 the affix matched by the wildcard is in
12912 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12913 and both the whole and varying values are tainted.
12914
12915 .vitem &$local_scan_data$&
12916 .vindex "&$local_scan_data$&"
12917 This variable contains the text returned by the &[local_scan()]& function when
12918 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12919
12920 .vitem &$local_user_gid$&
12921 .vindex "&$local_user_gid$&"
12922 See &$local_user_uid$&.
12923
12924 .vitem &$local_user_uid$&
12925 .vindex "&$local_user_uid$&"
12926 This variable and &$local_user_gid$& are set to the uid and gid after the
12927 &%check_local_user%& router precondition succeeds. This means that their values
12928 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12929 and &%condition%&), for the &%address_data%& expansion, and for any
12930 router-specific expansions. At all other times, the values in these variables
12931 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12932
12933 .vitem &$localhost_number$&
12934 .vindex "&$localhost_number$&"
12935 This contains the expanded value of the
12936 &%localhost_number%& option. The expansion happens after the main options have
12937 been read.
12938
12939 .vitem &$log_inodes$&
12940 .vindex "&$log_inodes$&"
12941 The number of free inodes in the disk partition where Exim's
12942 log files are being written. The value is recalculated whenever the variable is
12943 referenced. If the relevant file system does not have the concept of inodes,
12944 the value of is -1. See also the &%check_log_inodes%& option.
12945
12946 .vitem &$log_space$&
12947 .vindex "&$log_space$&"
12948 The amount of free space (as a number of kilobytes) in the disk
12949 partition where Exim's log files are being written. The value is recalculated
12950 whenever the variable is referenced. If the operating system does not have the
12951 ability to find the amount of free space (only true for experimental systems),
12952 the space value is -1. See also the &%check_log_space%& option.
12953
12954
12955 .vitem &$lookup_dnssec_authenticated$&
12956 .vindex "&$lookup_dnssec_authenticated$&"
12957 This variable is set after a DNS lookup done by
12958 a dnsdb lookup expansion, dnslookup router or smtp transport.
12959 .cindex "DNS" "DNSSEC"
12960 It will be empty if &(DNSSEC)& was not requested,
12961 &"no"& if the result was not labelled as authenticated data
12962 and &"yes"& if it was.
12963 Results that are labelled as authoritative answer that match
12964 the &%dns_trust_aa%& configuration variable count also
12965 as authenticated data.
12966
12967 .vitem &$mailstore_basename$&
12968 .vindex "&$mailstore_basename$&"
12969 This variable is set only when doing deliveries in &"mailstore"& format in the
12970 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12971 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12972 contains the basename of the files that are being written, that is, the name
12973 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12974 variable is empty.
12975
12976 .vitem &$malware_name$&
12977 .vindex "&$malware_name$&"
12978 This variable is available when Exim is compiled with the
12979 content-scanning extension. It is set to the name of the virus that was found
12980 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12981
12982 .vitem &$max_received_linelength$&
12983 .vindex "&$max_received_linelength$&"
12984 .cindex "maximum" "line length"
12985 .cindex "line length" "maximum"
12986 This variable contains the number of bytes in the longest line that was
12987 received as part of the message, not counting the line termination
12988 character(s).
12989 It is not valid if the &%spool_wireformat%& option is used.
12990
12991 .vitem &$message_age$&
12992 .cindex "message" "age of"
12993 .vindex "&$message_age$&"
12994 This variable is set at the start of a delivery attempt to contain the number
12995 of seconds since the message was received. It does not change during a single
12996 delivery attempt.
12997
12998 .tvar &$message_body$&
12999 .cindex "body of message" "expansion variable"
13000 .cindex "message body" "in expansion"
13001 .cindex "binary zero" "in message body"
13002 .oindex "&%message_body_visible%&"
13003 This variable contains the initial portion of a message's body while it is
13004 being delivered, and is intended mainly for use in filter files. The maximum
13005 number of characters of the body that are put into the variable is set by the
13006 &%message_body_visible%& configuration option; the default is 500.
13007
13008 .oindex "&%message_body_newlines%&"
13009 By default, newlines are converted into spaces in &$message_body$&, to make it
13010 easier to search for phrases that might be split over a line break. However,
13011 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13012 zeros are always converted into spaces.
13013
13014 .tvar &$message_body_end$&
13015 .cindex "body of message" "expansion variable"
13016 .cindex "message body" "in expansion"
13017 This variable contains the final portion of a message's
13018 body while it is being delivered. The format and maximum size are as for
13019 &$message_body$&.
13020
13021 .vitem &$message_body_size$&
13022 .cindex "body of message" "size"
13023 .cindex "message body" "size"
13024 .vindex "&$message_body_size$&"
13025 When a message is being delivered, this variable contains the size of the body
13026 in bytes. The count starts from the character after the blank line that
13027 separates the body from the header. Newlines are included in the count. See
13028 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13029
13030 If the spool file is wireformat
13031 (see the &%spool_wireformat%& main option)
13032 the CRLF line-terminators are included in the count.
13033
13034 .vitem &$message_exim_id$&
13035 .vindex "&$message_exim_id$&"
13036 When a message is being received or delivered, this variable contains the
13037 unique message id that is generated and used by Exim to identify the message.
13038 An id is not created for a message until after its header has been successfully
13039 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13040 line; it is the local id that Exim assigns to the message, for example:
13041 &`1BXTIK-0001yO-VA`&.
13042
13043 .tvar &$message_headers$&
13044 This variable contains a concatenation of all the header lines when a message
13045 is being processed, except for lines added by routers or transports. The header
13046 lines are separated by newline characters. Their contents are decoded in the
13047 same way as a header line that is inserted by &%bheader%&.
13048
13049 .tvar &$message_headers_raw$&
13050 This variable is like &$message_headers$& except that no processing of the
13051 contents of header lines is done.
13052
13053 .vitem &$message_id$&
13054 This is an old name for &$message_exim_id$&. It is now deprecated.
13055
13056 .vitem &$message_linecount$&
13057 .vindex "&$message_linecount$&"
13058 This variable contains the total number of lines in the header and body of the
13059 message. Compare &$body_linecount$&, which is the count for the body only.
13060 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13061 number of lines received. Before delivery happens (that is, before filters,
13062 routers, and transports run) the count is increased to include the
13063 &'Received:'& header line that Exim standardly adds, and also any other header
13064 lines that are added by ACLs. The blank line that separates the message header
13065 from the body is not counted.
13066
13067 As with the special case of &$message_size$&, during the expansion of the
13068 appendfile transport's maildir_tag option in maildir format, the value of
13069 &$message_linecount$& is the precise size of the number of newlines in the
13070 file that has been written (minus one for the blank line between the
13071 header and the body).
13072
13073 Here is an example of the use of this variable in a DATA ACL:
13074 .code
13075 deny condition = \
13076       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13077      message   = Too many lines in message header
13078 .endd
13079 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13080 message has not yet been received.
13081
13082 This variable is not valid if the &%spool_wireformat%& option is used.
13083
13084 .vitem &$message_size$&
13085 .cindex "size" "of message"
13086 .cindex "message" "size"
13087 .vindex "&$message_size$&"
13088 When a message is being processed, this variable contains its size in bytes. In
13089 most cases, the size includes those headers that were received with the
13090 message, but not those (such as &'Envelope-to:'&) that are added to individual
13091 deliveries as they are written. However, there is one special case: during the
13092 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13093 doing a delivery in maildir format, the value of &$message_size$& is the
13094 precise size of the file that has been written. See also
13095 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13096
13097 .cindex "RCPT" "value of &$message_size$&"
13098 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13099 contains the size supplied on the MAIL command, or -1 if no size was given. The
13100 value may not, of course, be truthful.
13101
13102 .vitem &$mime_anomaly_level$& &&&
13103        &$mime_anomaly_text$& &&&
13104        &$mime_boundary$& &&&
13105        &$mime_charset$& &&&
13106        &$mime_content_description$& &&&
13107        &$mime_content_disposition$& &&&
13108        &$mime_content_id$& &&&
13109        &$mime_content_size$& &&&
13110        &$mime_content_transfer_encoding$& &&&
13111        &$mime_content_type$& &&&
13112        &$mime_decoded_filename$& &&&
13113        &$mime_filename$& &&&
13114        &$mime_is_coverletter$& &&&
13115        &$mime_is_multipart$& &&&
13116        &$mime_is_rfc822$& &&&
13117        &$mime_part_count$&
13118 A number of variables whose names start with &$mime$& are
13119 available when Exim is compiled with the content-scanning extension. For
13120 details, see section &<<SECTscanmimepart>>&.
13121
13122 .vitem "&$n0$& &-- &$n9$&"
13123 These variables are counters that can be incremented by means
13124 of the &%add%& command in filter files.
13125
13126 .tvar &$original_domain$&
13127 .vindex "&$domain$&"
13128 When a top-level address is being processed for delivery, this contains the
13129 same value as &$domain$&. However, if a &"child"& address (for example,
13130 generated by an alias, forward, or filter file) is being processed, this
13131 variable contains the domain of the original address (lower cased). This
13132 differs from &$parent_domain$& only when there is more than one level of
13133 aliasing or forwarding. When more than one address is being delivered in a
13134 single transport run, &$original_domain$& is not set.
13135
13136 If a new address is created by means of a &%deliver%& command in a system
13137 filter, it is set up with an artificial &"parent"& address. This has the local
13138 part &'system-filter'& and the default qualify domain.
13139
13140 .tvar &$original_local_part$&
13141 .vindex "&$local_part$&"
13142 When a top-level address is being processed for delivery, this contains the
13143 same value as &$local_part$&, unless a prefix or suffix was removed from the
13144 local part, because &$original_local_part$& always contains the full local
13145 part. When a &"child"& address (for example, generated by an alias, forward, or
13146 filter file) is being processed, this variable contains the full local part of
13147 the original address.
13148
13149 If the router that did the redirection processed the local part
13150 case-insensitively, the value in &$original_local_part$& is in lower case.
13151 This variable differs from &$parent_local_part$& only when there is more than
13152 one level of aliasing or forwarding. When more than one address is being
13153 delivered in a single transport run, &$original_local_part$& is not set.
13154
13155 If a new address is created by means of a &%deliver%& command in a system
13156 filter, it is set up with an artificial &"parent"& address. This has the local
13157 part &'system-filter'& and the default qualify domain.
13158
13159 .vitem &$originator_gid$&
13160 .cindex "gid (group id)" "of originating user"
13161 .cindex "sender" "gid"
13162 .vindex "&$caller_gid$&"
13163 .vindex "&$originator_gid$&"
13164 This variable contains the value of &$caller_gid$& that was set when the
13165 message was received. For messages received via the command line, this is the
13166 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13167 normally the gid of the Exim user.
13168
13169 .vitem &$originator_uid$&
13170 .cindex "uid (user id)" "of originating user"
13171 .cindex "sender" "uid"
13172 .vindex "&$caller_uid$&"
13173 .vindex "&$originator_uid$&"
13174 The value of &$caller_uid$& that was set when the message was received. For
13175 messages received via the command line, this is the uid of the sending user.
13176 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13177 user.
13178
13179 .tvar &$parent_domain$&
13180 This variable is similar to &$original_domain$& (see
13181 above), except that it refers to the immediately preceding parent address.
13182
13183 .tvar &$parent_local_part$&
13184 This variable is similar to &$original_local_part$&
13185 (see above), except that it refers to the immediately preceding parent address.
13186
13187 .vitem &$pid$&
13188 .cindex "pid (process id)" "of current process"
13189 .vindex "&$pid$&"
13190 This variable contains the current process id.
13191
13192 .vitem &$pipe_addresses$&
13193 .cindex "filter" "transport filter"
13194 .cindex "transport" "filter"
13195 .vindex "&$pipe_addresses$&"
13196 This is not an expansion variable, but is mentioned here because the string
13197 &`$pipe_addresses`& is handled specially in the command specification for the
13198 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13199 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13200 It cannot be used in general expansion strings, and provokes an &"unknown
13201 variable"& error if encountered.
13202 &*Note*&: This value permits data supplied by a potential attacker to
13203 be used in the command for a &(pipe)& transport.
13204 Such configurations should be carefully assessed for security vulnerbilities.
13205
13206 .vitem &$primary_hostname$&
13207 .vindex "&$primary_hostname$&"
13208 This variable contains the value set by &%primary_hostname%& in the
13209 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13210 a single-component name, Exim calls &[gethostbyname()]& (or
13211 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13212 qualified host name. See also &$smtp_active_hostname$&.
13213
13214
13215 .vitem &$proxy_external_address$& &&&
13216        &$proxy_external_port$& &&&
13217        &$proxy_local_address$& &&&
13218        &$proxy_local_port$& &&&
13219        &$proxy_session$&
13220 These variables are only available when built with Proxy Protocol
13221 or SOCKS5 support.
13222 For details see chapter &<<SECTproxyInbound>>&.
13223
13224 .vitem &$prdr_requested$&
13225 .cindex "PRDR" "variable for"
13226 This variable is set to &"yes"& if PRDR was requested by the client for the
13227 current message, otherwise &"no"&.
13228
13229 .vitem &$prvscheck_address$& &&&
13230        &$prvscheck_keynum$& &&&
13231        &$prvscheck_result$&
13232 These variables are used in conjunction with the &%prvscheck%& expansion item,
13233 which is described in sections &<<SECTexpansionitems>>& and
13234 &<<SECTverifyPRVS>>&.
13235
13236 .vitem &$qualify_domain$&
13237 .vindex "&$qualify_domain$&"
13238 The value set for the &%qualify_domain%& option in the configuration file.
13239
13240 .vitem &$qualify_recipient$&
13241 .vindex "&$qualify_recipient$&"
13242 The value set for the &%qualify_recipient%& option in the configuration file,
13243 or if not set, the value of &$qualify_domain$&.
13244
13245 .vitem &$queue_name$&
13246 .vindex &$queue_name$&
13247 .cindex "named queues" variable
13248 .cindex queues named
13249 The name of the spool queue in use; empty for the default queue.
13250
13251 .vitem &$queue_size$&
13252 .vindex "&$queue_size$&"
13253 .cindex "queue" "size of"
13254 .cindex "spool" "number of messages"
13255 This variable contains the number of messages queued.
13256 It is evaluated on demand, but no more often than once every minute.
13257 If there is no daemon notifier socket open, the value will be
13258 an empty string.
13259
13260 .vitem &$r_...$&
13261 .vindex &$r_...$&
13262 .cindex router variables
13263 Values can be placed in these variables by the &%set%& option of a router.
13264 They can be given any name that starts with &$r_$&.
13265 The values persist for the address being handled through subsequent routers
13266 and the eventual transport.
13267
13268 .vitem &$rcpt_count$&
13269 .vindex "&$rcpt_count$&"
13270 When a message is being received by SMTP, this variable contains the number of
13271 RCPT commands received for the current message. If this variable is used in a
13272 RCPT ACL, its value includes the current command.
13273
13274 .vitem &$rcpt_defer_count$&
13275 .vindex "&$rcpt_defer_count$&"
13276 .cindex "4&'xx'& responses" "count of"
13277 When a message is being received by SMTP, this variable contains the number of
13278 RCPT commands in the current message that have previously been rejected with a
13279 temporary (4&'xx'&) response.
13280
13281 .vitem &$rcpt_fail_count$&
13282 .vindex "&$rcpt_fail_count$&"
13283 When a message is being received by SMTP, this variable contains the number of
13284 RCPT commands in the current message that have previously been rejected with a
13285 permanent (5&'xx'&) response.
13286
13287 .vitem &$received_count$&
13288 .vindex "&$received_count$&"
13289 This variable contains the number of &'Received:'& header lines in the message,
13290 including the one added by Exim (so its value is always greater than zero). It
13291 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13292 delivering.
13293
13294 .tvar &$received_for$&
13295 If there is only a single recipient address in an incoming message, this
13296 variable contains that address when the &'Received:'& header line is being
13297 built. The value is copied after recipient rewriting has happened, but before
13298 the &[local_scan()]& function is run.
13299
13300 .vitem &$received_ip_address$& &&&
13301        &$received_port$&
13302 .vindex "&$received_ip_address$&"
13303 .vindex "&$received_port$&"
13304 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13305 variables are set to the address and port on the local IP interface.
13306 (The remote IP address and port are in
13307 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13308 the port value is -1 unless it has been set using the &%-oMi%& command line
13309 option.
13310
13311 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13312 could be used, for example, to make the filename for a TLS certificate depend
13313 on which interface and/or port is being used for the incoming connection. The
13314 values of &$received_ip_address$& and &$received_port$& are saved with any
13315 messages that are received, thus making these variables available at delivery
13316 time.
13317 For outbound connections see &$sending_ip_address$&.
13318
13319 .vitem &$received_protocol$&
13320 .vindex "&$received_protocol$&"
13321 When a message is being processed, this variable contains the name of the
13322 protocol by which it was received. Most of the names used by Exim are defined
13323 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13324 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13325 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13326 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13327 connection and the client was successfully authenticated.
13328
13329 Exim uses the protocol name &"smtps"& for the case when encryption is
13330 automatically set up on connection without the use of STARTTLS (see
13331 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13332 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13333 where the client initially uses EHLO, sets up an encrypted connection using
13334 STARTTLS, and then uses HELO afterwards.
13335
13336 The &%-oMr%& option provides a way of specifying a custom protocol name for
13337 messages that are injected locally by trusted callers. This is commonly used to
13338 identify messages that are being re-injected after some kind of scanning.
13339
13340 .vitem &$received_time$&
13341 .vindex "&$received_time$&"
13342 This variable contains the date and time when the current message was received,
13343 as a number of seconds since the start of the Unix epoch.
13344
13345 .vitem &$recipient_data$&
13346 .vindex "&$recipient_data$&"
13347 This variable is set after an indexing lookup success in an ACL &%recipients%&
13348 condition. It contains the data from the lookup, and the value remains set
13349 until the next &%recipients%& test. Thus, you can do things like this:
13350 .display
13351 &`require recipients  = cdb*@;/some/file`&
13352 &`deny    `&&'some further test involving'& &`$recipient_data`&
13353 .endd
13354 &*Warning*&: This variable is set only when a lookup is used as an indexing
13355 method in the address list, using the semicolon syntax as in the example above.
13356 The variable is not set for a lookup that is used as part of the string
13357 expansion that all such lists undergo before being interpreted.
13358
13359 .vitem &$recipient_verify_failure$&
13360 .vindex "&$recipient_verify_failure$&"
13361 In an ACL, when a recipient verification fails, this variable contains
13362 information about the failure. It is set to one of the following words:
13363
13364 .ilist
13365 &"qualify"&: The address was unqualified (no domain), and the message
13366 was neither local nor came from an exempted host.
13367
13368 .next
13369 &"route"&: Routing failed.
13370
13371 .next
13372 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13373 or before the MAIL command (that is, on initial connection, HELO, or
13374 MAIL).
13375
13376 .next
13377 &"recipient"&: The RCPT command in a callout was rejected.
13378 .next
13379
13380 &"postmaster"&: The postmaster check in a callout was rejected.
13381 .endlist
13382
13383 The main use of this variable is expected to be to distinguish between
13384 rejections of MAIL and rejections of RCPT.
13385
13386 .tvar &$recipients$&
13387 This variable contains a list of envelope recipients for a message. A comma and
13388 a space separate the addresses in the replacement text. However, the variable
13389 is not generally available, to prevent exposure of Bcc recipients in
13390 unprivileged users' filter files. You can use &$recipients$& only in these
13391 cases:
13392
13393 .olist
13394 In a system filter file.
13395 .next
13396 In the ACLs associated with the DATA command and with non-SMTP messages, that
13397 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13398 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13399 &%acl_not_smtp_mime%&.
13400 .next
13401 From within a &[local_scan()]& function.
13402 .endlist
13403
13404
13405 .vitem &$recipients_count$&
13406 .vindex "&$recipients_count$&"
13407 When a message is being processed, this variable contains the number of
13408 envelope recipients that came with the message. Duplicates are not excluded
13409 from the count. While a message is being received over SMTP, the number
13410 increases for each accepted recipient. It can be referenced in an ACL.
13411
13412
13413 .vitem &$regex_match_string$&
13414 .vindex "&$regex_match_string$&"
13415 This variable is set to contain the matching regular expression after a
13416 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13417
13418 .vitem "&$regex1$&, &$regex2$&, etc"
13419 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13420 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13421 these variables contain the
13422 captured substrings identified by the regular expression.
13423 If the subject string was tainted then so will any captured substring.
13424
13425
13426 .tvar &$reply_address$&
13427 When a message is being processed, this variable contains the contents of the
13428 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13429 contents of the &'From:'& header line. Apart from the removal of leading
13430 white space, the value is not processed in any way. In particular, no RFC 2047
13431 decoding or character code translation takes place.
13432
13433 .vitem &$return_path$&
13434 .vindex "&$return_path$&"
13435 When a message is being delivered, this variable contains the return path &--
13436 the sender field that will be sent as part of the envelope. It is not enclosed
13437 in <> characters. At the start of routing an address, &$return_path$& has the
13438 same value as &$sender_address$&, but if, for example, an incoming message to a
13439 mailing list has been expanded by a router which specifies a different address
13440 for bounce messages, &$return_path$& subsequently contains the new bounce
13441 address, whereas &$sender_address$& always contains the original sender address
13442 that was received with the message. In other words, &$sender_address$& contains
13443 the incoming envelope sender, and &$return_path$& contains the outgoing
13444 envelope sender.
13445
13446 .vitem &$return_size_limit$&
13447 .vindex "&$return_size_limit$&"
13448 This is an obsolete name for &$bounce_return_size_limit$&.
13449
13450 .vitem &$router_name$&
13451 .cindex "router" "name"
13452 .cindex "name" "of router"
13453 .vindex "&$router_name$&"
13454 During the running of a router, or a transport called,
13455 this variable contains the router name.
13456
13457 .vitem &$runrc$&
13458 .cindex "return code" "from &%run%& expansion"
13459 .vindex "&$runrc$&"
13460 This variable contains the return code from a command that is run by the
13461 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13462 assume the order in which option values are expanded, except for those
13463 preconditions whose order of testing is documented. Therefore, you cannot
13464 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13465 another.
13466
13467 .vitem &$self_hostname$&
13468 .oindex "&%self%&" "value of host name"
13469 .vindex "&$self_hostname$&"
13470 When an address is routed to a supposedly remote host that turns out to be the
13471 local host, what happens is controlled by the &%self%& generic router option.
13472 One of its values causes the address to be passed to another router. When this
13473 happens, &$self_hostname$& is set to the name of the local host that the
13474 original router encountered. In other circumstances its contents are null.
13475
13476 .tvar &$sender_address$&
13477 When a message is being processed, this variable contains the sender's address
13478 that was received in the message's envelope. The case of letters in the address
13479 is retained, in both the local part and the domain. For bounce messages, the
13480 value of this variable is the empty string. See also &$return_path$&.
13481
13482 .vitem &$sender_address_data$&
13483 .vindex "&$address_data$&"
13484 .vindex "&$sender_address_data$&"
13485 If &$address_data$& is set when the routers are called from an ACL to verify a
13486 sender address, the final value is preserved in &$sender_address_data$&, to
13487 distinguish it from data from a recipient address. The value does not persist
13488 after the end of the current ACL statement. If you want to preserve it for
13489 longer, you can save it in an ACL variable.
13490
13491 .tvar &$sender_address_domain$&
13492 The domain portion of &$sender_address$&.
13493
13494 .tvar &$sender_address_local_part$&
13495 The local part portion of &$sender_address$&.
13496
13497 .vitem &$sender_data$&
13498 .vindex "&$sender_data$&"
13499 This variable is set after a lookup success in an ACL &%senders%& condition or
13500 in a router &%senders%& option. It contains the data from the lookup, and the
13501 value remains set until the next &%senders%& test. Thus, you can do things like
13502 this:
13503 .display
13504 &`require senders      = cdb*@;/some/file`&
13505 &`deny    `&&'some further test involving'& &`$sender_data`&
13506 .endd
13507 &*Warning*&: This variable is set only when a lookup is used as an indexing
13508 method in the address list, using the semicolon syntax as in the example above.
13509 The variable is not set for a lookup that is used as part of the string
13510 expansion that all such lists undergo before being interpreted.
13511
13512 .vitem &$sender_fullhost$&
13513 .vindex "&$sender_fullhost$&"
13514 When a message is received from a remote host, this variable contains the host
13515 name and IP address in a single string. It ends with the IP address in square
13516 brackets, followed by a colon and a port number if the logging of ports is
13517 enabled. The format of the rest of the string depends on whether the host
13518 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13519 looking up its IP address. (Looking up the IP address can be forced by the
13520 &%host_lookup%& option, independent of verification.) A plain host name at the
13521 start of the string is a verified host name; if this is not present,
13522 verification either failed or was not requested. A host name in parentheses is
13523 the argument of a HELO or EHLO command. This is omitted if it is identical to
13524 the verified host name or to the host's IP address in square brackets.
13525
13526 .vitem &$sender_helo_dnssec$&
13527 .vindex "&$sender_helo_dnssec$&"
13528 This boolean variable is true if a successful HELO verification was
13529 .cindex "DNS" "DNSSEC"
13530 done using DNS information the resolver library stated was authenticated data.
13531
13532 .tvar &$sender_helo_name$&
13533 When a message is received from a remote host that has issued a HELO or EHLO
13534 command, the argument of that command is placed in this variable. It is also
13535 set if HELO or EHLO is used when a message is received using SMTP locally via
13536 the &%-bs%& or &%-bS%& options.
13537
13538 .vitem &$sender_host_address$&
13539 .vindex "&$sender_host_address$&"
13540 When a message is received from a remote host using SMTP,
13541 this variable contains that
13542 host's IP address. For locally non-SMTP submitted messages, it is empty.
13543
13544 .vitem &$sender_host_authenticated$&
13545 .vindex "&$sender_host_authenticated$&"
13546 This variable contains the name (not the public name) of the authenticator
13547 driver that successfully authenticated the client from which the message was
13548 received. It is empty if there was no successful authentication. See also
13549 &$authenticated_id$&.
13550
13551 .vitem &$sender_host_dnssec$&
13552 .vindex "&$sender_host_dnssec$&"
13553 If an attempt to populate &$sender_host_name$& has been made
13554 (by reference, &%hosts_lookup%& or
13555 otherwise) then this boolean will have been set true if, and only if, the
13556 resolver library states that both
13557 the reverse and forward DNS were authenticated data.  At all
13558 other times, this variable is false.
13559
13560 .cindex "DNS" "DNSSEC"
13561 It is likely that you will need to coerce DNSSEC support on in the resolver
13562 library, by setting:
13563 .code
13564 dns_dnssec_ok = 1
13565 .endd
13566
13567 In addition, on Linux with glibc 2.31 or newer the resolver library will
13568 default to stripping out a successful validation status.
13569 This will break a previously working Exim installation.
13570 Provided that you do trust the resolver (ie, is on localhost) you can tell
13571 glibc to pass through any successful validation with a new option in
13572 &_/etc/resolv.conf_&:
13573 .code
13574 options trust-ad
13575 .endd
13576
13577 Exim does not perform DNSSEC validation itself, instead leaving that to a
13578 validating resolver (e.g. unbound, or bind with suitable configuration).
13579
13580 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13581 mechanism in the list, then this variable will be false.
13582
13583 This requires that your system resolver library support EDNS0 (and that
13584 DNSSEC flags exist in the system headers).  If the resolver silently drops
13585 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13586 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13587
13588
13589 .tvar &$sender_host_name$&
13590 When a message is received from a remote host, this variable contains the
13591 host's name as obtained by looking up its IP address. For messages received by
13592 other means, this variable is empty.
13593
13594 .vindex "&$host_lookup_failed$&"
13595 If the host name has not previously been looked up, a reference to
13596 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13597 A looked up name is accepted only if it leads back to the original IP address
13598 via a forward lookup. If either the reverse or the forward lookup fails to find
13599 any data, or if the forward lookup does not yield the original IP address,
13600 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13601
13602 .vindex "&$host_lookup_deferred$&"
13603 However, if either of the lookups cannot be completed (for example, there is a
13604 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13605 &$host_lookup_failed$& remains set to &"0"&.
13606
13607 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13608 host name again if there is a subsequent reference to &$sender_host_name$&
13609 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13610 is set to &"1"&.
13611
13612 Exim does not automatically look up every calling host's name. If you want
13613 maximum efficiency, you should arrange your configuration so that it avoids
13614 these lookups altogether. The lookup happens only if one or more of the
13615 following are true:
13616
13617 .ilist
13618 A string containing &$sender_host_name$& is expanded.
13619 .next
13620 The calling host matches the list in &%host_lookup%&. In the default
13621 configuration, this option is set to *, so it must be changed if lookups are
13622 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13623 .next
13624 Exim needs the host name in order to test an item in a host list. The items
13625 that require this are described in sections &<<SECThoslispatnam>>& and
13626 &<<SECThoslispatnamsk>>&.
13627 .next
13628 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13629 In this case, the host name is required to compare with the name quoted in any
13630 EHLO or HELO commands that the client issues.
13631 .next
13632 The remote host issues a EHLO or HELO command that quotes one of the
13633 domains in &%helo_lookup_domains%&. The default value of this option is
13634 . ==== As this is a nested list, any displays it contains must be indented
13635 . ==== as otherwise they are too far to the left.
13636 .code
13637   helo_lookup_domains = @ : @[]
13638 .endd
13639 which causes a lookup if a remote host (incorrectly) gives the server's name or
13640 IP address in an EHLO or HELO command.
13641 .endlist
13642
13643
13644 .vitem &$sender_host_port$&
13645 .vindex "&$sender_host_port$&"
13646 When a message is received from a remote host, this variable contains the port
13647 number that was used on the remote host.
13648
13649 .vitem &$sender_ident$&
13650 .vindex "&$sender_ident$&"
13651 When a message is received from a remote host, this variable contains the
13652 identification received in response to an RFC 1413 request. When a message has
13653 been received locally, this variable contains the login name of the user that
13654 called Exim.
13655
13656 .vitem &$sender_rate_$&&'xxx'&
13657 A number of variables whose names begin &$sender_rate_$& are set as part of the
13658 &%ratelimit%& ACL condition. Details are given in section
13659 &<<SECTratelimiting>>&.
13660
13661 .vitem &$sender_rcvhost$&
13662 .cindex "DNS" "reverse lookup"
13663 .cindex "reverse DNS lookup"
13664 .vindex "&$sender_rcvhost$&"
13665 This is provided specifically for use in &'Received:'& headers. It starts with
13666 either the verified host name (as obtained from a reverse DNS lookup) or, if
13667 there is no verified host name, the IP address in square brackets. After that
13668 there may be text in parentheses. When the first item is a verified host name,
13669 the first thing in the parentheses is the IP address in square brackets,
13670 followed by a colon and a port number if port logging is enabled. When the
13671 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13672 the parentheses.
13673
13674 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13675 was used and its argument was not identical to the real host name or IP
13676 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13677 all three items are present in the parentheses, a newline and tab are inserted
13678 into the string, to improve the formatting of the &'Received:'& header.
13679
13680 .vitem &$sender_verify_failure$&
13681 .vindex "&$sender_verify_failure$&"
13682 In an ACL, when a sender verification fails, this variable contains information
13683 about the failure. The details are the same as for
13684 &$recipient_verify_failure$&.
13685
13686 .vitem &$sending_ip_address$&
13687 .vindex "&$sending_ip_address$&"
13688 This variable is set whenever an outgoing SMTP connection to another host has
13689 been set up. It contains the IP address of the local interface that is being
13690 used. This is useful if a host that has more than one IP address wants to take
13691 on different personalities depending on which one is being used. For incoming
13692 connections, see &$received_ip_address$&.
13693
13694 .vitem &$sending_port$&
13695 .vindex "&$sending_port$&"
13696 This variable is set whenever an outgoing SMTP connection to another host has
13697 been set up. It contains the local port that is being used. For incoming
13698 connections, see &$received_port$&.
13699
13700 .vitem &$smtp_active_hostname$&
13701 .vindex "&$smtp_active_hostname$&"
13702 During an incoming SMTP session, this variable contains the value of the active
13703 host name, as specified by the &%smtp_active_hostname%& option. The value of
13704 &$smtp_active_hostname$& is saved with any message that is received, so its
13705 value can be consulted during routing and delivery.
13706
13707 .tvar &$smtp_command$&
13708 During the processing of an incoming SMTP command, this variable contains the
13709 entire command. This makes it possible to distinguish between HELO and EHLO in
13710 the HELO ACL, and also to distinguish between commands such as these:
13711 .code
13712 MAIL FROM:<>
13713 MAIL FROM: <>
13714 .endd
13715 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13716 command, the address in &$smtp_command$& is the original address before any
13717 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13718 the address after SMTP-time rewriting.
13719
13720 .tvar &$smtp_command_argument$&
13721 .cindex "SMTP" "command, argument for"
13722 While an ACL is running to check an SMTP command, this variable contains the
13723 argument, that is, the text that follows the command name, with leading white
13724 space removed. Following the introduction of &$smtp_command$&, this variable is
13725 somewhat redundant, but is retained for backwards compatibility.
13726
13727 .vitem &$smtp_command_history$&
13728 .cindex SMTP "command history"
13729 .vindex "&$smtp_command_history$&"
13730 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13731 received, in time-order left to right.  Only a limited number of commands
13732 are remembered.
13733
13734 .vitem &$smtp_count_at_connection_start$&
13735 .vindex "&$smtp_count_at_connection_start$&"
13736 This variable is set greater than zero only in processes spawned by the Exim
13737 daemon for handling incoming SMTP connections. The name is deliberately long,
13738 in order to emphasize what the contents are. When the daemon accepts a new
13739 connection, it increments this variable. A copy of the variable is passed to
13740 the child process that handles the connection, but its value is fixed, and
13741 never changes. It is only an approximation of how many incoming connections
13742 there actually are, because many other connections may come and go while a
13743 single connection is being processed. When a child process terminates, the
13744 daemon decrements its copy of the variable.
13745
13746 .vitem "&$sn0$& &-- &$sn9$&"
13747 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13748 that were current at the end of the system filter file. This allows a system
13749 filter file to set values that can be tested in users' filter files. For
13750 example, a system filter could set a value indicating how likely it is that a
13751 message is junk mail.
13752
13753 .vitem &$spam_score$& &&&
13754        &$spam_score_int$& &&&
13755        &$spam_bar$& &&&
13756        &$spam_report$& &&&
13757        &$spam_action$&
13758 A number of variables whose names start with &$spam$& are available when Exim
13759 is compiled with the content-scanning extension. For details, see section
13760 &<<SECTscanspamass>>&.
13761
13762 .vitem &$spf_header_comment$& &&&
13763        &$spf_received$& &&&
13764        &$spf_result$& &&&
13765        &$spf_result_guessed$& &&&
13766        &$spf_smtp_comment$&
13767 These variables are only available if Exim is built with SPF support.
13768 For details see section &<<SECSPF>>&.
13769
13770 .vitem &$spool_directory$&
13771 .vindex "&$spool_directory$&"
13772 The name of Exim's spool directory.
13773
13774 .vitem &$spool_inodes$&
13775 .vindex "&$spool_inodes$&"
13776 The number of free inodes in the disk partition where Exim's spool files are
13777 being written. The value is recalculated whenever the variable is referenced.
13778 If the relevant file system does not have the concept of inodes, the value of
13779 is -1. See also the &%check_spool_inodes%& option.
13780
13781 .vitem &$spool_space$&
13782 .vindex "&$spool_space$&"
13783 The amount of free space (as a number of kilobytes) in the disk partition where
13784 Exim's spool files are being written. The value is recalculated whenever the
13785 variable is referenced. If the operating system does not have the ability to
13786 find the amount of free space (only true for experimental systems), the space
13787 value is -1. For example, to check in an ACL that there is at least 50
13788 megabytes free on the spool, you could write:
13789 .code
13790 condition = ${if > {$spool_space}{50000}}
13791 .endd
13792 See also the &%check_spool_space%& option.
13793
13794
13795 .vitem &$thisaddress$&
13796 .vindex "&$thisaddress$&"
13797 This variable is set only during the processing of the &%foranyaddress%&
13798 command in a filter file. Its use is explained in the description of that
13799 command, which can be found in the separate document entitled &'Exim's
13800 interfaces to mail filtering'&.
13801
13802 .vitem &$tls_in_bits$&
13803 .vindex "&$tls_in_bits$&"
13804 Contains an approximation of the TLS cipher's bit-strength
13805 on the inbound connection; the meaning of
13806 this depends upon the TLS implementation used.
13807 If TLS has not been negotiated, the value will be 0.
13808 The value of this is automatically fed into the Cyrus SASL authenticator
13809 when acting as a server, to specify the "external SSF" (a SASL term).
13810
13811 The deprecated &$tls_bits$& variable refers to the inbound side
13812 except when used in the context of an outbound SMTP delivery, when it refers to
13813 the outbound.
13814
13815 .vitem &$tls_out_bits$&
13816 .vindex "&$tls_out_bits$&"
13817 Contains an approximation of the TLS cipher's bit-strength
13818 on an outbound SMTP connection; the meaning of
13819 this depends upon the TLS implementation used.
13820 If TLS has not been negotiated, the value will be 0.
13821
13822 .vitem &$tls_in_ourcert$&
13823 .vindex "&$tls_in_ourcert$&"
13824 .cindex certificate variables
13825 This variable refers to the certificate presented to the peer of an
13826 inbound connection when the message was received.
13827 It is only useful as the argument of a
13828 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13829 or a &%def%& condition.
13830
13831 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13832 when a list of more than one
13833 file is used for &%tls_certificate%&, this variable is not reliable.
13834 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13835
13836 .vitem &$tls_in_peercert$&
13837 .vindex "&$tls_in_peercert$&"
13838 This variable refers to the certificate presented by the peer of an
13839 inbound connection when the message was received.
13840 It is only useful as the argument of a
13841 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13842 or a &%def%& condition.
13843 If certificate verification fails it may refer to a failing chain element
13844 which is not the leaf.
13845
13846 .vitem &$tls_out_ourcert$&
13847 .vindex "&$tls_out_ourcert$&"
13848 This variable refers to the certificate presented to the peer of an
13849 outbound connection.  It is only useful as the argument of a
13850 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13851 or a &%def%& condition.
13852
13853 .vitem &$tls_out_peercert$&
13854 .vindex "&$tls_out_peercert$&"
13855 This variable refers to the certificate presented by the peer of an
13856 outbound connection.  It is only useful as the argument of a
13857 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13858 or a &%def%& condition.
13859 If certificate verification fails it may refer to a failing chain element
13860 which is not the leaf.
13861
13862 .vitem &$tls_in_certificate_verified$&
13863 .vindex "&$tls_in_certificate_verified$&"
13864 This variable is set to &"1"& if a TLS certificate was verified when the
13865 message was received, and &"0"& otherwise.
13866
13867 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13868 except when used in the context of an outbound SMTP delivery, when it refers to
13869 the outbound.
13870
13871 .vitem &$tls_out_certificate_verified$&
13872 .vindex "&$tls_out_certificate_verified$&"
13873 This variable is set to &"1"& if a TLS certificate was verified when an
13874 outbound SMTP connection was made,
13875 and &"0"& otherwise.
13876
13877 .vitem &$tls_in_cipher$&
13878 .vindex "&$tls_in_cipher$&"
13879 .vindex "&$tls_cipher$&"
13880 When a message is received from a remote host over an encrypted SMTP
13881 connection, this variable is set to the cipher suite that was negotiated, for
13882 example DES-CBC3-SHA. In other circumstances, in particular, for message
13883 received over unencrypted connections, the variable is empty. Testing
13884 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13885 non-encrypted connections during ACL processing.
13886
13887 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13888 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13889 becomes the same as &$tls_out_cipher$&.
13890
13891 .vitem &$tls_in_cipher_std$&
13892 .vindex "&$tls_in_cipher_std$&"
13893 As above, but returning the RFC standard name for the cipher suite.
13894
13895 .vitem &$tls_out_cipher$&
13896 .vindex "&$tls_out_cipher$&"
13897 This variable is
13898 cleared before any outgoing SMTP connection is made,
13899 and then set to the outgoing cipher suite if one is negotiated. See chapter
13900 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13901 details of the &(smtp)& transport.
13902
13903 .vitem &$tls_out_cipher_std$&
13904 .vindex "&$tls_out_cipher_std$&"
13905 As above, but returning the RFC standard name for the cipher suite.
13906
13907 .vitem &$tls_out_dane$&
13908 .vindex &$tls_out_dane$&
13909 DANE active status.  See section &<<SECDANE>>&.
13910
13911 .vitem &$tls_in_ocsp$&
13912 .vindex "&$tls_in_ocsp$&"
13913 When a message is received from a remote client connection
13914 the result of any OCSP request from the client is encoded in this variable:
13915 .code
13916 0 OCSP proof was not requested (default value)
13917 1 No response to request
13918 2 Response not verified
13919 3 Verification failed
13920 4 Verification succeeded
13921 .endd
13922
13923 .vitem &$tls_out_ocsp$&
13924 .vindex "&$tls_out_ocsp$&"
13925 When a message is sent to a remote host connection
13926 the result of any OCSP request made is encoded in this variable.
13927 See &$tls_in_ocsp$& for values.
13928
13929 .vitem &$tls_in_peerdn$&
13930 .vindex "&$tls_in_peerdn$&"
13931 .vindex "&$tls_peerdn$&"
13932 .cindex certificate "extracting fields"
13933 When a message is received from a remote host over an encrypted SMTP
13934 connection, and Exim is configured to request a certificate from the client,
13935 the value of the Distinguished Name of the certificate is made available in the
13936 &$tls_in_peerdn$& during subsequent processing.
13937 If certificate verification fails it may refer to a failing chain element
13938 which is not the leaf.
13939
13940 The deprecated &$tls_peerdn$& variable refers to the inbound side
13941 except when used in the context of an outbound SMTP delivery, when it refers to
13942 the outbound.
13943
13944 .vitem &$tls_out_peerdn$&
13945 .vindex "&$tls_out_peerdn$&"
13946 When a message is being delivered to a remote host over an encrypted SMTP
13947 connection, and Exim is configured to request a certificate from the server,
13948 the value of the Distinguished Name of the certificate is made available in the
13949 &$tls_out_peerdn$& during subsequent processing.
13950 If certificate verification fails it may refer to a failing chain element
13951 which is not the leaf.
13952
13953
13954 .vitem &$tls_in_resumption$& &&&
13955        &$tls_out_resumption$&
13956 .vindex &$tls_in_resumption$&
13957 .vindex &$tls_out_resumption$&
13958 .cindex TLS resumption
13959 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13960
13961
13962 .tvar &$tls_in_sni$&
13963 .vindex "&$tls_sni$&"
13964 .cindex "TLS" "Server Name Indication"
13965 .cindex "TLS" SNI
13966 .cindex SNI "observability on server"
13967 When a TLS session is being established, if the client sends the Server
13968 Name Indication extension, the value will be placed in this variable.
13969 If the variable appears in &%tls_certificate%& then this option and
13970 some others, described in &<<SECTtlssni>>&,
13971 will be re-expanded early in the TLS session, to permit
13972 a different certificate to be presented (and optionally a different key to be
13973 used) to the client, based upon the value of the SNI extension.
13974
13975 The deprecated &$tls_sni$& variable refers to the inbound side
13976 except when used in the context of an outbound SMTP delivery, when it refers to
13977 the outbound.
13978
13979 .vitem &$tls_out_sni$&
13980 .vindex "&$tls_out_sni$&"
13981 .cindex "TLS" "Server Name Indication"
13982 .cindex "TLS" SNI
13983 .cindex SNI "observability in client"
13984 During outbound
13985 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13986 the transport.
13987
13988 .vitem &$tls_out_tlsa_usage$&
13989 .vindex &$tls_out_tlsa_usage$&
13990 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13991
13992 .vitem &$tls_in_ver$&
13993 .vindex "&$tls_in_ver$&"
13994 When a message is received from a remote host over an encrypted SMTP connection
13995 this variable is set to the protocol version, eg &'TLS1.2'&.
13996
13997 .vitem &$tls_out_ver$&
13998 .vindex "&$tls_out_ver$&"
13999 When a message is being delivered to a remote host over an encrypted SMTP connection
14000 this variable is set to the protocol version.
14001
14002
14003 .vitem &$tod_bsdinbox$&
14004 .vindex "&$tod_bsdinbox$&"
14005 The time of day and the date, in the format required for BSD-style mailbox
14006 files, for example: Thu Oct 17 17:14:09 1995.
14007
14008 .vitem &$tod_epoch$&
14009 .vindex "&$tod_epoch$&"
14010 The time and date as a number of seconds since the start of the Unix epoch.
14011
14012 .vitem &$tod_epoch_l$&
14013 .vindex "&$tod_epoch_l$&"
14014 The time and date as a number of microseconds since the start of the Unix epoch.
14015
14016 .vitem &$tod_full$&
14017 .vindex "&$tod_full$&"
14018 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14019 +0100. The timezone is always given as a numerical offset from UTC, with
14020 positive values used for timezones that are ahead (east) of UTC, and negative
14021 values for those that are behind (west).
14022
14023 .vitem &$tod_log$&
14024 .vindex "&$tod_log$&"
14025 The time and date in the format used for writing Exim's log files, for example:
14026 1995-10-12 15:32:29, but without a timezone.
14027
14028 .vitem &$tod_logfile$&
14029 .vindex "&$tod_logfile$&"
14030 This variable contains the date in the format yyyymmdd. This is the format that
14031 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14032 flag.
14033
14034 .vitem &$tod_zone$&
14035 .vindex "&$tod_zone$&"
14036 This variable contains the numerical value of the local timezone, for example:
14037 -0500.
14038
14039 .vitem &$tod_zulu$&
14040 .vindex "&$tod_zulu$&"
14041 This variable contains the UTC date and time in &"Zulu"& format, as specified
14042 by ISO 8601, for example: 20030221154023Z.
14043
14044 .vitem &$transport_name$&
14045 .cindex "transport" "name"
14046 .cindex "name" "of transport"
14047 .vindex "&$transport_name$&"
14048 During the running of a transport, this variable contains its name.
14049
14050 .vitem &$value$&
14051 .vindex "&$value$&"
14052 This variable contains the result of an expansion lookup, extraction operation,
14053 or external command, as described above. It is also used during a
14054 &*reduce*& expansion.
14055
14056 .vitem &$verify_mode$&
14057 .vindex "&$verify_mode$&"
14058 While a router or transport is being run in verify mode or for cutthrough delivery,
14059 contains "S" for sender-verification or "R" for recipient-verification.
14060 Otherwise, empty.
14061
14062 .vitem &$version_number$&
14063 .vindex "&$version_number$&"
14064 The version number of Exim. Same as &$exim_version$&, may be overridden
14065 by the &%exim_version%& main config option.
14066
14067 .vitem &$warn_message_delay$&
14068 .vindex "&$warn_message_delay$&"
14069 This variable is set only during the creation of a message warning about a
14070 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14071
14072 .vitem &$warn_message_recipients$&
14073 .vindex "&$warn_message_recipients$&"
14074 This variable is set only during the creation of a message warning about a
14075 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14076 .endlist
14077 .ecindex IIDstrexp
14078
14079
14080
14081 . ////////////////////////////////////////////////////////////////////////////
14082 . ////////////////////////////////////////////////////////////////////////////
14083
14084 .chapter "Embedded Perl" "CHAPperl"
14085 .scindex IIDperl "Perl" "calling from Exim"
14086 Exim can be built to include an embedded Perl interpreter. When this is done,
14087 Perl subroutines can be called as part of the string expansion process. To make
14088 use of the Perl support, you need version 5.004 or later of Perl installed on
14089 your system. To include the embedded interpreter in the Exim binary, include
14090 the line
14091 .code
14092 EXIM_PERL = perl.o
14093 .endd
14094 in your &_Local/Makefile_& and then build Exim in the normal way.
14095
14096
14097 .section "Setting up so Perl can be used" "SECID85"
14098 .oindex "&%perl_startup%&"
14099 Access to Perl subroutines is via a global configuration option called
14100 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14101 no &%perl_startup%& option in the Exim configuration file then no Perl
14102 interpreter is started and there is almost no overhead for Exim (since none of
14103 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14104 option then the associated value is taken to be Perl code which is executed in
14105 a newly created Perl interpreter.
14106
14107 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14108 need backslashes before any characters to escape special meanings. The option
14109 should usually be something like
14110 .code
14111 perl_startup = do '/etc/exim.pl'
14112 .endd
14113 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14114 use from Exim. Exim can be configured either to start up a Perl interpreter as
14115 soon as it is entered, or to wait until the first time it is needed. Starting
14116 the interpreter at the beginning ensures that it is done while Exim still has
14117 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14118 fact used in a particular run. Also, note that this does not mean that Exim is
14119 necessarily running as root when Perl is called at a later time. By default,
14120 the interpreter is started only when it is needed, but this can be changed in
14121 two ways:
14122
14123 .ilist
14124 .oindex "&%perl_at_start%&"
14125 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14126 a startup when Exim is entered.
14127 .next
14128 The command line option &%-ps%& also requests a startup when Exim is entered,
14129 overriding the setting of &%perl_at_start%&.
14130 .endlist
14131
14132 There is also a command line option &%-pd%& (for delay) which suppresses the
14133 initial startup, even if &%perl_at_start%& is set.
14134
14135 .ilist
14136 .oindex "&%perl_taintmode%&"
14137 .cindex "Perl" "taintmode"
14138 To provide more security executing Perl code via the embedded Perl
14139 interpreter, the &%perl_taintmode%& option can be set. This enables the
14140 taint mode of the Perl interpreter. You are encouraged to set this
14141 option to a true value. To avoid breaking existing installations, it
14142 defaults to false.
14143
14144 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14145
14146
14147 .section "Calling Perl subroutines" "SECID86"
14148 When the configuration file includes a &%perl_startup%& option you can make use
14149 of the string expansion item to call the Perl subroutines that are defined
14150 by the &%perl_startup%& code. The operator is used in any of the following
14151 forms:
14152 .code
14153 ${perl{foo}}
14154 ${perl{foo}{argument}}
14155 ${perl{foo}{argument1}{argument2} ... }
14156 .endd
14157 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14158 arguments may be passed. Passing more than this results in an expansion failure
14159 with an error message of the form
14160 .code
14161 Too many arguments passed to Perl subroutine "foo" (max is 8)
14162 .endd
14163 The return value of the Perl subroutine is evaluated in a scalar context before
14164 it is passed back to Exim to be inserted into the expanded string. If the
14165 return value is &'undef'&, the expansion is forced to fail in the same way as
14166 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14167 by obeying Perl's &%die%& function, the expansion fails with the error message
14168 that was passed to &%die%&.
14169
14170
14171 .section "Calling Exim functions from Perl" "SECID87"
14172 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14173 is available to call back into Exim's string expansion function. For example,
14174 the Perl code
14175 .code
14176 my $lp = Exim::expand_string('$local_part');
14177 .endd
14178 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14179 Note those are single quotes and not double quotes to protect against
14180 &$local_part$& being interpolated as a Perl variable.
14181
14182 If the string expansion is forced to fail by a &"fail"& item, the result of
14183 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14184 expansion string, the Perl call from the original expansion string fails with
14185 an appropriate error message, in the same way as if &%die%& were used.
14186
14187 .cindex "debugging" "from embedded Perl"
14188 .cindex "log" "writing from embedded Perl"
14189 Two other Exim functions are available for use from within Perl code.
14190 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14191 debugging is enabled. If you want a newline at the end, you must supply it.
14192 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14193 timestamp. In this case, you should not supply a terminating newline.
14194
14195
14196 .section "Use of standard output and error by Perl" "SECID88"
14197 .cindex "Perl" "standard output and error"
14198 You should not write to the standard error or output streams from within your
14199 Perl code, as it is not defined how these are set up. In versions of Exim
14200 before 4.50, it is possible for the standard output or error to refer to the
14201 SMTP connection during message reception via the daemon. Writing to this stream
14202 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14203 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14204 avoided, but the output is lost.
14205
14206 .cindex "Perl" "use of &%warn%&"
14207 The Perl &%warn%& statement writes to the standard error stream by default.
14208 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14209 you have no control. When Exim starts up the Perl interpreter, it arranges for
14210 output from the &%warn%& statement to be written to the Exim main log. You can
14211 change this by including appropriate Perl magic somewhere in your Perl code.
14212 For example, to discard &%warn%& output completely, you need this:
14213 .code
14214 $SIG{__WARN__} = sub { };
14215 .endd
14216 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14217 example, the code for the subroutine is empty, so it does nothing, but you can
14218 include any Perl code that you like. The text of the &%warn%& message is passed
14219 as the first subroutine argument.
14220 .ecindex IIDperl
14221
14222
14223 . ////////////////////////////////////////////////////////////////////////////
14224 . ////////////////////////////////////////////////////////////////////////////
14225
14226 .chapter "Starting the daemon and the use of network interfaces" &&&
14227          "CHAPinterfaces" &&&
14228          "Starting the daemon"
14229 .cindex "daemon" "starting"
14230 .cindex "interface" "listening"
14231 .cindex "network interface"
14232 .cindex "interface" "network"
14233 .cindex "IP address" "for listening"
14234 .cindex "daemon" "listening IP addresses"
14235 .cindex "TCP/IP" "setting listening interfaces"
14236 .cindex "TCP/IP" "setting listening ports"
14237 A host that is connected to a TCP/IP network may have one or more physical
14238 hardware network interfaces. Each of these interfaces may be configured as one
14239 or more &"logical"& interfaces, which are the entities that a program actually
14240 works with. Each of these logical interfaces is associated with an IP address.
14241 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14242 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14243 knowledge about the host's interfaces for use in three different circumstances:
14244
14245 .olist
14246 When a listening daemon is started, Exim needs to know which interfaces
14247 and ports to listen on.
14248 .next
14249 When Exim is routing an address, it needs to know which IP addresses
14250 are associated with local interfaces. This is required for the correct
14251 processing of MX lists by removing the local host and others with the
14252 same or higher priority values. Also, Exim needs to detect cases
14253 when an address is routed to an IP address that in fact belongs to the
14254 local host. Unless the &%self%& router option or the &%allow_localhost%&
14255 option of the smtp transport is set (as appropriate), this is treated
14256 as an error situation.
14257 .next
14258 When Exim connects to a remote host, it may need to know which interface to use
14259 for the outgoing connection.
14260 .endlist
14261
14262
14263 Exim's default behaviour is likely to be appropriate in the vast majority
14264 of cases. If your host has only one interface, and you want all its IP
14265 addresses to be treated in the same way, and you are using only the
14266 standard SMTP port, you should not need to take any special action. The
14267 rest of this chapter does not apply to you.
14268
14269 In a more complicated situation you may want to listen only on certain
14270 interfaces, or on different ports, and for this reason there are a number of
14271 options that can be used to influence Exim's behaviour. The rest of this
14272 chapter describes how they operate.
14273
14274 When a message is received over TCP/IP, the interface and port that were
14275 actually used are set in &$received_ip_address$& and &$received_port$&.
14276
14277
14278
14279 .section "Starting a listening daemon" "SECID89"
14280 When a listening daemon is started (by means of the &%-bd%& command line
14281 option), the interfaces and ports on which it listens are controlled by the
14282 following options:
14283
14284 .ilist
14285 &%daemon_smtp_ports%& contains a list of default ports
14286 or service names.
14287 (For backward compatibility, this option can also be specified in the singular.)
14288 .next
14289 &%local_interfaces%& contains list of interface IP addresses on which to
14290 listen. Each item may optionally also specify a port.
14291 .endlist
14292
14293 The default list separator in both cases is a colon, but this can be changed as
14294 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14295 it is usually best to change the separator to avoid having to double all the
14296 colons. For example:
14297 .code
14298 local_interfaces = <; 127.0.0.1 ; \
14299                       192.168.23.65 ; \
14300                       ::1 ; \
14301                       3ffe:ffff:836f::fe86:a061
14302 .endd
14303 There are two different formats for specifying a port along with an IP address
14304 in &%local_interfaces%&:
14305
14306 .olist
14307 The port is added onto the address with a dot separator. For example, to listen
14308 on port 1234 on two different IP addresses:
14309 .code
14310 local_interfaces = <; 192.168.23.65.1234 ; \
14311                       3ffe:ffff:836f::fe86:a061.1234
14312 .endd
14313 .next
14314 The IP address is enclosed in square brackets, and the port is added
14315 with a colon separator, for example:
14316 .code
14317 local_interfaces = <; [192.168.23.65]:1234 ; \
14318                       [3ffe:ffff:836f::fe86:a061]:1234
14319 .endd
14320 .endlist
14321
14322 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14323 default setting contains just one port:
14324 .code
14325 daemon_smtp_ports = smtp
14326 .endd
14327 If more than one port is listed, each interface that does not have its own port
14328 specified listens on all of them. Ports that are listed in
14329 &%daemon_smtp_ports%& can be identified either by name (defined in
14330 &_/etc/services_&) or by number. However, when ports are given with individual
14331 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14332
14333
14334
14335 .section "Special IP listening addresses" "SECID90"
14336 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14337 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14338 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14339 instead of setting up separate listening sockets for each interface. The
14340 default value of &%local_interfaces%& is
14341 .code
14342 local_interfaces = 0.0.0.0
14343 .endd
14344 when Exim is built without IPv6 support; otherwise it is:
14345 .code
14346 local_interfaces = <; ::0 ; 0.0.0.0
14347 .endd
14348 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14349
14350
14351
14352 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14353 The &%-oX%& command line option can be used to override the values of
14354 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14355 instance. Another way of doing this would be to use macros and the &%-D%&
14356 option. However, &%-oX%& can be used by any admin user, whereas modification of
14357 the runtime configuration by &%-D%& is allowed only when the caller is root or
14358 exim.
14359
14360 The value of &%-oX%& is a list of items. The default colon separator can be
14361 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14362 If there are any items that do not
14363 contain dots or colons (that is, are not IP addresses), the value of
14364 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14365 items that do contain dots or colons, the value of &%local_interfaces%& is
14366 replaced by those items. Thus, for example,
14367 .code
14368 -oX 1225
14369 .endd
14370 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14371 whereas
14372 .code
14373 -oX 192.168.34.5.1125
14374 .endd
14375 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14376 (However, since &%local_interfaces%& now contains no items without ports, the
14377 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14378
14379
14380
14381 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14382 .cindex "submissions protocol"
14383 .cindex "ssmtp protocol"
14384 .cindex "smtps protocol"
14385 .cindex "SMTP" "ssmtp protocol"
14386 .cindex "SMTP" "smtps protocol"
14387 Exim supports the use of TLS-on-connect, used by mail clients in the
14388 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14389 For some years, IETF Standards Track documents only blessed the
14390 STARTTLS-based Submission service (port 587) while common practice was to support
14391 the same feature set on port 465, but using TLS-on-connect.
14392 If your installation needs to provide service to mail clients
14393 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14394 the 465 TCP ports.
14395
14396 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14397 service names, connections to those ports must first establish TLS, before
14398 proceeding to the application layer use of the SMTP protocol.
14399
14400 The common use of this option is expected to be
14401 .code
14402 tls_on_connect_ports = 465
14403 .endd
14404 per RFC 8314.
14405 There is also a command line option &%-tls-on-connect%&, which forces all ports
14406 to behave in this way when a daemon is started.
14407
14408 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14409 daemon to listen on those ports. You must still specify them in
14410 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14411 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14412 connections via the daemon.)
14413
14414
14415
14416
14417 .section "IPv6 address scopes" "SECID92"
14418 .cindex "IPv6" "address scopes"
14419 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14420 can, in principle, have the same link-local IPv6 address on different
14421 interfaces. Thus, additional information is needed, over and above the IP
14422 address, to distinguish individual interfaces. A convention of using a
14423 percent sign followed by something (often the interface name) has been
14424 adopted in some cases, leading to addresses like this:
14425 .code
14426 fe80::202:b3ff:fe03:45c1%eth0
14427 .endd
14428 To accommodate this usage, a percent sign followed by an arbitrary string is
14429 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14430 to convert a textual IPv6 address for actual use. This function recognizes the
14431 percent convention in operating systems that support it, and it processes the
14432 address appropriately. Unfortunately, some older libraries have problems with
14433 &[getaddrinfo()]&. If
14434 .code
14435 IPV6_USE_INET_PTON=yes
14436 .endd
14437 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14438 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14439 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14440 function.) Of course, this means that the additional functionality of
14441 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14442
14443 .section "Disabling IPv6" "SECID93"
14444 .cindex "IPv6" "disabling"
14445 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14446 run on a host whose kernel does not support IPv6. The binary will fall back to
14447 using IPv4, but it may waste resources looking up AAAA records, and trying to
14448 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14449 .oindex "&%disable_ipv6%&"
14450 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14451 activities take place. AAAA records are never looked up, and any IPv6 addresses
14452 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14453 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14454 to handle IPv6 literal addresses.
14455
14456 On the other hand, when IPv6 is in use, there may be times when you want to
14457 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14458 option to globally suppress the lookup of AAAA records for specified domains,
14459 and you can use the &%ignore_target_hosts%& generic router option to ignore
14460 IPv6 addresses in an individual router.
14461
14462
14463
14464 .section "Examples of starting a listening daemon" "SECID94"
14465 The default case in an IPv6 environment is
14466 .code
14467 daemon_smtp_ports = smtp
14468 local_interfaces = <; ::0 ; 0.0.0.0
14469 .endd
14470 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14471 Either one or two sockets may be used, depending on the characteristics of
14472 the TCP/IP stack. (This is complicated and messy; for more information,
14473 read the comments in the &_daemon.c_& source file.)
14474
14475 To specify listening on ports 25 and 26 on all interfaces:
14476 .code
14477 daemon_smtp_ports = 25 : 26
14478 .endd
14479 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14480 .code
14481 local_interfaces = <; ::0.25     ; ::0.26 \
14482                       0.0.0.0.25 ; 0.0.0.0.26
14483 .endd
14484 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14485 IPv4 loopback address only:
14486 .code
14487 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14488 .endd
14489 To specify listening on the default port on specific interfaces only:
14490 .code
14491 local_interfaces = 10.0.0.67 : 192.168.34.67
14492 .endd
14493 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14494
14495
14496
14497 .section "Recognizing the local host" "SECTreclocipadd"
14498 The &%local_interfaces%& option is also used when Exim needs to determine
14499 whether or not an IP address refers to the local host. That is, the IP
14500 addresses of all the interfaces on which a daemon is listening are always
14501 treated as local.
14502
14503 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14504 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14505 available interfaces from the operating system, and extracts the relevant
14506 (that is, IPv4 or IPv6) addresses to use for checking.
14507
14508 Some systems set up large numbers of virtual interfaces in order to provide
14509 many virtual web servers. In this situation, you may want to listen for
14510 email on only a few of the available interfaces, but nevertheless treat all
14511 interfaces as local when routing. You can do this by setting
14512 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14513 &"all"& wildcard values. These addresses are recognized as local, but are not
14514 used for listening. Consider this example:
14515 .code
14516 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14517                       192.168.53.235 ; \
14518                       3ffe:2101:12:1:a00:20ff:fe86:a061
14519
14520 extra_local_interfaces = <; ::0 ; 0.0.0.0
14521 .endd
14522 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14523 address, but all available interface addresses are treated as local when
14524 Exim is routing.
14525
14526 In some environments the local host name may be in an MX list, but with an IP
14527 address that is not assigned to any local interface. In other cases it may be
14528 desirable to treat other host names as if they referred to the local host. Both
14529 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14530 This contains host names rather than IP addresses. When a host is referenced
14531 during routing, either via an MX record or directly, it is treated as the local
14532 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14533 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14534
14535
14536
14537 .section "Delivering to a remote host" "SECID95"
14538 Delivery to a remote host is handled by the smtp transport. By default, it
14539 allows the system's TCP/IP functions to choose which interface to use (if
14540 there is more than one) when connecting to a remote host. However, the
14541 &%interface%& option can be set to specify which interface is used. See the
14542 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14543 details.
14544
14545
14546
14547
14548 . ////////////////////////////////////////////////////////////////////////////
14549 . ////////////////////////////////////////////////////////////////////////////
14550
14551 .chapter "Main configuration" "CHAPmainconfig"
14552 .scindex IIDconfima "configuration file" "main section"
14553 .scindex IIDmaiconf "main configuration"
14554 The first part of the runtime configuration file contains three types of item:
14555
14556 .ilist
14557 Macro definitions: These lines start with an upper case letter. See section
14558 &<<SECTmacrodefs>>& for details of macro processing.
14559 .next
14560 Named list definitions: These lines start with one of the words &"domainlist"&,
14561 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14562 section &<<SECTnamedlists>>&.
14563 .next
14564 Main configuration settings: Each setting occupies one line of the file
14565 (with possible continuations). If any setting is preceded by the word
14566 &"hide"&, the &%-bP%& command line option displays its value to admin users
14567 only. See section &<<SECTcos>>& for a description of the syntax of these option
14568 settings.
14569 .endlist
14570
14571 This chapter specifies all the main configuration options, along with their
14572 types and default values. For ease of finding a particular option, they appear
14573 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14574 are now so many options, they are first listed briefly in functional groups, as
14575 an aid to finding the name of the option you are looking for. Some options are
14576 listed in more than one group.
14577
14578 .section "Miscellaneous" "SECID96"
14579 .table2
14580 .row &%add_environment%&             "environment variables"
14581 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14582 .row &%debug_store%&                 "do extra internal checks"
14583 .row &%disable_ipv6%&                "do no IPv6 processing"
14584 .row &%keep_environment%&            "environment variables"
14585 .row &%keep_malformed%&              "for broken files &-- should not happen"
14586 .row &%localhost_number%&            "for unique message ids in clusters"
14587 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14588 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14589 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14590 .row &%print_topbitchars%&           "top-bit characters are printing"
14591 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14592 .row &%timezone%&                    "force time zone"
14593 .endtable
14594
14595
14596 .section "Exim parameters" "SECID97"
14597 .table2
14598 .row &%exim_group%&                  "override compiled-in value"
14599 .row &%exim_path%&                   "override compiled-in value"
14600 .row &%exim_user%&                   "override compiled-in value"
14601 .row &%primary_hostname%&            "default from &[uname()]&"
14602 .row &%split_spool_directory%&       "use multiple directories"
14603 .row &%spool_directory%&             "override compiled-in value"
14604 .endtable
14605
14606
14607
14608 .section "Privilege controls" "SECID98"
14609 .table2
14610 .row &%admin_groups%&                "groups that are Exim admin users"
14611 .row &%commandline_checks_require_admin%& "require admin for various checks"
14612 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14613 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14614 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14615 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14616 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14617 .row &%never_users%&                 "do not run deliveries as these"
14618 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14619 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14620 .row &%trusted_groups%&              "groups that are trusted"
14621 .row &%trusted_users%&               "users that are trusted"
14622 .endtable
14623
14624
14625
14626 .section "Logging" "SECID99"
14627 .table2
14628 .row &%event_action%&                "custom logging"
14629 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14630 .row &%log_file_path%&               "override compiled-in value"
14631 .row &%log_selector%&                "set/unset optional logging"
14632 .row &%log_timezone%&                "add timezone to log lines"
14633 .row &%message_logs%&                "create per-message logs"
14634 .row &%preserve_message_logs%&       "after message completion"
14635 .row &%panic_coredump%&              "request coredump on fatal errors"
14636 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14637 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14638 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14639 .row &%syslog_facility%&             "set syslog &""facility""& field"
14640 .row &%syslog_pid%&                  "pid in syslog lines"
14641 .row &%syslog_processname%&          "set syslog &""ident""& field"
14642 .row &%syslog_timestamp%&            "timestamp syslog lines"
14643 .row &%write_rejectlog%&             "control use of message log"
14644 .endtable
14645
14646
14647
14648 .section "Frozen messages" "SECID100"
14649 .table2
14650 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14651 .row &%freeze_tell%&                 "send message when freezing"
14652 .row &%move_frozen_messages%&        "to another directory"
14653 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14654 .endtable
14655
14656
14657
14658 .section "Data lookups" "SECID101"
14659 .table2
14660 .row &%ibase_servers%&               "InterBase servers"
14661 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14662 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14663 .row &%ldap_cert_file%&              "client cert file for LDAP"
14664 .row &%ldap_cert_key%&               "client key file for LDAP"
14665 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14666 .row &%ldap_default_servers%&        "used if no server in query"
14667 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14668 .row &%ldap_start_tls%&              "require TLS within LDAP"
14669 .row &%ldap_version%&                "set protocol version"
14670 .row &%lookup_open_max%&             "lookup files held open"
14671 .row &%mysql_servers%&               "default MySQL servers"
14672 .row &%oracle_servers%&              "Oracle servers"
14673 .row &%pgsql_servers%&               "default PostgreSQL servers"
14674 .row &%sqlite_lock_timeout%&         "as it says"
14675 .endtable
14676
14677
14678
14679 .section "Message ids" "SECID102"
14680 .table2
14681 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14682 .row &%message_id_header_text%&      "ditto"
14683 .endtable
14684
14685
14686
14687 .section "Embedded Perl Startup" "SECID103"
14688 .table2
14689 .row &%perl_at_start%&               "always start the interpreter"
14690 .row &%perl_startup%&                "code to obey when starting Perl"
14691 .row &%perl_taintmode%&              "enable taint mode in Perl"
14692 .endtable
14693
14694
14695
14696 .section "Daemon" "SECID104"
14697 .table2
14698 .row &%daemon_smtp_ports%&           "default ports"
14699 .row &%daemon_startup_retries%&      "number of times to retry"
14700 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14701 .row &%extra_local_interfaces%&      "not necessarily listened on"
14702 .row &%local_interfaces%&            "on which to listen, with optional ports"
14703 .row &%notifier_socket%&             "override compiled-in value"
14704 .row &%pid_file_path%&               "override compiled-in value"
14705 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14706 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14707 .endtable
14708
14709
14710
14711 .section "Resource control" "SECID105"
14712 .table2
14713 .row &%check_log_inodes%&            "before accepting a message"
14714 .row &%check_log_space%&             "before accepting a message"
14715 .row &%check_spool_inodes%&          "before accepting a message"
14716 .row &%check_spool_space%&           "before accepting a message"
14717 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14718 .row &%queue_only_load%&             "queue incoming if load high"
14719 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14720 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14721 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14722 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14723 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14724 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14725 .row &%smtp_accept_max_per_connection%& "messages per connection"
14726 .row &%smtp_accept_max_per_host%&    "connections from one host"
14727 .row &%smtp_accept_queue%&           "queue mail if more connections"
14728 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14729                                            connection"
14730 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14731 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14732 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14733 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14734 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14735 .endtable
14736
14737
14738
14739 .section "Policy controls" "SECID106"
14740 .table2
14741 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14742 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14743 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14744 .row &%acl_smtp_auth%&               "ACL for AUTH"
14745 .row &%acl_smtp_connect%&            "ACL for connection"
14746 .row &%acl_smtp_data%&               "ACL for DATA"
14747 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14748 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14749 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14750 .row &%acl_smtp_expn%&               "ACL for EXPN"
14751 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14752 .row &%acl_smtp_mail%&               "ACL for MAIL"
14753 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14754 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14755 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14756 .row &%acl_smtp_predata%&            "ACL for start of data"
14757 .row &%acl_smtp_quit%&               "ACL for QUIT"
14758 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14759 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14760 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14761 .row &%av_scanner%&                  "specify virus scanner"
14762 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14763                                       words""&"
14764 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14765 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14766 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14767 .row &%header_maxsize%&              "total size of message header"
14768 .row &%header_line_maxsize%&         "individual header line limit"
14769 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14770 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14771 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14772 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14773 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14774 .row &%host_lookup%&                 "host name looked up for these hosts"
14775 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14776 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14777 .row &%host_reject_connection%&      "reject connection from these hosts"
14778 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14779 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14780 .row &%message_size_limit%&          "for all messages"
14781 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14782 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14783 .row &%spamd_address%&               "set interface to SpamAssassin"
14784 .row &%strict_acl_vars%&             "object to unset ACL variables"
14785 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14786 .endtable
14787
14788
14789
14790 .section "Callout cache" "SECID107"
14791 .table2
14792 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14793                                          item"
14794 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14795                                          item"
14796 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14797 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14798 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14799 .endtable
14800
14801
14802
14803 .section "TLS" "SECID108"
14804 .table2
14805 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14806 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14807 .row &%hosts_require_alpn%&          "mandatory ALPN"
14808 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14809 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14810 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14811 .row &%tls_alpn%&                    "acceptable protocol names"
14812 .row &%tls_certificate%&             "location of server certificate"
14813 .row &%tls_crl%&                     "certificate revocation list"
14814 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14815 .row &%tls_dhparam%&                 "DH parameters for server"
14816 .row &%tls_eccurve%&                 "EC curve selection for server"
14817 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14818 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14819 .row &%tls_privatekey%&              "location of server private key"
14820 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14821 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14822 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14823 .row &%tls_verify_certificates%&     "expected client certificates"
14824 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14825 .endtable
14826
14827
14828
14829 .section "Local user handling" "SECID109"
14830 .table2
14831 .row &%finduser_retries%&            "useful in NIS environments"
14832 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14833 .row &%gecos_pattern%&               "ditto"
14834 .row &%max_username_length%&         "for systems that truncate"
14835 .row &%unknown_login%&               "used when no login name found"
14836 .row &%unknown_username%&            "ditto"
14837 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14838 .row &%uucp_from_sender%&            "ditto"
14839 .endtable
14840
14841
14842
14843 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14844 .table2
14845 .row &%header_maxsize%&              "total size of message header"
14846 .row &%header_line_maxsize%&         "individual header line limit"
14847 .row &%message_size_limit%&          "applies to all messages"
14848 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14849 .row &%received_header_text%&        "expanded to make &'Received:'&"
14850 .row &%received_headers_max%&        "for mail loop detection"
14851 .row &%recipients_max%&              "limit per message"
14852 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14853 .endtable
14854
14855
14856
14857
14858 .section "Non-SMTP incoming messages" "SECID111"
14859 .table2
14860 .row &%receive_timeout%&             "for non-SMTP messages"
14861 .endtable
14862
14863
14864
14865
14866
14867 .section "Incoming SMTP messages" "SECID112"
14868 See also the &'Policy controls'& section above.
14869
14870 .table2
14871 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14872 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14873 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14874 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14875 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14876 .row &%dmarc_history_file%&          "DMARC results log"
14877 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14878 .row &%host_lookup%&                 "host name looked up for these hosts"
14879 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14880 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14881 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14882 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14883 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14884 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14885 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14886 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14887 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14888 .row &%smtp_accept_max_per_connection%& "messages per connection"
14889 .row &%smtp_accept_max_per_host%&    "connections from one host"
14890 .row &%smtp_accept_queue%&           "queue mail if more connections"
14891 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14892                                            connection"
14893 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14894 .row &%smtp_active_hostname%&        "host name to use in messages"
14895 .row &%smtp_banner%&                 "text for welcome banner"
14896 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14897 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14898 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14899 .row &%smtp_etrn_command%&           "what to run for ETRN"
14900 .row &%smtp_etrn_serialize%&         "only one at once"
14901 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14902 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14903 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14904 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14905 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14906 .row &%smtp_receive_timeout%&        "per command or data line"
14907 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14908 .row &%smtp_return_error_details%&   "give detail on rejections"
14909 .endtable
14910
14911
14912
14913 .section "SMTP extensions" "SECID113"
14914 .table2
14915 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14916 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14917 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14918 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14919 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14920 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14921 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14922 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14923 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14924 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14925 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14926 .endtable
14927
14928
14929
14930 .section "Processing messages" "SECID114"
14931 .table2
14932 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14933 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14934 .row &%allow_utf8_domains%&          "in addresses"
14935 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14936                                       words""&"
14937 .row &%delivery_date_remove%&        "from incoming messages"
14938 .row &%envelope_to_remove%&          "from incoming messages"
14939 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14940 .row &%headers_charset%&             "default for translations"
14941 .row &%qualify_domain%&              "default for senders"
14942 .row &%qualify_recipient%&           "default for recipients"
14943 .row &%return_path_remove%&          "from incoming messages"
14944 .row &%strip_excess_angle_brackets%& "in addresses"
14945 .row &%strip_trailing_dot%&          "at end of addresses"
14946 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14947 .endtable
14948
14949
14950
14951 .section "System filter" "SECID115"
14952 .table2
14953 .row &%system_filter%&               "locate system filter"
14954 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14955                                             directory"
14956 .row &%system_filter_file_transport%& "transport for delivery to a file"
14957 .row &%system_filter_group%&         "group for filter running"
14958 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14959 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14960 .row &%system_filter_user%&          "user for filter running"
14961 .endtable
14962
14963
14964
14965 .section "Routing and delivery" "SECID116"
14966 .table2
14967 .row &%disable_ipv6%&                "do no IPv6 processing"
14968 .row &%dns_again_means_nonexist%&    "for broken domains"
14969 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14970 .row &%dns_dnssec_ok%&               "parameter for resolver"
14971 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14972 .row &%dns_retrans%&                 "parameter for resolver"
14973 .row &%dns_retry%&                   "parameter for resolver"
14974 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14975 .row &%dns_use_edns0%&               "parameter for resolver"
14976 .row &%hold_domains%&                "hold delivery for these domains"
14977 .row &%local_interfaces%&            "for routing checks"
14978 .row &%queue_domains%&               "no immediate delivery for these"
14979 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14980 .row &%queue_only%&                  "no immediate delivery at all"
14981 .row &%queue_only_file%&             "no immediate delivery if file exists"
14982 .row &%queue_only_load%&             "no immediate delivery if load is high"
14983 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14984 .row &%queue_only_override%&         "allow command line to override"
14985 .row &%queue_run_in_order%&          "order of arrival"
14986 .row &%queue_run_max%&               "of simultaneous queue runners"
14987 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14988 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14989 .row &%remote_sort_domains%&         "order of remote deliveries"
14990 .row &%retry_data_expire%&           "timeout for retry data"
14991 .row &%retry_interval_max%&          "safety net for retry rules"
14992 .endtable
14993
14994
14995
14996 .section "Bounce and warning messages" "SECID117"
14997 .table2
14998 .row &%bounce_message_file%&         "content of bounce"
14999 .row &%bounce_message_text%&         "content of bounce"
15000 .row &%bounce_return_body%&          "include body if returning message"
15001 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15002 .row &%bounce_return_message%&       "include original message in bounce"
15003 .row &%bounce_return_size_limit%&    "limit on returned message"
15004 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15005 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15006 .row &%errors_copy%&                 "copy bounce messages"
15007 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15008 .row &%delay_warning%&               "time schedule"
15009 .row &%delay_warning_condition%&     "condition for warning messages"
15010 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15011 .row &%smtp_return_error_details%&   "give detail on rejections"
15012 .row &%warn_message_file%&           "content of warning message"
15013 .endtable
15014
15015
15016
15017 .section "Alphabetical list of main options" "SECTalomo"
15018 Those options that undergo string expansion before use are marked with
15019 &dagger;.
15020
15021 .option accept_8bitmime main boolean true
15022 .cindex "8BITMIME"
15023 .cindex "8-bit characters"
15024 .cindex "log" "selectors"
15025 .cindex "log" "8BITMIME"
15026 .cindex "ESMTP extensions" 8BITMIME
15027 This option causes Exim to send 8BITMIME in its response to an SMTP
15028 EHLO command, and to accept the BODY= parameter on MAIL commands.
15029 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15030 takes no steps to do anything special with messages received by this route.
15031
15032 Historically Exim kept this option off by default, but the maintainers
15033 feel that in today's Internet, this causes more problems than it solves.
15034 It now defaults to true.
15035 A more detailed analysis of the issues is provided by Dan Bernstein:
15036 .display
15037 &url(https://cr.yp.to/smtp/8bitmime.html)
15038 .endd
15039
15040 To log received 8BITMIME status use
15041 .code
15042 log_selector = +8bitmime
15043 .endd
15044
15045 .option acl_not_smtp main string&!! unset
15046 .cindex "&ACL;" "for non-SMTP messages"
15047 .cindex "non-SMTP messages" "ACLs for"
15048 This option defines the ACL that is run when a non-SMTP message has been
15049 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15050 further details.
15051
15052 .option acl_not_smtp_mime main string&!! unset
15053 This option defines the ACL that is run for individual MIME parts of non-SMTP
15054 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15055 SMTP messages.
15056
15057 .option acl_not_smtp_start main string&!! unset
15058 .cindex "&ACL;" "at start of non-SMTP message"
15059 .cindex "non-SMTP messages" "ACLs for"
15060 This option defines the ACL that is run before Exim starts reading a
15061 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15062
15063 .option acl_smtp_auth main string&!! unset
15064 .cindex "&ACL;" "setting up for SMTP commands"
15065 .cindex "AUTH" "ACL for"
15066 This option defines the ACL that is run when an SMTP AUTH command is
15067 received. See chapter &<<CHAPACL>>& for further details.
15068
15069 .option acl_smtp_connect main string&!! unset
15070 .cindex "&ACL;" "on SMTP connection"
15071 This option defines the ACL that is run when an SMTP connection is received.
15072 See chapter &<<CHAPACL>>& for further details.
15073
15074 .option acl_smtp_data main string&!! unset
15075 .cindex "DATA" "ACL for"
15076 This option defines the ACL that is run after an SMTP DATA command has been
15077 processed and the message itself has been received, but before the final
15078 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15079
15080 .option acl_smtp_data_prdr main string&!! accept
15081 .cindex "PRDR" "ACL for"
15082 .cindex "DATA" "PRDR ACL for"
15083 .cindex "&ACL;" "PRDR-related"
15084 .cindex "&ACL;" "per-user data processing"
15085 This option defines the ACL that,
15086 if the PRDR feature has been negotiated,
15087 is run for each recipient after an SMTP DATA command has been
15088 processed and the message itself has been received, but before the
15089 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15090
15091 .option acl_smtp_dkim main string&!! unset
15092 .cindex DKIM "ACL for"
15093 This option defines the ACL that is run for each DKIM signature
15094 (by default, or as specified in the dkim_verify_signers option)
15095 of a received message.
15096 See section &<<SECDKIMVFY>>& for further details.
15097
15098 .option acl_smtp_etrn main string&!! unset
15099 .cindex "ETRN" "ACL for"
15100 This option defines the ACL that is run when an SMTP ETRN command is
15101 received. See chapter &<<CHAPACL>>& for further details.
15102
15103 .option acl_smtp_expn main string&!! unset
15104 .cindex "EXPN" "ACL for"
15105 This option defines the ACL that is run when an SMTP EXPN command is
15106 received. See chapter &<<CHAPACL>>& for further details.
15107
15108 .option acl_smtp_helo main string&!! unset
15109 .cindex "EHLO" "ACL for"
15110 .cindex "HELO" "ACL for"
15111 This option defines the ACL that is run when an SMTP EHLO or HELO
15112 command is received. See chapter &<<CHAPACL>>& for further details.
15113
15114
15115 .option acl_smtp_mail main string&!! unset
15116 .cindex "MAIL" "ACL for"
15117 This option defines the ACL that is run when an SMTP MAIL command is
15118 received. See chapter &<<CHAPACL>>& for further details.
15119
15120 .option acl_smtp_mailauth main string&!! unset
15121 .cindex "AUTH" "on MAIL command"
15122 This option defines the ACL that is run when there is an AUTH parameter on
15123 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15124 &<<CHAPSMTPAUTH>>& for details of authentication.
15125
15126 .option acl_smtp_mime main string&!! unset
15127 .cindex "MIME content scanning" "ACL for"
15128 This option is available when Exim is built with the content-scanning
15129 extension. It defines the ACL that is run for each MIME part in a message. See
15130 section &<<SECTscanmimepart>>& for details.
15131
15132 .option acl_smtp_notquit main string&!! unset
15133 .cindex "not-QUIT, ACL for"
15134 This option defines the ACL that is run when an SMTP session
15135 ends without a QUIT command being received.
15136 See chapter &<<CHAPACL>>& for further details.
15137
15138 .option acl_smtp_predata main string&!! unset
15139 This option defines the ACL that is run when an SMTP DATA command is
15140 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15141 further details.
15142
15143 .option acl_smtp_quit main string&!! unset
15144 .cindex "QUIT, ACL for"
15145 This option defines the ACL that is run when an SMTP QUIT command is
15146 received. See chapter &<<CHAPACL>>& for further details.
15147
15148 .option acl_smtp_rcpt main string&!! unset
15149 .cindex "RCPT" "ACL for"
15150 This option defines the ACL that is run when an SMTP RCPT command is
15151 received. See chapter &<<CHAPACL>>& for further details.
15152
15153 .option acl_smtp_starttls main string&!! unset
15154 .cindex "STARTTLS, ACL for"
15155 This option defines the ACL that is run when an SMTP STARTTLS command is
15156 received. See chapter &<<CHAPACL>>& for further details.
15157
15158 .option acl_smtp_vrfy main string&!! unset
15159 .cindex "VRFY" "ACL for"
15160 This option defines the ACL that is run when an SMTP VRFY command is
15161 received. See chapter &<<CHAPACL>>& for further details.
15162
15163 .option add_environment main "string list" empty
15164 .cindex "environment" "set values"
15165 This option adds individual environment variables that the
15166 currently linked libraries and programs in child processes may use.
15167 Each list element should be of the form &"name=value"&.
15168
15169 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15170
15171 .option admin_groups main "string list&!!" unset
15172 .cindex "admin user"
15173 This option is expanded just once, at the start of Exim's processing. If the
15174 current group or any of the supplementary groups of an Exim caller is in this
15175 colon-separated list, the caller has admin privileges. If all your system
15176 programmers are in a specific group, for example, you can give them all Exim
15177 admin privileges by putting that group in &%admin_groups%&. However, this does
15178 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15179 To permit this, you have to add individuals to the Exim group.
15180
15181 .option allow_domain_literals main boolean false
15182 .cindex "domain literal"
15183 If this option is set, the RFC 2822 domain literal format is permitted in
15184 email addresses. The option is not set by default, because the domain literal
15185 format is not normally required these days, and few people know about it. It
15186 has, however, been exploited by mail abusers.
15187
15188 Unfortunately, it seems that some DNS black list maintainers are using this
15189 format to report black listing to postmasters. If you want to accept messages
15190 addressed to your hosts by IP address, you need to set
15191 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15192 domains (defined in the named domain list &%local_domains%& in the default
15193 configuration). This &"magic string"& matches the domain literal form of all
15194 the local host's IP addresses.
15195
15196 .option allow_mx_to_ip main boolean false
15197 .cindex "MX record" "pointing to IP address"
15198 It appears that more and more DNS zone administrators are breaking the rules
15199 and putting domain names that look like IP addresses on the right hand side of
15200 MX records. Exim follows the rules and rejects this, giving an error message
15201 that explains the misconfiguration. However, some other MTAs support this
15202 practice, so to avoid &"Why can't Exim do this?"& complaints,
15203 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15204 recommended, except when you have no other choice.
15205
15206 .option allow_utf8_domains main boolean false
15207 .cindex "domain" "UTF-8 characters in"
15208 .cindex "UTF-8" "in domain name"
15209 Lots of discussion is going on about internationalized domain names. One
15210 camp is strongly in favour of just using UTF-8 characters, and it seems
15211 that at least two other MTAs permit this.
15212 This option allows Exim users to experiment if they wish.
15213
15214 If it is set true, Exim's domain parsing function allows valid
15215 UTF-8 multicharacters to appear in domain name components, in addition to
15216 letters, digits, and hyphens.
15217
15218 If Exim is built with internationalization support
15219 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15220 this option can be left as default.
15221 Without that,
15222 if you want to look up such domain names in the DNS, you must also
15223 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15224 suitable setting is:
15225 .code
15226 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15227   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15228 .endd
15229 Alternatively, you can just disable this feature by setting
15230 .code
15231 dns_check_names_pattern =
15232 .endd
15233 That is, set the option to an empty string so that no check is done.
15234
15235
15236 .option auth_advertise_hosts main "host list&!!" *
15237 .cindex "authentication" "advertising"
15238 .cindex "AUTH" "advertising"
15239 .cindex "ESMTP extensions" AUTH
15240 If any server authentication mechanisms are configured, Exim advertises them in
15241 response to an EHLO command only if the calling host matches this list.
15242 Otherwise, Exim does not advertise AUTH.
15243 Exim does not accept AUTH commands from clients to which it has not
15244 advertised the availability of AUTH. The advertising of individual
15245 authentication mechanisms can be controlled by the use of the
15246 &%server_advertise_condition%& generic authenticator option on the individual
15247 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15248
15249 Certain mail clients (for example, Netscape) require the user to provide a name
15250 and password for authentication if AUTH is advertised, even though it may
15251 not be needed (the host may accept messages from hosts on its local LAN without
15252 authentication, for example). The &%auth_advertise_hosts%& option can be used
15253 to make these clients more friendly by excluding them from the set of hosts to
15254 which Exim advertises AUTH.
15255
15256 .cindex "AUTH" "advertising when encrypted"
15257 If you want to advertise the availability of AUTH only when the connection
15258 is encrypted using TLS, you can make use of the fact that the value of this
15259 option is expanded, with a setting like this:
15260 .code
15261 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15262 .endd
15263 .vindex "&$tls_in_cipher$&"
15264 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15265 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15266 expansion is *, which matches all hosts.
15267
15268
15269 .option auto_thaw main time 0s
15270 .cindex "thawing messages"
15271 .cindex "unfreezing messages"
15272 If this option is set to a time greater than zero, a queue runner will try a
15273 new delivery attempt on any frozen message, other than a bounce message, if
15274 this much time has passed since it was frozen. This may result in the message
15275 being re-frozen if nothing has changed since the last attempt. It is a way of
15276 saying &"keep on trying, even though there are big problems"&.
15277
15278 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15279 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15280 thought to be very useful any more, and its use should probably be avoided.
15281
15282
15283 .option av_scanner main string "see below"
15284 This option is available if Exim is built with the content-scanning extension.
15285 It specifies which anti-virus scanner to use. The default value is:
15286 .code
15287 sophie:/var/run/sophie
15288 .endd
15289 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15290 before use. See section &<<SECTscanvirus>>& for further details.
15291
15292
15293 .option bi_command main string unset
15294 .oindex "&%-bi%&"
15295 This option supplies the name of a command that is run when Exim is called with
15296 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15297 just the command name, it is not a complete command line. If an argument is
15298 required, it must come from the &%-oA%& command line option.
15299
15300
15301 .option bounce_message_file main string&!! unset
15302 .cindex "bounce message" "customizing"
15303 .cindex "customizing" "bounce message"
15304 This option defines a template file containing paragraphs of text to be used
15305 for constructing bounce messages.  Details of the file's contents are given in
15306 chapter &<<CHAPemsgcust>>&.
15307 .cindex bounce_message_file "tainted data"
15308 The option is expanded to give the file path, which must be
15309 absolute and untainted.
15310 See also &%warn_message_file%&.
15311
15312
15313 .option bounce_message_text main string unset
15314 When this option is set, its contents are included in the default bounce
15315 message immediately after &"This message was created automatically by mail
15316 delivery software."& It is not used if &%bounce_message_file%& is set.
15317
15318 .option bounce_return_body main boolean true
15319 .cindex "bounce message" "including body"
15320 This option controls whether the body of an incoming message is included in a
15321 bounce message when &%bounce_return_message%& is true. The default setting
15322 causes the entire message, both header and body, to be returned (subject to the
15323 value of &%bounce_return_size_limit%&). If this option is false, only the
15324 message header is included. In the case of a non-SMTP message containing an
15325 error that is detected during reception, only those header lines preceding the
15326 point at which the error was detected are returned.
15327 .cindex "bounce message" "including original"
15328
15329 .option bounce_return_linesize_limit main integer 998
15330 .cindex "size" "of bounce lines, limit"
15331 .cindex "bounce message" "line length limit"
15332 .cindex "limit" "bounce message line length"
15333 This option sets a limit in bytes on the line length of messages
15334 that are returned to senders due to delivery problems,
15335 when &%bounce_return_message%& is true.
15336 The default value corresponds to RFC limits.
15337 If the message being returned has lines longer than this value it is
15338 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15339
15340 The option also applies to bounces returned when an error is detected
15341 during reception of a message.
15342 In this case lines from the original are truncated.
15343
15344 The option does not apply to messages generated by an &(autoreply)& transport.
15345
15346
15347 .option bounce_return_message main boolean true
15348 If this option is set false, none of the original message is included in
15349 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15350 &%bounce_return_body%&.
15351
15352
15353 .option bounce_return_size_limit main integer 100K
15354 .cindex "size" "of bounce, limit"
15355 .cindex "bounce message" "size limit"
15356 .cindex "limit" "bounce message size"
15357 This option sets a limit in bytes on the size of messages that are returned to
15358 senders as part of bounce messages when &%bounce_return_message%& is true. The
15359 limit should be less than the value of the global &%message_size_limit%& and of
15360 any &%message_size_limit%& settings on transports, to allow for the bounce text
15361 that Exim generates. If this option is set to zero there is no limit.
15362
15363 When the body of any message that is to be included in a bounce message is
15364 greater than the limit, it is truncated, and a comment pointing this out is
15365 added at the top. The actual cutoff may be greater than the value given, owing
15366 to the use of buffering for transferring the message in chunks (typically 8K in
15367 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15368 messages.
15369
15370 .option bounce_sender_authentication main string unset
15371 .cindex "bounce message" "sender authentication"
15372 .cindex "authentication" "bounce message"
15373 .cindex "AUTH" "on bounce message"
15374 This option provides an authenticated sender address that is sent with any
15375 bounce messages generated by Exim that are sent over an authenticated SMTP
15376 connection. A typical setting might be:
15377 .code
15378 bounce_sender_authentication = mailer-daemon@my.domain.example
15379 .endd
15380 which would cause bounce messages to be sent using the SMTP command:
15381 .code
15382 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15383 .endd
15384 The value of &%bounce_sender_authentication%& must always be a complete email
15385 address.
15386
15387 .option callout_domain_negative_expire main time 3h
15388 .cindex "caching" "callout timeouts"
15389 .cindex "callout" "caching timeouts"
15390 This option specifies the expiry time for negative callout cache data for a
15391 domain. See section &<<SECTcallver>>& for details of callout verification, and
15392 section &<<SECTcallvercache>>& for details of the caching.
15393
15394
15395 .option callout_domain_positive_expire main time 7d
15396 This option specifies the expiry time for positive callout cache data for a
15397 domain. See section &<<SECTcallver>>& for details of callout verification, and
15398 section &<<SECTcallvercache>>& for details of the caching.
15399
15400
15401 .option callout_negative_expire main time 2h
15402 This option specifies the expiry time for negative callout cache data for an
15403 address. See section &<<SECTcallver>>& for details of callout verification, and
15404 section &<<SECTcallvercache>>& for details of the caching.
15405
15406
15407 .option callout_positive_expire main time 24h
15408 This option specifies the expiry time for positive callout cache data for an
15409 address. See section &<<SECTcallver>>& for details of callout verification, and
15410 section &<<SECTcallvercache>>& for details of the caching.
15411
15412
15413 .option callout_random_local_part main string&!! "see below"
15414 This option defines the &"random"& local part that can be used as part of
15415 callout verification. The default value is
15416 .code
15417 $primary_hostname-$tod_epoch-testing
15418 .endd
15419 See section &<<CALLaddparcall>>& for details of how this value is used.
15420
15421
15422 .option check_log_inodes main integer 100
15423 See &%check_spool_space%& below.
15424
15425
15426 .option check_log_space main integer 10M
15427 See &%check_spool_space%& below.
15428
15429 .oindex "&%check_rfc2047_length%&"
15430 .cindex "RFC 2047" "disabling length check"
15431 .option check_rfc2047_length main boolean true
15432 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15433 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15434 word; strings to be encoded that exceed this length are supposed to use
15435 multiple encoded words. By default, Exim does not recognize encoded words that
15436 exceed the maximum length. However, it seems that some software, in violation
15437 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15438 set false, Exim recognizes encoded words of any length.
15439
15440
15441 .option check_spool_inodes main integer 100
15442 See &%check_spool_space%& below.
15443
15444
15445 .option check_spool_space main integer 10M
15446 .cindex "checking disk space"
15447 .cindex "disk space, checking"
15448 .cindex "spool directory" "checking space"
15449 The four &%check_...%& options allow for checking of disk resources before a
15450 message is accepted.
15451
15452 .vindex "&$log_inodes$&"
15453 .vindex "&$log_space$&"
15454 .vindex "&$spool_inodes$&"
15455 .vindex "&$spool_space$&"
15456 When any of these options are nonzero, they apply to all incoming messages. If you
15457 want to apply different checks to different kinds of message, you can do so by
15458 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15459 &$spool_space$& in an ACL with appropriate additional conditions.
15460
15461
15462 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15463 either value is greater than zero, for example:
15464 .code
15465 check_spool_space = 100M
15466 check_spool_inodes = 100
15467 .endd
15468 The spool partition is the one that contains the directory defined by
15469 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15470 transit.
15471
15472 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15473 files are written if either is greater than zero. These should be set only if
15474 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15475
15476 If there is less space or fewer inodes than requested, Exim refuses to accept
15477 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15478 error response to the MAIL command. If ESMTP is in use and there was a
15479 SIZE parameter on the MAIL command, its value is added to the
15480 &%check_spool_space%& value, and the check is performed even if
15481 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15482
15483 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15484 number of kilobytes (though specified in bytes).
15485 If a non-multiple of 1024 is specified, it is rounded up.
15486
15487 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15488 failure a message is written to stderr and Exim exits with a non-zero code, as
15489 it obviously cannot send an error message of any kind.
15490
15491 There is a slight performance penalty for these checks.
15492 Versions of Exim preceding 4.88 had these disabled by default;
15493 high-rate installations confident they will never run out of resources
15494 may wish to deliberately disable them.
15495
15496 .option chunking_advertise_hosts main "host list&!!" *
15497 .cindex CHUNKING advertisement
15498 .cindex "RFC 3030" "CHUNKING"
15499 .cindex "ESMTP extensions" CHUNKING
15500 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15501 these hosts.
15502 Hosts may use the BDAT command as an alternate to DATA.
15503
15504 .option commandline_checks_require_admin main boolean &`false`&
15505 .cindex "restricting access to features"
15506 This option restricts various basic checking features to require an
15507 administrative user.
15508 This affects most of the &%-b*%& options, such as &%-be%&.
15509
15510 .option debug_store main boolean &`false`&
15511 .cindex debugging "memory corruption"
15512 .cindex memory debugging
15513 This option, when true, enables extra checking in Exim's internal memory
15514 management.  For use when a memory corruption issue is being investigated,
15515 it should normally be left as default.
15516
15517 .option daemon_smtp_ports main string &`smtp`&
15518 .cindex "port" "for daemon"
15519 .cindex "TCP/IP" "setting listening ports"
15520 This option specifies one or more default SMTP ports on which the Exim daemon
15521 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15522 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15523
15524 .option daemon_startup_retries main integer 9
15525 .cindex "daemon startup, retrying"
15526 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15527 the daemon at startup when it cannot immediately bind a listening socket
15528 (typically because the socket is already in use): &%daemon_startup_retries%&
15529 defines the number of retries after the first failure, and
15530 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15531
15532 .option daemon_startup_sleep main time 30s
15533 See &%daemon_startup_retries%&.
15534
15535 .option delay_warning main "time list" 24h
15536 .cindex "warning of delay"
15537 .cindex "delay warning, specifying"
15538 .cindex "queue" "delay warning"
15539 When a message is delayed, Exim sends a warning message to the sender at
15540 intervals specified by this option. The data is a colon-separated list of times
15541 after which to send warning messages. If the value of the option is an empty
15542 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15543 message has been in the queue for longer than the last time, the last interval
15544 between the times is used to compute subsequent warning times. For example,
15545 with
15546 .code
15547 delay_warning = 4h:8h:24h
15548 .endd
15549 the first message is sent after 4 hours, the second after 8 hours, and
15550 the third one after 24 hours. After that, messages are sent every 16 hours,
15551 because that is the interval between the last two times on the list. If you set
15552 just one time, it specifies the repeat interval. For example, with:
15553 .code
15554 delay_warning = 6h
15555 .endd
15556 messages are repeated every six hours. To stop warnings after a given time, set
15557 a very large time at the end of the list. For example:
15558 .code
15559 delay_warning = 2h:12h:99d
15560 .endd
15561 Note that the option is only evaluated at the time a delivery attempt fails,
15562 which depends on retry and queue-runner configuration.
15563 Typically retries will be configured more frequently than warning messages.
15564
15565 .option delay_warning_condition main string&!! "see below"
15566 .vindex "&$domain$&"
15567 The string is expanded at the time a warning message might be sent. If all the
15568 deferred addresses have the same domain, it is set in &$domain$& during the
15569 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15570 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15571 &"false"& (the comparison being done caselessly) then the warning message is
15572 not sent. The default is:
15573 .code
15574 delay_warning_condition = ${if or {\
15575   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15576   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15577   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15578   } {no}{yes}}
15579 .endd
15580 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15581 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15582 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15583 &"auto-replied"& in an &'Auto-Submitted:'& header.
15584
15585 .option deliver_drop_privilege main boolean false
15586 .cindex "unprivileged delivery"
15587 .cindex "delivery" "unprivileged"
15588 If this option is set true, Exim drops its root privilege at the start of a
15589 delivery process, and runs as the Exim user throughout. This severely restricts
15590 the kinds of local delivery that are possible, but is viable in certain types
15591 of configuration. There is a discussion about the use of root privilege in
15592 chapter &<<CHAPsecurity>>&.
15593
15594 .option deliver_queue_load_max main fixed-point unset
15595 .cindex "load average"
15596 .cindex "queue runner" "abandoning"
15597 When this option is set, a queue run is abandoned if the system load average
15598 becomes greater than the value of the option. The option has no effect on
15599 ancient operating systems on which Exim cannot determine the load average.
15600 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15601
15602
15603 .option delivery_date_remove main boolean true
15604 .cindex "&'Delivery-date:'& header line"
15605 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15606 message when it is delivered, in exactly the same way as &'Return-path:'& is
15607 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15608 should not be present in incoming messages, and this option causes them to be
15609 removed at the time the message is received, to avoid any problems that might
15610 occur when a delivered message is subsequently sent on to some other recipient.
15611
15612 .option disable_fsync main boolean false
15613 .cindex "&[fsync()]&, disabling"
15614 This option is available only if Exim was built with the compile-time option
15615 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15616 a runtime configuration generates an &"unknown option"& error. You should not
15617 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15618 really, really, really understand what you are doing. &'No pre-compiled
15619 distributions of Exim should ever make this option available.'&
15620
15621 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15622 updated files' data to be written to disc before continuing. Unexpected events
15623 such as crashes and power outages may cause data to be lost or scrambled.
15624 Here be Dragons. &*Beware.*&
15625
15626
15627 .option disable_ipv6 main boolean false
15628 .cindex "IPv6" "disabling"
15629 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15630 activities take place. AAAA records are never looked up, and any IPv6 addresses
15631 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15632 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15633 to handle IPv6 literal addresses.
15634
15635
15636 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15637 .cindex DKIM "selecting signature algorithms"
15638 This option gives a list of hash types which are acceptable in signatures,
15639 and an order of processing.
15640 Signatures with algorithms not in the list will be ignored.
15641
15642 Acceptable values include:
15643 .code
15644 sha1
15645 sha256
15646 sha512
15647 .endd
15648
15649 Note that the acceptance of sha1 violates RFC 8301.
15650
15651 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15652 This option gives a list of key types which are acceptable in signatures,
15653 and an order of processing.
15654 Signatures with algorithms not in the list will be ignored.
15655
15656
15657 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15658 This option gives a list of key sizes which are acceptable in signatures.
15659 The list is keyed by the algorithm type for the key; the values are in bits.
15660 Signatures with keys smaller than given by this option will fail verification.
15661
15662 The default enforces the RFC 8301 minimum key size for RSA signatures.
15663
15664 .option dkim_verify_minimal main boolean false
15665 If set to true, verification of signatures will terminate after the
15666 first success.
15667
15668 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15669 .cindex DKIM "controlling calls to the ACL"
15670 This option gives a list of DKIM domains for which the DKIM ACL is run.
15671 It is expanded after the message is received; by default it runs
15672 the ACL once for each signature in the message.
15673 See section &<<SECDKIMVFY>>&.
15674
15675
15676 .option dmarc_forensic_sender main string&!! unset
15677 .option dmarc_history_file main string unset
15678 .option dmarc_tld_file main string unset
15679 .cindex DMARC "main section options"
15680 These options control DMARC processing.
15681 See section &<<SECDMARC>>& for details.
15682
15683
15684 .option dns_again_means_nonexist main "domain list&!!" unset
15685 .cindex "DNS" "&""try again""& response; overriding"
15686 DNS lookups give a &"try again"& response for the DNS errors
15687 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15688 keep trying to deliver a message, or to give repeated temporary errors to
15689 incoming mail. Sometimes the effect is caused by a badly set up name server and
15690 may persist for a long time. If a domain which exhibits this problem matches
15691 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15692 This option should be used with care. You can make it apply to reverse lookups
15693 by a setting such as this:
15694 .code
15695 dns_again_means_nonexist = *.in-addr.arpa
15696 .endd
15697 This option applies to all DNS lookups that Exim does,
15698 .new
15699 except for TLSA lookups (where knowing about such failures
15700 is security-relevant).
15701 .wen
15702 It also applies when the
15703 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15704 since these are most likely to be caused by DNS lookup problems. The
15705 &(dnslookup)& router has some options of its own for controlling what happens
15706 when lookups for MX or SRV records give temporary errors. These more specific
15707 options are applied after this global option.
15708
15709 .option dns_check_names_pattern main string "see below"
15710 .cindex "DNS" "pre-check of name syntax"
15711 When this option is set to a non-empty string, it causes Exim to check domain
15712 names for characters that are not allowed in host names before handing them to
15713 the DNS resolver, because some resolvers give temporary errors for names that
15714 contain unusual characters. If a domain name contains any unwanted characters,
15715 a &"not found"& result is forced, and the resolver is not called. The check is
15716 done by matching the domain name against a regular expression, which is the
15717 value of this option. The default pattern is
15718 .code
15719 dns_check_names_pattern = \
15720   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15721 .endd
15722 which permits only letters, digits, slashes, and hyphens in components, but
15723 they must start and end with a letter or digit. Slashes are not, in fact,
15724 permitted in host names, but they are found in certain NS records (which can be
15725 accessed in Exim by using a &%dnsdb%& lookup). If you set
15726 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15727 empty string.
15728
15729 .option dns_csa_search_limit main integer 5
15730 This option controls the depth of parental searching for CSA SRV records in the
15731 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15732
15733 .option dns_csa_use_reverse main boolean true
15734 This option controls whether or not an IP address, given as a CSA domain, is
15735 reversed and looked up in the reverse DNS, as described in more detail in
15736 section &<<SECTverifyCSA>>&.
15737
15738 .option dns_cname_loops main integer 1
15739 .cindex DNS "CNAME following"
15740 This option controls the following of CNAME chains, needed if the resolver does
15741 not do it internally.
15742 As of 2018 most should, and the default can be left.
15743 If you have an ancient one, a value of 10 is likely needed.
15744
15745 The default value of one CNAME-follow is needed
15746 thanks to the observed return for an MX request,
15747 given no MX presence but a CNAME to an A, of the CNAME.
15748
15749
15750 .option dns_dnssec_ok main integer -1
15751 .cindex "DNS" "resolver options"
15752 .cindex "DNS" "DNSSEC"
15753 If this option is set to a non-negative number then Exim will initialise the
15754 DNS resolver library to either use or not use DNSSEC, overriding the system
15755 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15756
15757 If the resolver library does not support DNSSEC then this option has no effect.
15758
15759 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15760 will default to stripping out a successful validation status.
15761 This will break a previously working Exim installation.
15762 Provided that you do trust the resolver (ie, is on localhost) you can tell
15763 glibc to pass through any successful validation with a new option in
15764 &_/etc/resolv.conf_&:
15765 .code
15766 options trust-ad
15767 .endd
15768
15769
15770 .option dns_ipv4_lookup main "domain list&!!" unset
15771 .cindex "IPv6" "DNS lookup for AAAA records"
15772 .cindex "DNS" "IPv6 lookup for AAAA records"
15773 .cindex DNS "IPv6 disabling"
15774 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15775 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15776 (A records) when trying to find IP addresses for hosts, unless the host's
15777 domain matches this list.
15778
15779 This is a fudge to help with name servers that give big delays or otherwise do
15780 not work for the AAAA record type. In due course, when the world's name
15781 servers have all been upgraded, there should be no need for this option.
15782 Note that all lookups, including those done for verification, are affected;
15783 this will result in verify failure for IPv6 connections or ones using names
15784 only valid for IPv6 addresses.
15785
15786
15787 .option dns_retrans main time 0s
15788 .cindex "DNS" "resolver options"
15789 .cindex timeout "dns lookup"
15790 .cindex "DNS" timeout
15791 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15792 retransmission and retry parameters for DNS lookups. Values of zero (the
15793 defaults) leave the system default settings unchanged. The first value is the
15794 time between retries, and the second is the number of retries. It isn't
15795 totally clear exactly how these settings affect the total time a DNS lookup may
15796 take. I haven't found any documentation about timeouts on DNS lookups; these
15797 parameter values are available in the external resolver interface structure,
15798 but nowhere does it seem to describe how they are used or what you might want
15799 to set in them.
15800 See also the &%slow_lookup_log%& option.
15801
15802
15803 .option dns_retry main integer 0
15804 See &%dns_retrans%& above.
15805
15806
15807 .option dns_trust_aa main "domain list&!!" unset
15808 .cindex "DNS" "resolver options"
15809 .cindex "DNS" "DNSSEC"
15810 If this option is set then lookup results marked with the AA bit
15811 (Authoritative Answer) are trusted the same way as if they were
15812 DNSSEC-verified. The authority section's name of the answer must
15813 match with this expanded domain list.
15814
15815 Use this option only if you talk directly to a resolver that is
15816 authoritative for some zones and does not set the AD (Authentic Data)
15817 bit in the answer. Some DNS servers may have an configuration option to
15818 mark the answers from their own zones as verified (they set the AD bit).
15819 Others do not have this option. It is considered as poor practice using
15820 a resolver that is an authoritative server for some zones.
15821
15822 Use this option only if you really have to (e.g. if you want
15823 to use DANE for remote delivery to a server that is listed in the DNS
15824 zones that your resolver is authoritative for).
15825
15826 If the DNS answer packet has the AA bit set and contains resource record
15827 in the answer section, the name of the first NS record appearing in the
15828 authority section is compared against the list. If the answer packet is
15829 authoritative but the answer section is empty, the name of the first SOA
15830 record in the authoritative section is used instead.
15831
15832 .cindex "DNS" "resolver options"
15833 .option dns_use_edns0 main integer -1
15834 .cindex "DNS" "resolver options"
15835 .cindex "DNS" "EDNS0"
15836 .cindex "DNS" "OpenBSD
15837 If this option is set to a non-negative number then Exim will initialise the
15838 DNS resolver library to either use or not use EDNS0 extensions, overriding
15839 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15840 on.
15841
15842 If the resolver library does not support EDNS0 then this option has no effect.
15843
15844 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15845 means that DNSSEC will not work with Exim on that platform either, unless Exim
15846 is linked against an alternative DNS client library.
15847
15848
15849 .option drop_cr main boolean false
15850 This is an obsolete option that is now a no-op. It used to affect the way Exim
15851 handled CR and LF characters in incoming messages. What happens now is
15852 described in section &<<SECTlineendings>>&.
15853
15854 .option dsn_advertise_hosts main "host list&!!" unset
15855 .cindex "bounce messages" "success"
15856 .cindex "DSN" "success"
15857 .cindex "Delivery Status Notification" "success"
15858 .cindex "ESMTP extensions" DSN
15859 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15860 and accepted from, these hosts.
15861 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15862 and RET and ENVID options on MAIL FROM commands.
15863 A NOTIFY=SUCCESS option requests success-DSN messages.
15864 A NOTIFY= option with no argument requests that no delay or failure DSNs
15865 are sent.
15866 &*Note*&: Supplying success-DSN messages has been criticised
15867 on privacy grounds; it can leak details of internal forwarding.
15868
15869 .option dsn_from main "string&!!" "see below"
15870 .cindex "&'From:'& header line" "in bounces"
15871 .cindex "bounce messages" "&'From:'& line, specifying"
15872 This option can be used to vary the contents of &'From:'& header lines in
15873 bounces and other automatically generated messages (&"Delivery Status
15874 Notifications"& &-- hence the name of the option). The default setting is:
15875 .code
15876 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15877 .endd
15878 The value is expanded every time it is needed. If the expansion fails, a
15879 panic is logged, and the default value is used.
15880
15881 .option envelope_to_remove main boolean true
15882 .cindex "&'Envelope-to:'& header line"
15883 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15884 message when it is delivered, in exactly the same way as &'Return-path:'& is
15885 handled. &'Envelope-to:'& records the original recipient address from the
15886 message's envelope that caused the delivery to happen. Such headers should not
15887 be present in incoming messages, and this option causes them to be removed at
15888 the time the message is received, to avoid any problems that might occur when a
15889 delivered message is subsequently sent on to some other recipient.
15890
15891
15892 .option errors_copy main "string list&!!" unset
15893 .cindex "bounce message" "copy to other address"
15894 .cindex "copy of bounce message"
15895 Setting this option causes Exim to send bcc copies of bounce messages that it
15896 generates to other addresses. &*Note*&: This does not apply to bounce messages
15897 coming from elsewhere. The value of the option is a colon-separated list of
15898 items. Each item consists of a pattern, terminated by white space, followed by
15899 a comma-separated list of email addresses. If a pattern contains spaces, it
15900 must be enclosed in double quotes.
15901
15902 Each pattern is processed in the same way as a single item in an address list
15903 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15904 the bounce message, the message is copied to the addresses on the list. The
15905 items are scanned in order, and once a matching one is found, no further items
15906 are examined. For example:
15907 .code
15908 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15909               rqps@mydomain   hostmaster@mydomain.example,\
15910                               postmaster@mydomain.example
15911 .endd
15912 .vindex "&$domain$&"
15913 .vindex "&$local_part$&"
15914 The address list is expanded before use. The expansion variables &$local_part$&
15915 and &$domain$& are set from the original recipient of the error message, and if
15916 there was any wildcard matching in the pattern, the expansion
15917 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15918 variables &$0$&, &$1$&, etc. are set in the normal way.
15919
15920
15921 .option errors_reply_to main string unset
15922 .cindex "bounce message" "&'Reply-to:'& in"
15923 By default, Exim's bounce and delivery warning messages contain the header line
15924 .display
15925 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15926 .endd
15927 .oindex &%quota_warn_message%&
15928 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15929 A warning message that is generated by the &%quota_warn_message%& option in an
15930 &(appendfile)& transport may contain its own &'From:'& header line that
15931 overrides the default.
15932
15933 Experience shows that people reply to bounce messages. If the
15934 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15935 and warning messages. For example:
15936 .code
15937 errors_reply_to = postmaster@my.domain.example
15938 .endd
15939 The value of the option is not expanded. It must specify a valid RFC 2822
15940 address. However, if a warning message that is generated by the
15941 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15942 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15943 not used.
15944
15945
15946 .option event_action main string&!! unset
15947 .cindex events
15948 This option declares a string to be expanded for Exim's events mechanism.
15949 For details see chapter &<<CHAPevents>>&.
15950
15951
15952 .option exim_group main string "compile-time configured"
15953 .cindex "gid (group id)" "Exim's own"
15954 .cindex "Exim group"
15955 This option changes the gid under which Exim runs when it gives up root
15956 privilege. The default value is compiled into the binary. The value of this
15957 option is used only when &%exim_user%& is also set. Unless it consists entirely
15958 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15959 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15960 security issues.
15961
15962
15963 .option exim_path main string "see below"
15964 .cindex "Exim binary, path name"
15965 This option specifies the path name of the Exim binary, which is used when Exim
15966 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15967 the directory configured at compile time by the BIN_DIRECTORY setting. It
15968 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15969 other place.
15970 &*Warning*&: Do not use a macro to define the value of this option, because
15971 you will break those Exim utilities that scan the configuration file to find
15972 where the binary is. (They then use the &%-bP%& option to extract option
15973 settings such as the value of &%spool_directory%&.)
15974
15975
15976 .option exim_user main string "compile-time configured"
15977 .cindex "uid (user id)" "Exim's own"
15978 .cindex "Exim user"
15979 This option changes the uid under which Exim runs when it gives up root
15980 privilege. The default value is compiled into the binary. Ownership of the run
15981 time configuration file and the use of the &%-C%& and &%-D%& command line
15982 options is checked against the values in the binary, not what is set here.
15983
15984 Unless it consists entirely of digits, the string is looked up using
15985 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15986 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15987 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15988
15989
15990 .option exim_version main string "current version"
15991 .cindex "Exim version"
15992 .cindex customizing "version number"
15993 .cindex "version number of Exim" override
15994 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15995 various places.  Use with care; this may fool stupid security scanners.
15996
15997
15998 .option extra_local_interfaces main "string list" unset
15999 This option defines network interfaces that are to be considered local when
16000 routing, but which are not used for listening by the daemon. See section
16001 &<<SECTreclocipadd>>& for details.
16002
16003
16004 . Allow this long option name to split; give it unsplit as a fifth argument
16005 . for the automatic .oindex that is generated by .option.
16006
16007 .option "extract_addresses_remove_arguments" main boolean true &&&
16008          extract_addresses_remove_arguments
16009 .oindex "&%-t%&"
16010 .cindex "command line" "addresses with &%-t%&"
16011 .cindex "Sendmail compatibility" "&%-t%& option"
16012 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16013 are present on the command line when the &%-t%& option is used to build an
16014 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16015 line addresses are removed from the recipients list. This is also how Smail
16016 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16017 command line addresses are added to those obtained from the header lines. When
16018 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16019 argument headers. If it is set false, Exim adds rather than removes argument
16020 addresses.
16021
16022
16023 .option finduser_retries main integer 0
16024 .cindex "NIS, retrying user lookups"
16025 On systems running NIS or other schemes in which user and group information is
16026 distributed from a remote system, there can be times when &[getpwnam()]& and
16027 related functions fail, even when given valid data, because things time out.
16028 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16029 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16030 many extra times to find a user or a group, waiting for one second between
16031 retries.
16032
16033 .cindex "&_/etc/passwd_&" "multiple reading of"
16034 You should not set this option greater than zero if your user information is in
16035 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16036 search the file multiple times for non-existent users, and also cause delay.
16037
16038
16039
16040 .option freeze_tell main "string list, comma separated" unset
16041 .cindex "freezing messages" "sending a message when freezing"
16042 On encountering certain errors, or when configured to do so in a system filter,
16043 ACL, or special router, Exim freezes a message. This means that no further
16044 delivery attempts take place until an administrator thaws the message, or the
16045 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16046 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16047 warning message whenever it freezes something, unless the message it is
16048 freezing is a locally-generated bounce message. (Without this exception there
16049 is the possibility of looping.) The warning message is sent to the addresses
16050 supplied as the comma-separated value of this option. If several of the
16051 message's addresses cause freezing, only a single message is sent. If the
16052 freezing was automatic, the reason(s) for freezing can be found in the message
16053 log. If you configure freezing in a filter or ACL, you must arrange for any
16054 logging that you require.
16055
16056
16057 .option gecos_name main string&!! unset
16058 .cindex "HP-UX"
16059 .cindex "&""gecos""& field, parsing"
16060 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16061 password file to hold other information in addition to users' real names. Exim
16062 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16063 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16064 of the field are used unchanged, except that, if an ampersand is encountered,
16065 it is replaced by the user's login name with the first character forced to
16066 upper case, since this is a convention that is observed on many systems.
16067
16068 When these options are set, &%gecos_pattern%& is treated as a regular
16069 expression that is to be applied to the field (again with && replaced by the
16070 login name), and if it matches, &%gecos_name%& is expanded and used as the
16071 user's name.
16072
16073 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16074 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16075 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16076 name terminates at the first comma, the following can be used:
16077 .code
16078 gecos_pattern = ([^,]*)
16079 gecos_name = $1
16080 .endd
16081
16082 .option gecos_pattern main string unset
16083 See &%gecos_name%& above.
16084
16085
16086 .option gnutls_compat_mode main boolean unset
16087 This option controls whether GnuTLS is used in compatibility mode in an Exim
16088 server. This reduces security slightly, but improves interworking with older
16089 implementations of TLS.
16090
16091
16092 .option gnutls_allow_auto_pkcs11 main boolean unset
16093 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16094 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16095
16096 See
16097 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16098 for documentation.
16099
16100
16101
16102 .option headers_charset main string "see below"
16103 This option sets a default character set for translating from encoded MIME
16104 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16105 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16106 ultimate default is ISO-8859-1. For more details see the description of header
16107 insertions in section &<<SECTexpansionitems>>&.
16108
16109
16110
16111 .option header_maxsize main integer "see below"
16112 .cindex "header section" "maximum size of"
16113 .cindex "limit" "size of message header section"
16114 This option controls the overall maximum size of a message's header
16115 section. The default is the value of HEADER_MAXSIZE in
16116 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16117 sections are rejected.
16118
16119
16120 .option header_line_maxsize main integer 0
16121 .cindex "header lines" "maximum size of"
16122 .cindex "limit" "size of one header line"
16123 This option limits the length of any individual header line in a message, after
16124 all the continuations have been joined together. Messages with individual
16125 header lines that are longer than the limit are rejected. The default value of
16126 zero means &"no limit"&.
16127
16128
16129
16130
16131 .option helo_accept_junk_hosts main "host list&!!" unset
16132 .cindex "HELO" "accepting junk data"
16133 .cindex "EHLO" "accepting junk data"
16134 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16135 mail, and gives an error response for invalid data. Unfortunately, there are
16136 some SMTP clients that send syntactic junk. They can be accommodated by setting
16137 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16138 if you want to do semantic checking.
16139 See also &%helo_allow_chars%& for a way of extending the permitted character
16140 set.
16141
16142
16143 .option helo_allow_chars main string unset
16144 .cindex "HELO" "underscores in"
16145 .cindex "EHLO" "underscores in"
16146 .cindex "underscore in EHLO/HELO"
16147 This option can be set to a string of rogue characters that are permitted in
16148 all EHLO and HELO names in addition to the standard letters, digits,
16149 hyphens, and dots. If you really must allow underscores, you can set
16150 .code
16151 helo_allow_chars = _
16152 .endd
16153 Note that the value is one string, not a list.
16154
16155
16156 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16157 .cindex "HELO" "forcing reverse lookup"
16158 .cindex "EHLO" "forcing reverse lookup"
16159 If the domain given by a client in a HELO or EHLO command matches this
16160 list, a reverse lookup is done in order to establish the host's true name. The
16161 default forces a lookup if the client host gives the server's name or any of
16162 its IP addresses (in brackets), something that broken clients have been seen to
16163 do.
16164
16165
16166 .option helo_try_verify_hosts main "host list&!!" unset
16167 .cindex "HELO verifying" "optional"
16168 .cindex "EHLO" "verifying, optional"
16169 By default, Exim just checks the syntax of HELO and EHLO commands (see
16170 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16171 to do more extensive checking of the data supplied by these commands. The ACL
16172 condition &`verify = helo`& is provided to make this possible.
16173 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16174 to force the check to occur. From release 4.53 onwards, this is no longer
16175 necessary. If the check has not been done before &`verify = helo`& is
16176 encountered, it is done at that time. Consequently, this option is obsolete.
16177 Its specification is retained here for backwards compatibility.
16178
16179 When an EHLO or HELO command is received, if the calling host matches
16180 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16181 EHLO command either:
16182
16183 .ilist
16184 is an IP literal matching the calling address of the host, or
16185 .next
16186 .cindex "DNS" "reverse lookup"
16187 .cindex "reverse DNS lookup"
16188 matches the host name that Exim obtains by doing a reverse lookup of the
16189 calling host address, or
16190 .next
16191 when looked up in DNS yields the calling host address.
16192 .endlist
16193
16194 However, the EHLO or HELO command is not rejected if any of the checks
16195 fail. Processing continues, but the result of the check is remembered, and can
16196 be detected later in an ACL by the &`verify = helo`& condition.
16197
16198 If DNS was used for successful verification, the variable
16199 .cindex "DNS" "DNSSEC"
16200 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16201
16202 .option helo_verify_hosts main "host list&!!" unset
16203 .cindex "HELO verifying" "mandatory"
16204 .cindex "EHLO" "verifying, mandatory"
16205 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16206 backwards compatibility. For hosts that match this option, Exim checks the host
16207 name given in the HELO or EHLO in the same way as for
16208 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16209 rejected with a 550 error, and entries are written to the main and reject logs.
16210 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16211 error.
16212
16213 .option hold_domains main "domain list&!!" unset
16214 .cindex "domain" "delaying delivery"
16215 .cindex "delivery" "delaying certain domains"
16216 This option allows mail for particular domains to be held in the queue
16217 manually. The option is overridden if a message delivery is forced with the
16218 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16219 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16220 item in &%hold_domains%&, no routing or delivery for that address is done, and
16221 it is deferred every time the message is looked at.
16222
16223 This option is intended as a temporary operational measure for delaying the
16224 delivery of mail while some problem is being sorted out, or some new
16225 configuration tested. If you just want to delay the processing of some
16226 domains until a queue run occurs, you should use &%queue_domains%& or
16227 &%queue_smtp_domains%&, not &%hold_domains%&.
16228
16229 A setting of &%hold_domains%& does not override Exim's code for removing
16230 messages from the queue if they have been there longer than the longest retry
16231 time in any retry rule. If you want to hold messages for longer than the normal
16232 retry times, insert a dummy retry rule with a long retry time.
16233
16234
16235 .option host_lookup main "host list&!!" unset
16236 .cindex "host name" "lookup, forcing"
16237 Exim does not look up the name of a calling host from its IP address unless it
16238 is required to compare against some host list, or the host matches
16239 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16240 option (which normally contains IP addresses rather than host names). The
16241 default configuration file contains
16242 .code
16243 host_lookup = *
16244 .endd
16245 which causes a lookup to happen for all hosts. If the expense of these lookups
16246 is felt to be too great, the setting can be changed or removed.
16247
16248 After a successful reverse lookup, Exim does a forward lookup on the name it
16249 has obtained, to verify that it yields the IP address that it started with. If
16250 this check fails, Exim behaves as if the name lookup failed.
16251
16252 .vindex "&$host_lookup_failed$&"
16253 .vindex "&$sender_host_name$&"
16254 After any kind of failure, the host name (in &$sender_host_name$&) remains
16255 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16256 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16257 &`verify = reverse_host_lookup`& in ACLs.
16258
16259
16260 .option host_lookup_order main "string list" &`bydns:byaddr`&
16261 This option specifies the order of different lookup methods when Exim is trying
16262 to find a host name from an IP address. The default is to do a DNS lookup
16263 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16264 if that fails. You can change the order of these lookups, or omit one entirely,
16265 if you want.
16266
16267 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16268 multiple PTR records in the DNS and the IP address is not listed in
16269 &_/etc/hosts_&. Different operating systems give different results in this
16270 case. That is why the default tries a DNS lookup first.
16271
16272
16273
16274 .option host_reject_connection main "host list&!!" unset
16275 .cindex "host" "rejecting connections from"
16276 If this option is set, incoming SMTP calls from the hosts listed are rejected
16277 as soon as the connection is made.
16278 This option is obsolete, and retained only for backward compatibility, because
16279 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16280 connections immediately.
16281
16282 .new
16283 If the connection is on a TLS-on-connect port then the TCP connection is
16284 just dropped.  Otherwise, an SMTP error is sent first.
16285 .wen
16286
16287 The ability to give an immediate rejection (either by this option or using an
16288 ACL) is provided for use in unusual cases. Many hosts will just try again,
16289 sometimes without much delay. Normally, it is better to use an ACL to reject
16290 incoming messages at a later stage, such as after RCPT commands. See
16291 chapter &<<CHAPACL>>&.
16292
16293
16294 .option hosts_connection_nolog main "host list&!!" unset
16295 .cindex "host" "not logging connections from"
16296 This option defines a list of hosts for which connection logging does not
16297 happen, even though the &%smtp_connection%& log selector is set. For example,
16298 you might want not to log SMTP connections from local processes, or from
16299 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16300 the daemon; you should therefore strive to restrict its value to a short inline
16301 list of IP addresses and networks. To disable logging SMTP connections from
16302 local processes, you must create a host list with an empty item. For example:
16303 .code
16304 hosts_connection_nolog = :
16305 .endd
16306 .new
16307 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16308 lines, as may commonly be produced by a monitoring system.
16309 .wen
16310
16311
16312 .option hosts_require_alpn main "host list&!!" unset
16313 .cindex ALPN "require negotiation in server"
16314 .cindex TLS ALPN
16315 .cindex TLS "Application Layer Protocol Names"
16316 If the TLS library supports ALPN
16317 then a successful negotiation of ALPN will be required for any client
16318 matching the list, for TLS to be used.
16319 See also the &%tls_alpn%& option.
16320
16321 &*Note*&: prevention of fallback to in-clear connection is not
16322 managed by this option, and should be done separately.
16323
16324
16325 .option hosts_require_helo main "host list&!!" *
16326 .cindex "HELO/EHLO" requiring
16327 Exim will require an accepted HELO or EHLO command from a host matching
16328 this list, before accepting a MAIL command.
16329
16330
16331 .option hosts_proxy main "host list&!!" unset
16332 .cindex proxy "proxy protocol"
16333 This option enables use of Proxy Protocol proxies for incoming
16334 connections.  For details see section &<<SECTproxyInbound>>&.
16335
16336
16337 .option hosts_treat_as_local main "domain list&!!" unset
16338 .cindex "local host" "domains treated as"
16339 .cindex "host" "treated as local"
16340 If this option is set, any host names that match the domain list are treated as
16341 if they were the local host when Exim is scanning host lists obtained from MX
16342 records
16343 or other sources. Note that the value of this option is a domain list, not a
16344 host list, because it is always used to check host names, not IP addresses.
16345
16346 This option also applies when Exim is matching the special items
16347 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16348 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16349 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16350 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16351 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16352 interfaces and recognizing the local host.
16353
16354
16355 .option ibase_servers main "string list" unset
16356 .cindex "InterBase" "server list"
16357 This option provides a list of InterBase servers and associated connection data,
16358 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16359 The option is available only if Exim has been built with InterBase support.
16360
16361
16362
16363 .option ignore_bounce_errors_after main time 10w
16364 .cindex "bounce message" "discarding"
16365 .cindex "discarding bounce message"
16366 This option affects the processing of bounce messages that cannot be delivered,
16367 that is, those that suffer a permanent delivery failure. (Bounce messages that
16368 suffer temporary delivery failures are of course retried in the usual way.)
16369
16370 After a permanent delivery failure, bounce messages are frozen,
16371 because there is no sender to whom they can be returned. When a frozen bounce
16372 message has been in the queue for more than the given time, it is unfrozen at
16373 the next queue run, and a further delivery is attempted. If delivery fails
16374 again, the bounce message is discarded. This makes it possible to keep failed
16375 bounce messages around for a shorter time than the normal maximum retry time
16376 for frozen messages. For example,
16377 .code
16378 ignore_bounce_errors_after = 12h
16379 .endd
16380 retries failed bounce message deliveries after 12 hours, discarding any further
16381 failures. If the value of this option is set to a zero time period, bounce
16382 failures are discarded immediately. Setting a very long time (as in the default
16383 value) has the effect of disabling this option. For ways of automatically
16384 dealing with other kinds of frozen message, see &%auto_thaw%& and
16385 &%timeout_frozen_after%&.
16386
16387
16388 .option ignore_fromline_hosts main "host list&!!" unset
16389 .cindex "&""From""& line"
16390 .cindex "UUCP" "&""From""& line"
16391 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16392 the headers of a message. By default this is treated as the start of the
16393 message's body, which means that any following headers are not recognized as
16394 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16395 match those hosts that insist on sending it. If the sender is actually a local
16396 process rather than a remote host, and is using &%-bs%& to inject the messages,
16397 &%ignore_fromline_local%& must be set to achieve this effect.
16398
16399
16400 .option ignore_fromline_local main boolean false
16401 See &%ignore_fromline_hosts%& above.
16402
16403 .option keep_environment main "string list" unset
16404 .cindex "environment" "values from"
16405 This option contains a string list of environment variables to keep.
16406 You have to trust these variables or you have to be sure that
16407 these variables do not impose any security risk. Keep in mind that
16408 during the startup phase Exim is running with an effective UID 0 in most
16409 installations. As the default value is an empty list, the default
16410 environment for using libraries, running embedded Perl code, or running
16411 external binaries is empty, and does not not even contain PATH or HOME.
16412
16413 Actually the list is interpreted as a list of patterns
16414 (&<<SECTlistexpand>>&), except that it is not expanded first.
16415
16416 WARNING: Macro substitution is still done first, so having a macro
16417 FOO and having FOO_HOME in your &%keep_environment%& option may have
16418 unexpected results. You may work around this using a regular expression
16419 that does not match the macro name: ^[F]OO_HOME$.
16420
16421 Current versions of Exim issue a warning during startup if you do not mention
16422 &%keep_environment%& in your runtime configuration file and if your
16423 current environment is not empty. Future versions may not issue that warning
16424 anymore.
16425
16426 See the &%add_environment%& main config option for a way to set
16427 environment variables to a fixed value.  The environment for &(pipe)&
16428 transports is handled separately, see section &<<SECTpipeenv>>& for
16429 details.
16430
16431
16432 .option keep_malformed main time 4d
16433 This option specifies the length of time to keep messages whose spool files
16434 have been corrupted in some way. This should, of course, never happen. At the
16435 next attempt to deliver such a message, it gets removed. The incident is
16436 logged.
16437
16438
16439 .option ldap_ca_cert_dir main string unset
16440 .cindex "LDAP", "TLS CA certificate directory"
16441 .cindex certificate "directory for LDAP"
16442 This option indicates which directory contains CA certificates for verifying
16443 a TLS certificate presented by an LDAP server.
16444 While Exim does not provide a default value, your SSL library may.
16445 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16446 and constrained to be a directory.
16447
16448
16449 .option ldap_ca_cert_file main string unset
16450 .cindex "LDAP", "TLS CA certificate file"
16451 .cindex certificate "file for LDAP"
16452 This option indicates which file contains CA certificates for verifying
16453 a TLS certificate presented by an LDAP server.
16454 While Exim does not provide a default value, your SSL library may.
16455 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16456 and constrained to be a file.
16457
16458
16459 .option ldap_cert_file main string unset
16460 .cindex "LDAP" "TLS client certificate file"
16461 .cindex certificate "file for LDAP"
16462 This option indicates which file contains an TLS client certificate which
16463 Exim should present to the LDAP server during TLS negotiation.
16464 Should be used together with &%ldap_cert_key%&.
16465
16466
16467 .option ldap_cert_key main string unset
16468 .cindex "LDAP" "TLS client key file"
16469 .cindex certificate "key for LDAP"
16470 This option indicates which file contains the secret/private key to use
16471 to prove identity to the LDAP server during TLS negotiation.
16472 Should be used together with &%ldap_cert_file%&, which contains the
16473 identity to be proven.
16474
16475
16476 .option ldap_cipher_suite main string unset
16477 .cindex "LDAP" "TLS cipher suite"
16478 This controls the TLS cipher-suite negotiation during TLS negotiation with
16479 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16480 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16481
16482
16483 .option ldap_default_servers main "string list" unset
16484 .cindex "LDAP" "default servers"
16485 This option provides a list of LDAP servers which are tried in turn when an
16486 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16487 details of LDAP queries. This option is available only when Exim has been built
16488 with LDAP support.
16489
16490
16491 .option ldap_require_cert main string unset.
16492 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16493 This should be one of the values "hard", "demand", "allow", "try" or "never".
16494 A value other than one of these is interpreted as "never".
16495 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16496 Although Exim does not set a default, the LDAP library probably defaults
16497 to hard/demand.
16498
16499
16500 .option ldap_start_tls main boolean false
16501 .cindex "LDAP" "whether or not to negotiate TLS"
16502 If set, Exim will attempt to negotiate TLS with the LDAP server when
16503 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16504 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16505 of SSL-on-connect.
16506 In the event of failure to negotiate TLS, the action taken is controlled
16507 by &%ldap_require_cert%&.
16508 This option is ignored for &`ldapi`& connections.
16509
16510
16511 .option ldap_version main integer unset
16512 .cindex "LDAP" "protocol version, forcing"
16513 This option can be used to force Exim to set a specific protocol version for
16514 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16515 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16516 the LDAP headers; otherwise it is 2. This option is available only when Exim
16517 has been built with LDAP support.
16518
16519
16520
16521 .option local_from_check main boolean true
16522 .cindex "&'Sender:'& header line" "disabling addition of"
16523 .cindex "&'From:'& header line" "disabling checking of"
16524 When a message is submitted locally (that is, not over a TCP/IP connection) by
16525 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16526 checks that the &'From:'& header line matches the login of the calling user and
16527 the domain specified by &%qualify_domain%&.
16528
16529 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16530 locally submitted message is automatically qualified by Exim, unless the
16531 &%-bnq%& command line option is used.
16532
16533 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16534 on the local part. If the &'From:'& header line does not match, Exim adds a
16535 &'Sender:'& header with an address constructed from the calling user's login
16536 and the default qualify domain.
16537
16538 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16539 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16540 &'Sender:'& header lines supplied by untrusted users, you must also set
16541 &%local_sender_retain%& to be true.
16542
16543 .cindex "envelope from"
16544 .cindex "envelope sender"
16545 These options affect only the header lines in the message. The envelope sender
16546 is still forced to be the login id at the qualify domain unless
16547 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16548
16549 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16550 request similar header line checking. See section &<<SECTthesenhea>>&, which
16551 has more details about &'Sender:'& processing.
16552
16553
16554
16555
16556 .option local_from_prefix main string unset
16557 When Exim checks the &'From:'& header line of locally submitted messages for
16558 matching the login id (see &%local_from_check%& above), it can be configured to
16559 ignore certain prefixes and suffixes in the local part of the address. This is
16560 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16561 appropriate lists, in the same form as the &%local_part_prefix%& and
16562 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16563 example, if
16564 .code
16565 local_from_prefix = *-
16566 .endd
16567 is set, a &'From:'& line containing
16568 .code
16569 From: anything-user@your.domain.example
16570 .endd
16571 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16572 matches the actual sender address that is constructed from the login name and
16573 qualify domain.
16574
16575
16576 .option local_from_suffix main string unset
16577 See &%local_from_prefix%& above.
16578
16579
16580 .option local_interfaces main "string list" "see below"
16581 This option controls which network interfaces are used by the daemon for
16582 listening; they are also used to identify the local host when routing. Chapter
16583 &<<CHAPinterfaces>>& contains a full description of this option and the related
16584 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16585 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16586 &%local_interfaces%& is
16587 .code
16588 local_interfaces = 0.0.0.0
16589 .endd
16590 when Exim is built without IPv6 support; otherwise it is
16591 .code
16592 local_interfaces = <; ::0 ; 0.0.0.0
16593 .endd
16594
16595 .option local_scan_timeout main time 5m
16596 .cindex "timeout" "for &[local_scan()]& function"
16597 .cindex "&[local_scan()]& function" "timeout"
16598 This timeout applies to the &[local_scan()]& function (see chapter
16599 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16600 the incoming message is rejected with a temporary error if it is an SMTP
16601 message. For a non-SMTP message, the message is dropped and Exim ends with a
16602 non-zero code. The incident is logged on the main and reject logs.
16603
16604
16605
16606 .option local_sender_retain main boolean false
16607 .cindex "&'Sender:'& header line" "retaining from local submission"
16608 When a message is submitted locally (that is, not over a TCP/IP connection) by
16609 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16610 do not want this to happen, you must set &%local_sender_retain%&, and you must
16611 also set &%local_from_check%& to be false (Exim will complain if you do not).
16612 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16613 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16614
16615
16616
16617
16618 .option localhost_number main string&!! unset
16619 .cindex "host" "locally unique number for"
16620 .cindex "message ids" "with multiple hosts"
16621 .vindex "&$localhost_number$&"
16622 Exim's message ids are normally unique only within the local host. If
16623 uniqueness among a set of hosts is required, each host must set a different
16624 value for the &%localhost_number%& option. The string is expanded immediately
16625 after reading the configuration file (so that a number can be computed from the
16626 host name, for example) and the result of the expansion must be a number in the
16627 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16628 systems). This is available in subsequent string expansions via the variable
16629 &$localhost_number$&. When &%localhost_number is set%&, the final two
16630 characters of the message id, instead of just being a fractional part of the
16631 time, are computed from the time and the local host number as described in
16632 section &<<SECTmessiden>>&.
16633
16634
16635
16636 .option log_file_path main "string list&!!" "set at compile time"
16637 .cindex "log" "file path for"
16638 This option sets the path which is used to determine the names of Exim's log
16639 files, or indicates that logging is to be to syslog, or both. It is expanded
16640 when Exim is entered, so it can, for example, contain a reference to the host
16641 name. If no specific path is set for the log files at compile or runtime,
16642 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16643 they are written in a sub-directory called &_log_& in Exim's spool directory.
16644 A path must start with a slash.
16645 To send to syslog, use the word &"syslog"&.
16646 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16647 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16648 used. If this string is fixed at your installation (contains no expansion
16649 variables) it is recommended that you do not set this option in the
16650 configuration file, but instead supply the path using LOG_FILE_PATH in
16651 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16652 early on &-- in particular, failure to read the configuration file.
16653
16654
16655 .option log_selector main string unset
16656 .cindex "log" "selectors"
16657 This option can be used to reduce or increase the number of things that Exim
16658 writes to its log files. Its argument is made up of names preceded by plus or
16659 minus characters. For example:
16660 .code
16661 log_selector = +arguments -retry_defer
16662 .endd
16663 A list of possible names and what they control is given in the chapter on
16664 logging, in section &<<SECTlogselector>>&.
16665
16666
16667 .option log_timezone main boolean false
16668 .cindex "log" "timezone for entries"
16669 .vindex "&$tod_log$&"
16670 .vindex "&$tod_zone$&"
16671 By default, the timestamps on log lines are in local time without the
16672 timezone. This means that if your timezone changes twice a year, the timestamps
16673 in log lines are ambiguous for an hour when the clocks go back. One way of
16674 avoiding this problem is to set the timezone to UTC. An alternative is to set
16675 &%log_timezone%& true. This turns on the addition of the timezone offset to
16676 timestamps in log lines. Turning on this option can add quite a lot to the size
16677 of log files because each line is extended by 6 characters. Note that the
16678 &$tod_log$& variable contains the log timestamp without the zone, but there is
16679 another variable called &$tod_zone$& that contains just the timezone offset.
16680
16681
16682 .option lookup_open_max main integer 25
16683 .cindex "too many open files"
16684 .cindex "open files, too many"
16685 .cindex "file" "too many open"
16686 .cindex "lookup" "maximum open files"
16687 .cindex "limit" "open files for lookups"
16688 This option limits the number of simultaneously open files for single-key
16689 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16690 Exim normally keeps these files open during routing, because often the same
16691 file is required several times. If the limit is reached, Exim closes the least
16692 recently used file. Note that if you are using the &'ndbm'& library, it
16693 actually opens two files for each logical DBM database, though it still counts
16694 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16695 open files"& errors with NDBM, you need to reduce the value of
16696 &%lookup_open_max%&.
16697
16698
16699 .option max_username_length main integer 0
16700 .cindex "length of login name"
16701 .cindex "user name" "maximum length"
16702 .cindex "limit" "user name length"
16703 Some operating systems are broken in that they truncate long arguments to
16704 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16705 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16706 an argument that is longer behaves as if &[getpwnam()]& failed.
16707
16708
16709 .option message_body_newlines main bool false
16710 .cindex "message body" "newlines in variables"
16711 .cindex "newline" "in message body variables"
16712 .vindex "&$message_body$&"
16713 .vindex "&$message_body_end$&"
16714 By default, newlines in the message body are replaced by spaces when setting
16715 the &$message_body$& and &$message_body_end$& expansion variables. If this
16716 option is set true, this no longer happens.
16717
16718
16719 .option message_body_visible main integer 500
16720 .cindex "body of message" "visible size"
16721 .cindex "message body" "visible size"
16722 .vindex "&$message_body$&"
16723 .vindex "&$message_body_end$&"
16724 This option specifies how much of a message's body is to be included in the
16725 &$message_body$& and &$message_body_end$& expansion variables.
16726
16727
16728 .option message_id_header_domain main string&!! unset
16729 .cindex "&'Message-ID:'& header line"
16730 If this option is set, the string is expanded and used as the right hand side
16731 (domain) of the &'Message-ID:'& header that Exim creates if a
16732 locally-originated incoming message does not have one. &"Locally-originated"&
16733 means &"not received over TCP/IP."&
16734 Otherwise, the primary host name is used.
16735 Only letters, digits, dot and hyphen are accepted; any other characters are
16736 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16737 empty string, the option is ignored.
16738
16739
16740 .option message_id_header_text main string&!! unset
16741 If this variable is set, the string is expanded and used to augment the text of
16742 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16743 message does not have one. The text of this header is required by RFC 2822 to
16744 take the form of an address. By default, Exim uses its internal message id as
16745 the local part, and the primary host name as the domain. If this option is set,
16746 it is expanded, and provided the expansion is not forced to fail, and does not
16747 yield an empty string, the result is inserted into the header immediately
16748 before the @, separated from the internal message id by a dot. Any characters
16749 that are illegal in an address are automatically converted into hyphens. This
16750 means that variables such as &$tod_log$& can be used, because the spaces and
16751 colons will become hyphens.
16752
16753
16754 .option message_logs main boolean true
16755 .cindex "message logs" "disabling"
16756 .cindex "log" "message log; disabling"
16757 If this option is turned off, per-message log files are not created in the
16758 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16759 Exim, by reducing the number of files involved in handling a message from a
16760 minimum of four (header spool file, body spool file, delivery journal, and
16761 per-message log) to three. The other major I/O activity is Exim's main log,
16762 which is not affected by this option.
16763
16764
16765 .option message_size_limit main string&!! 50M
16766 .cindex "message" "size limit"
16767 .cindex "limit" "message size"
16768 .cindex "size" "of message, limit"
16769 This option limits the maximum size of message that Exim will process. The
16770 value is expanded for each incoming connection so, for example, it can be made
16771 to depend on the IP address of the remote host for messages arriving via
16772 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16773 optionally followed by K or M.
16774
16775 .cindex "SIZE" "ESMTP extension, advertising"
16776 .cindex "ESMTP extensions" SIZE
16777 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16778 service extension keyword.
16779
16780 &*Note*&: This limit cannot be made to depend on a message's sender or any
16781 other properties of an individual message, because it has to be advertised in
16782 the server's response to EHLO. String expansion failure causes a temporary
16783 error. A value of zero means no limit, but its use is not recommended. See also
16784 &%bounce_return_size_limit%&.
16785
16786 Incoming SMTP messages are failed with a 552 error if the limit is
16787 exceeded; locally-generated messages either get a stderr message or a delivery
16788 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16789 an oversized message is logged in both the main and the reject logs. See also
16790 the generic transport option &%message_size_limit%&, which limits the size of
16791 message that an individual transport can process.
16792
16793 If you use a virus-scanner and set this option to to a value larger than the
16794 maximum size that your virus-scanner is configured to support, you may get
16795 failures triggered by large mails.  The right size to configure for the
16796 virus-scanner depends upon what data is passed and the options in use but it's
16797 probably safest to just set it to a little larger than this value.  E.g., with a
16798 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16799 some problems may result.
16800
16801 A value of 0 will disable size limit checking; Exim will still advertise the
16802 SIZE extension in an EHLO response, but without a limit, so as to permit
16803 SMTP clients to still indicate the message size along with the MAIL verb.
16804
16805
16806 .option move_frozen_messages main boolean false
16807 .cindex "frozen messages" "moving"
16808 This option, which is available only if Exim has been built with the setting
16809 .code
16810 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16811 .endd
16812 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16813 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16814 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16815 standard utilities for handling such moved messages, and they do not show up in
16816 lists generated by &%-bp%& or by the Exim monitor.
16817
16818
16819 .option mua_wrapper main boolean false
16820 Setting this option true causes Exim to run in a very restrictive mode in which
16821 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16822 contains a full description of this facility.
16823
16824
16825
16826 .option mysql_servers main "string list" unset
16827 .cindex "MySQL" "server list"
16828 This option provides a list of MySQL servers and associated connection data, to
16829 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16830 option is available only if Exim has been built with MySQL support.
16831
16832
16833 .option never_users main "string list&!!" unset
16834 This option is expanded just once, at the start of Exim's processing. Local
16835 message deliveries are normally run in processes that are setuid to the
16836 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16837 It is usually desirable to prevent any deliveries from running as root, as a
16838 safety precaution.
16839
16840 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16841 list of users that must not be used for local deliveries. This list is fixed in
16842 the binary and cannot be overridden by the configuration file. By default, it
16843 contains just the single user name &"root"&. The &%never_users%& runtime option
16844 can be used to add more users to the fixed list.
16845
16846 If a message is to be delivered as one of the users on the fixed list or the
16847 &%never_users%& list, an error occurs, and delivery is deferred. A common
16848 example is
16849 .code
16850 never_users = root:daemon:bin
16851 .endd
16852 Including root is redundant if it is also on the fixed list, but it does no
16853 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16854 transport driver.
16855
16856
16857 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16858 This option gives the name for a unix-domain socket on which the daemon
16859 listens for work and information-requests.
16860 Only installations running multiple daemons sharing a spool directory
16861 should need to modify the default.
16862
16863 The option is expanded before use.
16864 If the platform supports Linux-style abstract socket names, the result
16865 is used with a nul byte prefixed.
16866 Otherwise,
16867 it should be a full path name and use a directory accessible
16868 to Exim.
16869
16870 If this option is set as empty,
16871 or the command line &%-oY%& option is used, or
16872 the command line uses a &%-oX%& option and does not use &%-oP%&,
16873 then a notifier socket is not created.
16874
16875
16876 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16877 .cindex "OpenSSL "compatibility options"
16878 This option allows an administrator to adjust the SSL options applied
16879 by OpenSSL to connections.  It is given as a space-separated list of items,
16880 each one to be +added or -subtracted from the current value.
16881
16882 This option is only available if Exim is built against OpenSSL.  The values
16883 available for this option vary according to the age of your OpenSSL install.
16884 The &"all"& value controls a subset of flags which are available, typically
16885 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16886 list the values known on your system and Exim should support all the
16887 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16888 names lose the leading &"SSL_OP_"& and are lower-cased.
16889
16890 Note that adjusting the options can have severe impact upon the security of
16891 SSL as used by Exim.  It is possible to disable safety checks and shoot
16892 yourself in the foot in various unpleasant ways.  This option should not be
16893 adjusted lightly.  An unrecognised item will be detected at startup, by
16894 invoking Exim with the &%-bV%& flag.
16895
16896 The option affects Exim operating both as a server and as a client.
16897
16898 Historical note: prior to release 4.80, Exim defaulted this value to
16899 "+dont_insert_empty_fragments", which may still be needed for compatibility
16900 with some clients, but which lowers security by increasing exposure to
16901 some now infamous attacks.
16902
16903 Examples:
16904 .code
16905 # Make both old MS and old Eudora happy:
16906 openssl_options = -all +microsoft_big_sslv3_buffer \
16907                        +dont_insert_empty_fragments
16908
16909 # Disable older protocol versions:
16910 openssl_options = +no_sslv2 +no_sslv3
16911 .endd
16912
16913 Possible options may include:
16914 .ilist
16915 &`all`&
16916 .next
16917 &`allow_unsafe_legacy_renegotiation`&
16918 .next
16919 &`cipher_server_preference`&
16920 .next
16921 &`dont_insert_empty_fragments`&
16922 .next
16923 &`ephemeral_rsa`&
16924 .next
16925 &`legacy_server_connect`&
16926 .next
16927 &`microsoft_big_sslv3_buffer`&
16928 .next
16929 &`microsoft_sess_id_bug`&
16930 .next
16931 &`msie_sslv2_rsa_padding`&
16932 .next
16933 &`netscape_challenge_bug`&
16934 .next
16935 &`netscape_reuse_cipher_change_bug`&
16936 .next
16937 &`no_compression`&
16938 .next
16939 &`no_session_resumption_on_renegotiation`&
16940 .next
16941 &`no_sslv2`&
16942 .next
16943 &`no_sslv3`&
16944 .next
16945 &`no_ticket`&
16946 .next
16947 &`no_tlsv1`&
16948 .next
16949 &`no_tlsv1_1`&
16950 .next
16951 &`no_tlsv1_2`&
16952 .next
16953 &`safari_ecdhe_ecdsa_bug`&
16954 .next
16955 &`single_dh_use`&
16956 .next
16957 &`single_ecdh_use`&
16958 .next
16959 &`ssleay_080_client_dh_bug`&
16960 .next
16961 &`sslref2_reuse_cert_type_bug`&
16962 .next
16963 &`tls_block_padding_bug`&
16964 .next
16965 &`tls_d5_bug`&
16966 .next
16967 &`tls_rollback_bug`&
16968 .endlist
16969
16970 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16971 all clients connecting using the MacOS SecureTransport TLS facility prior
16972 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16973 to negotiate TLS then this option value might help, provided that your OpenSSL
16974 release is new enough to contain this work-around.  This may be a situation
16975 where you have to upgrade OpenSSL to get buggy clients working.
16976
16977
16978 .option oracle_servers main "string list" unset
16979 .cindex "Oracle" "server list"
16980 This option provides a list of Oracle servers and associated connection data,
16981 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16982 The option is available only if Exim has been built with Oracle support.
16983
16984
16985 .new
16986 .option panic_coredump main boolean false
16987 This option is rarely needed but can help for some debugging investigations.
16988 If set, when an internal error is detected by Exim which is sufficient
16989 to terminate the process
16990 (all such are logged in the paniclog)
16991 then a coredump is requested.
16992
16993 Note that most systems require additional administrative configuration
16994 to permit write a core file for a setuid program, which is Exim's
16995 common installed configuration.
16996 .wen
16997
16998 .option percent_hack_domains main "domain list&!!" unset
16999 .cindex "&""percent hack""&"
17000 .cindex "source routing" "in email address"
17001 .cindex "address" "source-routed"
17002 The &"percent hack"& is the convention whereby a local part containing a
17003 percent sign is re-interpreted as a new email address, with the percent
17004 replaced by @. This is sometimes called &"source routing"&, though that term is
17005 also applied to RFC 2822 addresses that begin with an @ character. If this
17006 option is set, Exim implements the percent facility for those domains listed,
17007 but no others. This happens before an incoming SMTP address is tested against
17008 an ACL.
17009
17010 &*Warning*&: The &"percent hack"& has often been abused by people who are
17011 trying to get round relaying restrictions. For this reason, it is best avoided
17012 if at all possible. Unfortunately, a number of less security-conscious MTAs
17013 implement it unconditionally. If you are running Exim on a gateway host, and
17014 routing mail through to internal MTAs without processing the local parts, it is
17015 a good idea to reject recipient addresses with percent characters in their
17016 local parts. Exim's default configuration does this.
17017
17018
17019 .option perl_at_start main boolean false
17020 .cindex "Perl"
17021 This option is available only when Exim is built with an embedded Perl
17022 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17023
17024
17025 .option perl_startup main string unset
17026 .cindex "Perl"
17027 This option is available only when Exim is built with an embedded Perl
17028 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17029
17030 .option perl_taintmode main boolean false
17031 .cindex "Perl"
17032 This option enables the taint mode of the embedded Perl interpreter.
17033
17034
17035 .option pgsql_servers main "string list" unset
17036 .cindex "PostgreSQL lookup type" "server list"
17037 This option provides a list of PostgreSQL servers and associated connection
17038 data, to be used in conjunction with &(pgsql)& lookups (see section
17039 &<<SECID72>>&). The option is available only if Exim has been built with
17040 PostgreSQL support.
17041
17042
17043 .option pid_file_path main string&!! "set at compile time"
17044 .cindex "daemon" "pid file path"
17045 .cindex "pid file, path for"
17046 This option sets the name of the file to which the Exim daemon writes its
17047 process id. The string is expanded, so it can contain, for example, references
17048 to the host name:
17049 .code
17050 pid_file_path = /var/log/$primary_hostname/exim.pid
17051 .endd
17052 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17053 spool directory.
17054 The value set by the option can be overridden by the &%-oP%& command line
17055 option. A pid file is not written if a &"non-standard"& daemon is run by means
17056 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17057
17058
17059 .option pipelining_advertise_hosts main "host list&!!" *
17060 .cindex "PIPELINING" "suppressing advertising"
17061 .cindex "ESMTP extensions" PIPELINING
17062 This option can be used to suppress the advertisement of the SMTP
17063 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17064 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17065 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17066 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17067 that clients will use it; &"out of order"& commands that are &"expected"& do
17068 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17069
17070 .option pipelining_connect_advertise_hosts main "host list&!!" *
17071 .cindex "pipelining" "early connection"
17072 .cindex "pipelining" PIPECONNECT
17073 .cindex "ESMTP extensions" PIPECONNECT
17074 If Exim is built without the DISABLE_PIPE_CONNECT build option
17075 this option controls which hosts the facility is advertised to
17076 and from which pipeline early-connection (before MAIL) SMTP
17077 commands are acceptable.
17078 When used, the pipelining saves on roundtrip times.
17079
17080 See also the &%hosts_pipe_connect%& smtp transport option.
17081
17082 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17083 it permits the client to pipeline
17084 TCP connection and hello command (inclear phase),
17085 or TLS-establishment and hello command (encrypted phase),
17086 on later connections to the same host.
17087
17088
17089 .option prdr_enable main boolean false
17090 .cindex "PRDR" "enabling on server"
17091 .cindex "ESMTP extensions" PRDR
17092 This option can be used to enable the Per-Recipient Data Response extension
17093 to SMTP, defined by Eric Hall.
17094 If the option is set, PRDR is advertised by Exim when operating as a server.
17095 If the client requests PRDR, and more than one recipient, for a message
17096 an additional ACL is called for each recipient after the message content
17097 is received.  See section &<<SECTPRDRACL>>&.
17098
17099 .option preserve_message_logs main boolean false
17100 .cindex "message logs" "preserving"
17101 If this option is set, message log files are not deleted when messages are
17102 completed. Instead, they are moved to a sub-directory of the spool directory
17103 called &_msglog.OLD_&, where they remain available for statistical or debugging
17104 purposes. This is a dangerous option to set on systems with any appreciable
17105 volume of mail. Use with care!
17106
17107
17108 .option primary_hostname main string "see below"
17109 .cindex "name" "of local host"
17110 .cindex "host" "name of local"
17111 .cindex "local host" "name of"
17112 .vindex "&$primary_hostname$&"
17113 This specifies the name of the current host. It is used in the default EHLO or
17114 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17115 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17116 The value is also used by default in some SMTP response messages from an Exim
17117 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17118
17119 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17120 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17121 contains only one component, Exim passes it to &[gethostbyname()]& (or
17122 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17123 version. The variable &$primary_hostname$& contains the host name, whether set
17124 explicitly by this option, or defaulted.
17125
17126
17127 .option print_topbitchars main boolean false
17128 .cindex "printing characters"
17129 .cindex "8-bit characters"
17130 By default, Exim considers only those characters whose codes lie in the range
17131 32&--126 to be printing characters. In a number of circumstances (for example,
17132 when writing log entries) non-printing characters are converted into escape
17133 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17134 is set, code values of 128 and above are also considered to be printing
17135 characters.
17136
17137 This option also affects the header syntax checks performed by the
17138 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17139 the user's full name when constructing From: and Sender: addresses (as
17140 described in section &<<SECTconstr>>&). Setting this option can cause
17141 Exim to generate eight bit message headers that do not conform to the
17142 standards.
17143
17144
17145 .option process_log_path main string unset
17146 .cindex "process log path"
17147 .cindex "log" "process log"
17148 .cindex "&'exiwhat'&"
17149 This option sets the name of the file to which an Exim process writes its
17150 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17151 utility script. If this option is unset, the file called &_exim-process.info_&
17152 in Exim's spool directory is used. The ability to specify the name explicitly
17153 can be useful in environments where two different Exims are running, using
17154 different spool directories.
17155
17156
17157 .option prod_requires_admin main boolean true
17158 .cindex "restricting access to features"
17159 .oindex "&%-M%&"
17160 .oindex "&%-R%&"
17161 .oindex "&%-q%&"
17162 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17163 admin user unless &%prod_requires_admin%& is set false. See also
17164 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17165
17166
17167 .option proxy_protocol_timeout main time 3s
17168 .cindex proxy "proxy protocol"
17169 This option sets the timeout for proxy protocol negotiation.
17170 For details see section &<<SECTproxyInbound>>&.
17171
17172
17173 .option qualify_domain main string "see below"
17174 .cindex "domain" "for qualifying addresses"
17175 .cindex "address" "qualification"
17176 This option specifies the domain name that is added to any envelope sender
17177 addresses that do not have a domain qualification. It also applies to
17178 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17179 are accepted by default only for locally-generated messages. Qualification is
17180 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17181 locally-generated messages, unless the &%-bnq%& command line option is used.
17182
17183 Messages from external sources must always contain fully qualified addresses,
17184 unless the sending host matches &%sender_unqualified_hosts%& or
17185 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17186 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17187 necessary. Internally, Exim always works with fully qualified envelope
17188 addresses. If &%qualify_domain%& is not set, it defaults to the
17189 &%primary_hostname%& value.
17190
17191
17192 .option qualify_recipient main string "see below"
17193 This option allows you to specify a different domain for qualifying recipient
17194 addresses to the one that is used for senders. See &%qualify_domain%& above.
17195
17196
17197
17198 .option queue_domains main "domain list&!!" unset
17199 .cindex "domain" "specifying non-immediate delivery"
17200 .cindex "queueing incoming messages"
17201 .cindex "message" "queueing certain domains"
17202 This option lists domains for which immediate delivery is not required.
17203 A delivery process is started whenever a message is received, but only those
17204 domains that do not match are processed. All other deliveries wait until the
17205 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17206
17207
17208 .option queue_fast_ramp main boolean true
17209 .cindex "queue runner" "two phase"
17210 .cindex "queue" "double scanning"
17211 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17212 command line, may start parallel delivery processes during their first
17213 phase.  This will be done when a threshold number of messages have been
17214 routed for a single host.
17215
17216
17217 .option queue_list_requires_admin main boolean true
17218 .cindex "restricting access to features"
17219 .oindex "&%-bp%&"
17220 The &%-bp%& command-line option, which lists the messages that are on the
17221 queue, requires the caller to be an admin user unless
17222 &%queue_list_requires_admin%& is set false.
17223 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17224
17225
17226 .option queue_only main boolean false
17227 .cindex "queueing incoming messages"
17228 .cindex "message" "queueing unconditionally"
17229 If &%queue_only%& is set, a delivery process is not automatically started
17230 whenever a message is received. Instead, the message waits in the queue for the
17231 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17232 delivered immediately when certain conditions (such as heavy load) occur.
17233
17234 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17235 and &%-odi%& command line options override &%queue_only%& unless
17236 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17237 &%queue_only_load%&, and &%smtp_accept_queue%&.
17238
17239
17240 .option queue_only_file main string unset
17241 .cindex "queueing incoming messages"
17242 .cindex "message" "queueing by file existence"
17243 This option can be set to a colon-separated list of absolute path names, each
17244 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17245 it tests for the existence of each listed path using a call to &[stat()]&. For
17246 each path that exists, the corresponding queueing option is set.
17247 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17248 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17249 .code
17250 queue_only_file = smtp/some/file
17251 .endd
17252 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17253 &_/some/file_& exists.
17254
17255
17256 .option queue_only_load main fixed-point unset
17257 .cindex "load average"
17258 .cindex "queueing incoming messages"
17259 .cindex "message" "queueing by load"
17260 If the system load average is higher than this value, incoming messages from
17261 all sources are queued, and no automatic deliveries are started. If this
17262 happens during local or remote SMTP input, all subsequent messages received on
17263 the same SMTP connection are queued by default, whatever happens to the load in
17264 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17265 false.
17266
17267 Deliveries will subsequently be performed by queue runner processes. This
17268 option has no effect on ancient operating systems on which Exim cannot
17269 determine the load average. See also &%deliver_queue_load_max%& and
17270 &%smtp_load_reserve%&.
17271
17272
17273 .option queue_only_load_latch main boolean true
17274 .cindex "load average" "re-evaluating per message"
17275 When this option is true (the default), once one message has been queued
17276 because the load average is higher than the value set by &%queue_only_load%&,
17277 all subsequent messages received on the same SMTP connection are also queued.
17278 This is a deliberate choice; even though the load average may fall below the
17279 threshold, it doesn't seem right to deliver later messages on the same
17280 connection when not delivering earlier ones. However, there are special
17281 circumstances such as very long-lived connections from scanning appliances
17282 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17283 should be set false. This causes the value of the load average to be
17284 re-evaluated for each message.
17285
17286
17287 .option queue_only_override main boolean true
17288 .cindex "queueing incoming messages"
17289 When this option is true, the &%-od%&&'x'& command line options override the
17290 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17291 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17292 to override; they are accepted, but ignored.
17293
17294
17295 .option queue_run_in_order main boolean false
17296 .cindex "queue runner" "processing messages in order"
17297 If this option is set, queue runs happen in order of message arrival instead of
17298 in an arbitrary order. For this to happen, a complete list of the entire queue
17299 must be set up before the deliveries start. When the queue is all held in a
17300 single directory (the default), a single list is created for both the ordered
17301 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17302 single list is not created when &%queue_run_in_order%& is false. In this case,
17303 the sub-directories are processed one at a time (in a random order), and this
17304 avoids setting up one huge list for the whole queue. Thus, setting
17305 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17306 when the queue is large, because of the extra work in setting up the single,
17307 large list. In most situations, &%queue_run_in_order%& should not be set.
17308
17309
17310
17311 .option queue_run_max main integer&!! 5
17312 .cindex "queue runner" "maximum number of"
17313 This controls the maximum number of queue runner processes that an Exim daemon
17314 can run simultaneously. This does not mean that it starts them all at once,
17315 but rather that if the maximum number are still running when the time comes to
17316 start another one, it refrains from starting another one. This can happen with
17317 very large queues and/or very sluggish deliveries. This option does not,
17318 however, interlock with other processes, so additional queue runners can be
17319 started by other means, or by killing and restarting the daemon.
17320
17321 Setting this option to zero does not suppress queue runs; rather, it disables
17322 the limit, allowing any number of simultaneous queue runner processes to be
17323 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17324 the daemon's command line.
17325
17326 .cindex queues named
17327 .cindex "named queues" "resource limit"
17328 To set limits for different named queues use
17329 an expansion depending on the &$queue_name$& variable.
17330
17331 .option queue_smtp_domains main "domain list&!!" unset
17332 .cindex "queueing incoming messages"
17333 .cindex "message" "queueing remote deliveries"
17334 .cindex "first pass routing"
17335 When this option is set, a delivery process is started whenever a message is
17336 received, routing is performed, and local deliveries take place.
17337 However, if any SMTP deliveries are required for domains that match
17338 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17339 message waits in the queue for the next queue run. Since routing of the message
17340 has taken place, Exim knows to which remote hosts it must be delivered, and so
17341 when the queue run happens, multiple messages for the same host are delivered
17342 over a single SMTP connection. The &%-odqs%& command line option causes all
17343 SMTP deliveries to be queued in this way, and is equivalent to setting
17344 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17345 &%queue_domains%&.
17346
17347
17348 .option receive_timeout main time 0s
17349 .cindex "timeout" "for non-SMTP input"
17350 This option sets the timeout for accepting a non-SMTP message, that is, the
17351 maximum time that Exim waits when reading a message on the standard input. If
17352 the value is zero, it will wait forever. This setting is overridden by the
17353 &%-or%& command line option. The timeout for incoming SMTP messages is
17354 controlled by &%smtp_receive_timeout%&.
17355
17356 .option received_header_text main string&!! "see below"
17357 .cindex "customizing" "&'Received:'& header"
17358 .cindex "&'Received:'& header line" "customizing"
17359 This string defines the contents of the &'Received:'& message header that is
17360 added to each message, except for the timestamp, which is automatically added
17361 on at the end (preceded by a semicolon). The string is expanded each time it is
17362 used. If the expansion yields an empty string, no &'Received:'& header line is
17363 added to the message. Otherwise, the string should start with the text
17364 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17365 header lines.
17366 The default setting is:
17367
17368 .code
17369 received_header_text = Received: \
17370   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17371     {${if def:sender_ident \
17372       {from ${quote_local_part:$sender_ident} }}\
17373         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17374   by $primary_hostname \
17375   ${if def:received_protocol {with $received_protocol }}\
17376   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17377   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17378   (Exim $version_number)\n\t\
17379   ${if def:sender_address \
17380   {(envelope-from <$sender_address>)\n\t}}\
17381   id $message_exim_id\
17382   ${if def:received_for {\n\tfor $received_for}}
17383 .endd
17384
17385 The references to the TLS version and cipher are
17386 omitted when Exim is built without TLS
17387 support. The use of conditional expansions ensures that this works for both
17388 locally generated messages and messages received from remote hosts, giving
17389 header lines such as the following:
17390 .code
17391 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17392 by marley.carol.example with esmtp (Exim 4.00)
17393 (envelope-from <bob@carol.example>)
17394 id 16IOWa-00019l-00
17395 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17396 Received: by scrooge.carol.example with local (Exim 4.00)
17397 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17398 .endd
17399 Until the body of the message has been received, the timestamp is the time when
17400 the message started to be received. Once the body has arrived, and all policy
17401 checks have taken place, the timestamp is updated to the time at which the
17402 message was accepted.
17403
17404
17405 .option received_headers_max main integer 30
17406 .cindex "loop" "prevention"
17407 .cindex "mail loop prevention"
17408 .cindex "&'Received:'& header line" "counting"
17409 When a message is to be delivered, the number of &'Received:'& headers is
17410 counted, and if it is greater than this parameter, a mail loop is assumed to
17411 have occurred, the delivery is abandoned, and an error message is generated.
17412 This applies to both local and remote deliveries.
17413
17414
17415 .option recipient_unqualified_hosts main "host list&!!" unset
17416 .cindex "unqualified addresses"
17417 .cindex "host" "unqualified addresses from"
17418 This option lists those hosts from which Exim is prepared to accept unqualified
17419 recipient addresses in message envelopes. The addresses are made fully
17420 qualified by the addition of the &%qualify_recipient%& value. This option also
17421 affects message header lines. Exim does not reject unqualified recipient
17422 addresses in headers, but it qualifies them only if the message came from a
17423 host that matches &%recipient_unqualified_hosts%&,
17424 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17425 option was not set.
17426
17427
17428 .option recipients_max main integer 50000
17429 .cindex "limit" "number of recipients"
17430 .cindex "recipient" "maximum number"
17431 If this option is set greater than zero, it specifies the maximum number of
17432 original recipients for any message. Additional recipients that are generated
17433 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17434 all recipients over the limit; earlier recipients are delivered as normal.
17435 Non-SMTP messages with too many recipients are failed, and no deliveries are
17436 done.
17437
17438 .cindex "RCPT" "maximum number of incoming"
17439 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17440 RCPT commands in a single message.
17441
17442
17443 .option recipients_max_reject main boolean false
17444 If this option is set true, Exim rejects SMTP messages containing too many
17445 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17446 error to the eventual DATA command. Otherwise (the default) it gives a 452
17447 error to the surplus RCPT commands and accepts the message on behalf of the
17448 initial set of recipients. The remote server should then re-send the message
17449 for the remaining recipients at a later time.
17450
17451
17452 .option remote_max_parallel main integer 4
17453 .cindex "delivery" "parallelism for remote"
17454 This option controls parallel delivery of one message to a number of remote
17455 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17456 does all the remote deliveries for a message one by one. Otherwise, if a single
17457 message has to be delivered to more than one remote host, or if several copies
17458 have to be sent to the same remote host, up to &%remote_max_parallel%&
17459 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17460 deliveries are required, the maximum number of processes are started, and as
17461 each one finishes, another is begun. The order of starting processes is the
17462 same as if sequential delivery were being done, and can be controlled by the
17463 &%remote_sort_domains%& option. If parallel delivery takes place while running
17464 with debugging turned on, the debugging output from each delivery process is
17465 tagged with its process id.
17466
17467 This option controls only the maximum number of parallel deliveries for one
17468 message in one Exim delivery process. Because Exim has no central queue
17469 manager, there is no way of controlling the total number of simultaneous
17470 deliveries if the configuration allows a delivery attempt as soon as a message
17471 is received.
17472
17473 See also the &%max_parallel%& generic transport option,
17474 and the &%serialize_hosts%& smtp transport option.
17475
17476 .cindex "number of deliveries"
17477 .cindex "delivery" "maximum number of"
17478 If you want to control the total number of deliveries on the system, you
17479 need to set the &%queue_only%& option. This ensures that all incoming messages
17480 are added to the queue without starting a delivery process. Then set up an Exim
17481 daemon to start queue runner processes at appropriate intervals (probably
17482 fairly often, for example, every minute), and limit the total number of queue
17483 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17484 delivers only one message at a time, the maximum number of deliveries that can
17485 then take place at once is &%queue_run_max%& multiplied by
17486 &%remote_max_parallel%&.
17487
17488 If it is purely remote deliveries you want to control, use
17489 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17490 doing the SMTP routing before queueing, so that several messages for the same
17491 host will eventually get delivered down the same connection.
17492
17493
17494 .option remote_sort_domains main "domain list&!!" unset
17495 .cindex "sorting remote deliveries"
17496 .cindex "delivery" "sorting remote"
17497 When there are a number of remote deliveries for a message, they are sorted by
17498 domain into the order given by this list. For example,
17499 .code
17500 remote_sort_domains = *.cam.ac.uk:*.uk
17501 .endd
17502 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17503 then to those in the &%uk%& domain, then to any others.
17504
17505
17506 .option retry_data_expire main time 7d
17507 .cindex "hints database" "data expiry"
17508 This option sets a &"use before"& time on retry information in Exim's hints
17509 database. Any older retry data is ignored. This means that, for example, once a
17510 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17511 past failures.
17512
17513
17514 .option retry_interval_max main time 24h
17515 .cindex "retry" "limit on interval"
17516 .cindex "limit" "on retry interval"
17517 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17518 intervals between delivery attempts for messages that cannot be delivered
17519 straight away. This option sets an overall limit to the length of time between
17520 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17521 the default value.
17522
17523
17524 .option return_path_remove main boolean true
17525 .cindex "&'Return-path:'& header line" "removing"
17526 RFC 2821, section 4.4, states that an SMTP server must insert a
17527 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17528 The &'Return-path:'& header preserves the sender address as received in the
17529 MAIL command. This description implies that this header should not be present
17530 in an incoming message. If &%return_path_remove%& is true, any existing
17531 &'Return-path:'& headers are removed from messages at the time they are
17532 received. Exim's transports have options for adding &'Return-path:'& headers at
17533 the time of delivery. They are normally used only for final local deliveries.
17534
17535
17536 .option return_size_limit main integer 100K
17537 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17538
17539
17540 .option rfc1413_hosts main "host list&!!" @[]
17541 .cindex "RFC 1413"
17542 .cindex "host" "for RFC 1413 calls"
17543 RFC 1413 identification calls are made to any client host which matches
17544 an item in the list.
17545 The default value specifies just this host, being any local interface
17546 for the system.
17547
17548 .option rfc1413_query_timeout main time 0s
17549 .cindex "RFC 1413" "query timeout"
17550 .cindex "timeout" "for RFC 1413 call"
17551 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17552 no RFC 1413 calls are ever made.
17553
17554
17555 .option sender_unqualified_hosts main "host list&!!" unset
17556 .cindex "unqualified addresses"
17557 .cindex "host" "unqualified addresses from"
17558 This option lists those hosts from which Exim is prepared to accept unqualified
17559 sender addresses. The addresses are made fully qualified by the addition of
17560 &%qualify_domain%&. This option also affects message header lines. Exim does
17561 not reject unqualified addresses in headers that contain sender addresses, but
17562 it qualifies them only if the message came from a host that matches
17563 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17564 using TCP/IP), and the &%-bnq%& option was not set.
17565
17566
17567 .option slow_lookup_log main integer 0
17568 .cindex "logging" "slow lookups"
17569 .cindex "dns" "logging slow lookups"
17570 This option controls logging of slow lookups.
17571 If the value is nonzero it is taken as a number of milliseconds
17572 and lookups taking longer than this are logged.
17573 Currently this applies only to DNS lookups.
17574
17575
17576
17577 .option smtp_accept_keepalive main boolean true
17578 .cindex "keepalive" "on incoming connection"
17579 This option controls the setting of the SO_KEEPALIVE option on incoming
17580 TCP/IP socket connections. When set, it causes the kernel to probe idle
17581 connections periodically, by sending packets with &"old"& sequence numbers. The
17582 other end of the connection should send an acknowledgment if the connection is
17583 still okay or a reset if the connection has been aborted. The reason for doing
17584 this is that it has the beneficial effect of freeing up certain types of
17585 connection that can get stuck when the remote host is disconnected without
17586 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17587 hours to detect unreachable hosts.
17588
17589
17590
17591 .option smtp_accept_max main integer 20
17592 .cindex "limit" "incoming SMTP connections"
17593 .cindex "SMTP" "incoming connection count"
17594 .cindex "inetd"
17595 This option specifies the maximum number of simultaneous incoming SMTP calls
17596 that Exim will accept. It applies only to the listening daemon; there is no
17597 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17598 value is set to zero, no limit is applied. However, it is required to be
17599 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17600 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17601
17602 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17603 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17604 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17605 and &%smtp_load_reserve%& are then checked before accepting the connection.
17606
17607
17608 .option smtp_accept_max_nonmail main integer 10
17609 .cindex "limit" "non-mail SMTP commands"
17610 .cindex "SMTP" "limiting non-mail commands"
17611 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17612 the connection if there are too many. This option defines &"too many"&. The
17613 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17614 client looping sending EHLO, for example. The check is applied only if the
17615 client host matches &%smtp_accept_max_nonmail_hosts%&.
17616
17617 When a new message is expected, one occurrence of RSET is not counted. This
17618 allows a client to send one RSET between messages (this is not necessary,
17619 but some clients do it). Exim also allows one uncounted occurrence of HELO
17620 or EHLO, and one occurrence of STARTTLS between messages. After
17621 starting up a TLS session, another EHLO is expected, and so it too is not
17622 counted. The first occurrence of AUTH in a connection, or immediately
17623 following STARTTLS is not counted. Otherwise, all commands other than
17624 MAIL, RCPT, DATA, and QUIT are counted.
17625
17626
17627 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17628 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17629 check by setting this option. The default value makes it apply to all hosts. By
17630 changing the value, you can exclude any badly-behaved hosts that you have to
17631 live with.
17632
17633
17634 . Allow this long option name to split; give it unsplit as a fifth argument
17635 . for the automatic .oindex that is generated by .option.
17636 . We insert " &~&~" which is both pretty nasty visually and results in
17637 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17638 . zero-width-space, which would be nicer visually and results in (at least)
17639 . html that Firefox will split on when it's forced to reflow (rather than
17640 . inserting a horizontal scrollbar).  However, the text is still not
17641 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17642 . the option name to split.
17643
17644 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17645          smtp_accept_max_per_connection
17646 .cindex "SMTP" "limiting incoming message count"
17647 .cindex "limit" "messages per SMTP connection"
17648 The value of this option limits the number of MAIL commands that Exim is
17649 prepared to accept over a single SMTP connection, whether or not each command
17650 results in the transfer of a message. After the limit is reached, a 421
17651 response is given to subsequent MAIL commands. This limit is a safety
17652 precaution against a client that goes mad (incidents of this type have been
17653 seen).
17654 The option is expanded after the HELO or EHLO is received
17655 and may depend on values available at that time.
17656 An empty or zero value after expansion removes the limit.
17657
17658
17659 .option smtp_accept_max_per_host main string&!! unset
17660 .cindex "limit" "SMTP connections from one host"
17661 .cindex "host" "limiting SMTP connections from"
17662 This option restricts the number of simultaneous IP connections from a single
17663 host (strictly, from a single IP address) to the Exim daemon. The option is
17664 expanded, to enable different limits to be applied to different hosts by
17665 reference to &$sender_host_address$&. Once the limit is reached, additional
17666 connection attempts from the same host are rejected with error code 421. This
17667 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17668 of zero imposes no limit. If this option is set greater than zero, it is
17669 required that &%smtp_accept_max%& be non-zero.
17670
17671 &*Warning*&: When setting this option you should not use any expansion
17672 constructions that take an appreciable amount of time. The expansion and test
17673 happen in the main daemon loop, in order to reject additional connections
17674 without forking additional processes (otherwise a denial-of-service attack
17675 could cause a vast number or processes to be created). While the daemon is
17676 doing this processing, it cannot accept any other incoming connections.
17677
17678
17679
17680 .option smtp_accept_queue main integer 0
17681 .cindex "SMTP" "incoming connection count"
17682 .cindex "queueing incoming messages"
17683 .cindex "message" "queueing by SMTP connection count"
17684 If the number of simultaneous incoming SMTP connections being handled via the
17685 listening daemon exceeds this value, messages received by SMTP are just placed
17686 in the queue; no delivery processes are started automatically. The count is
17687 fixed at the start of an SMTP connection. It cannot be updated in the
17688 subprocess that receives messages, and so the queueing or not queueing applies
17689 to all messages received in the same connection.
17690
17691 A value of zero implies no limit, and clearly any non-zero value is useful only
17692 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17693 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17694 various &%-od%&&'x'& command line options.
17695
17696
17697 . See the comment on smtp_accept_max_per_connection
17698
17699 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17700          smtp_accept_queue_per_connection
17701 .cindex "queueing incoming messages"
17702 .cindex "message" "queueing by message count"
17703 This option limits the number of delivery processes that Exim starts
17704 automatically when receiving messages via SMTP, whether via the daemon or by
17705 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17706 and the number of messages received in a single SMTP session exceeds this
17707 number, subsequent messages are placed in the queue, but no delivery processes
17708 are started. This helps to limit the number of Exim processes when a server
17709 restarts after downtime and there is a lot of mail waiting for it on other
17710 systems. On large systems, the default should probably be increased, and on
17711 dial-in client systems it should probably be set to zero (that is, disabled).
17712
17713
17714 .option smtp_accept_reserve main integer 0
17715 .cindex "SMTP" "incoming call count"
17716 .cindex "host" "reserved"
17717 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17718 number of SMTP connections that are reserved for connections from the hosts
17719 that are specified in &%smtp_reserve_hosts%&. The value set in
17720 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17721 restricted to this number of connections; the option specifies a minimum number
17722 of connection slots for them, not a maximum. It is a guarantee that this group
17723 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17724 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17725 individual host.
17726
17727 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17728 set to 5, once there are 45 active connections (from any hosts), new
17729 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17730 provided the other criteria for acceptance are met.
17731
17732
17733 .option smtp_active_hostname main string&!! unset
17734 .cindex "host" "name in SMTP responses"
17735 .cindex "SMTP" "host name in responses"
17736 .vindex "&$primary_hostname$&"
17737 This option is provided for multi-homed servers that want to masquerade as
17738 several different hosts. At the start of an incoming SMTP connection, its value
17739 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17740 responses. For example, it is used as domain name in the response to an
17741 incoming HELO or EHLO command.
17742
17743 .vindex "&$smtp_active_hostname$&"
17744 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17745 is saved with any messages that are received. It is therefore available for use
17746 in routers and transports when the message is later delivered.
17747
17748 If this option is unset, or if its expansion is forced to fail, or if the
17749 expansion results in an empty string, the value of &$primary_hostname$& is
17750 used. Other expansion failures cause a message to be written to the main and
17751 panic logs, and the SMTP command receives a temporary error. Typically, the
17752 value of &%smtp_active_hostname%& depends on the incoming interface address.
17753 For example:
17754 .code
17755 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17756   {cox.mydomain}{box.mydomain}}
17757 .endd
17758
17759 Although &$smtp_active_hostname$& is primarily concerned with incoming
17760 messages, it is also used as the default for HELO commands in callout
17761 verification if there is no remote transport from which to obtain a
17762 &%helo_data%& value.
17763
17764 .option smtp_backlog_monitor main integer 0
17765 .cindex "connection backlog" monitoring
17766 If this option is set to greater than zero, and the backlog of available
17767 TCP connections on a socket listening for SMTP is larger than it, a line
17768 is logged giving the value and the socket address and port.
17769 The value is retrived jsut before an accept call.
17770 This facility is only available on Linux.
17771
17772 .option smtp_banner main string&!! "see below"
17773 .cindex "SMTP" "welcome banner"
17774 .cindex "banner for SMTP"
17775 .cindex "welcome banner for SMTP"
17776 .cindex "customizing" "SMTP banner"
17777 If a connect ACL does not supply a message,
17778 this string (which is expanded every time it is used) is output as the initial
17779 positive response to an SMTP connection. The default setting is:
17780 .code
17781 smtp_banner = $smtp_active_hostname ESMTP Exim \
17782   $version_number $tod_full
17783 .endd
17784 .new
17785 Failure to expand the string causes a panic error;
17786 a forced fail just closes the connection.
17787 .wen
17788 If you want to create a
17789 multiline response to the initial SMTP connection, use &"\n"& in the string at
17790 appropriate points, but not at the end. Note that the 220 code is not included
17791 in this string. Exim adds it automatically (several times in the case of a
17792 multiline response).
17793
17794
17795 .option smtp_check_spool_space main boolean true
17796 .cindex "checking disk space"
17797 .cindex "disk space, checking"
17798 .cindex "spool directory" "checking space"
17799 When this option is set, if an incoming SMTP session encounters the SIZE
17800 option on a MAIL command, it checks that there is enough space in the
17801 spool directory's partition to accept a message of that size, while still
17802 leaving free the amount specified by &%check_spool_space%& (even if that value
17803 is zero). If there isn't enough space, a temporary error code is returned.
17804
17805
17806 .option smtp_connect_backlog main integer 20
17807 .cindex "connection backlog" "set maximum"
17808 .cindex "SMTP" "connection backlog"
17809 .cindex "backlog of connections"
17810 This option specifies a maximum number of waiting SMTP connections. Exim passes
17811 this value to the TCP/IP system when it sets up its listener. Once this number
17812 of connections are waiting for the daemon's attention, subsequent connection
17813 attempts are refused at the TCP/IP level. At least, that is what the manuals
17814 say; in some circumstances such connection attempts have been observed to time
17815 out instead. For large systems it is probably a good idea to increase the
17816 value (to 50, say). It also gives some protection against denial-of-service
17817 attacks by SYN flooding.
17818
17819
17820 .option smtp_enforce_sync main boolean true
17821 .cindex "SMTP" "synchronization checking"
17822 .cindex "synchronization checking in SMTP"
17823 The SMTP protocol specification requires the client to wait for a response from
17824 the server at certain points in the dialogue. Without PIPELINING these
17825 synchronization points are after every command; with PIPELINING they are
17826 fewer, but they still exist.
17827
17828 Some spamming sites send out a complete set of SMTP commands without waiting
17829 for any response. Exim protects against this by rejecting a message if the
17830 client has sent further input when it should not have. The error response &"554
17831 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17832 for this error cannot be perfect because of transmission delays (unexpected
17833 input may be on its way but not yet received when Exim checks). However, it
17834 does detect many instances.
17835
17836 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17837 If you want to disable the check selectively (for example, only for certain
17838 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17839 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17840
17841
17842
17843 .option smtp_etrn_command main string&!! unset
17844 .cindex "ETRN" "command to be run"
17845 .cindex "ESMTP extensions" ETRN
17846 .vindex "&$domain$&"
17847 If this option is set, the given command is run whenever an SMTP ETRN
17848 command is received from a host that is permitted to issue such commands (see
17849 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17850 are independently expanded. The expansion variable &$domain$& is set to the
17851 argument of the ETRN command, and no syntax checking is done on it. For
17852 example:
17853 .code
17854 smtp_etrn_command = /etc/etrn_command $domain \
17855                     $sender_host_address
17856 .endd
17857 If the option is not set, the argument for the ETRN command must
17858 be a &'#'& followed by an address string.
17859 In this case an &'exim -R <string>'& command is used;
17860 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17861
17862 A new process is created to run the command, but Exim does not wait for it to
17863 complete. Consequently, its status cannot be checked. If the command cannot be
17864 run, a line is written to the panic log, but the ETRN caller still receives
17865 a 250 success response. Exim is normally running under its own uid when
17866 receiving SMTP, so it is not possible for it to change the uid before running
17867 the command.
17868
17869
17870 .option smtp_etrn_serialize main boolean true
17871 .cindex "ETRN" "serializing"
17872 When this option is set, it prevents the simultaneous execution of more than
17873 one identical command as a result of ETRN in an SMTP connection. See
17874 section &<<SECTETRN>>& for details.
17875
17876
17877 .option smtp_load_reserve main fixed-point unset
17878 .cindex "load average"
17879 If the system load average ever gets higher than this, incoming SMTP calls are
17880 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17881 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17882 the load is over the limit. The option has no effect on ancient operating
17883 systems on which Exim cannot determine the load average. See also
17884 &%deliver_queue_load_max%& and &%queue_only_load%&.
17885
17886
17887
17888 .option smtp_max_synprot_errors main integer 3
17889 .cindex "SMTP" "limiting syntax and protocol errors"
17890 .cindex "limit" "SMTP syntax and protocol errors"
17891 Exim rejects SMTP commands that contain syntax or protocol errors. In
17892 particular, a syntactically invalid email address, as in this command:
17893 .code
17894 RCPT TO:<abc xyz@a.b.c>
17895 .endd
17896 causes immediate rejection of the command, before any other tests are done.
17897 (The ACL cannot be run if there is no valid address to set up for it.) An
17898 example of a protocol error is receiving RCPT before MAIL. If there are
17899 too many syntax or protocol errors in one SMTP session, the connection is
17900 dropped. The limit is set by this option.
17901
17902 .cindex "PIPELINING" "expected errors"
17903 When the PIPELINING extension to SMTP is in use, some protocol errors are
17904 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17905 Exim assumes that PIPELINING will be used if it advertises it (see
17906 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17907 not count towards the limit.
17908
17909
17910
17911 .option smtp_max_unknown_commands main integer 3
17912 .cindex "SMTP" "limiting unknown commands"
17913 .cindex "limit" "unknown SMTP commands"
17914 If there are too many unrecognized commands in an incoming SMTP session, an
17915 Exim server drops the connection. This is a defence against some kinds of abuse
17916 that subvert web
17917 clients
17918 into making connections to SMTP ports; in these circumstances, a number of
17919 non-SMTP command lines are sent first.
17920
17921
17922
17923 .option smtp_ratelimit_hosts main "host list&!!" unset
17924 .cindex "SMTP" "rate limiting"
17925 .cindex "limit" "rate of message arrival"
17926 .cindex "RCPT" "rate limiting"
17927 Some sites find it helpful to be able to limit the rate at which certain hosts
17928 can send them messages, and the rate at which an individual message can specify
17929 recipients.
17930
17931 Exim has two rate-limiting facilities. This section describes the older
17932 facility, which can limit rates within a single connection. The newer
17933 &%ratelimit%& ACL condition can limit rates across all connections. See section
17934 &<<SECTratelimiting>>& for details of the newer facility.
17935
17936 When a host matches &%smtp_ratelimit_hosts%&, the values of
17937 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17938 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17939 respectively. Each option, if set, must contain a set of four comma-separated
17940 values:
17941
17942 .ilist
17943 A threshold, before which there is no rate limiting.
17944 .next
17945 An initial time delay. Unlike other times in Exim, numbers with decimal
17946 fractional parts are allowed here.
17947 .next
17948 A factor by which to increase the delay each time.
17949 .next
17950 A maximum value for the delay. This should normally be less than 5 minutes,
17951 because after that time, the client is liable to timeout the SMTP command.
17952 .endlist
17953
17954 For example, these settings have been used successfully at the site which
17955 first suggested this feature, for controlling mail from their customers:
17956 .code
17957 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17958 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17959 .endd
17960 The first setting specifies delays that are applied to MAIL commands after
17961 two have been received over a single connection. The initial delay is 0.5
17962 seconds, increasing by a factor of 1.05 each time. The second setting applies
17963 delays to RCPT commands when more than four occur in a single message.
17964
17965
17966 .option smtp_ratelimit_mail main string unset
17967 See &%smtp_ratelimit_hosts%& above.
17968
17969
17970 .option smtp_ratelimit_rcpt main string unset
17971 See &%smtp_ratelimit_hosts%& above.
17972
17973
17974 .option smtp_receive_timeout main time&!! 5m
17975 .cindex "timeout" "for SMTP input"
17976 .cindex "SMTP" "input timeout"
17977 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17978 input, including batch SMTP. If a line of input (either an SMTP command or a
17979 data line) is not received within this time, the SMTP connection is dropped and
17980 the message is abandoned.
17981 A line is written to the log containing one of the following messages:
17982 .code
17983 SMTP command timeout on connection from...
17984 SMTP data timeout on connection from...
17985 .endd
17986 The former means that Exim was expecting to read an SMTP command; the latter
17987 means that it was in the DATA phase, reading the contents of a message.
17988
17989 If the first character of the option is a &"$"& the option is
17990 expanded before use and may depend on
17991 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17992
17993
17994 .oindex "&%-os%&"
17995 The value set by this option can be overridden by the
17996 &%-os%& command-line option. A setting of zero time disables the timeout, but
17997 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17998 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17999 timeout is controlled by &%receive_timeout%& and &%-or%&.
18000
18001
18002 .option smtp_reserve_hosts main "host list&!!" unset
18003 This option defines hosts for which SMTP connections are reserved; see
18004 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18005
18006
18007 .option smtp_return_error_details main boolean false
18008 .cindex "SMTP" "details policy failures"
18009 .cindex "policy control" "rejection, returning details"
18010 In the default state, Exim uses bland messages such as
18011 &"Administrative prohibition"& when it rejects SMTP commands for policy
18012 reasons. Many sysadmins like this because it gives away little information
18013 to spammers. However, some other sysadmins who are applying strict checking
18014 policies want to give out much fuller information about failures. Setting
18015 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18016 example, instead of &"Administrative prohibition"&, it might give:
18017 .code
18018 550-Rejected after DATA: '>' missing at end of address:
18019 550 failing address in "From" header is: <user@dom.ain
18020 .endd
18021
18022
18023 .option smtputf8_advertise_hosts main "host list&!!" *
18024 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18025 .cindex "ESMTP extensions" SMTPUTF8
18026 When Exim is built with support for internationalised mail names,
18027 the availability thereof is advertised in
18028 response to EHLO only to those client hosts that match this option. See
18029 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18030
18031
18032 .option spamd_address main string "127.0.0.1 783"
18033 This option is available when Exim is compiled with the content-scanning
18034 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18035 See section &<<SECTscanspamass>>& for more details.
18036
18037
18038
18039 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18040 This option is available when Exim is compiled with SPF support.
18041 See section &<<SECSPF>>& for more details.
18042
18043 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18044 This option is available when Exim is compiled with SPF support.  It
18045 allows the customisation of the SMTP comment that the SPF library
18046 generates.  You are strongly encouraged to link to your own explanative
18047 site. The template must not contain spaces. If you need spaces in the
18048 output, use the proper placeholder. If libspf2 can not parse the
18049 template, it uses a built-in default broken link. The following placeholders
18050 (along with Exim variables (but see below)) are allowed in the template:
18051 .ilist
18052 &*%_*&: A space.
18053 .next
18054 &*%{L}*&: Envelope sender's local part.
18055 .next
18056 &*%{S}*&: Envelope sender.
18057 .next
18058 &*%{O}*&: Envelope sender's domain.
18059 .next
18060 &*%{D}*&: Current(?) domain.
18061 .next
18062 &*%{I}*&: SMTP client Ip.
18063 .next
18064 &*%{C}*&: SMTP client pretty IP.
18065 .next
18066 &*%{T}*&: Epoch time (UTC).
18067 .next
18068 &*%{P}*&: SMTP client domain name.
18069 .next
18070 &*%{V}*&: IP version.
18071 .next
18072 &*%{H}*&: EHLO/HELO domain.
18073 .next
18074 &*%{R}*&: Receiving domain.
18075 .endlist
18076 The capitalized placeholders do proper URL encoding, if you use them
18077 lowercased, no encoding takes place.  This list was compiled from the
18078 libspf2 sources.
18079
18080 A note on using Exim variables: As
18081 currently the SPF library is initialized before the SMTP EHLO phase,
18082 the variables useful for expansion are quite limited.
18083
18084
18085 .option split_spool_directory main boolean false
18086 .cindex "multiple spool directories"
18087 .cindex "spool directory" "split"
18088 .cindex "directories, multiple"
18089 If this option is set, it causes Exim to split its input directory into 62
18090 subdirectories, each with a single alphanumeric character as its name. The
18091 sixth character of the message id is used to allocate messages to
18092 subdirectories; this is the least significant base-62 digit of the time of
18093 arrival of the message.
18094
18095 Splitting up the spool in this way may provide better performance on systems
18096 where there are long mail queues, by reducing the number of files in any one
18097 directory. The msglog directory is also split up in a similar way to the input
18098 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18099 are still placed in the single directory &_msglog.OLD_&.
18100
18101 It is not necessary to take any special action for existing messages when
18102 changing &%split_spool_directory%&. Exim notices messages that are in the
18103 &"wrong"& place, and continues to process them. If the option is turned off
18104 after a period of being on, the subdirectories will eventually empty and be
18105 automatically deleted.
18106
18107 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18108 changes. Instead of creating a list of all messages in the queue, and then
18109 trying to deliver each one, in turn, it constructs a list of those in one
18110 sub-directory and tries to deliver them, before moving on to the next
18111 sub-directory. The sub-directories are processed in a random order. This
18112 spreads out the scanning of the input directories, and uses less memory. It is
18113 particularly beneficial when there are lots of messages in the queue. However,
18114 if &%queue_run_in_order%& is set, none of this new processing happens. The
18115 entire queue has to be scanned and sorted before any deliveries can start.
18116
18117
18118 .option spool_directory main string&!! "set at compile time"
18119 .cindex "spool directory" "path to"
18120 This defines the directory in which Exim keeps its spool, that is, the messages
18121 it is waiting to deliver. The default value is taken from the compile-time
18122 configuration setting, if there is one. If not, this option must be set. The
18123 string is expanded, so it can contain, for example, a reference to
18124 &$primary_hostname$&.
18125
18126 If the spool directory name is fixed on your installation, it is recommended
18127 that you set it at build time rather than from this option, particularly if the
18128 log files are being written to the spool directory (see &%log_file_path%&).
18129 Otherwise log files cannot be used for errors that are detected early on, such
18130 as failures in the configuration file.
18131
18132 By using this option to override the compiled-in path, it is possible to run
18133 tests of Exim without using the standard spool.
18134
18135 .option spool_wireformat main boolean false
18136 .cindex "spool directory" "file formats"
18137 If this option is set, Exim may for some messages use an alternative format
18138 for data-files in the spool which matches the wire format.
18139 Doing this permits more efficient message reception and transmission.
18140 Currently it is only done for messages received using the ESMTP CHUNKING
18141 option.
18142
18143 The following variables will not have useful values:
18144 .code
18145 $max_received_linelength
18146 $body_linecount
18147 $body_zerocount
18148 .endd
18149
18150 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18151 and any external programs which are passed a reference to a message data file
18152 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18153 will need to be aware of the different formats potentially available.
18154
18155 Using any of the ACL conditions noted will negate the reception benefit
18156 (as a Unix-mbox-format file is constructed for them).
18157 The transmission benefit is maintained.
18158
18159 .option sqlite_lock_timeout main time 5s
18160 .cindex "sqlite lookup type" "lock timeout"
18161 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18162 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18163
18164 .option strict_acl_vars main boolean false
18165 .cindex "&ACL;" "variables, handling unset"
18166 This option controls what happens if a syntactically valid but undefined ACL
18167 variable is referenced. If it is false (the default), an empty string
18168 is substituted; if it is true, an error is generated. See section
18169 &<<SECTaclvariables>>& for details of ACL variables.
18170
18171 .option strip_excess_angle_brackets main boolean false
18172 .cindex "angle brackets, excess"
18173 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18174 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18175 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18176 passed on to another MTA, the excess angle brackets are not passed on. If this
18177 option is not set, multiple pairs of angle brackets cause a syntax error.
18178
18179
18180 .option strip_trailing_dot main boolean false
18181 .cindex "trailing dot on domain"
18182 .cindex "dot" "trailing on domain"
18183 If this option is set, a trailing dot at the end of a domain in an address is
18184 ignored. If this is in the envelope and the message is passed on to another
18185 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18186 domain causes a syntax error.
18187 However, addresses in header lines are checked only when an ACL requests header
18188 syntax checking.
18189
18190
18191 .option syslog_duplication main boolean true
18192 .cindex "syslog" "duplicate log lines; suppressing"
18193 When Exim is logging to syslog, it writes the log lines for its three
18194 separate logs at different syslog priorities so that they can in principle
18195 be separated on the logging hosts. Some installations do not require this
18196 separation, and in those cases, the duplication of certain log lines is a
18197 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18198 particular log line is written to syslog. For lines that normally go to
18199 both the main log and the reject log, the reject log version (possibly
18200 containing message header lines) is written, at LOG_NOTICE priority.
18201 Lines that normally go to both the main and the panic log are written at
18202 the LOG_ALERT priority.
18203
18204
18205 .option syslog_facility main string unset
18206 .cindex "syslog" "facility; setting"
18207 This option sets the syslog &"facility"& name, used when Exim is logging to
18208 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18209 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18210 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18211 details of Exim's logging.
18212
18213
18214 .option syslog_pid main boolean true
18215 .cindex "syslog" "pid"
18216 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18217 omitted when these lines are sent to syslog. (Syslog normally prefixes
18218 the log lines with the PID of the logging process automatically.) You need
18219 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18220 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18221
18222
18223
18224 .option syslog_processname main string &`exim`&
18225 .cindex "syslog" "process name; setting"
18226 This option sets the syslog &"ident"& name, used when Exim is logging to
18227 syslog. The value must be no longer than 32 characters. See chapter
18228 &<<CHAPlog>>& for details of Exim's logging.
18229
18230
18231
18232 .option syslog_timestamp main boolean true
18233 .cindex "syslog" "timestamps"
18234 .cindex timestamps syslog
18235 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18236 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18237 details of Exim's logging.
18238
18239
18240 .option system_filter main string&!! unset
18241 .cindex "filter" "system filter"
18242 .cindex "system filter" "specifying"
18243 .cindex "Sieve filter" "not available for system filter"
18244 This option specifies an Exim filter file that is applied to all messages at
18245 the start of each delivery attempt, before any routing is done. System filters
18246 must be Exim filters; they cannot be Sieve filters. If the system filter
18247 generates any deliveries to files or pipes, or any new mail messages, the
18248 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18249 which transports are to be used. Details of this facility are given in chapter
18250 &<<CHAPsystemfilter>>&.
18251 A forced expansion failure results in no filter operation.
18252
18253
18254 .option system_filter_directory_transport main string&!! unset
18255 .vindex "&$address_file$&"
18256 This sets the name of the transport driver that is to be used when the
18257 &%save%& command in a system message filter specifies a path ending in &"/"&,
18258 implying delivery of each message into a separate file in some directory.
18259 During the delivery, the variable &$address_file$& contains the path name.
18260
18261
18262 .option system_filter_file_transport main string&!! unset
18263 .cindex "file" "transport for system filter"
18264 This sets the name of the transport driver that is to be used when the &%save%&
18265 command in a system message filter specifies a path not ending in &"/"&. During
18266 the delivery, the variable &$address_file$& contains the path name.
18267
18268 .option system_filter_group main string unset
18269 .cindex "gid (group id)" "system filter"
18270 This option is used only when &%system_filter_user%& is also set. It sets the
18271 gid under which the system filter is run, overriding any gid that is associated
18272 with the user. The value may be numerical or symbolic.
18273
18274 .option system_filter_pipe_transport main string&!! unset
18275 .cindex "&(pipe)& transport" "for system filter"
18276 .vindex "&$address_pipe$&"
18277 This specifies the transport driver that is to be used when a &%pipe%& command
18278 is used in a system filter. During the delivery, the variable &$address_pipe$&
18279 contains the pipe command.
18280
18281
18282 .option system_filter_reply_transport main string&!! unset
18283 .cindex "&(autoreply)& transport" "for system filter"
18284 This specifies the transport driver that is to be used when a &%mail%& command
18285 is used in a system filter.
18286
18287
18288 .option system_filter_user main string unset
18289 .cindex "uid (user id)" "system filter"
18290 If this option is set to root, the system filter is run in the main Exim
18291 delivery process, as root.  Otherwise, the system filter runs in a separate
18292 process, as the given user, defaulting to the Exim run-time user.
18293 Unless the string consists entirely of digits, it
18294 is looked up in the password data. Failure to find the named user causes a
18295 configuration error. The gid is either taken from the password data, or
18296 specified by &%system_filter_group%&. When the uid is specified numerically,
18297 &%system_filter_group%& is required to be set.
18298
18299 If the system filter generates any pipe, file, or reply deliveries, the uid
18300 under which the filter is run is used when transporting them, unless a
18301 transport option overrides.
18302
18303
18304 .option tcp_nodelay main boolean true
18305 .cindex "daemon" "TCP_NODELAY on sockets"
18306 .cindex "Nagle algorithm"
18307 .cindex "TCP_NODELAY on listening sockets"
18308 If this option is set false, it stops the Exim daemon setting the
18309 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18310 turns off the &"Nagle algorithm"&, which is a way of improving network
18311 performance in interactive (character-by-character) situations. Turning it off
18312 should improve Exim's performance a bit, so that is what happens by default.
18313 However, it appears that some broken clients cannot cope, and time out. Hence
18314 this option. It affects only those sockets that are set up for listening by the
18315 daemon. Sockets created by the smtp transport for delivering mail always set
18316 TCP_NODELAY.
18317
18318
18319 .option timeout_frozen_after main time 0s
18320 .cindex "frozen messages" "timing out"
18321 .cindex "timeout" "frozen messages"
18322 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18323 message of any kind that has been in the queue for longer than the given time
18324 is automatically cancelled at the next queue run. If the frozen message is a
18325 bounce message, it is just discarded; otherwise, a bounce is sent to the
18326 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18327 If you want to timeout frozen bounce messages earlier than other kinds of
18328 frozen message, see &%ignore_bounce_errors_after%&.
18329
18330 &*Note:*& the default value of zero means no timeouts; with this setting,
18331 frozen messages remain in the queue forever (except for any frozen bounce
18332 messages that are released by &%ignore_bounce_errors_after%&).
18333
18334
18335 .option timezone main string unset
18336 .cindex "timezone, setting"
18337 .cindex "environment" "values from"
18338 The value of &%timezone%& is used to set the environment variable TZ while
18339 running Exim (if it is different on entry). This ensures that all timestamps
18340 created by Exim are in the required timezone. If you want all your timestamps
18341 to be in UTC (aka GMT) you should set
18342 .code
18343 timezone = UTC
18344 .endd
18345 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18346 or, if that is not set, from the value of the TZ environment variable when Exim
18347 is built. If &%timezone%& is set to the empty string, either at build or run
18348 time, any existing TZ variable is removed from the environment when Exim
18349 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18350 unfortunately not all, operating systems.
18351
18352
18353 .option tls_advertise_hosts main "host list&!!" *
18354 .cindex "TLS" "advertising"
18355 .cindex "encryption" "on SMTP connection"
18356 .cindex "SMTP" "encrypted connection"
18357 .cindex "ESMTP extensions" STARTTLS
18358 When Exim is built with support for TLS encrypted connections, the availability
18359 of the STARTTLS command to set up an encrypted session is advertised in
18360 response to EHLO only to those client hosts that match this option. See
18361 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18362 Note that the default value requires that a certificate be supplied
18363 using the &%tls_certificate%& option.  If TLS support for incoming connections
18364 is not required the &%tls_advertise_hosts%& option should be set empty.
18365
18366
18367 .option tls_alpn main "string list&!!" "smtp : esmtp"
18368 .cindex TLS "Application Layer Protocol Names"
18369 .cindex TLS ALPN
18370 .cindex ALPN "set acceptable names for server"
18371 If this option is set,
18372 the TLS library supports ALPN,
18373 and the client offers either more than
18374 ALPN name or a name which does not match the list,
18375 the TLS connection is declined.
18376
18377
18378 .option tls_certificate main "string list&!!" unset
18379 .cindex "TLS" "server certificate; location of"
18380 .cindex "certificate" "server, location of"
18381 The value of this option is expanded, and must then be a list of absolute paths to
18382 files which contain the server's certificates (in PEM format).
18383 Commonly only one file is needed.
18384 The server's private key is also
18385 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18386 &<<CHAPTLS>>& for further details.
18387
18388 &*Note*&: The certificates defined by this option are used only when Exim is
18389 receiving incoming messages as a server. If you want to supply certificates for
18390 use when sending messages as a client, you must set the &%tls_certificate%&
18391 option in the relevant &(smtp)& transport.
18392
18393 &*Note*&: If you use filenames based on IP addresses, change the list
18394 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18395
18396 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18397 when a list of more than one
18398 file is used, the &$tls_in_ourcert$& variable is unreliable.
18399 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18400
18401 .cindex SNI "selecting server certificate based on"
18402 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18403 if the OpenSSL build supports TLS extensions and the TLS client sends the
18404 Server Name Indication extension, then this option and others documented in
18405 &<<SECTtlssni>>& will be re-expanded.
18406
18407 If this option is unset or empty a self-signed certificate will be
18408 used.
18409 Under Linux this is generated at daemon startup; on other platforms it will be
18410 generated fresh for every connection.
18411
18412 .option tls_crl main string&!! unset
18413 .cindex "TLS" "server certificate revocation list"
18414 .cindex "certificate" "revocation list for server"
18415 This option specifies a certificate revocation list. The expanded value must
18416 be the name of a file that contains CRLs in PEM format.
18417
18418 Under OpenSSL the option can specify a directory with CRL files.
18419
18420 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18421 for each signing element of the certificate chain (i.e. all but the leaf).
18422 For the file variant this can be multiple PEM blocks in the one file.
18423
18424 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18425
18426
18427 .option tls_dh_max_bits main integer 2236
18428 .cindex "TLS" "D-H bit count"
18429 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18430 the chosen TLS library.  That value might prove to be too high for
18431 interoperability.  This option provides a maximum clamp on the value
18432 suggested, trading off security for interoperability.
18433
18434 The value must be at least 1024.
18435
18436 The value 2236 was chosen because, at time of adding the option, it was the
18437 hard-coded maximum value supported by the NSS cryptographic library, as used
18438 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18439
18440 If you prefer more security and are willing to break some clients, raise this
18441 number.
18442
18443 Note that the value passed to GnuTLS for *generating* a new prime may be a
18444 little less than this figure, because GnuTLS is inexact and may produce a
18445 larger prime than requested.
18446
18447
18448 .option tls_dhparam main string&!! unset
18449 .cindex "TLS" "D-H parameters for server"
18450 The value of this option is expanded and indicates the source of DH parameters
18451 to be used by Exim.
18452
18453 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18454 local DH parameters*&, which has been supported across all versions of Exim.  The
18455 other specific constants available are a fallback so that even when
18456 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18457
18458 If &%tls_dhparam%& is a filename starting with a &`/`&,
18459 then it names a file from which DH
18460 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18461 PKCS#3 representation of the DH prime.  If the file does not exist, for
18462 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18463 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18464 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18465 and treated as though the &%tls_dhparam%& were set to "none".
18466
18467 If this option expands to the string "none", then no DH parameters will be
18468 loaded by Exim.
18469
18470 If this option expands to the string "historic" and Exim is using GnuTLS, then
18471 Exim will attempt to load a file from inside the spool directory.  If the file
18472 does not exist, Exim will attempt to create it.
18473 See section &<<SECTgnutlsparam>>& for further details.
18474
18475 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18476 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18477
18478 In older versions of Exim the default was the 2048 bit prime described in section
18479 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18480 in IKE is assigned number 23.
18481
18482 Otherwise, the option must expand to the name used by Exim for any of a number
18483 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18484 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18485 the number used by IKE, or "default" which corresponds to
18486 &`exim.dev.20160529.3`&.
18487
18488 The available standard primes are:
18489 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18490 &`ike1`&, &`ike2`&, &`ike5`&,
18491 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18492 &`ike22`&, &`ike23`& and &`ike24`&.
18493
18494 The available additional primes are:
18495 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18496
18497 Some of these will be too small to be accepted by clients.
18498 Some may be too large to be accepted by clients.
18499 The open cryptographic community has suspicions about the integrity of some
18500 of the later IKE values, which led into RFC7919 providing new fixed constants
18501 (the "ffdhe" identifiers).
18502
18503 At this point, all of the "ike" values should be considered obsolete;
18504 they are still in Exim to avoid breaking unusual configurations, but are
18505 candidates for removal the next time we have backwards-incompatible changes.
18506 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18507 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18508 SHOULD NOT.
18509 Because of this, Exim regards them as deprecated; if either of the first pair
18510 are used, warnings will be logged in the paniclog, and if any are used then
18511 warnings will be logged in the mainlog.
18512 All four will be removed in a future Exim release.
18513
18514 The TLS protocol does not negotiate an acceptable size for this; clients tend
18515 to hard-drop connections if what is offered by the server is unacceptable,
18516 whether too large or too small, and there's no provision for the client to
18517 tell the server what these constraints are.  Thus, as a server operator, you
18518 need to make an educated guess as to what is most likely to work for your
18519 userbase.
18520
18521 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18522 is most likely to maximise interoperability.  The upper bound comes from
18523 applications using the Mozilla Network Security Services (NSS) library, which
18524 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18525 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18526 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18527 acceptable bound from 1024 to 2048.
18528
18529
18530 .option tls_eccurve main string list&!! &`auto`&
18531 .cindex TLS "EC cryptography"
18532 This option selects EC curves for use by Exim when used with OpenSSL.
18533 It has no effect when Exim is used with GnuTLS
18534 (the equivalent can be done using a priority string for the
18535 &%tls_require_ciphers%& option).
18536
18537 After expansion it must contain
18538 .new
18539 one or (only for OpenSSL versiona 1.1.1 onwards) more
18540 .wen
18541 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18542 Consult your OpenSSL manual for valid curve names.
18543
18544 For OpenSSL versions before (and not including) 1.0.2, the string
18545 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18546 &`auto`& tells the library to choose.
18547
18548 .new
18549 If the option expands to an empty string, the effect is undefined.
18550 .wen
18551
18552
18553 .option tls_ocsp_file main string&!! unset
18554 .cindex TLS "certificate status"
18555 .cindex TLS "OCSP proof file"
18556 This option
18557 must if set expand to the absolute path to a file which contains a current
18558 status proof for the server's certificate, as obtained from the
18559 Certificate Authority.
18560
18561 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18562 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18563
18564 For OpenSSL 1.1.0 or later, and
18565 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18566 of files, to match a list given for the &%tls_certificate%& option.
18567 The ordering of the two lists must match.
18568 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18569
18570 The file(s) should be in DER format,
18571 except for GnuTLS 3.6.3 or later
18572 or for OpenSSL,
18573 when an optional filetype prefix can be used.
18574 The prefix must be one of "DER" or "PEM", followed by
18575 a single space.  If one is used it sets the format for subsequent
18576 files in the list; the initial format is DER.
18577 If multiple proofs are wanted, for multiple chain elements
18578 (this only works under TLS1.3)
18579 they must be coded as a combined OCSP response.
18580
18581 Although GnuTLS will accept PEM files with multiple separate
18582 PEM blobs (ie. separate OCSP responses), it sends them in the
18583 TLS Certificate record interleaved with the certificates of the chain;
18584 although a GnuTLS client is happy with that, an OpenSSL client is not.
18585
18586 .option tls_on_connect_ports main "string list" unset
18587 .cindex SSMTP
18588 .cindex SMTPS
18589 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18590 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18591 set up without waiting for the client to issue a STARTTLS command. For
18592 further details, see section &<<SECTsupobssmt>>&.
18593
18594
18595
18596 .option tls_privatekey main "string list&!!" unset
18597 .cindex "TLS" "server private key; location of"
18598 The value of this option is expanded, and must then be a list of absolute paths to
18599 files which contains the server's private keys.
18600 If this option is unset, or if
18601 the expansion is forced to fail, or the result is an empty string, the private
18602 key is assumed to be in the same file as the server's certificates. See chapter
18603 &<<CHAPTLS>>& for further details.
18604
18605 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18606
18607
18608 .option tls_remember_esmtp main boolean false
18609 .cindex "TLS" "esmtp state; remembering"
18610 .cindex "TLS" "broken clients"
18611 If this option is set true, Exim violates the RFCs by remembering that it is in
18612 &"esmtp"& state after successfully negotiating a TLS session. This provides
18613 support for broken clients that fail to send a new EHLO after starting a
18614 TLS session.
18615
18616
18617 .option tls_require_ciphers main string&!! unset
18618 .cindex "TLS" "requiring specific ciphers"
18619 .cindex "cipher" "requiring specific"
18620 This option controls which ciphers can be used for incoming TLS connections.
18621 The &(smtp)& transport has an option of the same name for controlling outgoing
18622 connections. This option is expanded for each connection, so can be varied for
18623 different clients if required. The value of this option must be a list of
18624 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18625 in somewhat different ways. If GnuTLS is being used, the client controls the
18626 preference order of the available ciphers. Details are given in sections
18627 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18628
18629
18630 .option tls_resumption_hosts main "host list&!!" unset
18631 .cindex TLS resumption
18632 This option controls which connections to offer the TLS resumption feature.
18633 See &<<SECTresumption>>& for details.
18634
18635
18636 .option tls_try_verify_hosts main "host list&!!" unset
18637 .cindex "TLS" "client certificate verification"
18638 .cindex "certificate" "verification of client"
18639 See &%tls_verify_hosts%& below.
18640
18641
18642 .option tls_verify_certificates main string&!! system
18643 .cindex "TLS" "client certificate verification"
18644 .cindex "certificate" "verification of client"
18645 The value of this option is expanded, and must then be either the
18646 word "system"
18647 or the absolute path to
18648 a file or directory containing permitted certificates for clients that
18649 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18650
18651 The "system" value for the option will use a
18652 system default location compiled into the SSL library.
18653 This is not available for GnuTLS versions preceding 3.0.20,
18654 and will be taken as empty; an explicit location
18655 must be specified.
18656
18657 The use of a directory for the option value is not available for GnuTLS versions
18658 preceding 3.3.6 and a single file must be used.
18659
18660 With OpenSSL the certificates specified
18661 explicitly
18662 either by file or directory
18663 are added to those given by the system default location.
18664
18665 These certificates should be for the certificate authorities trusted, rather
18666 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18667 the value is a file then the certificates are sent by Exim as a server to
18668 connecting clients, defining the list of accepted certificate authorities.
18669 Thus the values defined should be considered public data.  To avoid this,
18670 use the explicit directory version. (If your peer is Exim up to 4.85,
18671 using GnuTLS, you may need to send the CAs (thus using the file
18672 variant). Otherwise the peer doesn't send its certificate.)
18673
18674 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18675
18676 A forced expansion failure or setting to an empty string is equivalent to
18677 being unset.
18678
18679
18680 .option tls_verify_hosts main "host list&!!" unset
18681 .cindex "TLS" "client certificate verification"
18682 .cindex "certificate" "verification of client"
18683 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18684 certificates from clients. The expected certificates are defined by
18685 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18686 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18687 &%tls_verify_certificates%& is not set.
18688
18689 Any client that matches &%tls_verify_hosts%& is constrained by
18690 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18691 present one of the listed certificates. If it does not, the connection is
18692 aborted.
18693 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18694 the host to use TLS. It can still send SMTP commands through unencrypted
18695 connections. Forcing a client to use TLS has to be done separately using an
18696 ACL to reject inappropriate commands when the connection is not encrypted.
18697
18698 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18699 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18700 certificate and checks it against &%tls_verify_certificates%&, but does not
18701 abort the connection if there is no certificate or if it does not match. This
18702 state can be detected in an ACL, which makes it possible to implement policies
18703 such as &"accept for relay only if a verified certificate has been received,
18704 but accept for local delivery if encrypted, even without a verified
18705 certificate"&.
18706
18707 Client hosts that match neither of these lists are not asked to present
18708 certificates.
18709
18710
18711 .option trusted_groups main "string list&!!" unset
18712 .cindex "trusted groups"
18713 .cindex "groups" "trusted"
18714 This option is expanded just once, at the start of Exim's processing. If this
18715 option is set, any process that is running in one of the listed groups, or
18716 which has one of them as a supplementary group, is trusted. The groups can be
18717 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18718 details of what trusted callers are permitted to do. If neither
18719 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18720 are trusted.
18721
18722 .option trusted_users main "string list&!!" unset
18723 .cindex "trusted users"
18724 .cindex "user" "trusted"
18725 This option is expanded just once, at the start of Exim's processing. If this
18726 option is set, any process that is running as one of the listed users is
18727 trusted. The users can be specified numerically or by name. See section
18728 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18729 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18730 Exim user are trusted.
18731
18732 .option unknown_login main string&!! unset
18733 .cindex "uid (user id)" "unknown caller"
18734 .vindex "&$caller_uid$&"
18735 This is a specialized feature for use in unusual configurations. By default, if
18736 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18737 gives up. The &%unknown_login%& option can be used to set a login name to be
18738 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18739 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18740 is used for the user's real name (gecos field), unless this has been set by the
18741 &%-F%& option.
18742
18743 .option unknown_username main string unset
18744 See &%unknown_login%&.
18745
18746 .option untrusted_set_sender main "address list&!!" unset
18747 .cindex "trusted users"
18748 .cindex "sender" "setting by untrusted user"
18749 .cindex "untrusted user setting sender"
18750 .cindex "user" "untrusted setting sender"
18751 .cindex "envelope from"
18752 .cindex "envelope sender"
18753 When an untrusted user submits a message to Exim using the standard input, Exim
18754 normally creates an envelope sender address from the user's login and the
18755 default qualification domain. Data from the &%-f%& option (for setting envelope
18756 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18757 is used) is ignored.
18758
18759 However, untrusted users are permitted to set an empty envelope sender address,
18760 to declare that a message should never generate any bounces. For example:
18761 .code
18762 exim -f '<>' user@domain.example
18763 .endd
18764 .vindex "&$sender_ident$&"
18765 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18766 other envelope sender addresses in a controlled way. When it is set, untrusted
18767 users are allowed to set envelope sender addresses that match any of the
18768 patterns in the list. Like all address lists, the string is expanded. The
18769 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18770 users to setting senders that start with their login ids
18771 followed by a hyphen
18772 by a setting like this:
18773 .code
18774 untrusted_set_sender = ^$sender_ident-
18775 .endd
18776 If you want to allow untrusted users to set envelope sender addresses without
18777 restriction, you can use
18778 .code
18779 untrusted_set_sender = *
18780 .endd
18781 The &%untrusted_set_sender%& option applies to all forms of local input, but
18782 only to the setting of the envelope sender. It does not permit untrusted users
18783 to use the other options which trusted user can use to override message
18784 parameters. Furthermore, it does not stop Exim from removing an existing
18785 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18786 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18787 overriding these actions. The handling of the &'Sender:'& header is also
18788 described in section &<<SECTthesenhea>>&.
18789
18790 The log line for a message's arrival shows the envelope sender following
18791 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18792 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18793 envelope sender address, the user's login is shown in parentheses after the
18794 sender address.
18795
18796
18797 .option uucp_from_pattern main string "see below"
18798 .cindex "&""From""& line"
18799 .cindex "UUCP" "&""From""& line"
18800 Some applications that pass messages to an MTA via a command line interface use
18801 an initial line starting with &"From&~"& to pass the envelope sender. In
18802 particular, this is used by UUCP software. Exim recognizes such a line by means
18803 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18804 matches, the sender address is constructed by expanding the contents of
18805 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18806 default pattern recognizes lines in the following two forms:
18807 .code
18808 From ph10 Fri Jan  5 12:35 GMT 1996
18809 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18810 .endd
18811 The pattern can be seen by running
18812 .code
18813 exim -bP uucp_from_pattern
18814 .endd
18815 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18816 year in the second case. The first word after &"From&~"& is matched in the
18817 regular expression by a parenthesized subpattern. The default value for
18818 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18819 (&"ph10"& in the example above) as the message's sender. See also
18820 &%ignore_fromline_hosts%&.
18821
18822
18823 .option uucp_from_sender main string&!! &`$1`&
18824 See &%uucp_from_pattern%& above.
18825
18826
18827 .option warn_message_file main string&!! unset
18828 .cindex "warning of delay" "customizing the message"
18829 .cindex "customizing" "warning message"
18830 This option defines a template file containing paragraphs of text to be used
18831 for constructing the warning message which is sent by Exim when a message has
18832 been in the queue for a specified amount of time, as specified by
18833 &%delay_warning%&. Details of the file's contents are given in chapter
18834 &<<CHAPemsgcust>>&.
18835 .cindex warn_message_file "tainted data"
18836 The option is expanded to give the file path, which must be
18837 absolute and untainted.
18838 See also &%bounce_message_file%&.
18839
18840
18841 .option write_rejectlog main boolean true
18842 .cindex "reject log" "disabling"
18843 If this option is set false, Exim no longer writes anything to the reject log.
18844 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18845 .ecindex IIDconfima
18846 .ecindex IIDmaiconf
18847
18848
18849
18850
18851 . ////////////////////////////////////////////////////////////////////////////
18852 . ////////////////////////////////////////////////////////////////////////////
18853
18854 .chapter "Generic options for routers" "CHAProutergeneric"
18855 .scindex IIDgenoprou1 "options" "generic; for routers"
18856 .scindex IIDgenoprou2 "generic options" "router"
18857 This chapter describes the generic options that apply to all routers.
18858 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18859
18860 For a general description of how a router operates, see sections
18861 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18862 which the preconditions are tested. The order of expansion of the options that
18863 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18864 &%headers_remove%&, &%transport%&.
18865
18866 The name of a router is limited to be &drivernamemax; ASCII characters long;
18867 prior to Exim 4.95 names would be silently truncated at this length, but now
18868 it is enforced.
18869
18870
18871 .option address_data routers string&!! unset
18872 .cindex "router" "data attached to address"
18873 The string is expanded just before the router is run, that is, after all the
18874 precondition tests have succeeded. If the expansion is forced to fail, the
18875 router declines, the value of &%address_data%& remains unchanged, and the
18876 &%more%& option controls what happens next. Other expansion failures cause
18877 delivery of the address to be deferred.
18878
18879 .vindex "&$address_data$&"
18880 When the expansion succeeds, the value is retained with the address, and can be
18881 accessed using the variable &$address_data$& in the current router, subsequent
18882 routers, and the eventual transport.
18883
18884 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18885 that runs a user's filter file, the contents of &$address_data$& are accessible
18886 in the filter. This is not normally a problem, because such data is usually
18887 either not confidential or it &"belongs"& to the current user, but if you do
18888 put confidential data into &$address_data$& you need to remember this point.
18889
18890 Even if the router declines or passes, the value of &$address_data$& remains
18891 with the address, though it can be changed by another &%address_data%& setting
18892 on a subsequent router. If a router generates child addresses, the value of
18893 &$address_data$& propagates to them. This also applies to the special kind of
18894 &"child"& that is generated by a router with the &%unseen%& option.
18895
18896 The idea of &%address_data%& is that you can use it to look up a lot of data
18897 for the address once, and then pick out parts of the data later. For example,
18898 you could use a single LDAP lookup to return a string of the form
18899 .code
18900 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18901 .endd
18902 In the transport you could pick out the mailbox by a setting such as
18903 .code
18904 file = ${extract{mailbox}{$address_data}}
18905 .endd
18906 This makes the configuration file less messy, and also reduces the number of
18907 lookups (though Exim does cache lookups).
18908
18909 See also the &%set%& option below.
18910
18911 .vindex "&$sender_address_data$&"
18912 .vindex "&$address_data$&"
18913 The &%address_data%& facility is also useful as a means of passing information
18914 from one router to another, and from a router to a transport. In addition, if
18915 &$address_data$& is set by a router when verifying a recipient address from an
18916 ACL, it remains available for use in the rest of the ACL statement. After
18917 verifying a sender, the value is transferred to &$sender_address_data$&.
18918
18919
18920
18921 .option address_test routers&!? boolean true
18922 .oindex "&%-bt%&"
18923 .cindex "router" "skipping when address testing"
18924 If this option is set false, the router is skipped when routing is being tested
18925 by means of the &%-bt%& command line option. This can be a convenience when
18926 your first router sends messages to an external scanner, because it saves you
18927 having to set the &"already scanned"& indicator when testing real address
18928 routing.
18929
18930
18931
18932 .option cannot_route_message routers string&!! unset
18933 .cindex "router" "customizing &""cannot route""& message"
18934 .cindex "customizing" "&""cannot route""& message"
18935 This option specifies a text message that is used when an address cannot be
18936 routed because Exim has run out of routers. The default message is
18937 &"Unrouteable address"&. This option is useful only on routers that have
18938 &%more%& set false, or on the very last router in a configuration, because the
18939 value that is used is taken from the last router that is considered. This
18940 includes a router that is skipped because its preconditions are not met, as
18941 well as a router that declines. For example, using the default configuration,
18942 you could put:
18943 .code
18944 cannot_route_message = Remote domain not found in DNS
18945 .endd
18946 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18947 and
18948 .code
18949 cannot_route_message = Unknown local user
18950 .endd
18951 on the final router that checks for local users. If string expansion fails for
18952 this option, the default message is used. Unless the expansion failure was
18953 explicitly forced, a message about the failure is written to the main and panic
18954 logs, in addition to the normal message about the routing failure.
18955
18956
18957 .option caseful_local_part routers boolean false
18958 .cindex "case of local parts"
18959 .cindex "router" "case of local parts"
18960 By default, routers handle the local parts of addresses in a case-insensitive
18961 manner, though the actual case is preserved for transmission with the message.
18962 If you want the case of letters to be significant in a router, you must set
18963 this option true. For individual router options that contain address or local
18964 part lists (for example, &%local_parts%&), case-sensitive matching can be
18965 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18966 more details.
18967
18968 .vindex "&$local_part$&"
18969 .vindex "&$original_local_part$&"
18970 .vindex "&$parent_local_part$&"
18971 The value of the &$local_part$& variable is forced to lower case while a
18972 router is running unless &%caseful_local_part%& is set. When a router assigns
18973 an address to a transport, the value of &$local_part$& when the transport runs
18974 is the same as it was in the router. Similarly, when a router generates child
18975 addresses by aliasing or forwarding, the values of &$original_local_part$&
18976 and &$parent_local_part$& are those that were used by the redirecting router.
18977
18978 This option applies to the processing of an address by a router. When a
18979 recipient address is being processed in an ACL, there is a separate &%control%&
18980 modifier that can be used to specify case-sensitive processing within the ACL
18981 (see section &<<SECTcontrols>>&).
18982
18983
18984
18985 .option check_local_user routers&!? boolean false
18986 .cindex "local user, checking in router"
18987 .cindex "router" "checking for local user"
18988 .cindex "&_/etc/passwd_&"
18989 .vindex "&$home$&"
18990 When this option is true, Exim checks that the local part of the recipient
18991 address (with affixes removed if relevant) is the name of an account on the
18992 local system. The check is done by calling the &[getpwnam()]& function rather
18993 than trying to read &_/etc/passwd_& directly. This means that other methods of
18994 holding password data (such as NIS) are supported. If the local part is a local
18995 user,
18996 .cindex "tainted data" "de-tainting"
18997 .cindex "de-tainting" "using router check_local_user option"
18998 &$local_part_data$& is set to an untainted version of the local part and
18999 &$home$& is set from the password data. The latter can be tested in other
19000 preconditions that are evaluated after this one (the order of evaluation is
19001 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19002 overridden by &%router_home_directory%&. If the local part is not a local user,
19003 the router is skipped.
19004
19005 If you want to check that the local part is either the name of a local user
19006 or matches something else, you cannot combine &%check_local_user%& with a
19007 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19008 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19009 setting to achieve this. For example:
19010 .code
19011 local_parts = passwd;$local_part : lsearch;/etc/other/users
19012 .endd
19013 Note, however, that the side effects of &%check_local_user%& (such as setting
19014 up a home directory) do not occur when a &(passwd)& lookup is used in a
19015 &%local_parts%& (or any other) precondition.
19016
19017
19018
19019 .option condition routers&!? string&!! unset
19020 .cindex "router" "customized precondition"
19021 This option specifies a general precondition test that has to succeed for the
19022 router to be called. The &%condition%& option is the last precondition to be
19023 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19024 result is a forced failure, or an empty string, or one of the strings &"0"& or
19025 &"no"& or &"false"& (checked without regard to the case of the letters), the
19026 router is skipped, and the address is offered to the next one.
19027
19028 If the result is any other value, the router is run (as this is the last
19029 precondition to be evaluated, all the other preconditions must be true).
19030
19031 This option is unusual in that multiple &%condition%& options may be present.
19032 All &%condition%& options must succeed.
19033
19034 The &%condition%& option provides a means of applying custom conditions to the
19035 running of routers. Note that in the case of a simple conditional expansion,
19036 the default expansion values are exactly what is wanted. For example:
19037 .code
19038 condition = ${if >{$message_age}{600}}
19039 .endd
19040 Because of the default behaviour of the string expansion, this is equivalent to
19041 .code
19042 condition = ${if >{$message_age}{600}{true}{}}
19043 .endd
19044
19045 A multiple condition example, which succeeds:
19046 .code
19047 condition = ${if >{$message_age}{600}}
19048 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19049 condition = foobar
19050 .endd
19051
19052 If the expansion fails (other than forced failure) delivery is deferred. Some
19053 of the other precondition options are common special cases that could in fact
19054 be specified using &%condition%&.
19055
19056 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19057 are far older, and use one set of semantics.  ACLs are newer and when
19058 they were created, the ACL &%condition%& process was given far stricter
19059 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19060 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19061 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19062 Router rules processing behavior.
19063
19064 This is best illustrated in an example:
19065 .code
19066 # If used in an ACL condition will fail with a syntax error, but
19067 # in a router condition any extra characters are treated as a string
19068
19069 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19070 true {yes} {no}}
19071
19072 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19073  {yes} {no}}
19074 .endd
19075 In each example above, the &%if%& statement actually ends after
19076 &"{google.com}}"&.  Since no true or false braces were defined, the
19077 default &%if%& behavior is to return a boolean true or a null answer
19078 (which evaluates to false). The rest of the line is then treated as a
19079 string. So the first example resulted in the boolean answer &"true"&
19080 with the string &" {yes} {no}}"& appended to it. The second example
19081 resulted in the null output (indicating false) with the string
19082 &" {yes} {no}}"& appended to it.
19083
19084 In fact you can put excess forward braces in too.  In the router
19085 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19086 mean something, like after a &"$"& or when required as part of a
19087 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19088 string characters.
19089
19090 Thus, in a Router, the above expansion strings will both always evaluate
19091 true, as the result of expansion is a non-empty string which doesn't
19092 match an explicit false value.  This can be tricky to debug.  By
19093 contrast, in an ACL either of those strings will always result in an
19094 expansion error because the result doesn't look sufficiently boolean.
19095
19096
19097 .option debug_print routers string&!! unset
19098 .cindex "testing" "variables in drivers"
19099 If this option is set and debugging is enabled (see the &%-d%& command line
19100 option) or in address-testing mode (see the &%-bt%& command line option),
19101 the string is expanded and included in the debugging output.
19102 If expansion of the string fails, the error message is written to the debugging
19103 output, and Exim carries on processing.
19104 This option is provided to help with checking out the values of variables and
19105 so on when debugging router configurations. For example, if a &%condition%&
19106 option appears not to be working, &%debug_print%& can be used to output the
19107 variables it references. The output happens after checks for &%domains%&,
19108 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19109 are tested. A newline is added to the text if it does not end with one.
19110 The variable &$router_name$& contains the name of the router.
19111
19112
19113
19114 .option disable_logging routers boolean false
19115 If this option is set true, nothing is logged for any routing errors
19116 or for any deliveries caused by this router. You should not set this option
19117 unless you really, really know what you are doing. See also the generic
19118 transport option of the same name.
19119
19120 .option dnssec_request_domains routers "domain list&!!" *
19121 .cindex "MX record" "security"
19122 .cindex "DNSSEC" "MX lookup"
19123 .cindex "security" "MX lookup"
19124 .cindex "DNS" "DNSSEC"
19125 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19126 the DNSSEC request bit set.
19127 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19128
19129 .option dnssec_require_domains routers "domain list&!!" unset
19130 .cindex "MX record" "security"
19131 .cindex "DNSSEC" "MX lookup"
19132 .cindex "security" "MX lookup"
19133 .cindex "DNS" "DNSSEC"
19134 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19135 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19136 (AD bit) set will be ignored and logged as a host-lookup failure.
19137 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19138
19139
19140 .option domains routers&!? "domain list&!!" unset
19141 .cindex "router" "restricting to specific domains"
19142 .vindex "&$domain_data$&"
19143 If this option is set, the router is skipped unless the current domain matches
19144 the list. If the match is achieved by means of a file lookup, the data that the
19145 lookup returned for the domain is placed in &$domain_data$& for use in string
19146 expansions of the driver's private options and in the transport.
19147 See section &<<SECTrouprecon>>& for
19148 a list of the order in which preconditions are evaluated.
19149
19150
19151
19152 .option driver routers string unset
19153 This option must always be set. It specifies which of the available routers is
19154 to be used.
19155
19156
19157 .option dsn_lasthop routers boolean false
19158 .cindex "DSN" "success"
19159 .cindex "Delivery Status Notification" "success"
19160 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19161 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19162 instead send a success DSN as if the next hop does not support DSN.
19163 Not effective on redirect routers.
19164
19165
19166
19167 .option errors_to routers string&!! unset
19168 .cindex "envelope from"
19169 .cindex "envelope sender"
19170 .cindex "router" "changing address for errors"
19171 If a router successfully handles an address, it may assign the address to a
19172 transport for delivery or it may generate child addresses. In both cases, if
19173 there is a delivery problem during later processing, the resulting bounce
19174 message is sent to the address that results from expanding this string,
19175 provided that the address verifies successfully. The &%errors_to%& option is
19176 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19177
19178 The &%errors_to%& setting associated with an address can be overridden if it
19179 subsequently passes through other routers that have their own &%errors_to%&
19180 settings, or if the message is delivered by a transport with a &%return_path%&
19181 setting.
19182
19183 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19184 the expansion fails to verify, the errors address associated with the incoming
19185 address is used. At top level, this is the envelope sender. A non-forced
19186 expansion failure causes delivery to be deferred.
19187
19188 If an address for which &%errors_to%& has been set ends up being delivered over
19189 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19190 any bounces that are generated by other MTAs on the delivery route are also
19191 sent there. You can set &%errors_to%& to the empty string by either of these
19192 settings:
19193 .code
19194 errors_to =
19195 errors_to = ""
19196 .endd
19197 An expansion item that yields an empty string has the same effect. If you do
19198 this, a locally detected delivery error for addresses processed by this router
19199 no longer gives rise to a bounce message; the error is discarded. If the
19200 address is delivered to a remote host, the return path is set to &`<>`&, unless
19201 overridden by the &%return_path%& option on the transport.
19202
19203 .vindex "&$address_data$&"
19204 If for some reason you want to discard local errors, but use a non-empty
19205 MAIL command for remote delivery, you can preserve the original return
19206 path in &$address_data$& in the router, and reinstate it in the transport by
19207 setting &%return_path%&.
19208
19209 The most common use of &%errors_to%& is to direct mailing list bounces to the
19210 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19211 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19212
19213
19214
19215 .option expn routers&!? boolean true
19216 .cindex "address" "testing"
19217 .cindex "testing" "addresses"
19218 .cindex "EXPN" "router skipping"
19219 .cindex "router" "skipping for EXPN"
19220 If this option is turned off, the router is skipped when testing an address
19221 as a result of processing an SMTP EXPN command. You might, for example,
19222 want to turn it off on a router for users' &_.forward_& files, while leaving it
19223 on for the system alias file.
19224 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19225 are evaluated.
19226
19227 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19228 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19229 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19230
19231
19232
19233 .option fail_verify routers boolean false
19234 .cindex "router" "forcing verification failure"
19235 Setting this option has the effect of setting both &%fail_verify_sender%& and
19236 &%fail_verify_recipient%& to the same value.
19237
19238
19239
19240 .option fail_verify_recipient routers boolean false
19241 If this option is true and an address is accepted by this router when
19242 verifying a recipient, verification fails.
19243
19244
19245
19246 .option fail_verify_sender routers boolean false
19247 If this option is true and an address is accepted by this router when
19248 verifying a sender, verification fails.
19249
19250
19251
19252 .option fallback_hosts routers "string list" unset
19253 .cindex "router" "fallback hosts"
19254 .cindex "fallback" "hosts specified on router"
19255 String expansion is not applied to this option. The argument must be a
19256 colon-separated list of host names or IP addresses. The list separator can be
19257 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19258 each name or address. In fact, the format of each item is exactly the same as
19259 defined for the list of hosts in a &(manualroute)& router (see section
19260 &<<SECTformatonehostitem>>&).
19261
19262 If a router queues an address for a remote transport, this host list is
19263 associated with the address, and used instead of the transport's fallback host
19264 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19265 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19266 transport for further details.
19267
19268
19269 .option group routers string&!! "see below"
19270 .cindex "gid (group id)" "local delivery"
19271 .cindex "local transports" "uid and gid"
19272 .cindex "transport" "local"
19273 .cindex "router" "setting group"
19274 When a router queues an address for a transport, and the transport does not
19275 specify a group, the group given here is used when running the delivery
19276 process.
19277 The group may be specified numerically or by name. If expansion fails, the
19278 error is logged and delivery is deferred.
19279 The default is unset, unless &%check_local_user%& is set, when the default
19280 is taken from the password information. See also &%initgroups%& and &%user%&
19281 and the discussion in chapter &<<CHAPenvironment>>&.
19282
19283
19284
19285 .option headers_add routers list&!! unset
19286 .cindex "header lines" "adding"
19287 .cindex "router" "adding header lines"
19288 This option specifies a list of text headers,
19289 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19290 that is associated with any addresses that are accepted by the router.
19291 Each item is separately expanded, at routing time.  However, this
19292 option has no effect when an address is just being verified. The way in which
19293 the text is used to add header lines at transport time is described in section
19294 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19295 message is in the process of being transported. This means that references to
19296 header lines in string expansions in the transport's configuration do not
19297 &"see"& the added header lines.
19298
19299 The &%headers_add%& option is expanded after &%errors_to%&, but before
19300 &%headers_remove%& and &%transport%&. If an item is empty, or if
19301 an item expansion is forced to fail, the item has no effect. Other expansion
19302 failures are treated as configuration errors.
19303
19304 Unlike most options, &%headers_add%& can be specified multiple times
19305 for a router; all listed headers are added.
19306
19307 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19308 router that has the &%one_time%& option set.
19309
19310 .cindex "duplicate addresses"
19311 .oindex "&%unseen%&"
19312 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19313 additions are deleted when the address is passed on to subsequent routers.
19314 For a &%redirect%& router, if a generated address is the same as the incoming
19315 address, this can lead to duplicate addresses with different header
19316 modifications. Exim does not do duplicate deliveries (except, in certain
19317 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19318 which of the duplicates is discarded, so this ambiguous situation should be
19319 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19320
19321
19322
19323 .option headers_remove routers list&!! unset
19324 .cindex "header lines" "removing"
19325 .cindex "router" "removing header lines"
19326 This option specifies a list of text headers,
19327 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19328 that is associated with any addresses that are accepted by the router.
19329 However, the option has no effect when an address is just being verified.
19330 Each list item is separately expanded, at transport time.
19331 If an item ends in *, it will match any header with the given prefix.
19332 The way in which
19333 the text is used to remove header lines at transport time is described in
19334 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19335 the message is in the process of being transported. This means that references
19336 to header lines in string expansions in the transport's configuration still
19337 &"see"& the original header lines.
19338
19339 The &%headers_remove%& option is handled after &%errors_to%& and
19340 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19341 the item has no effect. Other expansion failures are treated as configuration
19342 errors.
19343
19344 Unlike most options, &%headers_remove%& can be specified multiple times
19345 for a router; all listed headers are removed.
19346
19347 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19348 router that has the &%one_time%& option set.
19349
19350 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19351 removal requests are deleted when the address is passed on to subsequent
19352 routers, and this can lead to problems with duplicates -- see the similar
19353 warning for &%headers_add%& above.
19354
19355 &*Warning 3*&: Because of the separate expansion of the list items,
19356 items that contain a list separator must have it doubled.
19357 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19358
19359
19360
19361 .option ignore_target_hosts routers "host list&!!" unset
19362 .cindex "IP address" "discarding"
19363 .cindex "router" "discarding IP addresses"
19364 Although this option is a host list, it should normally contain IP address
19365 entries rather than names. If any host that is looked up by the router has an
19366 IP address that matches an item in this list, Exim behaves as if that IP
19367 address did not exist. This option allows you to cope with rogue DNS entries
19368 like
19369 .code
19370 remote.domain.example.  A  127.0.0.1
19371 .endd
19372 by setting
19373 .code
19374 ignore_target_hosts = 127.0.0.1
19375 .endd
19376 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19377 discarded in this way, the router declines. In a conventional configuration, an
19378 attempt to mail to such a domain would normally provoke the &"unrouteable
19379 domain"& error, and an attempt to verify an address in the domain would fail.
19380 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19381 router declines if presented with one of the listed addresses.
19382
19383 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19384 means of the first or the second of the following settings, respectively:
19385 .code
19386 ignore_target_hosts = 0.0.0.0/0
19387 ignore_target_hosts = <; 0::0/0
19388 .endd
19389 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19390 in the second line matches all IPv6 addresses.
19391
19392 This option may also be useful for ignoring link-local and site-local IPv6
19393 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19394 is expanded before use as a list, it is possible to make it dependent on the
19395 domain that is being routed.
19396
19397 .vindex "&$host_address$&"
19398 During its expansion, &$host_address$& is set to the IP address that is being
19399 checked.
19400
19401 .option initgroups routers boolean false
19402 .cindex "additional groups"
19403 .cindex "groups" "additional"
19404 .cindex "local transports" "uid and gid"
19405 .cindex "transport" "local"
19406 If the router queues an address for a transport, and this option is true, and
19407 the uid supplied by the router is not overridden by the transport, the
19408 &[initgroups()]& function is called when running the transport to ensure that
19409 any additional groups associated with the uid are set up. See also &%group%&
19410 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19411
19412
19413
19414 .option local_part_prefix routers&!? "string list" unset
19415 .cindex affix "router precondition"
19416 .cindex "router" "prefix for local part"
19417 .cindex "prefix" "for local part, used in router"
19418 If this option is set, the router is skipped unless the local part starts with
19419 one of the given strings, or &%local_part_prefix_optional%& is true. See
19420 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19421 evaluated.
19422
19423 The list is scanned from left to right, and the first prefix that matches is
19424 used. A limited form of wildcard is available; if the prefix begins with an
19425 asterisk, it matches the longest possible sequence of arbitrary characters at
19426 the start of the local part. An asterisk should therefore always be followed by
19427 some character that does not occur in normal local parts.
19428 .cindex "multiple mailboxes"
19429 .cindex "mailbox" "multiple"
19430 Wildcarding can be used to set up multiple user mailboxes, as described in
19431 section &<<SECTmulbox>>&.
19432
19433 .vindex "&$local_part$&"
19434 .vindex "&$local_part_prefix$&"
19435 During the testing of the &%local_parts%& option, and while the router is
19436 running, the prefix is removed from the local part, and is available in the
19437 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19438 the router accepts the address, this remains true during subsequent delivery by
19439 a transport. In particular, the local part that is transmitted in the RCPT
19440 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19441 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19442 the relevant transport.
19443
19444 .vindex &$local_part_prefix_v$&
19445 If wildcarding (above) was used then the part of the prefix matching the
19446 wildcard is available in &$local_part_prefix_v$&.
19447
19448 When an address is being verified, &%local_part_prefix%& affects only the
19449 behaviour of the router. If the callout feature of verification is in use, this
19450 means that the full address, including the prefix, will be used during the
19451 callout.
19452
19453 The prefix facility is commonly used to handle local parts of the form
19454 &%owner-something%&. Another common use is to support local parts of the form
19455 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19456 to tell a user their forwarding is broken &-- by placing a router like this one
19457 immediately before the router that handles &_.forward_& files:
19458 .code
19459 real_localuser:
19460   driver = accept
19461   local_part_prefix = real-
19462   check_local_user
19463   transport = local_delivery
19464 .endd
19465 For security, it would probably be a good idea to restrict the use of this
19466 router to locally-generated messages, using a condition such as this:
19467 .code
19468   condition = ${if match {$sender_host_address}\
19469                          {\N^(|127\.0\.0\.1)$\N}}
19470 .endd
19471
19472 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19473 both conditions must be met if not optional. Care must be taken if wildcards
19474 are used in both a prefix and a suffix on the same router. Different
19475 separator characters must be used to avoid ambiguity.
19476
19477
19478 .option local_part_prefix_optional routers boolean false
19479 See &%local_part_prefix%& above.
19480
19481
19482
19483 .option local_part_suffix routers&!? "string list" unset
19484 .cindex "router" "suffix for local part"
19485 .cindex "suffix for local part" "used in router"
19486 This option operates in the same way as &%local_part_prefix%&, except that the
19487 local part must end (rather than start) with the given string, the
19488 &%local_part_suffix_optional%& option determines whether the suffix is
19489 mandatory, and the wildcard * character, if present, must be the last
19490 character of the suffix. This option facility is commonly used to handle local
19491 parts of the form &%something-request%& and multiple user mailboxes of the form
19492 &%username-foo%&.
19493
19494
19495 .option local_part_suffix_optional routers boolean false
19496 See &%local_part_suffix%& above.
19497
19498
19499
19500 .option local_parts routers&!? "local part list&!!" unset
19501 .cindex "router" "restricting to specific local parts"
19502 .cindex "local part" "checking in router"
19503 The router is run only if the local part of the address matches the list.
19504 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19505 are evaluated, and
19506 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19507 string is expanded, it is possible to make it depend on the domain, for
19508 example:
19509 .code
19510 local_parts = dbm;/usr/local/specials/$domain_data
19511 .endd
19512 .vindex "&$local_part_data$&"
19513 If the match is achieved by a lookup, the data that the lookup returned
19514 for the local part is placed in the variable &$local_part_data$& for use in
19515 expansions of the router's private options or in the transport.
19516 You might use this option, for
19517 example, if you have a large number of local virtual domains, and you want to
19518 send all postmaster mail to the same place without having to set up an alias in
19519 each virtual domain:
19520 .code
19521 postmaster:
19522   driver = redirect
19523   local_parts = postmaster
19524   data = postmaster@real.domain.example
19525 .endd
19526
19527
19528 .option log_as_local routers boolean "see below"
19529 .cindex "log" "delivery line"
19530 .cindex "delivery" "log line format"
19531 Exim has two logging styles for delivery, the idea being to make local
19532 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19533 recipient address is given just as the local part, without a domain. The use of
19534 this style is controlled by this option. It defaults to true for the &(accept)&
19535 router, and false for all the others. This option applies only when a
19536 router assigns an address to a transport. It has no effect on routers that
19537 redirect addresses.
19538
19539
19540
19541 .option more routers boolean&!! true
19542 The result of string expansion for this option must be a valid boolean value,
19543 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19544 result causes an error, and delivery is deferred. If the expansion is forced to
19545 fail, the default value for the option (true) is used. Other failures cause
19546 delivery to be deferred.
19547
19548 If this option is set false, and the router declines to handle the address, no
19549 further routers are tried, routing fails, and the address is bounced.
19550 .oindex "&%self%&"
19551 However, if the router explicitly passes an address to the following router by
19552 means of the setting
19553 .code
19554 self = pass
19555 .endd
19556 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19557 does not affect the behaviour if one of the precondition tests fails. In that
19558 case, the address is always passed to the next router.
19559
19560 Note that &%address_data%& is not considered to be a precondition. If its
19561 expansion is forced to fail, the router declines, and the value of &%more%&
19562 controls what happens next.
19563
19564
19565 .option pass_on_timeout routers boolean false
19566 .cindex "timeout" "of router"
19567 .cindex "router" "timeout"
19568 If a router times out during a host lookup, it normally causes deferral of the
19569 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19570 router, overriding &%no_more%&. This may be helpful for systems that are
19571 intermittently connected to the Internet, or those that want to pass to a smart
19572 host any messages that cannot immediately be delivered.
19573
19574 There are occasional other temporary errors that can occur while doing DNS
19575 lookups. They are treated in the same way as a timeout, and this option
19576 applies to all of them.
19577
19578
19579
19580 .option pass_router routers string unset
19581 .cindex "router" "go to after &""pass""&"
19582 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19583 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19584 routing to continue, and overriding a false setting of &%more%&. When one of
19585 these routers returns &"pass"&, the address is normally handed on to the next
19586 router in sequence. This can be changed by setting &%pass_router%& to the name
19587 of another router. However (unlike &%redirect_router%&) the named router must
19588 be below the current router, to avoid loops. Note that this option applies only
19589 to the special case of &"pass"&. It does not apply when a router returns
19590 &"decline"& because it cannot handle an address.
19591
19592
19593
19594 .option redirect_router routers string unset
19595 .cindex "router" "start at after redirection"
19596 Sometimes an administrator knows that it is pointless to reprocess addresses
19597 generated from alias or forward files with the same router again. For
19598 example, if an alias file translates real names into login ids there is no
19599 point searching the alias file a second time, especially if it is a large file.
19600
19601 The &%redirect_router%& option can be set to the name of any router instance.
19602 It causes the routing of any generated addresses to start at the named router
19603 instead of at the first router. This option has no effect if the router in
19604 which it is set does not generate new addresses.
19605
19606
19607
19608 .option require_files routers&!? "string list&!!" unset
19609 .cindex "file" "requiring for router"
19610 .cindex "router" "requiring file existence"
19611 This option provides a general mechanism for predicating the running of a
19612 router on the existence or non-existence of certain files or directories.
19613 Before running a router, as one of its precondition tests, Exim works its way
19614 through the &%require_files%& list, expanding each item separately.
19615
19616 Because the list is split before expansion, any colons in expansion items must
19617 be doubled, or the facility for using a different list separator must be used
19618 (&<<SECTlistsepchange>>&).
19619 If any expansion is forced to fail, the item is ignored. Other expansion
19620 failures cause routing of the address to be deferred.
19621
19622 If any expanded string is empty, it is ignored. Otherwise, except as described
19623 below, each string must be a fully qualified file path, optionally preceded by
19624 &"!"&. The paths are passed to the &[stat()]& function to test for the
19625 existence of the files or directories. The router is skipped if any paths not
19626 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19627
19628 .cindex "NFS"
19629 If &[stat()]& cannot determine whether a file exists or not, delivery of
19630 the message is deferred. This can happen when NFS-mounted filesystems are
19631 unavailable.
19632
19633 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19634 options, so you cannot use it to check for the existence of a file in which to
19635 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19636 full list of the order in which preconditions are evaluated.) However, as
19637 these options are all expanded, you can use the &%exists%& expansion condition
19638 to make such tests. The &%require_files%& option is intended for checking files
19639 that the router may be going to use internally, or which are needed by a
19640 transport (e.g., &_.procmailrc_&).
19641
19642 During delivery, the &[stat()]& function is run as root, but there is a
19643 facility for some checking of the accessibility of a file by another user.
19644 This is not a proper permissions check, but just a &"rough"& check that
19645 operates as follows:
19646
19647 If an item in a &%require_files%& list does not contain any forward slash
19648 characters, it is taken to be the user (and optional group, separated by a
19649 comma) to be checked for subsequent files in the list. If no group is specified
19650 but the user is specified symbolically, the gid associated with the uid is
19651 used. For example:
19652 .code
19653 require_files = mail:/some/file
19654 require_files = $local_part_data:$home/.procmailrc
19655 .endd
19656 If a user or group name in a &%require_files%& list does not exist, the
19657 &%require_files%& condition fails.
19658
19659 Exim performs the check by scanning along the components of the file path, and
19660 checking the access for the given uid and gid. It checks for &"x"& access on
19661 directories, and &"r"& access on the final file. Note that this means that file
19662 access control lists, if the operating system has them, are ignored.
19663
19664 &*Warning 1*&: When the router is being run to verify addresses for an
19665 incoming SMTP message, Exim is not running as root, but under its own uid. This
19666 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19667 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19668 user is not permitted to read one of the directories on the file's path.
19669
19670 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19671 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19672 without root access. In this case, if a check for access by a particular user
19673 is requested, Exim creates a subprocess that runs as that user, and tries the
19674 check again in that process.
19675
19676 The default action for handling an unresolved EACCES is to consider it to
19677 be caused by a configuration error, and routing is deferred because the
19678 existence or non-existence of the file cannot be determined. However, in some
19679 circumstances it may be desirable to treat this condition as if the file did
19680 not exist. If the filename (or the exclamation mark that precedes the filename
19681 for non-existence) is preceded by a plus sign, the EACCES error is treated
19682 as if the file did not exist. For example:
19683 .code
19684 require_files = +/some/file
19685 .endd
19686 If the router is not an essential part of verification (for example, it
19687 handles users' &_.forward_& files), another solution is to set the &%verify%&
19688 option false so that the router is skipped when verifying.
19689
19690
19691
19692 .option retry_use_local_part routers boolean "see below"
19693 .cindex "hints database" "retry keys"
19694 .cindex "local part" "in retry keys"
19695 When a delivery suffers a temporary routing failure, a retry record is created
19696 in Exim's hints database. For addresses whose routing depends only on the
19697 domain, the key for the retry record should not involve the local part, but for
19698 other addresses, both the domain and the local part should be included.
19699 Usually, remote routing is of the former kind, and local routing is of the
19700 latter kind.
19701
19702 This option controls whether the local part is used to form the key for retry
19703 hints for addresses that suffer temporary errors while being handled by this
19704 router. The default value is true for any router that has any of
19705 &%check_local_user%&,
19706 &%local_parts%&,
19707 &%condition%&,
19708 &%local_part_prefix%&,
19709 &%local_part_suffix%&,
19710 &%senders%& or
19711 &%require_files%&
19712 set, and false otherwise. Note that this option does not apply to hints keys
19713 for transport delays; they are controlled by a generic transport option of the
19714 same name.
19715
19716 Failing to set this option when it is needed
19717 (because a remote router handles only some of the local-parts for a domain)
19718 can result in incorrect error messages being generated.
19719
19720 The setting of &%retry_use_local_part%& applies only to the router on which it
19721 appears. If the router generates child addresses, they are routed
19722 independently; this setting does not become attached to them.
19723
19724
19725
19726 .option router_home_directory routers string&!! unset
19727 .cindex "router" "home directory for"
19728 .cindex "home directory" "for router"
19729 .vindex "&$home$&"
19730 This option sets a home directory for use while the router is running. (Compare
19731 &%transport_home_directory%&, which sets a home directory for later
19732 transporting.) In particular, if used on a &(redirect)& router, this option
19733 sets a value for &$home$& while a filter is running. The value is expanded;
19734 forced expansion failure causes the option to be ignored &-- other failures
19735 cause the router to defer.
19736
19737 Expansion of &%router_home_directory%& happens immediately after the
19738 &%check_local_user%& test (if configured), before any further expansions take
19739 place.
19740 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19741 are evaluated.)
19742 While the router is running, &%router_home_directory%& overrides the value of
19743 &$home$& that came from &%check_local_user%&.
19744
19745 When a router accepts an address and assigns it to a local transport (including
19746 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19747 delivery), the home directory setting for the transport is taken from the first
19748 of these values that is set:
19749
19750 .ilist
19751 The &%home_directory%& option on the transport;
19752 .next
19753 The &%transport_home_directory%& option on the router;
19754 .next
19755 The password data if &%check_local_user%& is set on the router;
19756 .next
19757 The &%router_home_directory%& option on the router.
19758 .endlist
19759
19760 In other words, &%router_home_directory%& overrides the password data for the
19761 router, but not for the transport.
19762
19763
19764
19765 .option self routers string freeze
19766 .cindex "MX record" "pointing to local host"
19767 .cindex "local host" "MX pointing to"
19768 This option applies to those routers that use a recipient address to find a
19769 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19770 and &(manualroute)& routers.
19771 Certain configurations of the &(queryprogram)& router can also specify a list
19772 of remote hosts.
19773 Usually such routers are configured to send the message to a remote host via an
19774 &(smtp)& transport. The &%self%& option specifies what happens when the first
19775 host on the list turns out to be the local host.
19776 The way in which Exim checks for the local host is described in section
19777 &<<SECTreclocipadd>>&.
19778
19779 Normally this situation indicates either an error in Exim's configuration (for
19780 example, the router should be configured not to process this domain), or an
19781 error in the DNS (for example, the MX should not point to this host). For this
19782 reason, the default action is to log the incident, defer the address, and
19783 freeze the message. The following alternatives are provided for use in special
19784 cases:
19785
19786 .vlist
19787 .vitem &%defer%&
19788 Delivery of the message is tried again later, but the message is not frozen.
19789
19790 .vitem "&%reroute%&: <&'domain'&>"
19791 The domain is changed to the given domain, and the address is passed back to
19792 be reprocessed by the routers. No rewriting of headers takes place. This
19793 behaviour is essentially a redirection.
19794
19795 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19796 The domain is changed to the given domain, and the address is passed back to be
19797 reprocessed by the routers. Any headers that contain the original domain are
19798 rewritten.
19799
19800 .vitem &%pass%&
19801 .oindex "&%more%&"
19802 .vindex "&$self_hostname$&"
19803 The router passes the address to the next router, or to the router named in the
19804 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19805 subsequent routing and delivery, the variable &$self_hostname$& contains the
19806 name of the local host that the router encountered. This can be used to
19807 distinguish between different cases for hosts with multiple names. The
19808 combination
19809 .code
19810 self = pass
19811 no_more
19812 .endd
19813 ensures that only those addresses that routed to the local host are passed on.
19814 Without &%no_more%&, addresses that were declined for other reasons would also
19815 be passed to the next router.
19816
19817 .vitem &%fail%&
19818 Delivery fails and an error report is generated.
19819
19820 .vitem &%send%&
19821 .cindex "local host" "sending to"
19822 The anomaly is ignored and the address is queued for the transport. This
19823 setting should be used with extreme caution. For an &(smtp)& transport, it
19824 makes sense only in cases where the program that is listening on the SMTP port
19825 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19826 different configuration file that handles the domain in another way.
19827 .endlist
19828
19829
19830
19831 .option senders routers&!? "address list&!!" unset
19832 .cindex "router" "checking senders"
19833 If this option is set, the router is skipped unless the message's sender
19834 address matches something on the list.
19835 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19836 are evaluated.
19837
19838 There are issues concerning verification when the running of routers is
19839 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19840 setting, it sets the sender to the null string. When using the &%-bt%& option
19841 to check a configuration file, it is necessary also to use the &%-f%& option to
19842 set an appropriate sender. For incoming mail, the sender is unset when
19843 verifying the sender, but is available when verifying any recipients. If the
19844 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19845 matters.
19846
19847
19848 .option set routers "string list" unset
19849 .cindex router variables
19850 This option may be used multiple times on a router;
19851 because of this the list aspect is mostly irrelevant.
19852 The list separator is a semicolon but can be changed in the
19853 usual way.
19854
19855 Each list-element given must be of the form &"name = value"&
19856 and the names used must start with the string &"r_"&.
19857 Values containing a list-separator should have them doubled.
19858 When a router runs, the strings are evaluated in order,
19859 to create variables which are added to the set associated with
19860 the address.
19861 This is done immediately after all the preconditions, before the
19862 evaluation of the &%address_data%& option.
19863 The variable is set with the expansion of the value.
19864 The variables can be used by the router options
19865 (not including any preconditions)
19866 and by the transport.
19867 Later definitions of a given named variable will override former ones.
19868 Variable use is via the usual &$r_...$& syntax.
19869
19870 This is similar to the &%address_data%& option, except that
19871 many independent variables can be used, with choice of naming.
19872
19873
19874 .option translate_ip_address routers string&!! unset
19875 .cindex "IP address" "translating"
19876 .cindex "packet radio"
19877 .cindex "router" "IP address translation"
19878 There exist some rare networking situations (for example, packet radio) where
19879 it is helpful to be able to translate IP addresses generated by normal routing
19880 mechanisms into other IP addresses, thus performing a kind of manual IP
19881 routing. This should be done only if the normal IP routing of the TCP/IP stack
19882 is inadequate or broken. Because this is an extremely uncommon requirement, the
19883 code to support this option is not included in the Exim binary unless
19884 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19885
19886 .vindex "&$host_address$&"
19887 The &%translate_ip_address%& string is expanded for every IP address generated
19888 by the router, with the generated address set in &$host_address$&. If the
19889 expansion is forced to fail, no action is taken.
19890 For any other expansion error, delivery of the message is deferred.
19891 If the result of the expansion is an IP address, that replaces the original
19892 address; otherwise the result is assumed to be a host name &-- this is looked
19893 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19894 produce one or more replacement IP addresses. For example, to subvert all IP
19895 addresses in some specific networks, this could be added to a router:
19896 .code
19897 translate_ip_address = \
19898   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19899     {$value}fail}}
19900 .endd
19901 The file would contain lines like
19902 .code
19903 10.2.3.128/26    some.host
19904 10.8.4.34/26     10.44.8.15
19905 .endd
19906 You should not make use of this facility unless you really understand what you
19907 are doing.
19908
19909
19910
19911 .option transport routers string&!! unset
19912 This option specifies the transport to be used when a router accepts an address
19913 and sets it up for delivery. A transport is never needed if a router is used
19914 only for verification. The value of the option is expanded at routing time,
19915 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19916 and result must be the name of one of the configured transports. If it is not,
19917 delivery is deferred.
19918
19919 The &%transport%& option is not used by the &(redirect)& router, but it does
19920 have some private options that set up transports for pipe and file deliveries
19921 (see chapter &<<CHAPredirect>>&).
19922
19923
19924
19925 .option transport_current_directory routers string&!! unset
19926 .cindex "current directory for local transport"
19927 This option associates a current directory with any address that is routed
19928 to a local transport. This can happen either because a transport is
19929 explicitly configured for the router, or because it generates a delivery to a
19930 file or a pipe. During the delivery process (that is, at transport time), this
19931 option string is expanded and is set as the current directory, unless
19932 overridden by a setting on the transport.
19933 If the expansion fails for any reason, including forced failure, an error is
19934 logged, and delivery is deferred.
19935 See chapter &<<CHAPenvironment>>& for details of the local delivery
19936 environment.
19937
19938
19939
19940
19941 .option transport_home_directory routers string&!! "see below"
19942 .cindex "home directory" "for local transport"
19943 This option associates a home directory with any address that is routed to a
19944 local transport. This can happen either because a transport is explicitly
19945 configured for the router, or because it generates a delivery to a file or a
19946 pipe. During the delivery process (that is, at transport time), the option
19947 string is expanded and is set as the home directory, unless overridden by a
19948 setting of &%home_directory%& on the transport.
19949 If the expansion fails for any reason, including forced failure, an error is
19950 logged, and delivery is deferred.
19951
19952 If the transport does not specify a home directory, and
19953 &%transport_home_directory%& is not set for the router, the home directory for
19954 the transport is taken from the password data if &%check_local_user%& is set for
19955 the router. Otherwise it is taken from &%router_home_directory%& if that option
19956 is set; if not, no home directory is set for the transport.
19957
19958 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19959 environment.
19960
19961
19962
19963
19964 .option unseen routers boolean&!! false
19965 .cindex "router" "carrying on after success"
19966 The result of string expansion for this option must be a valid boolean value,
19967 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19968 result causes an error, and delivery is deferred. If the expansion is forced to
19969 fail, the default value for the option (false) is used. Other failures cause
19970 delivery to be deferred.
19971
19972 When this option is set true, routing does not cease if the router accepts the
19973 address. Instead, a copy of the incoming address is passed to the next router,
19974 overriding a false setting of &%more%&. There is little point in setting
19975 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19976 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19977 sometimes true and sometimes false).
19978
19979 .cindex "copy of message (&%unseen%& option)"
19980 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19981 qualifier in filter files. It can be used to cause copies of messages to be
19982 delivered to some other destination, while also carrying out a normal delivery.
19983 In effect, the current address is made into a &"parent"& that has two children
19984 &-- one that is delivered as specified by this router, and a clone that goes on
19985 to be routed further. For this reason, &%unseen%& may not be combined with the
19986 &%one_time%& option in a &(redirect)& router.
19987
19988 &*Warning*&: Header lines added to the address (or specified for removal) by
19989 this router or by previous routers affect the &"unseen"& copy of the message
19990 only. The clone that continues to be processed by further routers starts with
19991 no added headers and none specified for removal. For a &%redirect%& router, if
19992 a generated address is the same as the incoming address, this can lead to
19993 duplicate addresses with different header modifications. Exim does not do
19994 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19995 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19996 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19997 &%redirect%& router may be of help.
19998
19999 Unlike the handling of header modifications, any data that was set by the
20000 &%address_data%& option in the current or previous routers &'is'& passed on to
20001 subsequent routers.
20002
20003
20004 .option user routers string&!! "see below"
20005 .cindex "uid (user id)" "local delivery"
20006 .cindex "local transports" "uid and gid"
20007 .cindex "transport" "local"
20008 .cindex "router" "user for filter processing"
20009 .cindex "filter" "user for processing"
20010 When a router queues an address for a transport, and the transport does not
20011 specify a user, the user given here is used when running the delivery process.
20012 The user may be specified numerically or by name. If expansion fails, the
20013 error is logged and delivery is deferred.
20014 This user is also used by the &(redirect)& router when running a filter file.
20015 The default is unset, except when &%check_local_user%& is set. In this case,
20016 the default is taken from the password information. If the user is specified as
20017 a name, and &%group%& is not set, the group associated with the user is used.
20018 See also &%initgroups%& and &%group%& and the discussion in chapter
20019 &<<CHAPenvironment>>&.
20020
20021
20022
20023 .option verify routers&!? boolean true
20024 Setting this option has the effect of setting &%verify_sender%& and
20025 &%verify_recipient%& to the same value.
20026
20027
20028 .option verify_only routers&!? boolean false
20029 .cindex "EXPN" "with &%verify_only%&"
20030 .oindex "&%-bv%&"
20031 .cindex "router" "used only when verifying"
20032 If this option is set, the router is used only when verifying an address,
20033 delivering in cutthrough mode or
20034 testing with the &%-bv%& option, not when actually doing a delivery, testing
20035 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20036 restricted to verifying only senders or recipients by means of
20037 &%verify_sender%& and &%verify_recipient%&.
20038
20039 &*Warning*&: When the router is being run to verify addresses for an incoming
20040 SMTP message, Exim is not running as root, but under its own uid. If the router
20041 accesses any files, you need to make sure that they are accessible to the Exim
20042 user or group.
20043
20044
20045 .option verify_recipient routers&!? boolean true
20046 If this option is false, the router is skipped when verifying recipient
20047 addresses,
20048 delivering in cutthrough mode
20049 or testing recipient verification using &%-bv%&.
20050 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20051 are evaluated.
20052 See also the &$verify_mode$& variable.
20053
20054
20055 .option verify_sender routers&!? boolean true
20056 If this option is false, the router is skipped when verifying sender addresses
20057 or testing sender verification using &%-bvs%&.
20058 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20059 are evaluated.
20060 See also the &$verify_mode$& variable.
20061 .ecindex IIDgenoprou1
20062 .ecindex IIDgenoprou2
20063
20064
20065
20066
20067
20068
20069 . ////////////////////////////////////////////////////////////////////////////
20070 . ////////////////////////////////////////////////////////////////////////////
20071
20072 .chapter "The accept router" "CHID4"
20073 .cindex "&(accept)& router"
20074 .cindex "routers" "&(accept)&"
20075 The &(accept)& router has no private options of its own. Unless it is being
20076 used purely for verification (see &%verify_only%&) a transport is required to
20077 be defined by the generic &%transport%& option. If the preconditions that are
20078 specified by generic options are met, the router accepts the address and queues
20079 it for the given transport. The most common use of this router is for setting
20080 up deliveries to local mailboxes. For example:
20081 .code
20082 localusers:
20083   driver = accept
20084   domains = mydomain.example
20085   check_local_user
20086   transport = local_delivery
20087 .endd
20088 The &%domains%& condition in this example checks the domain of the address, and
20089 &%check_local_user%& checks that the local part is the login of a local user.
20090 When both preconditions are met, the &(accept)& router runs, and queues the
20091 address for the &(local_delivery)& transport.
20092
20093
20094
20095
20096
20097
20098 . ////////////////////////////////////////////////////////////////////////////
20099 . ////////////////////////////////////////////////////////////////////////////
20100
20101 .chapter "The dnslookup router" "CHAPdnslookup"
20102 .scindex IIDdnsrou1 "&(dnslookup)& router"
20103 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20104 The &(dnslookup)& router looks up the hosts that handle mail for the
20105 recipient's domain in the DNS. A transport must always be set for this router,
20106 unless &%verify_only%& is set.
20107
20108 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20109 SRV records. If none are found, or if SRV support is not configured,
20110 MX records are looked up. If no MX records exist, address records are sought.
20111 However, &%mx_domains%& can be set to disable the direct use of address
20112 records.
20113
20114 MX records of equal priority are sorted by Exim into a random order. Exim then
20115 looks for address records for the host names obtained from MX or SRV records.
20116 When a host has more than one IP address, they are sorted into a random order,
20117 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20118 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20119 generic option, the router declines.
20120
20121 Unless they have the highest priority (lowest MX value), MX records that point
20122 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20123 are discarded, together with any other MX records of equal or lower priority.
20124
20125 .cindex "MX record" "pointing to local host"
20126 .cindex "local host" "MX pointing to"
20127 .oindex "&%self%&" "in &(dnslookup)& router"
20128 If the host pointed to by the highest priority MX record, or looked up as an
20129 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20130 happens is controlled by the generic &%self%& option.
20131
20132
20133 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20134 There have been problems with DNS servers when SRV records are looked up.
20135 Some misbehaving servers return a DNS error or timeout when a non-existent
20136 SRV record is sought. Similar problems have in the past been reported for
20137 MX records. The global &%dns_again_means_nonexist%& option can help with this
20138 problem, but it is heavy-handed because it is a global option.
20139
20140 For this reason, there are two options, &%srv_fail_domains%& and
20141 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20142 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20143 an attempt to look up an SRV or MX record causes one of these results, and the
20144 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20145 such record"&. In the case of an SRV lookup, this means that the router
20146 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20147 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20148 case routing fails.
20149
20150
20151 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20152 .cindex "&(dnslookup)& router" "declines"
20153 There are a few cases where a &(dnslookup)& router will decline to accept
20154 an address; if such a router is expected to handle "all remaining non-local
20155 domains", then it is important to set &%no_more%&.
20156
20157 The router will defer rather than decline if the domain
20158 is found in the &%fail_defer_domains%& router option.
20159
20160 Reasons for a &(dnslookup)& router to decline currently include:
20161 .ilist
20162 The domain does not exist in DNS
20163 .next
20164 The domain exists but the MX record's host part is just "."; this is a common
20165 convention (borrowed from SRV) used to indicate that there is no such service
20166 for this domain and to not fall back to trying A/AAAA records.
20167 .next
20168 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20169 .next
20170 MX record points to a non-existent host.
20171 .next
20172 MX record points to an IP address and the main section option
20173 &%allow_mx_to_ip%& is not set.
20174 .next
20175 MX records exist and point to valid hosts, but all hosts resolve only to
20176 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20177 .next
20178 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20179 &%dns_check_names_pattern%& for handling one variant of this)
20180 .next
20181 &%check_secondary_mx%& is set on this router but the local host can
20182 not be found in the MX records (see below)
20183 .endlist
20184
20185
20186
20187
20188 .section "Private options for dnslookup" "SECID118"
20189 .cindex "options" "&(dnslookup)& router"
20190 The private options for the &(dnslookup)& router are as follows:
20191
20192 .option check_secondary_mx dnslookup boolean false
20193 .cindex "MX record" "checking for secondary"
20194 If this option is set, the router declines unless the local host is found in
20195 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20196 process domains for which the local host is a secondary mail exchanger
20197 differently to other domains. The way in which Exim decides whether a host is
20198 the local host is described in section &<<SECTreclocipadd>>&.
20199
20200
20201 .option check_srv dnslookup string&!! unset
20202 .cindex "SRV record" "enabling use of"
20203 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20204 addition to MX and address records. The support is disabled by default. To
20205 enable SRV support, set the &%check_srv%& option to the name of the service
20206 required. For example,
20207 .code
20208 check_srv = smtp
20209 .endd
20210 looks for SRV records that refer to the normal smtp service. The option is
20211 expanded, so the service name can vary from message to message or address
20212 to address. This might be helpful if SRV records are being used for a
20213 submission service. If the expansion is forced to fail, the &%check_srv%&
20214 option is ignored, and the router proceeds to look for MX records in the
20215 normal way.
20216
20217 When the expansion succeeds, the router searches first for SRV records for
20218 the given service (it assumes TCP protocol). A single SRV record with a
20219 host name that consists of just a single dot indicates &"no such service for
20220 this domain"&; if this is encountered, the router declines. If other kinds of
20221 SRV record are found, they are used to construct a host list for delivery
20222 according to the rules of RFC 2782. MX records are not sought in this case.
20223
20224 When no SRV records are found, MX records (and address records) are sought in
20225 the traditional way. In other words, SRV records take precedence over MX
20226 records, just as MX records take precedence over address records. Note that
20227 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20228 defined it. It is apparently believed that MX records are sufficient for email
20229 and that SRV records should not be used for this purpose. However, SRV records
20230 have an additional &"weight"& feature which some people might find useful when
20231 trying to split an SMTP load between hosts of different power.
20232
20233 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20234 when there is a DNS lookup error.
20235
20236
20237
20238
20239 .option fail_defer_domains dnslookup "domain list&!!" unset
20240 .cindex "MX record" "not found"
20241 DNS lookups for domains matching &%fail_defer_domains%&
20242 which find no matching record will cause the router to defer
20243 rather than the default behaviour of decline.
20244 This maybe be useful for queueing messages for a newly created
20245 domain while the DNS configuration is not ready.
20246 However, it will result in any message with mistyped domains
20247 also being queued.
20248
20249
20250 .option ipv4_only "string&!!" unset
20251 .cindex IPv6 disabling
20252 .cindex DNS "IPv6 disabling"
20253 The string is expanded, and if the result is anything but a forced failure,
20254 or an empty string, or one of the strings “0” or “no” or “false”
20255 (checked without regard to the case of the letters),
20256 only A records are used.
20257
20258 .option ipv4_prefer "string&!!" unset
20259 .cindex IPv4 preference
20260 .cindex DNS "IPv4 preference"
20261 The string is expanded, and if the result is anything but a forced failure,
20262 or an empty string, or one of the strings “0” or “no” or “false”
20263 (checked without regard to the case of the letters),
20264 A records are sorted before AAAA records (inverting the default).
20265
20266 .option mx_domains dnslookup "domain list&!!" unset
20267 .cindex "MX record" "required to exist"
20268 .cindex "SRV record" "required to exist"
20269 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20270 record in order to be recognized. (The name of this option could be improved.)
20271 For example, if all the mail hosts in &'fict.example'& are known to have MX
20272 records, except for those in &'discworld.fict.example'&, you could use this
20273 setting:
20274 .code
20275 mx_domains = ! *.discworld.fict.example : *.fict.example
20276 .endd
20277 This specifies that messages addressed to a domain that matches the list but
20278 has no MX record should be bounced immediately instead of being routed using
20279 the address record.
20280
20281
20282 .option mx_fail_domains dnslookup "domain list&!!" unset
20283 If the DNS lookup for MX records for one of the domains in this list causes a
20284 DNS lookup error, Exim behaves as if no MX records were found. See section
20285 &<<SECTprowitdnsloo>>& for more discussion.
20286
20287
20288
20289
20290 .option qualify_single dnslookup boolean true
20291 .cindex "DNS" "resolver options"
20292 .cindex "DNS" "qualifying single-component names"
20293 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20294 lookups. Typically, but not standardly, this causes the resolver to qualify
20295 single-component names with the default domain. For example, on a machine
20296 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20297 &'thesaurus.ref.example'& inside the resolver. For details of what your
20298 resolver actually does, consult your man pages for &'resolver'& and
20299 &'resolv.conf'&.
20300
20301
20302
20303 .option rewrite_headers dnslookup boolean true
20304 .cindex "rewriting" "header lines"
20305 .cindex "header lines" "rewriting"
20306 If the domain name in the address that is being processed is not fully
20307 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20308 an address is specified as &'dormouse@teaparty'&, the domain might be
20309 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20310 occur as a result of setting the &%widen_domains%& option. If
20311 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20312 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20313 header lines of the message are rewritten with the full domain name.
20314
20315 This option should be turned off only when it is known that no message is
20316 ever going to be sent outside an environment where the abbreviation makes
20317 sense.
20318
20319 When an MX record is looked up in the DNS and matches a wildcard record, name
20320 servers normally return a record containing the name that has been looked up,
20321 making it impossible to detect whether a wildcard was present or not. However,
20322 some name servers have recently been seen to return the wildcard entry. If the
20323 name returned by a DNS lookup begins with an asterisk, it is not used for
20324 header rewriting.
20325
20326
20327 .option same_domain_copy_routing dnslookup boolean false
20328 .cindex "address" "copying routing"
20329 Addresses with the same domain are normally routed by the &(dnslookup)& router
20330 to the same list of hosts. However, this cannot be presumed, because the router
20331 options and preconditions may refer to the local part of the address. By
20332 default, therefore, Exim routes each address in a message independently. DNS
20333 servers run caches, so repeated DNS lookups are not normally expensive, and in
20334 any case, personal messages rarely have more than a few recipients.
20335
20336 If you are running mailing lists with large numbers of subscribers at the same
20337 domain, and you are using a &(dnslookup)& router which is independent of the
20338 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20339 lookups for identical domains in one message. In this case, when &(dnslookup)&
20340 routes an address to a remote transport, any other unrouted addresses in the
20341 message that have the same domain are automatically given the same routing
20342 without processing them independently,
20343 provided the following conditions are met:
20344
20345 .ilist
20346 No router that processed the address specified &%headers_add%& or
20347 &%headers_remove%&.
20348 .next
20349 The router did not change the address in any way, for example, by &"widening"&
20350 the domain.
20351 .endlist
20352
20353
20354
20355
20356 .option search_parents dnslookup boolean false
20357 .cindex "DNS" "resolver options"
20358 When this option is true, the resolver option RES_DNSRCH is set for DNS
20359 lookups. This is different from the &%qualify_single%& option in that it
20360 applies to domains containing dots. Typically, but not standardly, it causes
20361 the resolver to search for the name in the current domain and in parent
20362 domains. For example, on a machine in the &'fict.example'& domain, if looking
20363 up &'teaparty.wonderland'& failed, the resolver would try
20364 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20365 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20366
20367 Setting this option true can cause problems in domains that have a wildcard MX
20368 record, because any domain that does not have its own MX record matches the
20369 local wildcard.
20370
20371
20372
20373 .option srv_fail_domains dnslookup "domain list&!!" unset
20374 If the DNS lookup for SRV records for one of the domains in this list causes a
20375 DNS lookup error, Exim behaves as if no SRV records were found. See section
20376 &<<SECTprowitdnsloo>>& for more discussion.
20377
20378
20379
20380
20381 .option widen_domains dnslookup "string list" unset
20382 .cindex "domain" "partial; widening"
20383 If a DNS lookup fails and this option is set, each of its strings in turn is
20384 added onto the end of the domain, and the lookup is tried again. For example,
20385 if
20386 .code
20387 widen_domains = fict.example:ref.example
20388 .endd
20389 is set and a lookup of &'klingon.dictionary'& fails,
20390 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20391 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20392 and &%search_parents%& options can cause some widening to be undertaken inside
20393 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20394 when verifying, unless &%rewrite_headers%& is false (not the default).
20395
20396
20397 .section "Effect of qualify_single and search_parents" "SECID119"
20398 When a domain from an envelope recipient is changed by the resolver as a result
20399 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20400 corresponding address in the message's header lines unless &%rewrite_headers%&
20401 is set false. Exim then re-routes the address, using the full domain.
20402
20403 These two options affect only the DNS lookup that takes place inside the router
20404 for the domain of the address that is being routed. They do not affect lookups
20405 such as that implied by
20406 .code
20407 domains = @mx_any
20408 .endd
20409 that may happen while processing a router precondition before the router is
20410 entered. No widening ever takes place for these lookups.
20411 .ecindex IIDdnsrou1
20412 .ecindex IIDdnsrou2
20413
20414
20415
20416
20417
20418
20419
20420
20421
20422 . ////////////////////////////////////////////////////////////////////////////
20423 . ////////////////////////////////////////////////////////////////////////////
20424
20425 .chapter "The ipliteral router" "CHID5"
20426 .cindex "&(ipliteral)& router"
20427 .cindex "domain literal" "routing"
20428 .cindex "routers" "&(ipliteral)&"
20429 This router has no private options. Unless it is being used purely for
20430 verification (see &%verify_only%&) a transport is required to be defined by the
20431 generic &%transport%& option. The router accepts the address if its domain part
20432 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20433 router handles the address
20434 .code
20435 root@[192.168.1.1]
20436 .endd
20437 by setting up delivery to the host with that IP address. IPv4 domain literals
20438 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20439 are similar, but the address is preceded by &`ipv6:`&. For example:
20440 .code
20441 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20442 .endd
20443 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20444 grounds that sooner or later somebody will try it.
20445
20446 .oindex "&%self%&" "in &(ipliteral)& router"
20447 If the IP address matches something in &%ignore_target_hosts%&, the router
20448 declines. If an IP literal turns out to refer to the local host, the generic
20449 &%self%& option determines what happens.
20450
20451 The RFCs require support for domain literals; however, their use is
20452 controversial in today's Internet. If you want to use this router, you must
20453 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20454 Exim will not recognize the domain literal syntax in addresses.
20455
20456
20457
20458 . ////////////////////////////////////////////////////////////////////////////
20459 . ////////////////////////////////////////////////////////////////////////////
20460
20461 .chapter "The iplookup router" "CHID6"
20462 .cindex "&(iplookup)& router"
20463 .cindex "routers" "&(iplookup)&"
20464 The &(iplookup)& router was written to fulfil a specific requirement in
20465 Cambridge University (which in fact no longer exists). For this reason, it is
20466 not included in the binary of Exim by default. If you want to include it, you
20467 must set
20468 .code
20469 ROUTER_IPLOOKUP=yes
20470 .endd
20471 in your &_Local/Makefile_& configuration file.
20472
20473 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20474 connection to one or more specific hosts. The host can then return the same or
20475 a different address &-- in effect rewriting the recipient address in the
20476 message's envelope. The new address is then passed on to subsequent routers. If
20477 this process fails, the address can be passed on to other routers, or delivery
20478 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20479 must not be specified for it.
20480
20481 .cindex "options" "&(iplookup)& router"
20482 .option hosts iplookup string unset
20483 This option must be supplied. Its value is a colon-separated list of host
20484 names. The hosts are looked up using &[gethostbyname()]&
20485 (or &[getipnodebyname()]& when available)
20486 and are tried in order until one responds to the query. If none respond, what
20487 happens is controlled by &%optional%&.
20488
20489
20490 .option optional iplookup boolean false
20491 If &%optional%& is true, if no response is obtained from any host, the address
20492 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20493 delivery to the address is deferred.
20494
20495
20496 .option port iplookup integer 0
20497 .cindex "port" "&(iplookup)& router"
20498 This option must be supplied. It specifies the port number for the TCP or UDP
20499 call.
20500
20501
20502 .option protocol iplookup string udp
20503 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20504 protocols is to be used.
20505
20506
20507 .option query iplookup string&!! "see below"
20508 This defines the content of the query that is sent to the remote hosts. The
20509 default value is:
20510 .code
20511 $local_part@$domain $local_part@$domain
20512 .endd
20513 The repetition serves as a way of checking that a response is to the correct
20514 query in the default case (see &%response_pattern%& below).
20515
20516
20517 .option reroute iplookup string&!! unset
20518 If this option is not set, the rerouted address is precisely the byte string
20519 returned by the remote host, up to the first white space, if any. If set, the
20520 string is expanded to form the rerouted address. It can include parts matched
20521 in the response by &%response_pattern%& by means of numeric variables such as
20522 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20523 whether or not a pattern is in use. In all cases, the rerouted address must end
20524 up in the form &'local_part@domain'&.
20525
20526
20527 .option response_pattern iplookup string unset
20528 This option can be set to a regular expression that is applied to the string
20529 returned from the remote host. If the pattern does not match the response, the
20530 router declines. If &%response_pattern%& is not set, no checking of the
20531 response is done, unless the query was defaulted, in which case there is a
20532 check that the text returned after the first white space is the original
20533 address. This checks that the answer that has been received is in response to
20534 the correct question. For example, if the response is just a new domain, the
20535 following could be used:
20536 .code
20537 response_pattern = ^([^@]+)$
20538 reroute = $local_part@$1
20539 .endd
20540
20541 .option timeout iplookup time 5s
20542 This specifies the amount of time to wait for a response from the remote
20543 machine. The same timeout is used for the &[connect()]& function for a TCP
20544 call. It does not apply to UDP.
20545
20546
20547
20548
20549 . ////////////////////////////////////////////////////////////////////////////
20550 . ////////////////////////////////////////////////////////////////////////////
20551
20552 .chapter "The manualroute router" "CHID7"
20553 .scindex IIDmanrou1 "&(manualroute)& router"
20554 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20555 .cindex "domain" "manually routing"
20556 The &(manualroute)& router is so-called because it provides a way of manually
20557 routing an address according to its domain. It is mainly used when you want to
20558 route addresses to remote hosts according to your own rules, bypassing the
20559 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20560 route to local transports, a facility that may be useful if you want to save
20561 messages for dial-in hosts in local files.
20562
20563 The &(manualroute)& router compares a list of domain patterns with the domain
20564 it is trying to route. If there is no match, the router declines. Each pattern
20565 has associated with it a list of hosts and some other optional data, which may
20566 include a transport. The combination of a pattern and its data is called a
20567 &"routing rule"&. For patterns that do not have an associated transport, the
20568 generic &%transport%& option must specify a transport, unless the router is
20569 being used purely for verification (see &%verify_only%&).
20570
20571 .vindex "&$host$&"
20572 In the case of verification, matching the domain pattern is sufficient for the
20573 router to accept the address. When actually routing an address for delivery,
20574 an address that matches a domain pattern is queued for the associated
20575 transport. If the transport is not a local one, a host list must be associated
20576 with the pattern; IP addresses are looked up for the hosts, and these are
20577 passed to the transport along with the mail address. For local transports, a
20578 host list is optional. If it is present, it is passed in &$host$& as a single
20579 text string.
20580
20581 The list of routing rules can be provided as an inline string in
20582 &%route_list%&, or the data can be obtained by looking up the domain in a file
20583 or database by setting &%route_data%&. Only one of these settings may appear in
20584 any one instance of &(manualroute)&. The format of routing rules is described
20585 below, following the list of private options.
20586
20587
20588 .section "Private options for manualroute" "SECTprioptman"
20589
20590 .cindex "options" "&(manualroute)& router"
20591 The private options for the &(manualroute)& router are as follows:
20592
20593 .option host_all_ignored manualroute string defer
20594 See &%host_find_failed%&.
20595
20596 .option host_find_failed manualroute string freeze
20597 This option controls what happens when &(manualroute)& tries to find an IP
20598 address for a host, and the host does not exist. The option can be set to one
20599 of the following values:
20600 .code
20601 decline
20602 defer
20603 fail
20604 freeze
20605 ignore
20606 pass
20607 .endd
20608 The default (&"freeze"&) assumes that this state is a serious configuration
20609 error. The difference between &"pass"& and &"decline"& is that the former
20610 forces the address to be passed to the next router (or the router defined by
20611 &%pass_router%&),
20612 .oindex "&%more%&"
20613 overriding &%no_more%&, whereas the latter passes the address to the next
20614 router only if &%more%& is true.
20615
20616 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20617 cannot be found. If all the hosts in the list are ignored, the behaviour is
20618 controlled by the &%host_all_ignored%& option. This takes the same values
20619 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20620
20621 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20622 state; if a host lookup gets a temporary error, delivery is deferred unless the
20623 generic &%pass_on_timeout%& option is set.
20624
20625
20626 .option hosts_randomize manualroute boolean false
20627 .cindex "randomized host list"
20628 .cindex "host" "list of; randomized"
20629 If this option is set, the order of the items in a host list in a routing rule
20630 is randomized each time the list is used, unless an option in the routing rule
20631 overrides (see below). Randomizing the order of a host list can be used to do
20632 crude load sharing. However, if more than one mail address is routed by the
20633 same router to the same host list, the host lists are considered to be the same
20634 (even though they may be randomized into different orders) for the purpose of
20635 deciding whether to batch the deliveries into a single SMTP transaction.
20636
20637 When &%hosts_randomize%& is true, a host list may be split
20638 into groups whose order is separately randomized. This makes it possible to
20639 set up MX-like behaviour. The boundaries between groups are indicated by an
20640 item that is just &`+`& in the host list. For example:
20641 .code
20642 route_list = * host1:host2:host3:+:host4:host5
20643 .endd
20644 The order of the first three hosts and the order of the last two hosts is
20645 randomized for each use, but the first three always end up before the last two.
20646 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20647 randomized host list is passed to an &(smtp)& transport that also has
20648 &%hosts_randomize set%&, the list is not re-randomized.
20649
20650
20651 .option route_data manualroute string&!! unset
20652 If this option is set, it must expand to yield the data part of a routing rule.
20653 Typically, the expansion string includes a lookup based on the domain. For
20654 example:
20655 .code
20656 route_data = ${lookup{$domain}dbm{/etc/routes}}
20657 .endd
20658 If the expansion is forced to fail, or the result is an empty string, the
20659 router declines. Other kinds of expansion failure cause delivery to be
20660 deferred.
20661
20662
20663 .option route_list manualroute "string list" unset
20664 This string is a list of routing rules, in the form defined below. Note that,
20665 unlike most string lists, the items are separated by semicolons. This is so
20666 that they may contain colon-separated host lists.
20667
20668
20669 .option same_domain_copy_routing manualroute boolean false
20670 .cindex "address" "copying routing"
20671 Addresses with the same domain are normally routed by the &(manualroute)&
20672 router to the same list of hosts. However, this cannot be presumed, because the
20673 router options and preconditions may refer to the local part of the address. By
20674 default, therefore, Exim routes each address in a message independently. DNS
20675 servers run caches, so repeated DNS lookups are not normally expensive, and in
20676 any case, personal messages rarely have more than a few recipients.
20677
20678 If you are running mailing lists with large numbers of subscribers at the same
20679 domain, and you are using a &(manualroute)& router which is independent of the
20680 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20681 lookups for identical domains in one message. In this case, when
20682 &(manualroute)& routes an address to a remote transport, any other unrouted
20683 addresses in the message that have the same domain are automatically given the
20684 same routing without processing them independently. However, this is only done
20685 if &%headers_add%& and &%headers_remove%& are unset.
20686
20687
20688
20689
20690 .section "Routing rules in route_list" "SECID120"
20691 The value of &%route_list%& is a string consisting of a sequence of routing
20692 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20693 entered as two semicolons. Alternatively, the list separator can be changed as
20694 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20695 Empty rules are ignored. The format of each rule is
20696 .display
20697 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20698 .endd
20699 The following example contains two rules, each with a simple domain pattern and
20700 no options:
20701 .code
20702 route_list = \
20703   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20704   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20705 .endd
20706 The three parts of a rule are separated by white space. The pattern and the
20707 list of hosts can be enclosed in quotes if necessary, and if they are, the
20708 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20709 single domain pattern, which is the only mandatory item in the rule. The
20710 pattern is in the same format as one item in a domain list (see section
20711 &<<SECTdomainlist>>&),
20712 except that it may not be the name of an interpolated file.
20713 That is, it may be wildcarded, or a regular expression, or a file or database
20714 lookup (with semicolons doubled, because of the use of semicolon as a separator
20715 in a &%route_list%&).
20716
20717 The rules in &%route_list%& are searched in order until one of the patterns
20718 matches the domain that is being routed. The list of hosts and then options are
20719 then used as described below. If there is no match, the router declines. When
20720 &%route_list%& is set, &%route_data%& must not be set.
20721
20722
20723
20724 .section "Routing rules in route_data" "SECID121"
20725 The use of &%route_list%& is convenient when there are only a small number of
20726 routing rules. For larger numbers, it is easier to use a file or database to
20727 hold the routing information, and use the &%route_data%& option instead.
20728 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20729 Most commonly, &%route_data%& is set as a string that contains an
20730 expansion lookup. For example, suppose we place two routing rules in a file
20731 like this:
20732 .code
20733 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20734 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20735 .endd
20736 This data can be accessed by setting
20737 .code
20738 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20739 .endd
20740 Failure of the lookup results in an empty string, causing the router to
20741 decline. However, you do not have to use a lookup in &%route_data%&. The only
20742 requirement is that the result of expanding the string is a list of hosts,
20743 possibly followed by options, separated by white space. The list of hosts must
20744 be enclosed in quotes if it contains white space.
20745
20746
20747
20748
20749 .section "Format of the list of hosts" "SECID122"
20750 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20751 always separately expanded before use. If the expansion fails, the router
20752 declines. The result of the expansion must be a colon-separated list of names
20753 and/or IP addresses, optionally also including ports.
20754 If the list is written with spaces, it must be protected with quotes.
20755 The format of each item
20756 in the list is described in the next section. The list separator can be changed
20757 as described in section &<<SECTlistsepchange>>&.
20758
20759 If the list of hosts was obtained from a &%route_list%& item, the following
20760 variables are set during its expansion:
20761
20762 .ilist
20763 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20764 If the domain was matched against a regular expression, the numeric variables
20765 &$1$&, &$2$&, etc. may be set. For example:
20766 .code
20767 route_list = ^domain(\d+)   host-$1.text.example
20768 .endd
20769 .next
20770 &$0$& is always set to the entire domain.
20771 .next
20772 &$1$& is also set when partial matching is done in a file lookup.
20773
20774 .next
20775 .vindex "&$value$&"
20776 If the pattern that matched the domain was a lookup item, the data that was
20777 looked up is available in the expansion variable &$value$&. For example:
20778 .code
20779 route_list = lsearch;;/some/file.routes  $value
20780 .endd
20781 .endlist
20782
20783 Note the doubling of the semicolon in the pattern that is necessary because
20784 semicolon is the default route list separator.
20785
20786
20787
20788 .section "Format of one host item" "SECTformatonehostitem"
20789 Each item in the list of hosts can be either a host name or an IP address,
20790 optionally with an attached port number, or it can be a single "+"
20791 (see &%hosts_randomize%&).
20792 When no port is given, an IP address
20793 is not enclosed in brackets. When a port is specified, it overrides the port
20794 specification on the transport. The port is separated from the name or address
20795 by a colon. This leads to some complications:
20796
20797 .ilist
20798 Because colon is the default separator for the list of hosts, either
20799 the colon that specifies a port must be doubled, or the list separator must
20800 be changed. The following two examples have the same effect:
20801 .code
20802 route_list = * "host1.tld::1225 : host2.tld::1226"
20803 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20804 .endd
20805 .next
20806 When IPv6 addresses are involved, it gets worse, because they contain
20807 colons of their own. To make this case easier, it is permitted to
20808 enclose an IP address (either v4 or v6) in square brackets if a port
20809 number follows. For example:
20810 .code
20811 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20812 .endd
20813 .endlist
20814
20815 .section "How the list of hosts is used" "SECThostshowused"
20816 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20817 the hosts is tried, in the order specified, when carrying out the SMTP
20818 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20819 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20820 transport.
20821
20822 Hosts may be listed by name or by IP address. An unadorned name in the list of
20823 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20824 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20825 records in the DNS. For example:
20826 .code
20827 route_list = *  x.y.z:p.q.r/MX:e.f.g
20828 .endd
20829 If this feature is used with a port specifier, the port must come last. For
20830 example:
20831 .code
20832 route_list = *  dom1.tld/mx::1225
20833 .endd
20834 If the &%hosts_randomize%& option is set, the order of the items in the list is
20835 randomized before any lookups are done. Exim then scans the list; for any name
20836 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20837 be an interface on the local host and the item is not the first in the list,
20838 Exim discards it and any subsequent items. If it is the first item, what
20839 happens is controlled by the
20840 .oindex "&%self%&" "in &(manualroute)& router"
20841 &%self%& option of the router.
20842
20843 A name on the list that is followed by &`/MX`& is replaced with the list of
20844 hosts obtained by looking up MX records for the name. This is always a DNS
20845 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20846 below) are not relevant here. The order of these hosts is determined by the
20847 preference values in the MX records, according to the usual rules. Because
20848 randomizing happens before the MX lookup, it does not affect the order that is
20849 defined by MX preferences.
20850
20851 If the local host is present in the sublist obtained from MX records, but is
20852 not the most preferred host in that list, it and any equally or less
20853 preferred hosts are removed before the sublist is inserted into the main list.
20854
20855 If the local host is the most preferred host in the MX list, what happens
20856 depends on where in the original list of hosts the &`/MX`& item appears. If it
20857 is not the first item (that is, there are previous hosts in the main list),
20858 Exim discards this name and any subsequent items in the main list.
20859
20860 If the MX item is first in the list of hosts, and the local host is the
20861 most preferred host, what happens is controlled by the &%self%& option of the
20862 router.
20863
20864 DNS failures when lookup up the MX records are treated in the same way as DNS
20865 failures when looking up IP addresses: &%pass_on_timeout%& and
20866 &%host_find_failed%& are used when relevant.
20867
20868 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20869 whether obtained from an MX lookup or not.
20870
20871
20872
20873 .section "How the options are used" "SECThowoptused"
20874 The options are a sequence of words, space-separated.
20875 One of the words can be the name of a transport; this overrides the
20876 &%transport%& option on the router for this particular routing rule only. The
20877 other words (if present) control randomization of the list of hosts on a
20878 per-rule basis, and how the IP addresses of the hosts are to be found when
20879 routing to a remote transport. These options are as follows:
20880
20881 .ilist
20882 &%randomize%&: randomize the order of the hosts in this list, overriding the
20883 setting of &%hosts_randomize%& for this routing rule only.
20884 .next
20885 &%no_randomize%&: do not randomize the order of the hosts in this list,
20886 overriding the setting of &%hosts_randomize%& for this routing rule only.
20887 .next
20888 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20889 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20890 also look in &_/etc/hosts_& or other sources of information.
20891 .next
20892 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20893 no address records are found. If there is a temporary DNS error (such as a
20894 timeout), delivery is deferred.
20895 .next
20896 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20897 .next
20898 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20899 .endlist
20900
20901 For example:
20902 .code
20903 route_list = domain1  host1:host2:host3  randomize bydns;\
20904              domain2  host4:host5
20905 .endd
20906 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20907 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20908 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20909 or &[gethostbyname()]&, and the result of the lookup is the result of that
20910 call.
20911
20912 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20913 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20914 instead of TRY_AGAIN. That is why the default action is to try a DNS
20915 lookup first. Only if that gives a definite &"no such host"& is the local
20916 function called.
20917
20918 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20919 inadvertent constraint that a transport name as an option had to be the last
20920 option specified.
20921
20922
20923
20924 If no IP address for a host can be found, what happens is controlled by the
20925 &%host_find_failed%& option.
20926
20927 .vindex "&$host$&"
20928 When an address is routed to a local transport, IP addresses are not looked up.
20929 The host list is passed to the transport in the &$host$& variable.
20930
20931
20932
20933 .section "Manualroute examples" "SECID123"
20934 In some of the examples that follow, the presence of the &%remote_smtp%&
20935 transport, as defined in the default configuration file, is assumed:
20936
20937 .ilist
20938 .cindex "smart host" "example router"
20939 The &(manualroute)& router can be used to forward all external mail to a
20940 &'smart host'&. If you have set up, in the main part of the configuration, a
20941 named domain list that contains your local domains, for example:
20942 .code
20943 domainlist local_domains = my.domain.example
20944 .endd
20945 You can arrange for all other domains to be routed to a smart host by making
20946 your first router something like this:
20947 .code
20948 smart_route:
20949   driver = manualroute
20950   domains = !+local_domains
20951   transport = remote_smtp
20952   route_list = * smarthost.ref.example
20953 .endd
20954 This causes all non-local addresses to be sent to the single host
20955 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20956 they are tried in order
20957 (but you can use &%hosts_randomize%& to vary the order each time).
20958 Another way of configuring the same thing is this:
20959 .code
20960 smart_route:
20961   driver = manualroute
20962   transport = remote_smtp
20963   route_list = !+local_domains  smarthost.ref.example
20964 .endd
20965 There is no difference in behaviour between these two routers as they stand.
20966 However, they behave differently if &%no_more%& is added to them. In the first
20967 example, the router is skipped if the domain does not match the &%domains%&
20968 precondition; the following router is always tried. If the router runs, it
20969 always matches the domain and so can never decline. Therefore, &%no_more%&
20970 would have no effect. In the second case, the router is never skipped; it
20971 always runs. However, if it doesn't match the domain, it declines. In this case
20972 &%no_more%& would prevent subsequent routers from running.
20973
20974 .next
20975 .cindex "mail hub example"
20976 A &'mail hub'& is a host which receives mail for a number of domains via MX
20977 records in the DNS and delivers it via its own private routing mechanism. Often
20978 the final destinations are behind a firewall, with the mail hub being the one
20979 machine that can connect to machines both inside and outside the firewall. The
20980 &(manualroute)& router is usually used on a mail hub to route incoming messages
20981 to the correct hosts. For a small number of domains, the routing can be inline,
20982 using the &%route_list%& option, but for a larger number a file or database
20983 lookup is easier to manage.
20984
20985 If the domain names are in fact the names of the machines to which the mail is
20986 to be sent by the mail hub, the configuration can be quite simple. For
20987 example:
20988 .code
20989 hub_route:
20990   driver = manualroute
20991   transport = remote_smtp
20992   route_list = *.rhodes.tvs.example  $domain
20993 .endd
20994 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20995 whose names are the same as the mail domains. A similar approach can be taken
20996 if the host name can be obtained from the domain name by a string manipulation
20997 that the expansion facilities can handle. Otherwise, a lookup based on the
20998 domain can be used to find the host:
20999 .code
21000 through_firewall:
21001   driver = manualroute
21002   transport = remote_smtp
21003   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21004 .endd
21005 The result of the lookup must be the name or IP address of the host (or
21006 hosts) to which the address is to be routed. If the lookup fails, the route
21007 data is empty, causing the router to decline. The address then passes to the
21008 next router.
21009
21010 .next
21011 .cindex "batched SMTP output example"
21012 .cindex "SMTP" "batched outgoing; example"
21013 You can use &(manualroute)& to deliver messages to pipes or files in batched
21014 SMTP format for onward transportation by some other means. This is one way of
21015 storing mail for a dial-up host when it is not connected. The route list entry
21016 can be as simple as a single domain name in a configuration like this:
21017 .code
21018 save_in_file:
21019   driver = manualroute
21020   transport = batchsmtp_appendfile
21021   route_list = saved.domain.example
21022 .endd
21023 though often a pattern is used to pick up more than one domain. If there are
21024 several domains or groups of domains with different transport requirements,
21025 different transports can be listed in the routing information:
21026 .code
21027 save_in_file:
21028   driver = manualroute
21029   route_list = \
21030     *.saved.domain1.example  $domain  batch_appendfile; \
21031     *.saved.domain2.example  \
21032       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21033       batch_pipe
21034 .endd
21035 .vindex "&$domain$&"
21036 .vindex "&$host$&"
21037 The first of these just passes the domain in the &$host$& variable, which
21038 doesn't achieve much (since it is also in &$domain$&), but the second does a
21039 file lookup to find a value to pass, causing the router to decline to handle
21040 the address if the lookup fails.
21041
21042 .next
21043 .cindex "UUCP" "example of router for"
21044 Routing mail directly to UUCP software is a specific case of the use of
21045 &(manualroute)& in a gateway to another mail environment. This is an example of
21046 one way it can be done:
21047 .code
21048 # Transport
21049 uucp:
21050   driver = pipe
21051   user = nobody
21052   command = /usr/local/bin/uux -r - \
21053     ${substr_-5:$host}!rmail ${local_part}
21054   return_fail_output = true
21055
21056 # Router
21057 uucphost:
21058   transport = uucp
21059   driver = manualroute
21060   route_data = \
21061     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21062 .endd
21063 The file &_/usr/local/exim/uucphosts_& contains entries like
21064 .code
21065 darksite.ethereal.example:           darksite.UUCP
21066 .endd
21067 It can be set up more simply without adding and removing &".UUCP"& but this way
21068 makes clear the distinction between the domain name
21069 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21070 .endlist
21071 .ecindex IIDmanrou1
21072 .ecindex IIDmanrou2
21073
21074
21075
21076
21077
21078
21079
21080
21081 . ////////////////////////////////////////////////////////////////////////////
21082 . ////////////////////////////////////////////////////////////////////////////
21083
21084 .chapter "The queryprogram router" "CHAPdriverlast"
21085 .scindex IIDquerou1 "&(queryprogram)& router"
21086 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21087 .cindex "routing" "by external program"
21088 The &(queryprogram)& router routes an address by running an external command
21089 and acting on its output. This is an expensive way to route, and is intended
21090 mainly for use in lightly-loaded systems, or for performing experiments.
21091 However, if it is possible to use the precondition options (&%domains%&,
21092 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21093 be used in special cases, even on a busy host. There are the following private
21094 options:
21095 .cindex "options" "&(queryprogram)& router"
21096
21097 .option command queryprogram string&!! unset
21098 This option must be set. It specifies the command that is to be run. The
21099 command is split up into a command name and arguments, and then each is
21100 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21101 &<<CHAPpipetransport>>&).
21102
21103
21104 .option command_group queryprogram string unset
21105 .cindex "gid (group id)" "in &(queryprogram)& router"
21106 This option specifies a gid to be set when running the command while routing an
21107 address for deliver. It must be set if &%command_user%& specifies a numerical
21108 uid. If it begins with a digit, it is interpreted as the numerical value of the
21109 gid. Otherwise it is looked up using &[getgrnam()]&.
21110
21111
21112 .option command_user queryprogram string unset
21113 .cindex "uid (user id)" "for &(queryprogram)&"
21114 This option must be set. It specifies the uid which is set when running the
21115 command while routing an address for delivery. If the value begins with a digit,
21116 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21117 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21118 not set, a value for the gid also.
21119
21120 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21121 root, which it does during a normal delivery in a conventional configuration.
21122 However, when an address is being verified during message reception, Exim is
21123 usually running as the Exim user, not as root. If the &(queryprogram)& router
21124 is called from a non-root process, Exim cannot change uid or gid before running
21125 the command. In this circumstance the command runs under the current uid and
21126 gid.
21127
21128
21129 .option current_directory queryprogram string /
21130 This option specifies an absolute path which is made the current directory
21131 before running the command.
21132
21133
21134 .option timeout queryprogram time 1h
21135 If the command does not complete within the timeout period, its process group
21136 is killed and the message is frozen. A value of zero time specifies no
21137 timeout.
21138
21139
21140 The standard output of the command is connected to a pipe, which is read when
21141 the command terminates. It should consist of a single line of output,
21142 containing up to five fields, separated by white space. The maximum length of
21143 the line is 1023 characters. Longer lines are silently truncated. The first
21144 field is one of the following words (case-insensitive):
21145
21146 .ilist
21147 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21148 below).
21149 .next
21150 &'Decline'&: the router declines; pass the address to the next router, unless
21151 &%no_more%& is set.
21152 .next
21153 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21154 subsequent text on the line is an error message. If the router is run as part
21155 of address verification during an incoming SMTP message, the message is
21156 included in the SMTP response.
21157 .next
21158 &'Defer'&: routing could not be completed at this time; try again later. Any
21159 subsequent text on the line is an error message which is logged. It is not
21160 included in any SMTP response.
21161 .next
21162 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21163 .next
21164 &'Pass'&: pass the address to the next router (or the router specified by
21165 &%pass_router%&), overriding &%no_more%&.
21166 .next
21167 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21168 new addresses, which are routed independently, starting with the first router,
21169 or the router specified by &%redirect_router%&, if set.
21170 .endlist
21171
21172 When the first word is &'accept'&, the remainder of the line consists of a
21173 number of keyed data values, as follows (split into two lines here, to fit on
21174 the page):
21175 .code
21176 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21177 LOOKUP=byname|bydns DATA=<text>
21178 .endd
21179 The data items can be given in any order, and all are optional. If no transport
21180 is included, the transport specified by the generic &%transport%& option is
21181 used. The list of hosts and the lookup type are needed only if the transport is
21182 an &(smtp)& transport that does not itself supply a list of hosts.
21183
21184 The format of the list of hosts is the same as for the &(manualroute)& router.
21185 As well as host names and IP addresses with optional port numbers, as described
21186 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21187 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21188 (see section &<<SECThostshowused>>&).
21189
21190 If the lookup type is not specified, Exim behaves as follows when trying to
21191 find an IP address for each host: First, a DNS lookup is done. If this yields
21192 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21193 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21194 result of the lookup is the result of that call.
21195
21196 .vindex "&$address_data$&"
21197 If the DATA field is set, its value is placed in the &$address_data$&
21198 variable. For example, this return line
21199 .code
21200 accept hosts=x1.y.example:x2.y.example data="rule1"
21201 .endd
21202 routes the address to the default transport, passing a list of two hosts. When
21203 the transport runs, the string &"rule1"& is in &$address_data$&.
21204 .ecindex IIDquerou1
21205 .ecindex IIDquerou2
21206
21207
21208
21209
21210 . ////////////////////////////////////////////////////////////////////////////
21211 . ////////////////////////////////////////////////////////////////////////////
21212
21213 .chapter "The redirect router" "CHAPredirect"
21214 .scindex IIDredrou1 "&(redirect)& router"
21215 .scindex IIDredrou2 "routers" "&(redirect)&"
21216 .cindex "alias file" "in a &(redirect)& router"
21217 .cindex "address redirection" "&(redirect)& router"
21218 The &(redirect)& router handles several kinds of address redirection. Its most
21219 common uses are for resolving local part aliases from a central alias file
21220 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21221 files, but it has many other potential uses. The incoming address can be
21222 redirected in several different ways:
21223
21224 .ilist
21225 It can be replaced by one or more new addresses which are themselves routed
21226 independently.
21227 .next
21228 It can be routed to be delivered to a given file or directory.
21229 .next
21230 It can be routed to be delivered to a specified pipe command.
21231 .next
21232 It can cause an automatic reply to be generated.
21233 .next
21234 It can be forced to fail, optionally with a custom error message.
21235 .next
21236 It can be temporarily deferred, optionally with a custom message.
21237 .next
21238 It can be discarded.
21239 .endlist
21240
21241 The generic &%transport%& option must not be set for &(redirect)& routers.
21242 However, there are some private options which define transports for delivery to
21243 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21244 &%pipe_transport%& and &%reply_transport%& descriptions below.
21245
21246 If success DSNs have been requested
21247 .cindex "DSN" "success"
21248 .cindex "Delivery Status Notification" "success"
21249 redirection triggers one and the DSN options are not passed any further.
21250
21251
21252
21253 .section "Redirection data" "SECID124"
21254 The router operates by interpreting a text string which it obtains either by
21255 expanding the contents of the &%data%& option, or by reading the entire
21256 contents of a file whose name is given in the &%file%& option. These two
21257 options are mutually exclusive. The first is commonly used for handling system
21258 aliases, in a configuration like this:
21259 .code
21260 system_aliases:
21261   driver = redirect
21262   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21263 .endd
21264 If the lookup fails, the expanded string in this example is empty. When the
21265 expansion of &%data%& results in an empty string, the router declines. A forced
21266 expansion failure also causes the router to decline; other expansion failures
21267 cause delivery to be deferred.
21268
21269 A configuration using &%file%& is commonly used for handling users'
21270 &_.forward_& files, like this:
21271 .code
21272 userforward:
21273   driver = redirect
21274   check_local_user
21275   file = $home/.forward
21276   no_verify
21277 .endd
21278 If the file does not exist, or causes no action to be taken (for example, it is
21279 empty or consists only of comments), the router declines. &*Warning*&: This
21280 is not the case when the file contains syntactically valid items that happen to
21281 yield empty addresses, for example, items containing only RFC 2822 address
21282 comments.
21283
21284 .cindex "tainted data" "in filenames"
21285 .cindex redirect "tainted data"
21286 Tainted data may not be used for a filename.
21287
21288 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21289 directly for redirection,
21290 as they are provided by a potential attacker.
21291 In the examples above, &$local_part$& is used for looking up data held locally
21292 on the system, and not used directly (the second example derives &$home$& via
21293 the passsword file or database, using &$local_part$&).
21294
21295
21296
21297 .section "Forward files and address verification" "SECID125"
21298 .cindex "address redirection" "while verifying"
21299 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21300 &_.forward_& files, as in the example above. There are two reasons for this:
21301
21302 .ilist
21303 When Exim is receiving an incoming SMTP message from a remote host, it is
21304 running under the Exim uid, not as root. Exim is unable to change uid to read
21305 the file as the user, and it may not be able to read it as the Exim user. So in
21306 practice the router may not be able to operate.
21307 .next
21308 However, even when the router can operate, the existence of a &_.forward_& file
21309 is unimportant when verifying an address. What should be checked is whether the
21310 local part is a valid user name or not. Cutting out the redirection processing
21311 saves some resources.
21312 .endlist
21313
21314
21315
21316
21317
21318
21319 .section "Interpreting redirection data" "SECID126"
21320 .cindex "Sieve filter" "specifying in redirection data"
21321 .cindex "filter" "specifying in redirection data"
21322 The contents of the data string, whether obtained from &%data%& or &%file%&,
21323 can be interpreted in two different ways:
21324
21325 .ilist
21326 If the &%allow_filter%& option is set true, and the data begins with the text
21327 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21328 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21329 respectively. Details of the syntax and semantics of filter files are described
21330 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21331 document is intended for use by end users.
21332 .next
21333 Otherwise, the data must be a comma-separated list of redirection items, as
21334 described in the next section.
21335 .endlist
21336
21337 When a message is redirected to a file (a &"mail folder"&), the filename given
21338 in a non-filter redirection list must always be an absolute path. A filter may
21339 generate a relative path &-- how this is handled depends on the transport's
21340 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21341 for the &(appendfile)& transport.
21342
21343
21344
21345 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21346 .cindex "address redirection" "non-filter list items"
21347 When the redirection data is not an Exim or Sieve filter, for example, if it
21348 comes from a conventional alias or forward file, it consists of a list of
21349 addresses, filenames, pipe commands, or certain special items (see section
21350 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21351 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21352 depending on their default values. The items in the list are separated by
21353 commas or newlines.
21354 If a comma is required in an item, the entire item must be enclosed in double
21355 quotes.
21356
21357 Lines starting with a # character are comments, and are ignored, and # may
21358 also appear following a comma, in which case everything between the # and the
21359 next newline character is ignored.
21360
21361 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21362 double quotes are retained because some forms of mail address require their use
21363 (but never to enclose the entire address). In the following description,
21364 &"item"& refers to what remains after any surrounding double quotes have been
21365 removed.
21366
21367 .vindex "&$local_part$&"
21368 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21369 and the expansion contains a reference to &$local_part$&, you should make use
21370 of the &%quote_local_part%& expansion operator, in case the local part contains
21371 special characters. For example, to redirect all mail for the domain
21372 &'obsolete.example'&, retaining the existing local part, you could use this
21373 setting:
21374 .code
21375 data = ${quote_local_part:$local_part}@newdomain.example
21376 .endd
21377
21378
21379 .section "Redirecting to a local mailbox" "SECTredlocmai"
21380 .cindex "routing" "loops in"
21381 .cindex "loop" "while routing, avoidance of"
21382 .cindex "address redirection" "to local mailbox"
21383 A redirection item may safely be the same as the address currently under
21384 consideration. This does not cause a routing loop, because a router is
21385 automatically skipped if any ancestor of the address that is being processed
21386 is the same as the current address and was processed by the current router.
21387 Such an address is therefore passed to the following routers, so it is handled
21388 as if there were no redirection. When making this loop-avoidance test, the
21389 complete local part, including any prefix or suffix, is used.
21390
21391 .cindex "address redirection" "local part without domain"
21392 Specifying the same local part without a domain is a common usage in personal
21393 filter files when the user wants to have messages delivered to the local
21394 mailbox and also forwarded elsewhere. For example, the user whose login is
21395 &'cleo'& might have a &_.forward_& file containing this:
21396 .code
21397 cleo, cleopatra@egypt.example
21398 .endd
21399 .cindex "backslash in alias file"
21400 .cindex "alias file" "backslash in"
21401 For compatibility with other MTAs, such unqualified local parts may be
21402 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21403 it does make a difference if more than one domain is being handled
21404 synonymously.
21405
21406 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21407 2822 address that does not include a domain, the item is qualified using the
21408 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21409 addresses are qualified using the value in &%qualify_recipient%&, but you can
21410 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21411
21412 Care must be taken if there are alias names for local users.
21413 Consider an MTA handling a single local domain where the system alias file
21414 contains:
21415 .code
21416 Sam.Reman: spqr
21417 .endd
21418 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21419 messages in the local mailbox, and also forward copies elsewhere. He creates
21420 this forward file:
21421 .code
21422 Sam.Reman, spqr@reme.elsewhere.example
21423 .endd
21424 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21425 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21426 second time round, because it has previously routed it,
21427 and the following routers presumably cannot handle the alias. The forward file
21428 should really contain
21429 .code
21430 spqr, spqr@reme.elsewhere.example
21431 .endd
21432 but because this is such a common error, the &%check_ancestor%& option (see
21433 below) exists to provide a way to get round it. This is normally set on a
21434 &(redirect)& router that is handling users' &_.forward_& files.
21435
21436
21437
21438 .section "Special items in redirection lists" "SECTspecitredli"
21439 In addition to addresses, the following types of item may appear in redirection
21440 lists (that is, in non-filter redirection data):
21441
21442 .ilist
21443 .cindex "pipe" "in redirection list"
21444 .cindex "address redirection" "to pipe"
21445 An item is treated as a pipe command if it begins with &"|"& and does not parse
21446 as a valid RFC 2822 address that includes a domain. A transport for running the
21447 command must be specified by the &%pipe_transport%& option.
21448 Normally, either the router or the transport specifies a user and a group under
21449 which to run the delivery. The default is to use the Exim user and group.
21450
21451 Single or double quotes can be used for enclosing the individual arguments of
21452 the pipe command; no interpretation of escapes is done for single quotes. If
21453 the command contains a comma character, it is necessary to put the whole item
21454 in double quotes, for example:
21455 .code
21456 "|/some/command ready,steady,go"
21457 .endd
21458 since items in redirection lists are terminated by commas. Do not, however,
21459 quote just the command. An item such as
21460 .code
21461 |"/some/command ready,steady,go"
21462 .endd
21463 is interpreted as a pipe with a rather strange command name, and no arguments.
21464
21465 Note that the above example assumes that the text comes from a lookup source
21466 of some sort, so that the quotes are part of the data.  If composing a
21467 redirect router with a &%data%& option directly specifying this command, the
21468 quotes will be used by the configuration parser to define the extent of one
21469 string, but will not be passed down into the redirect router itself.  There
21470 are two main approaches to get around this: escape quotes to be part of the
21471 data itself, or avoid using this mechanism and instead create a custom
21472 transport with the &%command%& option set and reference that transport from
21473 an &%accept%& router.
21474
21475 .next
21476 .cindex "file" "in redirection list"
21477 .cindex "address redirection" "to file"
21478 An item is interpreted as a path name if it begins with &"/"& and does not
21479 parse as a valid RFC 2822 address that includes a domain. For example,
21480 .code
21481 /home/world/minbari
21482 .endd
21483 is treated as a filename, but
21484 .code
21485 /s=molari/o=babylon/@x400gate.way
21486 .endd
21487 is treated as an address. For a filename, a transport must be specified using
21488 the &%file_transport%& option. However, if the generated path name ends with a
21489 forward slash character, it is interpreted as a directory name rather than a
21490 filename, and &%directory_transport%& is used instead.
21491
21492 Normally, either the router or the transport specifies a user and a group under
21493 which to run the delivery. The default is to use the Exim user and group.
21494
21495 .cindex "&_/dev/null_&"
21496 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21497 bypassed at a high level, and the log entry shows &"**bypassed**"&
21498 instead of a transport name. In this case the user and group are not used.
21499
21500 .next
21501 .cindex "included address list"
21502 .cindex "address redirection" "included external list"
21503 If an item is of the form
21504 .code
21505 :include:<path name>
21506 .endd
21507 a list of further items is taken from the given file and included at that
21508 point. &*Note*&: Such a file can not be a filter file; it is just an
21509 out-of-line addition to the list. The items in the included list are separated
21510 by commas or newlines and are not subject to expansion. If this is the first
21511 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21512 the alias name. This example is incorrect:
21513 .code
21514 list1    :include:/opt/lists/list1
21515 .endd
21516 It must be given as
21517 .code
21518 list1:   :include:/opt/lists/list1
21519 .endd
21520 .cindex "tainted data" "in filenames"
21521 .cindex redirect "tainted data"
21522 Tainted data may not be used for a filename.
21523 .next
21524 .cindex "address redirection" "to black hole"
21525 .cindex "delivery" "discard"
21526 .cindex "delivery" "blackhole"
21527 .cindex "black hole"
21528 .cindex "abandoning mail"
21529 Sometimes you want to throw away mail to a particular local part.  Making the
21530 &%data%& option expand to an empty string does not work, because that causes
21531 the router to decline. Instead, the alias item
21532 .code
21533 :blackhole:
21534 .endd
21535 can be used. It does what its name implies. No delivery is
21536 done, and no error message is generated. This has the same effect as specifying
21537 &_/dev/null_& as a destination, but it can be independently disabled.
21538
21539 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21540 delivery is done for the original local part, even if other redirection items
21541 are present. If you are generating a multi-item list (for example, by reading a
21542 database) and need the ability to provide a no-op item, you must use
21543 &_/dev/null_&.
21544
21545 .next
21546 .cindex "delivery" "forcing failure"
21547 .cindex "delivery" "forcing deferral"
21548 .cindex "failing delivery" "forcing"
21549 .cindex "deferred delivery, forcing"
21550 .cindex "customizing" "failure message"
21551 An attempt to deliver a particular address can be deferred or forced to fail by
21552 redirection items of the form
21553 .code
21554 :defer:
21555 :fail:
21556 .endd
21557 respectively. When a redirection list contains such an item, it applies
21558 to the entire redirection; any other items in the list are ignored. Any
21559 text following &':fail:'& or &':defer:'& is placed in the error text
21560 associated with the failure. For example, an alias file might contain:
21561 .code
21562 X.Employee:  :fail: Gone away, no forwarding address
21563 .endd
21564 In the case of an address that is being verified from an ACL or as the subject
21565 of a
21566 .cindex "VRFY" "error text, display of"
21567 VRFY command, the text is included in the SMTP error response by
21568 default.
21569 .cindex "EXPN" "error text, display of"
21570 The text is not included in the response to an EXPN command. In non-SMTP cases
21571 the text is included in the error message that Exim generates.
21572
21573 .cindex "SMTP" "error codes"
21574 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21575 &':fail:'&. However, if the message starts with three digits followed by a
21576 space, optionally followed by an extended code of the form &'n.n.n'&, also
21577 followed by a space, and the very first digit is the same as the default error
21578 code, the code from the message is used instead. If the very first digit is
21579 incorrect, a panic error is logged, and the default code is used. You can
21580 suppress the use of the supplied code in a redirect router by setting the
21581 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21582 ignored.
21583
21584 .vindex "&$acl_verify_message$&"
21585 In an ACL, an explicitly provided message overrides the default, but the
21586 default message is available in the variable &$acl_verify_message$& and can
21587 therefore be included in a custom message if this is desired.
21588
21589 Normally the error text is the rest of the redirection list &-- a comma does
21590 not terminate it &-- but a newline does act as a terminator. Newlines are not
21591 normally present in alias expansions. In &(lsearch)& lookups they are removed
21592 as part of the continuation process, but they may exist in other kinds of
21593 lookup and in &':include:'& files.
21594
21595 During routing for message delivery (as opposed to verification), a redirection
21596 containing &':fail:'& causes an immediate failure of the incoming address,
21597 whereas &':defer:'& causes the message to remain in the queue so that a
21598 subsequent delivery attempt can happen at a later time. If an address is
21599 deferred for too long, it will ultimately fail, because the normal retry
21600 rules still apply.
21601
21602 .next
21603 .cindex "alias file" "exception to default"
21604 Sometimes it is useful to use a single-key search type with a default (see
21605 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21606 for exceptions to the default. These can be handled by aliasing them to
21607 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21608 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21609 results in an empty redirection list has the same effect.
21610 .endlist
21611
21612
21613 .section "Duplicate addresses" "SECTdupaddr"
21614 .cindex "duplicate addresses"
21615 .cindex "address duplicate, discarding"
21616 .cindex "pipe" "duplicated"
21617 Exim removes duplicate addresses from the list to which it is delivering, so as
21618 to deliver just one copy to each address. This does not apply to deliveries
21619 routed to pipes by different immediate parent addresses, but an indirect
21620 aliasing scheme of the type
21621 .code
21622 pipe:       |/some/command $local_part
21623 localpart1: pipe
21624 localpart2: pipe
21625 .endd
21626 does not work with a message that is addressed to both local parts, because
21627 when the second is aliased to the intermediate local part &"pipe"& it gets
21628 discarded as being the same as a previously handled address. However, a scheme
21629 such as
21630 .code
21631 localpart1: |/some/command $local_part
21632 localpart2: |/some/command $local_part
21633 .endd
21634 does result in two different pipe deliveries, because the immediate parents of
21635 the pipes are distinct.
21636
21637
21638
21639 .section "Repeated redirection expansion" "SECID128"
21640 .cindex "repeated redirection expansion"
21641 .cindex "address redirection" "repeated for each delivery attempt"
21642 When a message cannot be delivered to all of its recipients immediately,
21643 leading to two or more delivery attempts, redirection expansion is carried out
21644 afresh each time for those addresses whose children were not all previously
21645 delivered. If redirection is being used as a mailing list, this can lead to new
21646 members of the list receiving copies of old messages. The &%one_time%& option
21647 can be used to avoid this.
21648
21649
21650 .section "Errors in redirection lists" "SECID129"
21651 .cindex "address redirection" "errors"
21652 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21653 error is skipped, and an entry is written to the main log. This may be useful
21654 for mailing lists that are automatically managed. Otherwise, if an error is
21655 detected while generating the list of new addresses, the original address is
21656 deferred. See also &%syntax_errors_to%&.
21657
21658
21659
21660 .section "Private options for the redirect router" "SECID130"
21661
21662 .cindex "options" "&(redirect)& router"
21663 The private options for the &(redirect)& router are as follows:
21664
21665
21666 .option allow_defer redirect boolean false
21667 Setting this option allows the use of &':defer:'& in non-filter redirection
21668 data, or the &%defer%& command in an Exim filter file.
21669
21670
21671 .option allow_fail redirect boolean false
21672 .cindex "failing delivery" "from filter"
21673 If this option is true, the &':fail:'& item can be used in a redirection list,
21674 and the &%fail%& command may be used in an Exim filter file.
21675
21676
21677 .option allow_filter redirect boolean false
21678 .cindex "filter" "enabling use of"
21679 .cindex "Sieve filter" "enabling use of"
21680 Setting this option allows Exim to interpret redirection data that starts with
21681 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21682 are some features of Exim filter files that some administrators may wish to
21683 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21684
21685 It is also possible to lock out Exim filters or Sieve filters while allowing
21686 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21687
21688
21689 The filter is run using the uid and gid set by the generic &%user%& and
21690 &%group%& options. These take their defaults from the password data if
21691 &%check_local_user%& is set, so in the normal case of users' personal filter
21692 files, the filter is run as the relevant user. When &%allow_filter%& is set
21693 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21694
21695
21696
21697 .option allow_freeze redirect boolean false
21698 .cindex "freezing messages" "allowing in filter"
21699 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21700 This command is more normally encountered in system filters, and is disabled by
21701 default for redirection filters because it isn't something you usually want to
21702 let ordinary users do.
21703
21704
21705
21706 .option check_ancestor redirect boolean false
21707 This option is concerned with handling generated addresses that are the same
21708 as some address in the list of redirection ancestors of the current address.
21709 Although it is turned off by default in the code, it is set in the default
21710 configuration file for handling users' &_.forward_& files. It is recommended
21711 for this use of the &(redirect)& router.
21712
21713 When &%check_ancestor%& is set, if a generated address (including the domain)
21714 is the same as any ancestor of the current address, it is replaced by a copy of
21715 the current address. This helps in the case where local part A is aliased to B,
21716 and B has a &_.forward_& file pointing back to A. For example, within a single
21717 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21718 &_&~jb/.forward_& contains:
21719 .code
21720 \Joe.Bloggs, <other item(s)>
21721 .endd
21722 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21723 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21724 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21725 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21726 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21727 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21728 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21729 original address. See also the &%repeat_use%& option below.
21730
21731
21732 .option check_group redirect boolean "see below"
21733 When the &%file%& option is used, the group owner of the file is checked only
21734 when this option is set. The permitted groups are those listed in the
21735 &%owngroups%& option, together with the user's default group if
21736 &%check_local_user%& is set. If the file has the wrong group, routing is
21737 deferred. The default setting for this option is true if &%check_local_user%&
21738 is set and the &%modemask%& option permits the group write bit, or if the
21739 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21740
21741
21742
21743 .option check_owner redirect boolean "see below"
21744 When the &%file%& option is used, the owner of the file is checked only when
21745 this option is set. If &%check_local_user%& is set, the local user is
21746 permitted; otherwise the owner must be one of those listed in the &%owners%&
21747 option. The default value for this option is true if &%check_local_user%& or
21748 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21749
21750
21751 .option data redirect string&!! unset
21752 This option is mutually exclusive with &%file%&. One or other of them must be
21753 set, but not both. The contents of &%data%& are expanded, and then used as the
21754 list of forwarding items, or as a set of filtering instructions. If the
21755 expansion is forced to fail, or the result is an empty string or a string that
21756 has no effect (consists entirely of comments), the router declines.
21757
21758 When filtering instructions are used, the string must begin with &"#Exim
21759 filter"&, and all comments in the string, including this initial one, must be
21760 terminated with newline characters. For example:
21761 .code
21762 data = #Exim filter\n\
21763        if $h_to: contains Exim then save $home/mail/exim endif
21764 .endd
21765 If you are reading the data from a database where newlines cannot be included,
21766 you can use the &${sg}$& expansion item to turn the escape string of your
21767 choice into a newline.
21768
21769
21770 .option directory_transport redirect string&!! unset
21771 A &(redirect)& router sets up a direct delivery to a directory when a path name
21772 ending with a slash is specified as a new &"address"&. The transport used is
21773 specified by this option, which, after expansion, must be the name of a
21774 configured transport. This should normally be an &(appendfile)& transport.
21775
21776
21777 .option file redirect string&!! unset
21778 This option specifies the name of a file that contains the redirection data. It
21779 is mutually exclusive with the &%data%& option. The string is expanded before
21780 use; if the expansion is forced to fail, the router declines. Other expansion
21781 failures cause delivery to be deferred. The result of a successful expansion
21782 must be an absolute path. The entire file is read and used as the redirection
21783 data. If the data is an empty string or a string that has no effect (consists
21784 entirely of comments), the router declines.
21785
21786 .cindex "NFS" "checking for file existence"
21787 If the attempt to open the file fails with a &"does not exist"& error, Exim
21788 runs a check on the containing directory,
21789 unless &%ignore_enotdir%& is true (see below).
21790 If the directory does not appear to exist, delivery is deferred. This can
21791 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21792 is a mount problem. If the containing directory does exist, but the file does
21793 not, the router declines.
21794
21795
21796 .option file_transport redirect string&!! unset
21797 .vindex "&$address_file$&"
21798 A &(redirect)& router sets up a direct delivery to a file when a path name not
21799 ending in a slash is specified as a new &"address"&. The transport used is
21800 specified by this option, which, after expansion, must be the name of a
21801 configured transport. This should normally be an &(appendfile)& transport. When
21802 it is running, the filename is in &$address_file$&.
21803
21804
21805 .option filter_prepend_home redirect boolean true
21806 When this option is true, if a &(save)& command in an Exim filter specifies a
21807 relative path, and &$home$& is defined, it is automatically prepended to the
21808 relative path. If this option is set false, this action does not happen. The
21809 relative path is then passed to the transport unmodified.
21810
21811
21812 .option forbid_blackhole redirect boolean false
21813 .cindex "restricting access to features"
21814 .cindex "filter" "locking out certain features"
21815 If this option is true, the &':blackhole:'& item may not appear in a
21816 redirection list.
21817
21818
21819 .option forbid_exim_filter redirect boolean false
21820 .cindex "restricting access to features"
21821 .cindex "filter" "locking out certain features"
21822 If this option is set true, only Sieve filters are permitted when
21823 &%allow_filter%& is true.
21824
21825
21826
21827
21828 .option forbid_file redirect boolean false
21829 .cindex "restricting access to features"
21830 .cindex "delivery" "to file; forbidding"
21831 .cindex "filter" "locking out certain features"
21832 .cindex "Sieve filter" "forbidding delivery to a file"
21833 .cindex "Sieve filter" "&""keep""& facility; disabling"
21834 If this option is true, this router may not generate a new address that
21835 specifies delivery to a local file or directory, either from a filter or from a
21836 conventional forward file. This option is forced to be true if &%one_time%& is
21837 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21838 locks out the Sieve's &"keep"& facility.
21839
21840
21841 .option forbid_filter_dlfunc redirect boolean false
21842 .cindex "restricting access to features"
21843 .cindex "filter" "locking out certain features"
21844 If this option is true, string expansions in Exim filters are not allowed to
21845 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21846 functions.
21847
21848 .option forbid_filter_existstest redirect boolean false
21849 .cindex "restricting access to features"
21850 .cindex "filter" "locking out certain features"
21851 .cindex "expansion" "statting a file"
21852 If this option is true, string expansions in Exim filters are not allowed to
21853 make use of the &%exists%& condition or the &%stat%& expansion item.
21854
21855 .option forbid_filter_logwrite redirect boolean false
21856 .cindex "restricting access to features"
21857 .cindex "filter" "locking out certain features"
21858 If this option is true, use of the logging facility in Exim filters is not
21859 permitted. Logging is in any case available only if the filter is being run
21860 under some unprivileged uid (which is normally the case for ordinary users'
21861 &_.forward_& files).
21862
21863
21864 .option forbid_filter_lookup redirect boolean false
21865 .cindex "restricting access to features"
21866 .cindex "filter" "locking out certain features"
21867 If this option is true, string expansions in Exim filter files are not allowed
21868 to make use of &%lookup%& items.
21869
21870
21871 .option forbid_filter_perl redirect boolean false
21872 .cindex "restricting access to features"
21873 .cindex "filter" "locking out certain features"
21874 This option has an effect only if Exim is built with embedded Perl support. If
21875 it is true, string expansions in Exim filter files are not allowed to make use
21876 of the embedded Perl support.
21877
21878
21879 .option forbid_filter_readfile redirect boolean false
21880 .cindex "restricting access to features"
21881 .cindex "filter" "locking out certain features"
21882 If this option is true, string expansions in Exim filter files are not allowed
21883 to make use of &%readfile%& items.
21884
21885
21886 .option forbid_filter_readsocket redirect boolean false
21887 .cindex "restricting access to features"
21888 .cindex "filter" "locking out certain features"
21889 If this option is true, string expansions in Exim filter files are not allowed
21890 to make use of &%readsocket%& items.
21891
21892
21893 .option forbid_filter_reply redirect boolean false
21894 .cindex "restricting access to features"
21895 .cindex "filter" "locking out certain features"
21896 If this option is true, this router may not generate an automatic reply
21897 message. Automatic replies can be generated only from Exim or Sieve filter
21898 files, not from traditional forward files. This option is forced to be true if
21899 &%one_time%& is set.
21900
21901
21902 .option forbid_filter_run redirect boolean false
21903 .cindex "restricting access to features"
21904 .cindex "filter" "locking out certain features"
21905 If this option is true, string expansions in Exim filter files are not allowed
21906 to make use of &%run%& items.
21907
21908
21909 .option forbid_include redirect boolean false
21910 .cindex "restricting access to features"
21911 .cindex "filter" "locking out certain features"
21912 If this option is true, items of the form
21913 .code
21914 :include:<path name>
21915 .endd
21916 are not permitted in non-filter redirection lists.
21917
21918
21919 .option forbid_pipe redirect boolean false
21920 .cindex "restricting access to features"
21921 .cindex "filter" "locking out certain features"
21922 .cindex "delivery" "to pipe; forbidding"
21923 If this option is true, this router may not generate a new address which
21924 specifies delivery to a pipe, either from an Exim filter or from a conventional
21925 forward file. This option is forced to be true if &%one_time%& is set.
21926
21927
21928 .option forbid_sieve_filter redirect boolean false
21929 .cindex "restricting access to features"
21930 .cindex "filter" "locking out certain features"
21931 If this option is set true, only Exim filters are permitted when
21932 &%allow_filter%& is true.
21933
21934
21935 .cindex "SMTP" "error codes"
21936 .option forbid_smtp_code redirect boolean false
21937 If this option is set true, any SMTP error codes that are present at the start
21938 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21939 the default codes (451 and 550, respectively) are always used.
21940
21941
21942
21943
21944 .option hide_child_in_errmsg redirect boolean false
21945 .cindex "bounce message" "redirection details; suppressing"
21946 If this option is true, it prevents Exim from quoting a child address if it
21947 generates a bounce or delay message for it. Instead it says &"an address
21948 generated from <&'the top level address'&>"&. Of course, this applies only to
21949 bounces generated locally. If a message is forwarded to another host, &'its'&
21950 bounce may well quote the generated address.
21951
21952
21953 .option ignore_eacces redirect boolean false
21954 .cindex "EACCES"
21955 If this option is set and an attempt to open a redirection file yields the
21956 EACCES error (permission denied), the &(redirect)& router behaves as if the
21957 file did not exist.
21958
21959
21960 .option ignore_enotdir redirect boolean false
21961 .cindex "ENOTDIR"
21962 If this option is set and an attempt to open a redirection file yields the
21963 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21964 router behaves as if the file did not exist.
21965
21966 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21967 router that has the &%file%& option set discovers that the file does not exist
21968 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21969 against unmounted NFS directories. If the parent can not be statted, delivery
21970 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21971 is set, because that option tells Exim to ignore &"something on the path is not
21972 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21973 that some operating systems give ENOENT where others give ENOTDIR.
21974
21975
21976
21977 .option include_directory redirect string unset
21978 If this option is set, the path names of any &':include:'& items in a
21979 redirection list must start with this directory.
21980
21981
21982 .option modemask redirect "octal integer" 022
21983 This specifies mode bits which must not be set for a file specified by the
21984 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21985
21986
21987 .option one_time redirect boolean false
21988 .cindex "one-time aliasing/forwarding expansion"
21989 .cindex "alias file" "one-time expansion"
21990 .cindex "forward file" "one-time expansion"
21991 .cindex "mailing lists" "one-time expansion"
21992 .cindex "address redirection" "one-time expansion"
21993 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21994 files each time it tries to deliver a message causes a problem when one or more
21995 of the generated addresses fails be delivered at the first attempt. The problem
21996 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21997 but of what happens when the redirection list changes during the time that the
21998 message is on Exim's queue. This is particularly true in the case of mailing
21999 lists, where new subscribers might receive copies of messages that were posted
22000 before they subscribed.
22001
22002 If &%one_time%& is set and any addresses generated by the router fail to
22003 deliver at the first attempt, the failing addresses are added to the message as
22004 &"top level"& addresses, and the parent address that generated them is marked
22005 &"delivered"&. Thus, redirection does not happen again at the next delivery
22006 attempt.
22007
22008 &*Warning 1*&: Any header line addition or removal that is specified by this
22009 router would be lost if delivery did not succeed at the first attempt. For this
22010 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22011 permitted when &%one_time%& is set.
22012
22013 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22014 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22015 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22016
22017 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22018 &%one_time%&.
22019
22020 The original top-level address is remembered with each of the generated
22021 addresses, and is output in any log messages. However, any intermediate parent
22022 addresses are not recorded. This makes a difference to the log only if
22023 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22024 typically be used for mailing lists, where there is normally just one level of
22025 expansion.
22026
22027
22028 .option owners redirect "string list" unset
22029 .cindex "ownership" "alias file"
22030 .cindex "ownership" "forward file"
22031 .cindex "alias file" "ownership"
22032 .cindex "forward file" "ownership"
22033 This specifies a list of permitted owners for the file specified by &%file%&.
22034 This list is in addition to the local user when &%check_local_user%& is set.
22035 See &%check_owner%& above.
22036
22037
22038 .option owngroups redirect "string list" unset
22039 This specifies a list of permitted groups for the file specified by &%file%&.
22040 The list is in addition to the local user's primary group when
22041 &%check_local_user%& is set. See &%check_group%& above.
22042
22043
22044 .option pipe_transport redirect string&!! unset
22045 .vindex "&$address_pipe$&"
22046 A &(redirect)& router sets up a direct delivery to a pipe when a string
22047 starting with a vertical bar character is specified as a new &"address"&. The
22048 transport used is specified by this option, which, after expansion, must be the
22049 name of a configured transport. This should normally be a &(pipe)& transport.
22050 When the transport is run, the pipe command is in &$address_pipe$&.
22051
22052
22053 .option qualify_domain redirect string&!! unset
22054 .vindex "&$qualify_recipient$&"
22055 If this option is set, and an unqualified address (one without a domain) is
22056 generated, and that address would normally be qualified by the global setting
22057 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22058 expanding this string. If the expansion fails, the router declines. If you want
22059 to revert to the default, you can have the expansion generate
22060 &$qualify_recipient$&.
22061
22062 This option applies to all unqualified addresses generated by Exim filters,
22063 but for traditional &_.forward_& files, it applies only to addresses that are
22064 not preceded by a backslash. Sieve filters cannot generate unqualified
22065 addresses.
22066
22067 .option qualify_preserve_domain redirect boolean false
22068 .cindex "domain" "in redirection; preserving"
22069 .cindex "preserving domain in redirection"
22070 .cindex "address redirection" "domain; preserving"
22071 If this option is set, the router's local &%qualify_domain%& option must not be
22072 set (a configuration error occurs if it is). If an unqualified address (one
22073 without a domain) is generated, it is qualified with the domain of the parent
22074 address (the immediately preceding ancestor) instead of the global
22075 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22076 this applies whether or not the address is preceded by a backslash.
22077
22078
22079 .option repeat_use redirect boolean true
22080 If this option is set false, the router is skipped for a child address that has
22081 any ancestor that was routed by this router. This test happens before any of
22082 the other preconditions are tested. Exim's default anti-looping rules skip
22083 only when the ancestor is the same as the current address. See also
22084 &%check_ancestor%& above and the generic &%redirect_router%& option.
22085
22086
22087 .option reply_transport redirect string&!! unset
22088 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22089 &%vacation%& command is used in a filter file. The transport used is specified
22090 by this option, which, after expansion, must be the name of a configured
22091 transport. This should normally be an &(autoreply)& transport. Other transports
22092 are unlikely to do anything sensible or useful.
22093
22094
22095 .option rewrite redirect boolean true
22096 .cindex "address redirection" "disabling rewriting"
22097 If this option is set false, addresses generated by the router are not
22098 subject to address rewriting. Otherwise, they are treated like new addresses
22099 and are rewritten according to the global rewriting rules.
22100
22101
22102 .option sieve_subaddress redirect string&!! unset
22103 The value of this option is passed to a Sieve filter to specify the
22104 :subaddress part of an address.
22105
22106 .option sieve_useraddress redirect string&!! unset
22107 The value of this option is passed to a Sieve filter to specify the :user part
22108 of an address. However, if it is unset, the entire original local part
22109 (including any prefix or suffix) is used for :user.
22110
22111
22112 .option sieve_vacation_directory redirect string&!! unset
22113 .cindex "Sieve filter" "vacation directory"
22114 To enable the &"vacation"& extension for Sieve filters, you must set
22115 &%sieve_vacation_directory%& to the directory where vacation databases are held
22116 (do not put anything else in that directory), and ensure that the
22117 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22118 needs their own directory; Exim will create it if necessary.
22119
22120
22121
22122 .option skip_syntax_errors redirect boolean false
22123 .cindex "forward file" "broken"
22124 .cindex "address redirection" "broken files"
22125 .cindex "alias file" "broken"
22126 .cindex "broken alias or forward files"
22127 .cindex "ignoring faulty addresses"
22128 .cindex "skipping faulty addresses"
22129 .cindex "error" "skipping bad syntax"
22130 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22131 non-filter redirection data are skipped, and each failing address is logged. If
22132 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22133 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22134 are expanded and placed at the head of the error message generated by
22135 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22136 be the same address as the generic &%errors_to%& option. The
22137 &%skip_syntax_errors%& option is often used when handling mailing lists.
22138
22139 If all the addresses in a redirection list are skipped because of syntax
22140 errors, the router declines to handle the original address, and it is passed to
22141 the following routers.
22142
22143 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22144 error in the filter causes filtering to be abandoned without any action being
22145 taken. The incident is logged, and the router declines to handle the address,
22146 so it is passed to the following routers.
22147
22148 .cindex "Sieve filter" "syntax errors in"
22149 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22150 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22151 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22152
22153 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22154 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22155 option, used with an address that does not get redirected, can be used to
22156 notify users of these errors, by means of a router like this:
22157 .code
22158 userforward:
22159   driver = redirect
22160   allow_filter
22161   check_local_user
22162   file = $home/.forward
22163   file_transport = address_file
22164   pipe_transport = address_pipe
22165   reply_transport = address_reply
22166   no_verify
22167   skip_syntax_errors
22168   syntax_errors_to = real-$local_part@$domain
22169   syntax_errors_text = \
22170    This is an automatically generated message. An error has\n\
22171    been found in your .forward file. Details of the error are\n\
22172    reported below. While this error persists, you will receive\n\
22173    a copy of this message for every message that is addressed\n\
22174    to you. If your .forward file is a filter file, or if it is\n\
22175    a non-filter file containing no valid forwarding addresses,\n\
22176    a copy of each incoming message will be put in your normal\n\
22177    mailbox. If a non-filter file contains at least one valid\n\
22178    forwarding address, forwarding to the valid addresses will\n\
22179    happen, and those will be the only deliveries that occur.
22180 .endd
22181 You also need a router to ensure that local addresses that are prefixed by
22182 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22183 put this immediately before the &(userforward)& router:
22184 .code
22185 real_localuser:
22186   driver = accept
22187   check_local_user
22188   local_part_prefix = real-
22189   transport = local_delivery
22190 .endd
22191 For security, it would probably be a good idea to restrict the use of this
22192 router to locally-generated messages, using a condition such as this:
22193 .code
22194   condition = ${if match {$sender_host_address}\
22195                          {\N^(|127\.0\.0\.1)$\N}}
22196 .endd
22197
22198
22199 .option syntax_errors_text redirect string&!! unset
22200 See &%skip_syntax_errors%& above.
22201
22202
22203 .option syntax_errors_to redirect string unset
22204 See &%skip_syntax_errors%& above.
22205 .ecindex IIDredrou1
22206 .ecindex IIDredrou2
22207
22208
22209
22210
22211
22212
22213 . ////////////////////////////////////////////////////////////////////////////
22214 . ////////////////////////////////////////////////////////////////////////////
22215
22216 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22217          "Environment for local transports"
22218 .scindex IIDenvlotra1 "local transports" "environment for"
22219 .scindex IIDenvlotra2 "environment" "local transports"
22220 .scindex IIDenvlotra3 "transport" "local; environment for"
22221 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22222 transport can be thought of as similar to a pipe.) Exim always runs transports
22223 in subprocesses, under specified uids and gids. Typical deliveries to local
22224 mailboxes run under the uid and gid of the local user.
22225
22226 Exim also sets a specific current directory while running the transport; for
22227 some transports a home directory setting is also relevant. The &(pipe)&
22228 transport is the only one that sets up environment variables; see section
22229 &<<SECTpipeenv>>& for details.
22230
22231 The values used for the uid, gid, and the directories may come from several
22232 different places. In many cases, the router that handles the address associates
22233 settings with that address as a result of its &%check_local_user%&, &%group%&,
22234 or &%user%& options. However, values may also be given in the transport's own
22235 configuration, and these override anything that comes from the router.
22236
22237
22238
22239 .section "Concurrent deliveries" "SECID131"
22240 .cindex "concurrent deliveries"
22241 .cindex "simultaneous deliveries"
22242 If two different messages for the same local recipient arrive more or less
22243 simultaneously, the two delivery processes are likely to run concurrently. When
22244 the &(appendfile)& transport is used to write to a file, Exim applies locking
22245 rules to stop concurrent processes from writing to the same file at the same
22246 time.
22247
22248 However, when you use a &(pipe)& transport, it is up to you to arrange any
22249 locking that is needed. Here is a silly example:
22250 .code
22251 my_transport:
22252   driver = pipe
22253   command = /bin/sh -c 'cat >>/some/file'
22254 .endd
22255 This is supposed to write the message at the end of the file. However, if two
22256 messages arrive at the same time, the file will be scrambled. You can use the
22257 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22258 file using the same algorithm that Exim itself uses.
22259
22260
22261
22262
22263 .section "Uids and gids" "SECTenvuidgid"
22264 .cindex "local transports" "uid and gid"
22265 .cindex "transport" "local; uid and gid"
22266 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22267 overrides any group that the router set in the address, even if &%user%& is not
22268 set for the transport. This makes it possible, for example, to run local mail
22269 delivery under the uid of the recipient (set by the router), but in a special
22270 group (set by the transport). For example:
22271 .code
22272 # Routers ...
22273 # User/group are set by check_local_user in this router
22274 local_users:
22275   driver = accept
22276   check_local_user
22277   transport = group_delivery
22278
22279 # Transports ...
22280 # This transport overrides the group
22281 group_delivery:
22282   driver = appendfile
22283   file = /var/spool/mail/$local_part_data
22284   group = mail
22285 .endd
22286 If &%user%& is set for a transport, its value overrides what is set in the
22287 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22288 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22289 set.
22290
22291 .oindex "&%initgroups%&"
22292 When the uid is taken from the transport's configuration, the &[initgroups()]&
22293 function is called for the groups associated with that uid if the
22294 &%initgroups%& option is set for the transport. When the uid is not specified
22295 by the transport, but is associated with the address by a router, the option
22296 for calling &[initgroups()]& is taken from the router configuration.
22297
22298 .cindex "&(pipe)& transport" "uid for"
22299 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22300 is set and &%user%& is not set, the uid of the process that called Exim to
22301 receive the message is used, and if &%group%& is not set, the corresponding
22302 original gid is also used.
22303
22304 This is the detailed preference order for obtaining a gid; the first of the
22305 following that is set is used:
22306
22307 .ilist
22308 A &%group%& setting of the transport;
22309 .next
22310 A &%group%& setting of the router;
22311 .next
22312 A gid associated with a user setting of the router, either as a result of
22313 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22314 .next
22315 The group associated with a non-numeric &%user%& setting of the transport;
22316 .next
22317 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22318 the uid is the creator's uid;
22319 .next
22320 The Exim gid if the Exim uid is being used as a default.
22321 .endlist
22322
22323 If, for example, the user is specified numerically on the router and there are
22324 no group settings, no gid is available. In this situation, an error occurs.
22325 This is different for the uid, for which there always is an ultimate default.
22326 The first of the following that is set is used:
22327
22328 .ilist
22329 A &%user%& setting of the transport;
22330 .next
22331 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22332 .next
22333 A &%user%& setting of the router;
22334 .next
22335 A &%check_local_user%& setting of the router;
22336 .next
22337 The Exim uid.
22338 .endlist
22339
22340 Of course, an error will still occur if the uid that is chosen is on the
22341 &%never_users%& list.
22342
22343
22344
22345
22346
22347 .section "Current and home directories" "SECID132"
22348 .cindex "current directory for local transport"
22349 .cindex "home directory" "for local transport"
22350 .cindex "transport" "local; home directory for"
22351 .cindex "transport" "local; current directory for"
22352 Routers may set current and home directories for local transports by means of
22353 the &%transport_current_directory%& and &%transport_home_directory%& options.
22354 However, if the transport's &%current_directory%& or &%home_directory%& options
22355 are set, they override the router's values. In detail, the home directory
22356 for a local transport is taken from the first of these values that is set:
22357
22358 .ilist
22359 The &%home_directory%& option on the transport;
22360 .next
22361 The &%transport_home_directory%& option on the router;
22362 .next
22363 The password data if &%check_local_user%& is set on the router;
22364 .next
22365 The &%router_home_directory%& option on the router.
22366 .endlist
22367
22368 The current directory is taken from the first of these values that is set:
22369
22370 .ilist
22371 The &%current_directory%& option on the transport;
22372 .next
22373 The &%transport_current_directory%& option on the router.
22374 .endlist
22375
22376
22377 If neither the router nor the transport sets a current directory, Exim uses the
22378 value of the home directory, if it is set. Otherwise it sets the current
22379 directory to &_/_& before running a local transport.
22380
22381
22382
22383 .section "Expansion variables derived from the address" "SECID133"
22384 .vindex "&$domain$&"
22385 .vindex "&$local_part$&"
22386 .vindex "&$original_domain$&"
22387 Normally a local delivery is handling a single address, and in that case the
22388 variables such as &$domain$& and &$local_part$& are set during local
22389 deliveries. However, in some circumstances more than one address may be handled
22390 at once (for example, while writing batch SMTP for onward transmission by some
22391 other means). In this case, the variables associated with the local part are
22392 never set, &$domain$& is set only if all the addresses have the same domain,
22393 and &$original_domain$& is never set.
22394 .ecindex IIDenvlotra1
22395 .ecindex IIDenvlotra2
22396 .ecindex IIDenvlotra3
22397
22398
22399
22400
22401
22402
22403
22404 . ////////////////////////////////////////////////////////////////////////////
22405 . ////////////////////////////////////////////////////////////////////////////
22406
22407 .chapter "Generic options for transports" "CHAPtransportgeneric"
22408 .scindex IIDgenoptra1 "generic options" "transport"
22409 .scindex IIDgenoptra2 "options" "generic; for transports"
22410 .scindex IIDgenoptra3 "transport" "generic options for"
22411 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22412 prior to Exim 4.95 names would be silently truncated at this length, but now
22413 it is enforced.
22414
22415 The following generic options apply to all transports:
22416
22417
22418 .option body_only transports boolean false
22419 .cindex "transport" "body only"
22420 .cindex "message" "transporting body only"
22421 .cindex "body of message" "transporting"
22422 If this option is set, the message's headers are not transported. It is
22423 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22424 or &(pipe)& transports, the settings of &%message_prefix%& and
22425 &%message_suffix%& should be checked, because this option does not
22426 automatically suppress them.
22427
22428
22429 .option current_directory transports string&!! unset
22430 .cindex "transport" "current directory for"
22431 This specifies the current directory that is to be set while running the
22432 transport, overriding any value that may have been set by the router.
22433 If the expansion fails for any reason, including forced failure, an error is
22434 logged, and delivery is deferred.
22435
22436
22437 .option disable_logging transports boolean false
22438 If this option is set true, nothing is logged for any
22439 deliveries by the transport or for any
22440 transport errors. You should not set this option unless you really, really know
22441 what you are doing.
22442
22443
22444 .option debug_print transports string&!! unset
22445 .cindex "testing" "variables in drivers"
22446 If this option is set and debugging is enabled (see the &%-d%& command line
22447 option), the string is expanded and included in the debugging output when the
22448 transport is run.
22449 If expansion of the string fails, the error message is written to the debugging
22450 output, and Exim carries on processing.
22451 This facility is provided to help with checking out the values of variables and
22452 so on when debugging driver configurations. For example, if a &%headers_add%&
22453 option is not working properly, &%debug_print%& could be used to output the
22454 variables it references. A newline is added to the text if it does not end with
22455 one.
22456 The variables &$transport_name$& and &$router_name$& contain the name of the
22457 transport and the router that called it.
22458
22459 .option delivery_date_add transports boolean false
22460 .cindex "&'Delivery-date:'& header line"
22461 If this option is true, a &'Delivery-date:'& header is added to the message.
22462 This gives the actual time the delivery was made. As this is not a standard
22463 header, Exim has a configuration option (&%delivery_date_remove%&) which
22464 requests its removal from incoming messages, so that delivered messages can
22465 safely be resent to other recipients.
22466
22467
22468 .option driver transports string unset
22469 This specifies which of the available transport drivers is to be used.
22470 There is no default, and this option must be set for every transport.
22471
22472
22473 .option envelope_to_add transports boolean false
22474 .cindex "&'Envelope-to:'& header line"
22475 If this option is true, an &'Envelope-to:'& header is added to the message.
22476 This gives the original address(es) in the incoming envelope that caused this
22477 delivery to happen. More than one address may be present if the transport is
22478 configured to handle several addresses at once, or if more than one original
22479 address was redirected to the same final address. As this is not a standard
22480 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22481 its removal from incoming messages, so that delivered messages can safely be
22482 resent to other recipients.
22483
22484 &*Note:*& If used on a transport handling multiple recipients
22485 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22486 transport if &%batch_max%& is greater than 1)
22487 then information about Bcc recipients will be leaked.
22488 Doing so is generally not advised.
22489
22490
22491 .option event_action transports string&!! unset
22492 .cindex events
22493 This option declares a string to be expanded for Exim's events mechanism.
22494 For details see chapter &<<CHAPevents>>&.
22495
22496
22497 .option group transports string&!! "Exim group"
22498 .cindex "transport" "group; specifying"
22499 This option specifies a gid for running the transport process, overriding any
22500 value that the router supplies, and also overriding any value associated with
22501 &%user%& (see below).
22502
22503
22504 .option headers_add transports list&!! unset
22505 .cindex "header lines" "adding in transport"
22506 .cindex "transport" "header lines; adding"
22507 This option specifies a list of text headers,
22508 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22509 which are (separately) expanded and added to the header
22510 portion of a message as it is transported, as described in section
22511 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22512 routers. If the result of the expansion is an empty string, or if the expansion
22513 is forced to fail, no action is taken. Other expansion failures are treated as
22514 errors and cause the delivery to be deferred.
22515
22516 Unlike most options, &%headers_add%& can be specified multiple times
22517 for a transport; all listed headers are added.
22518
22519
22520 .option headers_only transports boolean false
22521 .cindex "transport" "header lines only"
22522 .cindex "message" "transporting headers only"
22523 .cindex "header lines" "transporting"
22524 If this option is set, the message's body is not transported. It is mutually
22525 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22526 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22527 checked, since this option does not automatically suppress them.
22528
22529
22530 .option headers_remove transports list&!! unset
22531 .cindex "header lines" "removing"
22532 .cindex "transport" "header lines; removing"
22533 This option specifies a list of text headers,
22534 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22535 to be removed from the message.
22536 However, the option has no effect when an address is just being verified.
22537 Each list item is separately expanded.
22538 If the result of the expansion is an empty string, or if the expansion
22539 is forced to fail, no action is taken. Other expansion failures are treated as
22540 errors and cause the delivery to be deferred.
22541 If an item ends in *, it will match any header with the given prefix.
22542
22543 Matching headers are omitted from the message as it is transported, as described
22544 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22545 routers.
22546
22547 Unlike most options, &%headers_remove%& can be specified multiple times
22548 for a transport; all listed headers are removed.
22549
22550 &*Warning*&: Because of the separate expansion of the list items,
22551 items that contain a list separator must have it doubled.
22552 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22553
22554
22555
22556 .option headers_rewrite transports string unset
22557 .cindex "transport" "header lines; rewriting"
22558 .cindex "rewriting" "at transport time"
22559 This option allows addresses in header lines to be rewritten at transport time,
22560 that is, as the message is being copied to its destination. The contents of the
22561 option are a colon-separated list of rewriting rules. Each rule is in exactly
22562 the same form as one of the general rewriting rules that are applied when a
22563 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22564 example,
22565 .code
22566 headers_rewrite = a@b c@d f : \
22567                   x@y w@z
22568 .endd
22569 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22570 &'w@z'& in all address-bearing header lines. The rules are applied to the
22571 header lines just before they are written out at transport time, so they affect
22572 only those copies of the message that pass through the transport. However, only
22573 the message's original header lines, and any that were added by a system
22574 filter, are rewritten. If a router or transport adds header lines, they are not
22575 affected by this option. These rewriting rules are &'not'& applied to the
22576 envelope. You can change the return path using &%return_path%&, but you cannot
22577 change envelope recipients at this time.
22578
22579
22580 .option home_directory transports string&!! unset
22581 .cindex "transport" "home directory for"
22582 .vindex "&$home$&"
22583 This option specifies a home directory setting for a local transport,
22584 overriding any value that may be set by the router. The home directory is
22585 placed in &$home$& while expanding the transport's private options. It is also
22586 used as the current directory if no current directory is set by the
22587 &%current_directory%& option on the transport or the
22588 &%transport_current_directory%& option on the router. If the expansion fails
22589 for any reason, including forced failure, an error is logged, and delivery is
22590 deferred.
22591
22592
22593 .option initgroups transports boolean false
22594 .cindex "additional groups"
22595 .cindex "groups" "additional"
22596 .cindex "transport" "group; additional"
22597 If this option is true and the uid for the delivery process is provided by the
22598 transport, the &[initgroups()]& function is called when running the transport
22599 to ensure that any additional groups associated with the uid are set up.
22600
22601
22602 .option max_parallel transports integer&!! unset
22603 .cindex limit "transport parallelism"
22604 .cindex transport "parallel processes"
22605 .cindex transport "concurrency limit"
22606 .cindex "delivery" "parallelism for transport"
22607 If this option is set and expands to an integer greater than zero
22608 it limits the number of concurrent runs of the transport.
22609 The control does not apply to shadow transports.
22610
22611 .cindex "hints database" "transport concurrency control"
22612 Exim implements this control by means of a hints database in which a record is
22613 incremented whenever a transport process is being created. The record
22614 is decremented and possibly removed when the process terminates.
22615 Obviously there is scope for
22616 records to get left lying around if there is a system or program crash. To
22617 guard against this, Exim ignores any records that are more than six hours old.
22618
22619 If you use this option, you should also arrange to delete the
22620 relevant hints database whenever your system reboots. The names of the files
22621 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22622 may be one or two files, depending on the type of DBM in use. The same files
22623 are used for ETRN and smtp transport serialization.
22624
22625
22626 .option message_size_limit transports string&!! 0
22627 .cindex "limit" "message size per transport"
22628 .cindex "size" "of message, limit"
22629 .cindex "transport" "message size; limiting"
22630 This option controls the size of messages passed through the transport. It is
22631 expanded before use; the result of the expansion must be a sequence of decimal
22632 digits, optionally followed by K or M. If the expansion fails for any reason,
22633 including forced failure, or if the result is not of the required form,
22634 delivery is deferred. If the value is greater than zero and the size of a
22635 message exceeds this limit, the address is failed. If there is any chance that
22636 the resulting bounce message could be routed to the same transport, you should
22637 ensure that &%return_size_limit%& is less than the transport's
22638 &%message_size_limit%&, as otherwise the bounce message will fail to get
22639 delivered.
22640
22641
22642
22643 .option rcpt_include_affixes transports boolean false
22644 .cindex "prefix" "for local part, including in envelope"
22645 .cindex "suffix for local part" "including in envelope"
22646 .cindex "local part" "prefix"
22647 .cindex "local part" "suffix"
22648 When this option is false (the default), and an address that has had any
22649 affixes (prefixes or suffixes) removed from the local part is delivered by any
22650 form of SMTP or LMTP, the affixes are not included. For example, if a router
22651 that contains
22652 .code
22653 local_part_prefix = *-
22654 .endd
22655 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22656 is delivered with
22657 .code
22658 RCPT TO:<xyz@some.domain>
22659 .endd
22660 This is also the case when an ACL-time callout is being used to verify a
22661 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22662 whole local part is included in the RCPT command. This option applies to BSMTP
22663 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22664 &(lmtp)& and &(smtp)& transports.
22665
22666
22667 .option retry_use_local_part transports boolean "see below"
22668 .cindex "hints database" "retry keys"
22669 When a delivery suffers a temporary failure, a retry record is created
22670 in Exim's hints database. For remote deliveries, the key for the retry record
22671 is based on the name and/or IP address of the failing remote host. For local
22672 deliveries, the key is normally the entire address, including both the local
22673 part and the domain. This is suitable for most common cases of local delivery
22674 temporary failure &-- for example, exceeding a mailbox quota should delay only
22675 deliveries to that mailbox, not to the whole domain.
22676
22677 However, in some special cases you may want to treat a temporary local delivery
22678 as a failure associated with the domain, and not with a particular local part.
22679 (For example, if you are storing all mail for some domain in files.) You can do
22680 this by setting &%retry_use_local_part%& false.
22681
22682 For all the local transports, its default value is true. For remote transports,
22683 the default value is false for tidiness, but changing the value has no effect
22684 on a remote transport in the current implementation.
22685
22686
22687 .option return_path transports string&!! unset
22688 .cindex "envelope sender"
22689 .cindex "envelope from"
22690 .cindex "transport" "return path; changing"
22691 .cindex "return path" "changing in transport"
22692 If this option is set, the string is expanded at transport time and replaces
22693 the existing return path (envelope sender) value in the copy of the message
22694 that is being delivered. An empty return path is permitted. This feature is
22695 designed for remote deliveries, where the value of this option is used in the
22696 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22697 only effect is to change the address that is placed in the &'Return-path:'&
22698 header line, if one is added to the message (see the next option).
22699
22700 &*Note:*& A changed return path is not logged unless you add
22701 &%return_path_on_delivery%& to the log selector.
22702
22703 .vindex "&$return_path$&"
22704 The expansion can refer to the existing value via &$return_path$&. This is
22705 either the message's envelope sender, or an address set by the
22706 &%errors_to%& option on a router. If the expansion is forced to fail, no
22707 replacement occurs; if it fails for another reason, delivery is deferred. This
22708 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22709 section &<<SECTverp>>&.
22710
22711 &*Note*&: If a delivery error is detected locally, including the case when a
22712 remote server rejects a message at SMTP time, the bounce message is not sent to
22713 the value of this option. It is sent to the previously set errors address.
22714 This defaults to the incoming sender address, but can be changed by setting
22715 &%errors_to%& in a router.
22716
22717
22718
22719 .option return_path_add transports boolean false
22720 .chindex Return-path:
22721 If this option is true, a &'Return-path:'& header is added to the message.
22722 Although the return path is normally available in the prefix line of BSD
22723 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22724 have easy access to it.
22725
22726 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22727 the delivery SMTP server makes the final delivery"&. This implies that this
22728 header should not be present in incoming messages. Exim has a configuration
22729 option, &%return_path_remove%&, which requests removal of this header from
22730 incoming messages, so that delivered messages can safely be resent to other
22731 recipients.
22732
22733
22734 .option shadow_condition transports string&!! unset
22735 See &%shadow_transport%& below.
22736
22737
22738 .option shadow_transport transports string unset
22739 .cindex "shadow transport"
22740 .cindex "transport" "shadow"
22741 A local transport may set the &%shadow_transport%& option to the name of
22742 another local transport. Shadow remote transports are not supported.
22743
22744 Whenever a delivery to the main transport succeeds, and either
22745 &%shadow_condition%& is unset, or its expansion does not result in the empty
22746 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22747 passed to the shadow transport, with the same delivery address or addresses. If
22748 expansion fails, no action is taken except that non-forced expansion failures
22749 cause a log line to be written.
22750
22751 The result of the shadow transport is discarded and does not affect the
22752 subsequent processing of the message. Only a single level of shadowing is
22753 provided; the &%shadow_transport%& option is ignored on any transport when it
22754 is running as a shadow. Options concerned with output from pipes are also
22755 ignored. The log line for the successful delivery has an item added on the end,
22756 of the form
22757 .code
22758 ST=<shadow transport name>
22759 .endd
22760 If the shadow transport did not succeed, the error message is put in
22761 parentheses afterwards. Shadow transports can be used for a number of different
22762 purposes, including keeping more detailed log information than Exim normally
22763 provides, and implementing automatic acknowledgment policies based on message
22764 headers that some sites insist on.
22765
22766
22767 .option transport_filter transports string&!! unset
22768 .cindex "transport" "filter"
22769 .cindex "filter" "transport filter"
22770 This option sets up a filtering (in the Unix shell sense) process for messages
22771 at transport time. It should not be confused with mail filtering as set up by
22772 individual users or via a system filter.
22773 If unset, or expanding to an empty string, no filtering is done.
22774
22775 When the message is about to be written out, the command specified by
22776 &%transport_filter%& is started up in a separate, parallel process, and
22777 the entire message, including the header lines, is passed to it on its standard
22778 input (this in fact is done from a third process, to avoid deadlock). The
22779 command must be specified as an absolute path.
22780
22781 The lines of the message that are written to the transport filter are
22782 terminated by newline (&"\n"&). The message is passed to the filter before any
22783 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22784 lines beginning with a dot, and also before any processing implied by the
22785 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22786 &(pipe)& transports.
22787
22788 The standard error for the filter process is set to the same destination as its
22789 standard output; this is read and written to the message's ultimate
22790 destination. The process that writes the message to the filter, the
22791 filter itself, and the original process that reads the result and delivers it
22792 are all run in parallel, like a shell pipeline.
22793
22794 The filter can perform any transformations it likes, but of course should take
22795 care not to break RFC 2822 syntax. Exim does not check the result, except to
22796 test for a final newline when SMTP is in use. All messages transmitted over
22797 SMTP must end with a newline, so Exim supplies one if it is missing.
22798
22799 .cindex "content scanning" "per user"
22800 A transport filter can be used to provide content-scanning on a per-user basis
22801 at delivery time if the only required effect of the scan is to modify the
22802 message. For example, a content scan could insert a new header line containing
22803 a spam score. This could be interpreted by a filter in the user's MUA. It is
22804 not possible to discard a message at this stage.
22805
22806 .cindex "SIZE" "ESMTP extension"
22807 A problem might arise if the filter increases the size of a message that is
22808 being sent down an SMTP connection. If the receiving SMTP server has indicated
22809 support for the SIZE parameter, Exim will have sent the size of the message
22810 at the start of the SMTP session. If what is actually sent is substantially
22811 more, the server might reject the message. This can be worked round by setting
22812 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22813 additions to the message, or to disable the use of SIZE altogether.
22814
22815 .vindex "&$pipe_addresses$&"
22816 The value of the &%transport_filter%& option is the command string for starting
22817 the filter, which is run directly from Exim, not under a shell. The string is
22818 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22819 Exim breaks it up into arguments and then expands each argument separately (see
22820 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22821 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22822 of arguments, one for each address that applies to this delivery. (This isn't
22823 an ideal name for this feature here, but as it was already implemented for the
22824 &(pipe)& transport, it seemed sensible not to change it.)
22825
22826 .vindex "&$host$&"
22827 .vindex "&$host_address$&"
22828 The expansion variables &$host$& and &$host_address$& are available when the
22829 transport is a remote one. They contain the name and IP address of the host to
22830 which the message is being sent. For example:
22831 . used to have $sender_address in this cmdline, but it's tainted
22832 .code
22833 transport_filter = /some/directory/transport-filter.pl \
22834   $host $host_address $pipe_addresses
22835 .endd
22836
22837 Two problems arise if you want to use more complicated expansion items to
22838 generate transport filter commands, both of which due to the fact that the
22839 command is split up &'before'& expansion.
22840 .ilist
22841 If an expansion item contains white space, you must quote it, so that it is all
22842 part of the same command item. If the entire option setting is one such
22843 expansion item, you have to take care what kind of quoting you use. For
22844 example:
22845 .code
22846 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22847 .endd
22848 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22849 &(/bin/cmd2)& otherwise.
22850
22851 Option strings in general have any fully-surrounding double quote wrapping
22852 removed early in parsing (see &<<SECTstrings>>&).
22853 Then, for this option, quotes protect against whitespace being
22854 regarded as a separator while splitting into the command argument vector.
22855 Either double or single quotes can be used here;
22856 the former interprets backlash-quoted charachters
22857 and the latter does not.
22858
22859 If double quotes had been used in this example, they would have been
22860 stripped by Exim when it read the option's value. When the value is used, if
22861 the single quotes were missing, the line would be split into two items,
22862 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22863 Exim tried to expand the first one.
22864 .next
22865 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22866 expansion cannot generate multiple arguments, or a command name followed by
22867 arguments. Consider this example:
22868 .code
22869 transport_filter = ${lookup{$host}lsearch{/a/file}\
22870                     {$value}{/bin/cat}}
22871 .endd
22872 The result of the lookup is interpreted as the name of the command, even
22873 if it contains white space. The simplest way round this is to use a shell:
22874 .code
22875 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22876                                {$value}{/bin/cat}}
22877 .endd
22878 .endlist
22879
22880 The filter process is run under the same uid and gid as the normal delivery.
22881 For remote deliveries this is the Exim uid/gid by default. The command should
22882 normally yield a zero return code. Transport filters are not supposed to fail.
22883 A non-zero code is taken to mean that the transport filter encountered some
22884 serious problem. Delivery of the message is deferred; the message remains on
22885 the queue and is tried again later. It is not possible to cause a message to be
22886 bounced from a transport filter.
22887
22888 If a transport filter is set on an autoreply transport, the original message is
22889 passed through the filter as it is being copied into the newly generated
22890 message, which happens if the &%return_message%& option is set.
22891
22892
22893 .option transport_filter_timeout transports time 5m
22894 .cindex "transport" "filter, timeout"
22895 When Exim is reading the output of a transport filter, it applies a timeout
22896 that can be set by this option. Exceeding the timeout is normally treated as a
22897 temporary delivery failure. However, if a transport filter is used with a
22898 &(pipe)& transport, a timeout in the transport filter is treated in the same
22899 way as a timeout in the pipe command itself. By default, a timeout is a hard
22900 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22901 becomes a temporary error.
22902
22903
22904 .option user transports string&!! "Exim user"
22905 .cindex "uid (user id)" "local delivery"
22906 .cindex "transport" "user, specifying"
22907 This option specifies the user under whose uid the delivery process is to be
22908 run, overriding any uid that may have been set by the router. If the user is
22909 given as a name, the uid is looked up from the password data, and the
22910 associated group is taken as the value of the gid to be used if the &%group%&
22911 option is not set.
22912
22913 For deliveries that use local transports, a user and group are normally
22914 specified explicitly or implicitly (for example, as a result of
22915 &%check_local_user%&) by the router or transport.
22916
22917 .cindex "hints database" "access by remote transport"
22918 For remote transports, you should leave this option unset unless you really are
22919 sure you know what you are doing. When a remote transport is running, it needs
22920 to be able to access Exim's hints databases, because each host may have its own
22921 retry data.
22922 .ecindex IIDgenoptra1
22923 .ecindex IIDgenoptra2
22924 .ecindex IIDgenoptra3
22925
22926
22927
22928
22929
22930
22931 . ////////////////////////////////////////////////////////////////////////////
22932 . ////////////////////////////////////////////////////////////////////////////
22933
22934 .chapter "Address batching in local transports" "CHAPbatching" &&&
22935          "Address batching"
22936 .cindex "transport" "local; address batching in"
22937 The only remote transport (&(smtp)&) is normally configured to handle more than
22938 one address at a time, so that when several addresses are routed to the same
22939 remote host, just one copy of the message is sent. Local transports, however,
22940 normally handle one address at a time. That is, a separate instance of the
22941 transport is run for each address that is routed to the transport. A separate
22942 copy of the message is delivered each time.
22943
22944 .cindex "batched local delivery"
22945 .oindex "&%batch_max%&"
22946 .oindex "&%batch_id%&"
22947 In special cases, it may be desirable to handle several addresses at once in a
22948 local transport, for example:
22949
22950 .ilist
22951 In an &(appendfile)& transport, when storing messages in files for later
22952 delivery by some other means, a single copy of the message with multiple
22953 recipients saves space.
22954 .next
22955 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22956 a single copy saves time, and is the normal way LMTP is expected to work.
22957 .next
22958 In a &(pipe)& transport, when passing the message
22959 to a scanner program or
22960 to some other delivery mechanism such as UUCP, multiple recipients may be
22961 acceptable.
22962 .endlist
22963
22964 These three local transports all have the same options for controlling multiple
22965 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22966 repeating the information for each transport, these options are described here.
22967
22968 The &%batch_max%& option specifies the maximum number of addresses that can be
22969 delivered together in a single run of the transport. Its default value is one
22970 (no batching). When more than one address is routed to a transport that has a
22971 &%batch_max%& value greater than one, the addresses are delivered in a batch
22972 (that is, in a single run of the transport with multiple recipients), subject
22973 to certain conditions:
22974
22975 .ilist
22976 .vindex "&$local_part$&"
22977 If any of the transport's options contain a reference to &$local_part$&, no
22978 batching is possible.
22979 .next
22980 .vindex "&$domain$&"
22981 If any of the transport's options contain a reference to &$domain$&, only
22982 addresses with the same domain are batched.
22983 .next
22984 .cindex "customizing" "batching condition"
22985 If &%batch_id%& is set, it is expanded for each address, and only those
22986 addresses with the same expanded value are batched. This allows you to specify
22987 customized batching conditions. Failure of the expansion for any reason,
22988 including forced failure, disables batching, but it does not stop the delivery
22989 from taking place.
22990 .next
22991 Batched addresses must also have the same errors address (where to send
22992 delivery errors), the same header additions and removals, the same user and
22993 group for the transport, and if a host list is present, the first host must
22994 be the same.
22995 .endlist
22996
22997 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22998 both when the file or pipe command is specified in the transport, and when it
22999 is specified by a &(redirect)& router, but all the batched addresses must of
23000 course be routed to the same file or pipe command. These two transports have an
23001 option called &%use_bsmtp%&, which causes them to deliver the message in
23002 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23003 &%check_string%& and &%escape_string%& options are forced to the values
23004 .code
23005 check_string = "."
23006 escape_string = ".."
23007 .endd
23008 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23009 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23010 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23011
23012 .cindex "&'Envelope-to:'& header line"
23013 If the generic &%envelope_to_add%& option is set for a batching transport, the
23014 &'Envelope-to:'& header that is added to the message contains all the addresses
23015 that are being processed together. If you are using a batching &(appendfile)&
23016 transport without &%use_bsmtp%&, the only way to preserve the recipient
23017 addresses is to set the &%envelope_to_add%& option.
23018
23019 .cindex "&(pipe)& transport" "with multiple addresses"
23020 .vindex "&$pipe_addresses$&"
23021 If you are using a &(pipe)& transport without BSMTP, and setting the
23022 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23023 the command. This is not a true variable; it is a bit of magic that causes each
23024 of the recipient addresses to be inserted into the command as a separate
23025 argument. This provides a way of accessing all the addresses that are being
23026 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23027 are specified by a &(redirect)& router.
23028
23029
23030
23031
23032 . ////////////////////////////////////////////////////////////////////////////
23033 . ////////////////////////////////////////////////////////////////////////////
23034
23035 .chapter "The appendfile transport" "CHAPappendfile"
23036 .scindex IIDapptra1 "&(appendfile)& transport"
23037 .scindex IIDapptra2 "transports" "&(appendfile)&"
23038 .cindex "directory creation"
23039 .cindex "creating directories"
23040 The &(appendfile)& transport delivers a message by appending it to an existing
23041 file, or by creating an entirely new file in a specified directory. Single
23042 files to which messages are appended can be in the traditional Unix mailbox
23043 format, or optionally in the MBX format supported by the Pine MUA and
23044 University of Washington IMAP daemon, &'inter alia'&. When each message is
23045 being delivered as a separate file, &"maildir"& format can optionally be used
23046 to give added protection against failures that happen part-way through the
23047 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23048 supported. For all file formats, Exim attempts to create as many levels of
23049 directory as necessary, provided that &%create_directory%& is set.
23050
23051 The code for the optional formats is not included in the Exim binary by
23052 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23053 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23054 included.
23055
23056 .cindex "quota" "system"
23057 Exim recognizes system quota errors, and generates an appropriate message. Exim
23058 also supports its own quota control within the transport, for use when the
23059 system facility is unavailable or cannot be used for some reason.
23060
23061 If there is an error while appending to a file (for example, quota exceeded or
23062 partition filled), Exim attempts to reset the file's length and last
23063 modification time back to what they were before. If there is an error while
23064 creating an entirely new file, the new file is removed.
23065
23066 Before appending to a file, a number of security checks are made, and the
23067 file is locked. A detailed description is given below, after the list of
23068 private options.
23069
23070 The &(appendfile)& transport is most commonly used for local deliveries to
23071 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23072 putting messages into files for remote delivery by some means other than Exim.
23073 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23074 option).
23075
23076
23077
23078 .section "The file and directory options" "SECTfildiropt"
23079 The &%file%& option specifies a single file, to which the message is appended;
23080 the &%directory%& option specifies a directory, in which a new file containing
23081 the message is created. Only one of these two options can be set, and for
23082 normal deliveries to mailboxes, one of them &'must'& be set.
23083
23084 .vindex "&$address_file$&"
23085 .vindex "&$local_part$&"
23086 However, &(appendfile)& is also used for delivering messages to files or
23087 directories whose names (or parts of names) are obtained from alias,
23088 forwarding, or filtering operations (for example, a &%save%& command in a
23089 user's Exim filter). When such a transport is running, &$local_part$& contains
23090 the local part that was aliased or forwarded, and &$address_file$& contains the
23091 name (or partial name) of the file or directory generated by the redirection
23092 operation. There are two cases:
23093
23094 .ilist
23095 If neither &%file%& nor &%directory%& is set, the redirection operation
23096 must specify an absolute path (one that begins with &`/`&). This is the most
23097 common case when users with local accounts use filtering to sort mail into
23098 different folders. See for example, the &(address_file)& transport in the
23099 default configuration. If the path ends with a slash, it is assumed to be the
23100 name of a directory. A delivery to a directory can also be forced by setting
23101 &%maildir_format%& or &%mailstore_format%&.
23102 .next
23103 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23104 used to determine the file or directory name for the delivery. Normally, the
23105 contents of &$address_file$& are used in some way in the string expansion.
23106 .endlist
23107 If the &%create_file%& option is set to a path which
23108 matches (see the option definition below for details)
23109 a file or directory name
23110 for the delivery, that name becomes de-tainted.
23111
23112 .cindex "tainted data" "in filenames"
23113 .cindex appendfile "tainted data"
23114 Tainted data may not be used for a file or directory name.
23115 This means that, for instance, &$local_part$& cannot be used directly
23116 as a component of a path.  It can however be used as the key for a lookup
23117 which returns a path (or component).
23118
23119
23120 .cindex "Sieve filter" "configuring &(appendfile)&"
23121 .cindex "Sieve filter" "relative mailbox path handling"
23122 As an example of the second case, consider an environment where users do not
23123 have home directories. They may be permitted to use Exim filter commands of the
23124 form:
23125 .code
23126 save folder23
23127 .endd
23128 or Sieve filter commands of the form:
23129 .code
23130 require "fileinto";
23131 fileinto "folder23";
23132 .endd
23133 In this situation, the expansion of &%file%& or &%directory%& in the transport
23134 must transform the relative path into an appropriate absolute filename. In the
23135 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23136 is used as a result of a &"keep"& action in the filter. This example shows one
23137 way of handling this requirement:
23138 .code
23139 file = ${if eq{$address_file}{inbox} \
23140             {/var/mail/$local_part_data} \
23141             {${if eq{${substr_0_1:$address_file}}{/} \
23142                   {$address_file} \
23143                   {$home/mail/$address_file} \
23144             }} \
23145        }
23146 .endd
23147 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23148 location, absolute paths are used without change, and other folders are in the
23149 &_mail_& directory within the home directory.
23150
23151 &*Note 1*&: While processing an Exim filter, a relative path such as
23152 &_folder23_& is turned into an absolute path if a home directory is known to
23153 the router. In particular, this is the case if &%check_local_user%& is set. If
23154 you want to prevent this happening at routing time, you can set
23155 &%router_home_directory%& empty. This forces the router to pass the relative
23156 path to the transport.
23157
23158 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23159 the &%file%& or &%directory%& option is still used if it is set.
23160
23161
23162
23163
23164 .section "Private options for appendfile" "SECID134"
23165 .cindex "options" "&(appendfile)& transport"
23166
23167
23168
23169 .option allow_fifo appendfile boolean false
23170 .cindex "fifo (named pipe)"
23171 .cindex "named pipe (fifo)"
23172 .cindex "pipe" "named (fifo)"
23173 Setting this option permits delivery to named pipes (FIFOs) as well as to
23174 regular files. If no process is reading the named pipe at delivery time, the
23175 delivery is deferred.
23176
23177
23178 .option allow_symlink appendfile boolean false
23179 .cindex "symbolic link" "to mailbox"
23180 .cindex "mailbox" "symbolic link"
23181 By default, &(appendfile)& will not deliver if the path name for the file is
23182 that of a symbolic link. Setting this option relaxes that constraint, but there
23183 are security issues involved in the use of symbolic links. Be sure you know
23184 what you are doing if you set this. Details of exactly what this option affects
23185 are included in the discussion which follows this list of options.
23186
23187
23188 .option batch_id appendfile string&!! unset
23189 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23190 However, batching is automatically disabled for &(appendfile)& deliveries that
23191 happen as a result of forwarding or aliasing or other redirection directly to a
23192 file.
23193
23194
23195 .option batch_max appendfile integer 1
23196 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23197
23198
23199 .option check_group appendfile boolean false
23200 When this option is set, the group owner of the file defined by the &%file%&
23201 option is checked to see that it is the same as the group under which the
23202 delivery process is running. The default setting is false because the default
23203 file mode is 0600, which means that the group is irrelevant.
23204
23205
23206 .option check_owner appendfile boolean true
23207 When this option is set, the owner of the file defined by the &%file%& option
23208 is checked to ensure that it is the same as the user under which the delivery
23209 process is running.
23210
23211
23212 .option check_string appendfile string "see below"
23213 .cindex "&""From""& line"
23214 As &(appendfile)& writes the message, the start of each line is tested for
23215 matching &%check_string%&, and if it does, the initial matching characters are
23216 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23217 a literal string, not a regular expression, and the case of any letters it
23218 contains is significant.
23219
23220 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23221 are forced to &"."& and &".."& respectively, and any settings in the
23222 configuration are ignored. Otherwise, they default to &"From&~"& and
23223 &">From&~"& when the &%file%& option is set, and unset when any of the
23224 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23225
23226 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23227 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23228 &"From&~"& indicates the start of a new message. All four options need changing
23229 if another format is used. For example, to deliver to mailboxes in MMDF format:
23230 .cindex "MMDF format mailbox"
23231 .cindex "mailbox" "MMDF format"
23232 .code
23233 check_string = "\1\1\1\1\n"
23234 escape_string = "\1\1\1\1 \n"
23235 message_prefix = "\1\1\1\1\n"
23236 message_suffix = "\1\1\1\1\n"
23237 .endd
23238 .option create_directory appendfile boolean true
23239 .cindex "directory creation"
23240 When this option is true, Exim attempts to create any missing superior
23241 directories for the file that it is about to write. A created directory's mode
23242 is given by the &%directory_mode%& option.
23243
23244 The group ownership of a newly created directory is highly dependent on the
23245 operating system (and possibly the file system) that is being used. For
23246 example, in Solaris, if the parent directory has the setgid bit set, its group
23247 is propagated to the child; if not, the currently set group is used. However,
23248 in FreeBSD, the parent's group is always used.
23249
23250
23251
23252 .option create_file appendfile string anywhere
23253 This option constrains the location of files and directories that are created
23254 by this transport. It applies to files defined by the &%file%& option and
23255 directories defined by the &%directory%& option. In the case of maildir
23256 delivery, it applies to the top level directory, not the maildir directories
23257 beneath.
23258
23259 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23260 &"belowhome"&, or to an absolute path.
23261
23262 In the second and third cases, a home directory must have been
23263 set for the transport, and the file or directory being created must
23264 reside within it.
23265 The "belowhome" checking additionally checks for attempts to use "../"
23266 to evade the testing.
23267 This option is not useful when an explicit filename is
23268 given for normal mailbox deliveries. It is intended for the case when filenames
23269 are generated from users' &_.forward_& files. These are usually handled
23270 by an &(appendfile)& transport called &%address_file%&. See also
23271 &%file_must_exist%&.
23272
23273 In the fourth case,
23274 the value given for this option must be an absolute path for an
23275 existing directory.
23276 The value is used for checking instead of a home directory;
23277 checking is done in "belowhome" mode.
23278
23279 .cindex "tainted data" "de-tainting"
23280 .cindex "de-tainting" "using appendfile create_file option"
23281 If "belowhome" checking is used, the file or directory path
23282 becomes de-tainted.
23283
23284
23285 .option directory appendfile string&!! unset
23286 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23287 or &%directory%& must be set, unless the delivery is the direct result of a
23288 redirection (see section &<<SECTfildiropt>>&).
23289
23290 When &%directory%& is set, the string is expanded, and the message is delivered
23291 into a new file or files in or below the given directory, instead of being
23292 appended to a single mailbox file. A number of different formats are provided
23293 (see &%maildir_format%& and &%mailstore_format%&), and see section
23294 &<<SECTopdir>>& for further details of this form of delivery.
23295
23296 The result of expansion must not be tainted, unless the &%create_file%& option
23297 specifies a path.
23298
23299
23300 .option directory_file appendfile string&!! "see below"
23301 .cindex "base62"
23302 .vindex "&$inode$&"
23303 When &%directory%& is set, but neither &%maildir_format%& nor
23304 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23305 whose name is obtained by expanding this string. The default value is:
23306 .code
23307 q${base62:$tod_epoch}-$inode
23308 .endd
23309 This generates a unique name from the current time, in base 62 form, and the
23310 inode of the file. The variable &$inode$& is available only when expanding this
23311 option.
23312
23313
23314 .option directory_mode appendfile "octal integer" 0700
23315 If &(appendfile)& creates any directories as a result of the
23316 &%create_directory%& option, their mode is specified by this option.
23317
23318
23319 .option escape_string appendfile string "see description"
23320 See &%check_string%& above.
23321
23322
23323 .option file appendfile string&!! unset
23324 This option is mutually exclusive with the &%directory%& option, but one of
23325 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23326 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23327 specifies a single file, to which the message is appended. One or more of
23328 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23329 &%file%&.
23330
23331 The result of expansion must not be tainted, unless the &%create_file%& option
23332 specifies a path.
23333
23334 .cindex "NFS" "lock file"
23335 .cindex "locking files"
23336 .cindex "lock files"
23337 If you are using more than one host to deliver over NFS into the same
23338 mailboxes, you should always use lock files.
23339
23340 The string value is expanded for each delivery, and must yield an absolute
23341 path. The most common settings of this option are variations on one of these
23342 examples:
23343 .code
23344 file = /var/spool/mail/$local_part_data
23345 file = /home/$local_part_data/inbox
23346 file = $home/inbox
23347 .endd
23348 .cindex "&""sticky""& bit"
23349 In the first example, all deliveries are done into the same directory. If Exim
23350 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23351 create a file in the directory, so the &"sticky"& bit must be turned on for
23352 deliveries to be possible, or alternatively the &%group%& option can be used to
23353 run the delivery under a group id which has write access to the directory.
23354
23355
23356
23357 .option file_format appendfile string unset
23358 .cindex "file" "mailbox; checking existing format"
23359 This option requests the transport to check the format of an existing file
23360 before adding to it. The check consists of matching a specific string at the
23361 start of the file. The value of the option consists of an even number of
23362 colon-separated strings. The first of each pair is the test string, and the
23363 second is the name of a transport. If the transport associated with a matched
23364 string is not the current transport, control is passed over to the other
23365 transport. For example, suppose the standard &(local_delivery)& transport has
23366 this added to it:
23367 .code
23368 file_format = "From       : local_delivery :\
23369                \1\1\1\1\n : local_mmdf_delivery"
23370 .endd
23371 Mailboxes that begin with &"From"& are still handled by this transport, but if
23372 a mailbox begins with four binary ones followed by a newline, control is passed
23373 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23374 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23375 is assumed to match the current transport. If the start of a mailbox doesn't
23376 match any string, or if the transport named for a given string is not defined,
23377 delivery is deferred.
23378
23379
23380 .option file_must_exist appendfile boolean false
23381 If this option is true, the file specified by the &%file%& option must exist.
23382 A temporary error occurs if it does not, causing delivery to be deferred.
23383 If this option is false, the file is created if it does not exist.
23384
23385
23386 .option lock_fcntl_timeout appendfile time 0s
23387 .cindex "timeout" "mailbox locking"
23388 .cindex "mailbox" "locking, blocking and non-blocking"
23389 .cindex "locking files"
23390 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23391 when locking an open mailbox file. If the call fails, the delivery process
23392 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23393 Non-blocking calls are used so that the file is not kept open during the wait
23394 for the lock; the reason for this is to make it as safe as possible for
23395 deliveries over NFS in the case when processes might be accessing an NFS
23396 mailbox without using a lock file. This should not be done, but
23397 misunderstandings and hence misconfigurations are not unknown.
23398
23399 On a busy system, however, the performance of a non-blocking lock approach is
23400 not as good as using a blocking lock with a timeout. In this case, the waiting
23401 is done inside the system call, and Exim's delivery process acquires the lock
23402 and can proceed as soon as the previous lock holder releases it.
23403
23404 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23405 timeout, are used. There may still be some retrying: the maximum number of
23406 retries is
23407 .code
23408 (lock_retries * lock_interval) / lock_fcntl_timeout
23409 .endd
23410 rounded up to the next whole number. In other words, the total time during
23411 which &(appendfile)& is trying to get a lock is roughly the same, unless
23412 &%lock_fcntl_timeout%& is set very large.
23413
23414 You should consider setting this option if you are getting a lot of delayed
23415 local deliveries because of errors of the form
23416 .code
23417 failed to lock mailbox /some/file (fcntl)
23418 .endd
23419
23420 .option lock_flock_timeout appendfile time 0s
23421 This timeout applies to file locking when using &[flock()]& (see
23422 &%use_flock%&); the timeout operates in a similar manner to
23423 &%lock_fcntl_timeout%&.
23424
23425
23426 .option lock_interval appendfile time 3s
23427 This specifies the time to wait between attempts to lock the file. See below
23428 for details of locking.
23429
23430
23431 .option lock_retries appendfile integer 10
23432 This specifies the maximum number of attempts to lock the file. A value of zero
23433 is treated as 1. See below for details of locking.
23434
23435
23436 .option lockfile_mode appendfile "octal integer" 0600
23437 This specifies the mode of the created lock file, when a lock file is being
23438 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23439
23440
23441 .option lockfile_timeout appendfile time 30m
23442 .cindex "timeout" "mailbox locking"
23443 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23444 exists and is older than this value, it is assumed to have been left behind by
23445 accident, and Exim attempts to remove it.
23446
23447
23448 .option mailbox_filecount appendfile string&!! unset
23449 .cindex "mailbox" "specifying size of"
23450 .cindex "size" "of mailbox"
23451 If this option is set, it is expanded, and the result is taken as the current
23452 number of files in the mailbox. It must be a decimal number, optionally
23453 followed by K or M. This provides a way of obtaining this information from an
23454 external source that maintains the data.
23455
23456
23457 .option mailbox_size appendfile string&!! unset
23458 .cindex "mailbox" "specifying size of"
23459 .cindex "size" "of mailbox"
23460 If this option is set, it is expanded, and the result is taken as the current
23461 size the mailbox. It must be a decimal number, optionally followed by K or M.
23462 This provides a way of obtaining this information from an external source that
23463 maintains the data. This is likely to be helpful for maildir deliveries where
23464 it is computationally expensive to compute the size of a mailbox.
23465
23466
23467
23468 .option maildir_format appendfile boolean false
23469 .cindex "maildir format" "specifying"
23470 If this option is set with the &%directory%& option, the delivery is into a new
23471 file, in the &"maildir"& format that is used by other mail software. When the
23472 transport is activated directly from a &(redirect)& router (for example, the
23473 &(address_file)& transport in the default configuration), setting
23474 &%maildir_format%& causes the path received from the router to be treated as a
23475 directory, whether or not it ends with &`/`&. This option is available only if
23476 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23477 &<<SECTmaildirdelivery>>& below for further details.
23478
23479
23480 .option maildir_quota_directory_regex appendfile string "See below"
23481 .cindex "maildir format" "quota; directories included in"
23482 .cindex "quota" "maildir; directories included in"
23483 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23484 a regular expression for specifying directories, relative to the quota
23485 directory (see &%quota_directory%&), that should be included in the quota
23486 calculation. The default value is:
23487 .code
23488 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23489 .endd
23490 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23491 (directories whose names begin with a dot). If you want to exclude the
23492 &_Trash_&
23493 folder from the count (as some sites do), you need to change this setting to
23494 .code
23495 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23496 .endd
23497 This uses a negative lookahead in the regular expression to exclude the
23498 directory whose name is &_.Trash_&. When a directory is excluded from quota
23499 calculations, quota processing is bypassed for any messages that are delivered
23500 directly into that directory.
23501
23502
23503 .option maildir_retries appendfile integer 10
23504 This option specifies the number of times to retry when writing a file in
23505 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23506
23507
23508 .option maildir_tag appendfile string&!! unset
23509 This option applies only to deliveries in maildir format, and is described in
23510 section &<<SECTmaildirdelivery>>& below.
23511
23512
23513 .option maildir_use_size_file appendfile&!! boolean false
23514 .cindex "maildir format" "&_maildirsize_& file"
23515 The result of string expansion for this option must be a valid boolean value.
23516 If it is true, it enables support for &_maildirsize_& files. Exim
23517 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23518 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23519 value is zero. See &%maildir_quota_directory_regex%& above and section
23520 &<<SECTmaildirdelivery>>& below for further details.
23521
23522 .option maildirfolder_create_regex appendfile string unset
23523 .cindex "maildir format" "&_maildirfolder_& file"
23524 .cindex "&_maildirfolder_&, creating"
23525 The value of this option is a regular expression. If it is unset, it has no
23526 effect. Otherwise, before a maildir delivery takes place, the pattern is
23527 matched against the name of the maildir directory, that is, the directory
23528 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23529 delivery. If there is a match, Exim checks for the existence of a file called
23530 &_maildirfolder_& in the directory, and creates it if it does not exist.
23531 See section &<<SECTmaildirdelivery>>& for more details.
23532
23533
23534 .option mailstore_format appendfile boolean false
23535 .cindex "mailstore format" "specifying"
23536 If this option is set with the &%directory%& option, the delivery is into two
23537 new files in  &"mailstore"& format. The option is available only if
23538 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23539 below for further details.
23540
23541
23542 .option mailstore_prefix appendfile string&!! unset
23543 This option applies only to deliveries in mailstore format, and is described in
23544 section &<<SECTopdir>>& below.
23545
23546
23547 .option mailstore_suffix appendfile string&!! unset
23548 This option applies only to deliveries in mailstore format, and is described in
23549 section &<<SECTopdir>>& below.
23550
23551
23552 .option mbx_format appendfile boolean false
23553 .cindex "locking files"
23554 .cindex "file" "locking"
23555 .cindex "file" "MBX format"
23556 .cindex "MBX format, specifying"
23557 This option is available only if Exim has been compiled with SUPPORT_MBX
23558 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23559 the message is appended to the mailbox file in MBX format instead of
23560 traditional Unix format. This format is supported by Pine4 and its associated
23561 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23562
23563 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23564 automatically changed by the use of &%mbx_format%&. They should normally be set
23565 empty when using MBX format, so this option almost always appears in this
23566 combination:
23567 .code
23568 mbx_format = true
23569 message_prefix =
23570 message_suffix =
23571 .endd
23572 If none of the locking options are mentioned in the configuration,
23573 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23574 is possible to specify the other kinds of locking with &%mbx_format%&, but
23575 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23576 interworks with &'c-client'&, providing for shared access to the mailbox. It
23577 should not be used if any program that does not use this form of locking is
23578 going to access the mailbox, nor should it be used if the mailbox file is NFS
23579 mounted, because it works only when the mailbox is accessed from a single host.
23580
23581 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23582 the standard version of &'c-client'&, because as long as it has a mailbox open
23583 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23584 append messages to it.
23585
23586
23587 .option message_prefix appendfile string&!! "see below"
23588 .cindex "&""From""& line"
23589 The string specified here is expanded and output at the start of every message.
23590 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23591 in which case it is:
23592 .code
23593 message_prefix = "From ${if def:return_path{$return_path}\
23594   {MAILER-DAEMON}} $tod_bsdinbox\n"
23595 .endd
23596 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23597 &`\n`& to &`\r\n`& in &%message_prefix%&.
23598
23599 .option message_suffix appendfile string&!! "see below"
23600 The string specified here is expanded and output at the end of every message.
23601 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23602 in which case it is a single newline character. The suffix can be suppressed by
23603 setting
23604 .code
23605 message_suffix =
23606 .endd
23607 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23608 &`\n`& to &`\r\n`& in &%message_suffix%&.
23609
23610 .option mode appendfile "octal integer" 0600
23611 If the output file is created, it is given this mode. If it already exists and
23612 has wider permissions, they are reduced to this mode. If it has narrower
23613 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23614 if the delivery is the result of a &%save%& command in a filter file specifying
23615 a particular mode, the mode of the output file is always forced to take that
23616 value, and this option is ignored.
23617
23618
23619 .option mode_fail_narrower appendfile boolean true
23620 This option applies in the case when an existing mailbox file has a narrower
23621 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23622 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23623 continues with the delivery attempt, using the existing mode of the file.
23624
23625
23626 .option notify_comsat appendfile boolean false
23627 If this option is true, the &'comsat'& daemon is notified after every
23628 successful delivery to a user mailbox. This is the daemon that notifies logged
23629 on users about incoming mail.
23630
23631
23632 .option quota appendfile string&!! unset
23633 .cindex "quota" "imposed by Exim"
23634 This option imposes a limit on the size of the file to which Exim is appending,
23635 or to the total space used in the directory tree when the &%directory%& option
23636 is set. In the latter case, computation of the space used is expensive, because
23637 all the files in the directory (and any sub-directories) have to be
23638 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23639 &%maildir_use_size_file%& for ways to avoid this in environments where users
23640 have no shell access to their mailboxes).
23641
23642 As there is no interlock against two simultaneous deliveries into a
23643 multi-file mailbox, it is possible for the quota to be overrun in this case.
23644 For single-file mailboxes, of course, an interlock is a necessity.
23645
23646 A file's size is taken as its &'used'& value. Because of blocking effects, this
23647 may be a lot less than the actual amount of disk space allocated to the file.
23648 If the sizes of a number of files are being added up, the rounding effect can
23649 become quite noticeable, especially on systems that have large block sizes.
23650 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23651 the obvious value which users understand most easily.
23652
23653 The value of the option is expanded, and must then be a numerical value
23654 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23655 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23656 and further option modifiers. If Exim is running on a system with
23657 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23658 be handled.
23659
23660 The option modifier &%no_check%& can be used to force delivery even if the over
23661 quota condition is met. The quota gets updated as usual.
23662
23663 &*Note*&: A value of zero is interpreted as &"no quota"&.
23664
23665 The expansion happens while Exim is running as root, before it changes uid for
23666 the delivery. This means that files that are inaccessible to the end user can
23667 be used to hold quota values that are looked up in the expansion. When delivery
23668 fails because this quota is exceeded, the handling of the error is as for
23669 system quota failures.
23670
23671 By default, Exim's quota checking mimics system quotas, and restricts the
23672 mailbox to the specified maximum size, though the value is not accurate to the
23673 last byte, owing to separator lines and additional headers that may get added
23674 during message delivery. When a mailbox is nearly full, large messages may get
23675 refused even though small ones are accepted, because the size of the current
23676 message is added to the quota when the check is made. This behaviour can be
23677 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23678 for exceeding the quota does not include the current message. Thus, deliveries
23679 continue until the quota has been exceeded; thereafter, no further messages are
23680 delivered. See also &%quota_warn_threshold%&.
23681
23682
23683 .option quota_directory appendfile string&!! unset
23684 This option defines the directory to check for quota purposes when delivering
23685 into individual files. The default is the delivery directory, or, if a file
23686 called &_maildirfolder_& exists in a maildir directory, the parent of the
23687 delivery directory.
23688
23689
23690 .option quota_filecount appendfile string&!! 0
23691 This option applies when the &%directory%& option is set. It limits the total
23692 number of files in the directory (compare the inode limit in system quotas). It
23693 can only be used if &%quota%& is also set. The value is expanded; an expansion
23694 failure causes delivery to be deferred. A value of zero is interpreted as
23695 &"no quota"&.
23696
23697 The option modifier &%no_check%& can be used to force delivery even if the over
23698 quota condition is met. The quota gets updated as usual.
23699
23700 .option quota_is_inclusive appendfile boolean true
23701 See &%quota%& above.
23702
23703
23704 .option quota_size_regex appendfile string unset
23705 This option applies when one of the delivery modes that writes a separate file
23706 for each message is being used. When Exim wants to find the size of one of
23707 these files in order to test the quota, it first checks &%quota_size_regex%&.
23708 If this is set to a regular expression that matches the filename, and it
23709 captures one string, that string is interpreted as a representation of the
23710 file's size. The value of &%quota_size_regex%& is not expanded.
23711
23712 This feature is useful only when users have no shell access to their mailboxes
23713 &-- otherwise they could defeat the quota simply by renaming the files. This
23714 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23715 the file length to the filename. For example:
23716 .code
23717 maildir_tag = ,S=$message_size
23718 quota_size_regex = ,S=(\d+)
23719 .endd
23720 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23721 number of lines in the message.
23722
23723 The regular expression should not assume that the length is at the end of the
23724 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23725 sometimes add other information onto the ends of message filenames.
23726
23727 Section &<<SECID136>>& contains further information.
23728
23729 This option should not be used when other message-handling software
23730 may duplicate messages by making hardlinks to the files.  When that is done Exim
23731 will count the message size once for each filename, in contrast with the actual
23732 disk usage.  When the option is not set, calculating total usage requires
23733 a system-call per file to get the size; the number of links is then available also
23734 as is used to adjust the effective size.
23735
23736
23737 .option quota_warn_message appendfile string&!! "see below"
23738 See below for the use of this option. If it is not set when
23739 &%quota_warn_threshold%& is set, it defaults to
23740 .code
23741 quota_warn_message = "\
23742   To: $local_part@$domain\n\
23743   Subject: Your mailbox\n\n\
23744   This message is automatically created \
23745   by mail delivery software.\n\n\
23746   The size of your mailbox has exceeded \
23747   a warning threshold that is\n\
23748   set by the system administrator.\n"
23749 .endd
23750
23751
23752 .option quota_warn_threshold appendfile string&!! 0
23753 .cindex "quota" "warning threshold"
23754 .cindex "mailbox" "size warning"
23755 .cindex "size" "of mailbox"
23756 This option is expanded in the same way as &%quota%& (see above). If the
23757 resulting value is greater than zero, and delivery of the message causes the
23758 size of the file or total space in the directory tree to cross the given
23759 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23760 may be specified as a percentage of it by following the value with a percent
23761 sign. For example:
23762 .code
23763 quota = 10M
23764 quota_warn_threshold = 75%
23765 .endd
23766 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23767 percent sign is ignored.
23768
23769 The warning message itself is specified by the &%quota_warn_message%& option,
23770 and it must start with a &'To:'& header line containing the recipient(s) of the
23771 warning message. These do not necessarily have to include the recipient(s) of
23772 the original message. A &'Subject:'& line should also normally be supplied. You
23773 can include any other header lines that you want. If you do not include a
23774 &'From:'& line, the default is:
23775 .code
23776 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23777 .endd
23778 .oindex &%errors_reply_to%&
23779 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23780 option.
23781
23782 The &%quota%& option does not have to be set in order to use this option; they
23783 are independent of one another except when the threshold is specified as a
23784 percentage.
23785
23786
23787 .option use_bsmtp appendfile boolean false
23788 .cindex "envelope from"
23789 .cindex "envelope sender"
23790 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23791 format, with the envelope sender and recipient(s) included as SMTP commands. If
23792 you want to include a leading HELO command with such messages, you can do
23793 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23794 for details of batch SMTP.
23795
23796
23797 .option use_crlf appendfile boolean false
23798 .cindex "carriage return"
23799 .cindex "linefeed"
23800 This option causes lines to be terminated with the two-character CRLF sequence
23801 (carriage return, linefeed) instead of just a linefeed character. In the case
23802 of batched SMTP, the byte sequence written to the file is then an exact image
23803 of what would be sent down a real SMTP connection.
23804
23805 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23806 (which are used to supply the traditional &"From&~"& and blank line separators
23807 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23808 carriage return characters if these are needed. In cases where these options
23809 have non-empty defaults, the values end with a single linefeed, so they must be
23810 changed to end with &`\r\n`& if &%use_crlf%& is set.
23811
23812
23813 .option use_fcntl_lock appendfile boolean "see below"
23814 This option controls the use of the &[fcntl()]& function to lock a file for
23815 exclusive use when a message is being appended. It is set by default unless
23816 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23817 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23818 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23819
23820
23821 .option use_flock_lock appendfile boolean false
23822 This option is provided to support the use of &[flock()]& for file locking, for
23823 the few situations where it is needed. Most modern operating systems support
23824 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23825 each other. Exim uses &[fcntl()]& locking by default.
23826
23827 This option is required only if you are using an operating system where
23828 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23829 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23830 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23831
23832 .cindex "Solaris" "&[flock()]& support"
23833 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23834 have it (and some, I think, provide a not quite right version built on top of
23835 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23836 the ability to use it, and any attempt to do so will cause a configuration
23837 error.
23838
23839 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23840 is just being mapped onto &[fcntl()]& by the OS).
23841
23842
23843 .option use_lockfile appendfile boolean "see below"
23844 If this option is turned off, Exim does not attempt to create a lock file when
23845 appending to a mailbox file. In this situation, the only locking is by
23846 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23847 sure that every MUA that is ever going to look at your users' mailboxes uses
23848 &[fcntl()]& rather than a lock file, and even then only when you are not
23849 delivering over NFS from more than one host.
23850
23851 .cindex "NFS" "lock file"
23852 In order to append to an NFS file safely from more than one host, it is
23853 necessary to take out a lock &'before'& opening the file, and the lock file
23854 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23855 file corruption.
23856
23857 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23858 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23859 except when &%mbx_format%& is set.
23860
23861
23862 .option use_mbx_lock appendfile boolean "see below"
23863 This option is available only if Exim has been compiled with SUPPORT_MBX
23864 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23865 locking rules be used. It is set by default if &%mbx_format%& is set and none
23866 of the locking options are mentioned in the configuration. The locking rules
23867 are the same as are used by the &'c-client'& library that underlies Pine and
23868 the IMAP4 and POP daemons that come with it (see the discussion below). The
23869 rules allow for shared access to the mailbox. However, this kind of locking
23870 does not work when the mailbox is NFS mounted.
23871
23872 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23873 &%use_flock_lock%& to control what kind of locking is used in implementing the
23874 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23875 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23876
23877
23878
23879
23880 .section "Operational details for appending" "SECTopappend"
23881 .cindex "appending to a file"
23882 .cindex "file" "appending"
23883 Before appending to a file, the following preparations are made:
23884
23885 .ilist
23886 If the name of the file is &_/dev/null_&, no action is taken, and a success
23887 return is given.
23888
23889 .next
23890 .cindex "directory creation"
23891 If any directories on the file's path are missing, Exim creates them if the
23892 &%create_directory%& option is set. A created directory's mode is given by the
23893 &%directory_mode%& option.
23894
23895 .next
23896 If &%file_format%& is set, the format of an existing file is checked. If this
23897 indicates that a different transport should be used, control is passed to that
23898 transport.
23899
23900 .next
23901 .cindex "file" "locking"
23902 .cindex "locking files"
23903 .cindex "NFS" "lock file"
23904 If &%use_lockfile%& is set, a lock file is built in a way that will work
23905 reliably over NFS, as follows:
23906
23907 .olist
23908 Create a &"hitching post"& file whose name is that of the lock file with the
23909 current time, primary host name, and process id added, by opening for writing
23910 as a new file. If this fails with an access error, delivery is deferred.
23911 .next
23912 Close the hitching post file, and hard link it to the lock filename.
23913 .next
23914 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23915 Unlink the hitching post name.
23916 .next
23917 Otherwise, use &[stat()]& to get information about the hitching post file, and
23918 then unlink hitching post name. If the number of links is exactly two, creation
23919 of the lock file succeeded but something (for example, an NFS server crash and
23920 restart) caused this fact not to be communicated to the &[link()]& call.
23921 .next
23922 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23923 up to &%lock_retries%& times. However, since any program that writes to a
23924 mailbox should complete its task very quickly, it is reasonable to time out old
23925 lock files that are normally the result of user agent and system crashes. If an
23926 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23927 it before trying again.
23928 .endlist olist
23929
23930 .next
23931 A call is made to &[lstat()]& to discover whether the main file exists, and if
23932 so, what its characteristics are. If &[lstat()]& fails for any reason other
23933 than non-existence, delivery is deferred.
23934
23935 .next
23936 .cindex "symbolic link" "to mailbox"
23937 .cindex "mailbox" "symbolic link"
23938 If the file does exist and is a symbolic link, delivery is deferred, unless the
23939 &%allow_symlink%& option is set, in which case the ownership of the link is
23940 checked, and then &[stat()]& is called to find out about the real file, which
23941 is then subjected to the checks below. The check on the top-level link
23942 ownership prevents one user creating a link for another's mailbox in a sticky
23943 directory, though allowing symbolic links in this case is definitely not a good
23944 idea. If there is a chain of symbolic links, the intermediate ones are not
23945 checked.
23946
23947 .next
23948 If the file already exists but is not a regular file, or if the file's owner
23949 and group (if the group is being checked &-- see &%check_group%& above) are
23950 different from the user and group under which the delivery is running,
23951 delivery is deferred.
23952
23953 .next
23954 If the file's permissions are more generous than specified, they are reduced.
23955 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23956 is set false, in which case the delivery is tried using the existing
23957 permissions.
23958
23959 .next
23960 The file's inode number is saved, and the file is then opened for appending.
23961 If this fails because the file has vanished, &(appendfile)& behaves as if it
23962 hadn't existed (see below). For any other failures, delivery is deferred.
23963
23964 .next
23965 If the file is opened successfully, check that the inode number hasn't
23966 changed, that it is still a regular file, and that the owner and permissions
23967 have not changed. If anything is wrong, defer delivery and freeze the message.
23968
23969 .next
23970 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23971 option is set. Otherwise, check that the file is being created in a permitted
23972 directory if the &%create_file%& option is set (deferring on failure), and then
23973 open for writing as a new file, with the O_EXCL and O_CREAT options,
23974 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23975 set). In this case, which can happen if the link points to a non-existent file,
23976 the file is opened for writing using O_CREAT but not O_EXCL, because
23977 that prevents link following.
23978
23979 .next
23980 .cindex "loop" "while file testing"
23981 If opening fails because the file exists, obey the tests given above for
23982 existing files. However, to avoid looping in a situation where the file is
23983 being continuously created and destroyed, the exists/not-exists loop is broken
23984 after 10 repetitions, and the message is then frozen.
23985
23986 .next
23987 If opening fails with any other error, defer delivery.
23988
23989 .next
23990 .cindex "file" "locking"
23991 .cindex "locking files"
23992 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23993 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23994 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23995 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23996 file, and an exclusive lock on the file whose name is
23997 .code
23998 /tmp/.<device-number>.<inode-number>
23999 .endd
24000 using the device and inode numbers of the open mailbox file, in accordance with
24001 the MBX locking rules. This file is created with a mode that is specified by
24002 the &%lockfile_mode%& option.
24003
24004 If Exim fails to lock the file, there are two possible courses of action,
24005 depending on the value of the locking timeout. This is obtained from
24006 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24007
24008 If the timeout value is zero, the file is closed, Exim waits for
24009 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24010 to lock it again. This happens up to &%lock_retries%& times, after which the
24011 delivery is deferred.
24012
24013 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24014 &[flock()]& are used (with the given timeout), so there has already been some
24015 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24016 immediately. It retries up to
24017 .code
24018 (lock_retries * lock_interval) / <timeout>
24019 .endd
24020 times (rounded up).
24021 .endlist
24022
24023 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24024 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24025
24026
24027 .section "Operational details for delivery to a new file" "SECTopdir"
24028 .cindex "delivery" "to single file"
24029 .cindex "&""From""& line"
24030 When the &%directory%& option is set instead of &%file%&, each message is
24031 delivered into a newly-created file or set of files. When &(appendfile)& is
24032 activated directly from a &(redirect)& router, neither &%file%& nor
24033 &%directory%& is normally set, because the path for delivery is supplied by the
24034 router. (See for example, the &(address_file)& transport in the default
24035 configuration.) In this case, delivery is to a new file if either the path name
24036 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24037
24038 No locking is required while writing the message to a new file, so the various
24039 locking options of the transport are ignored. The &"From"& line that by default
24040 separates messages in a single file is not normally needed, nor is the escaping
24041 of message lines that start with &"From"&, and there is no need to ensure a
24042 newline at the end of each message. Consequently, the default values for
24043 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24044 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24045
24046 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24047 the files in the delivery directory by default. However, you can specify a
24048 different directory by setting &%quota_directory%&. Also, for maildir
24049 deliveries (see below) the &_maildirfolder_& convention is honoured.
24050
24051
24052 .cindex "maildir format"
24053 .cindex "mailstore format"
24054 There are three different ways in which delivery to individual files can be
24055 done, controlled by the settings of the &%maildir_format%& and
24056 &%mailstore_format%& options. Note that code to support maildir or mailstore
24057 formats is not included in the binary unless SUPPORT_MAILDIR or
24058 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24059
24060 .cindex "directory creation"
24061 In all three cases an attempt is made to create the directory and any necessary
24062 sub-directories if they do not exist, provided that the &%create_directory%&
24063 option is set (the default). The location of a created directory can be
24064 constrained by setting &%create_file%&. A created directory's mode is given by
24065 the &%directory_mode%& option. If creation fails, or if the
24066 &%create_directory%& option is not set when creation is required, delivery is
24067 deferred.
24068
24069
24070
24071 .section "Maildir delivery" "SECTmaildirdelivery"
24072 .cindex "maildir format" "description of"
24073 If the &%maildir_format%& option is true, Exim delivers each message by writing
24074 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24075 directory that is defined by the &%directory%& option (the &"delivery
24076 directory"&). If the delivery is successful, the file is renamed into the
24077 &_new_& subdirectory.
24078
24079 In the filename, <&'stime'&> is the current time of day in seconds, and
24080 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24081 Exim checks that the time-of-day clock has moved on by at least one microsecond
24082 before terminating the delivery process. This guarantees uniqueness for the
24083 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24084 opening it. If any response other than ENOENT (does not exist) is given,
24085 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24086
24087 Before Exim carries out a maildir delivery, it ensures that subdirectories
24088 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24089 do not exist, Exim tries to create them and any superior directories in their
24090 path, subject to the &%create_directory%& and &%create_file%& options. If the
24091 &%maildirfolder_create_regex%& option is set, and the regular expression it
24092 contains matches the delivery directory, Exim also ensures that a file called
24093 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24094 &_maildirfolder_& file cannot be created, delivery is deferred.
24095
24096 These features make it possible to use Exim to create all the necessary files
24097 and directories in a maildir mailbox, including subdirectories for maildir++
24098 folders. Consider this example:
24099 .code
24100 maildir_format = true
24101 directory = /var/mail/$local_part_data\
24102            ${if eq{$local_part_suffix}{}{}\
24103            {/.${substr_1:$local_part_suffix}}}
24104 maildirfolder_create_regex = /\.[^/]+$
24105 .endd
24106 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24107 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24108 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24109 not match this name, so Exim will not look for or create the file
24110 &_/var/mail/pimbo/maildirfolder_&, though it will create
24111 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24112
24113 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24114 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24115 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24116 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24117 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24118
24119 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24120 not inadvertently match the toplevel maildir directory, because a
24121 &_maildirfolder_& file at top level would completely break quota calculations.
24122
24123 .cindex "quota" "in maildir delivery"
24124 .cindex "maildir++"
24125 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24126 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24127 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24128 Exim assumes the directory is a maildir++ folder directory, which is one level
24129 down from the user's top level mailbox directory. This causes it to start at
24130 the parent directory instead of the current directory when calculating the
24131 amount of space used.
24132
24133 One problem with delivering into a multi-file mailbox is that it is
24134 computationally expensive to compute the size of the mailbox for quota
24135 checking. Various approaches have been taken to reduce the amount of work
24136 needed. The next two sections describe two of them. A third alternative is to
24137 use some external process for maintaining the size data, and use the expansion
24138 of the &%mailbox_size%& option as a way of importing it into Exim.
24139
24140
24141
24142
24143 .section "Using tags to record message sizes" "SECID135"
24144 If &%maildir_tag%& is set, the string is expanded for each delivery.
24145 When the maildir file is renamed into the &_new_& sub-directory, the
24146 tag is added to its name. However, if adding the tag takes the length of the
24147 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24148 the tag is dropped and the maildir file is created with no tag.
24149
24150
24151 .vindex "&$message_size$&"
24152 Tags can be used to encode the size of files in their names; see
24153 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24154 happens after the message has been written. The value of the &$message_size$&
24155 variable is set to the number of bytes actually written. If the expansion is
24156 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24157 be deferred. The expanded tag may contain any printing characters except &"/"&.
24158 Non-printing characters in the string are ignored; if the resulting string is
24159 empty, it is ignored. If it starts with an alphanumeric character, a leading
24160 colon is inserted; this default has not proven to be the path that popular
24161 maildir implementations have chosen (but changing it in Exim would break
24162 backwards compatibility).
24163
24164 For one common implementation, you might set:
24165 .code
24166 maildir_tag = ,S=${message_size}
24167 .endd
24168 but you should check the documentation of the other software to be sure.
24169
24170 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24171 as this allows Exim to extract the size from your tag, instead of having to
24172 &[stat()]& each message file.
24173
24174
24175 .section "Using a maildirsize file" "SECID136"
24176 .cindex "quota" "in maildir delivery"
24177 .cindex "maildir format" "&_maildirsize_& file"
24178 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24179 storing quota and message size information in a file called &_maildirsize_&
24180 within the toplevel maildir directory. If this file does not exist, Exim
24181 creates it, setting the quota from the &%quota%& option of the transport. If
24182 the maildir directory itself does not exist, it is created before any attempt
24183 to write a &_maildirsize_& file.
24184
24185 The &_maildirsize_& file is used to hold information about the sizes of
24186 messages in the maildir, thus speeding up quota calculations. The quota value
24187 in the file is just a cache; if the quota is changed in the transport, the new
24188 value overrides the cached value when the next message is delivered. The cache
24189 is maintained for the benefit of other programs that access the maildir and
24190 need to know the quota.
24191
24192 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24193 file is maintained (with a zero quota setting), but no quota is imposed.
24194
24195 A regular expression is available for controlling which directories in the
24196 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24197 See the description of the &%maildir_quota_directory_regex%& option above for
24198 details.
24199
24200
24201 .section "Mailstore delivery" "SECID137"
24202 .cindex "mailstore format" "description of"
24203 If the &%mailstore_format%& option is true, each message is written as two
24204 files in the given directory. A unique base name is constructed from the
24205 message id and the current delivery process, and the files that are written use
24206 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24207 contains the message's envelope, and the &_.msg_& file contains the message
24208 itself. The base name is placed in the variable &$mailstore_basename$&.
24209
24210 During delivery, the envelope is first written to a file with the suffix
24211 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24212 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24213 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24214 file before accessing either of them. An alternative approach is to wait for
24215 the absence of a &_.tmp_& file.
24216
24217 The envelope file starts with any text defined by the &%mailstore_prefix%&
24218 option, expanded and terminated by a newline if there isn't one. Then follows
24219 the sender address on one line, then all the recipient addresses, one per line.
24220 There can be more than one recipient only if the &%batch_max%& option is set
24221 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24222 appended to the file, followed by a newline if it does not end with one.
24223
24224 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24225 failure, it is ignored. Other expansion errors are treated as serious
24226 configuration errors, and delivery is deferred. The variable
24227 &$mailstore_basename$& is available for use during these expansions.
24228
24229
24230 .section "Non-special new file delivery" "SECID138"
24231 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24232 file is created directly in the named directory. For example, when delivering
24233 messages into files in batched SMTP format for later delivery to some host (see
24234 section &<<SECTbatchSMTP>>&), a setting such as
24235 .code
24236 directory = /var/bsmtp/$host
24237 .endd
24238 might be used. A message is written to a file with a temporary name, which is
24239 then renamed when the delivery is complete. The final name is obtained by
24240 expanding the contents of the &%directory_file%& option.
24241 .ecindex IIDapptra1
24242 .ecindex IIDapptra2
24243
24244
24245
24246
24247
24248
24249 . ////////////////////////////////////////////////////////////////////////////
24250 . ////////////////////////////////////////////////////////////////////////////
24251
24252 .chapter "The autoreply transport" "CHID8"
24253 .scindex IIDauttra1 "transports" "&(autoreply)&"
24254 .scindex IIDauttra2 "&(autoreply)& transport"
24255 The &(autoreply)& transport is not a true transport in that it does not cause
24256 the message to be transmitted. Instead, it generates a new mail message as an
24257 automatic reply to the incoming message. &'References:'& and
24258 &'Auto-Submitted:'& header lines are included. These are constructed according
24259 to the rules in RFCs 2822 and 3834, respectively.
24260
24261 If the router that passes the message to this transport does not have the
24262 &%unseen%& option set, the original message (for the current recipient) is not
24263 delivered anywhere. However, when the &%unseen%& option is set on the router
24264 that passes the message to this transport, routing of the address continues, so
24265 another router can set up a normal message delivery.
24266
24267
24268 The &(autoreply)& transport is usually run as the result of mail filtering, a
24269 &"vacation"& message being the standard example. However, it can also be run
24270 directly from a router like any other transport. To reduce the possibility of
24271 message cascades, messages created by the &(autoreply)& transport always have
24272 empty envelope sender addresses, like bounce messages.
24273
24274 The parameters of the message to be sent can be specified in the configuration
24275 by options described below. However, these are used only when the address
24276 passed to the transport does not contain its own reply information. When the
24277 transport is run as a consequence of a
24278 &%mail%&
24279 or &%vacation%& command in a filter file, the parameters of the message are
24280 supplied by the filter, and passed with the address. The transport's options
24281 that define the message are then ignored (so they are not usually set in this
24282 case). The message is specified entirely by the filter or by the transport; it
24283 is never built from a mixture of options. However, the &%file_optional%&,
24284 &%mode%&, and &%return_message%& options apply in all cases.
24285
24286 &(Autoreply)& is implemented as a local transport. When used as a result of a
24287 command in a user's filter file, &(autoreply)& normally runs under the uid and
24288 gid of the user, and with appropriate current and home directories (see chapter
24289 &<<CHAPenvironment>>&).
24290
24291 There is a subtle difference between routing a message to a &(pipe)& transport
24292 that generates some text to be returned to the sender, and routing it to an
24293 &(autoreply)& transport. This difference is noticeable only if more than one
24294 address from the same message is so handled. In the case of a pipe, the
24295 separate outputs from the different addresses are gathered up and returned to
24296 the sender in a single message, whereas if &(autoreply)& is used, a separate
24297 message is generated for each address that is passed to it.
24298
24299 Non-printing characters are not permitted in the header lines generated for the
24300 message that &(autoreply)& creates, with the exception of newlines that are
24301 immediately followed by white space. If any non-printing characters are found,
24302 the transport defers.
24303 Whether characters with the top bit set count as printing characters or not is
24304 controlled by the &%print_topbitchars%& global option.
24305
24306 If any of the generic options for manipulating headers (for example,
24307 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24308 of the original message that is included in the generated message when
24309 &%return_message%& is set. They do not apply to the generated message itself.
24310
24311 .vindex "&$sender_address$&"
24312 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24313 the message, indicating that there were no recipients, it does not treat this
24314 as an error. This means that autoreplies sent to &$sender_address$& when this
24315 is empty (because the incoming message is a bounce message) do not cause
24316 problems. They are just discarded.
24317
24318
24319
24320 .section "Private options for autoreply" "SECID139"
24321 .cindex "options" "&(autoreply)& transport"
24322
24323 .option bcc autoreply string&!! unset
24324 This specifies the addresses that are to receive &"blind carbon copies"& of the
24325 message when the message is specified by the transport.
24326
24327
24328 .option cc autoreply string&!! unset
24329 This specifies recipients of the message and the contents of the &'Cc:'& header
24330 when the message is specified by the transport.
24331
24332
24333 .option file autoreply string&!! unset
24334 The contents of the file are sent as the body of the message when the message
24335 is specified by the transport. If both &%file%& and &%text%& are set, the text
24336 string comes first.
24337
24338
24339 .option file_expand autoreply boolean false
24340 If this is set, the contents of the file named by the &%file%& option are
24341 subjected to string expansion as they are added to the message.
24342
24343
24344 .option file_optional autoreply boolean false
24345 If this option is true, no error is generated if the file named by the &%file%&
24346 option or passed with the address does not exist or cannot be read.
24347
24348
24349 .option from autoreply string&!! unset
24350 This specifies the contents of the &'From:'& header when the message is
24351 specified by the transport.
24352
24353
24354 .option headers autoreply string&!! unset
24355 This specifies additional RFC 2822 headers that are to be added to the message
24356 when the message is specified by the transport. Several can be given by using
24357 &"\n"& to separate them. There is no check on the format.
24358
24359
24360 .option log autoreply string&!! unset
24361 This option names a file in which a record of every message sent is logged when
24362 the message is specified by the transport.
24363
24364
24365 .option mode autoreply "octal integer" 0600
24366 If either the log file or the &"once"& file has to be created, this mode is
24367 used.
24368
24369
24370 .option never_mail autoreply "address list&!!" unset
24371 If any run of the transport creates a message with a recipient that matches any
24372 item in the list, that recipient is quietly discarded. If all recipients are
24373 discarded, no message is created. This applies both when the recipients are
24374 generated by a filter and when they are specified in the transport.
24375
24376
24377
24378 .option once autoreply string&!! unset
24379 This option names a file or DBM database in which a record of each &'To:'&
24380 recipient is kept when the message is specified by the transport. &*Note*&:
24381 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24382
24383 If &%once%& is unset, or is set to an empty string, the message is always sent.
24384 By default, if &%once%& is set to a non-empty filename, the message
24385 is not sent if a potential recipient is already listed in the database.
24386 However, if the &%once_repeat%& option specifies a time greater than zero, the
24387 message is sent if that much time has elapsed since a message was last sent to
24388 this recipient. A setting of zero time for &%once_repeat%& (the default)
24389 prevents a message from being sent a second time &-- in this case, zero means
24390 infinity.
24391
24392 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24393 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24394 greater than zero, it changes the way Exim implements the &%once%& option.
24395 Instead of using a DBM file to record every recipient it sends to, it uses a
24396 regular file, whose size will never get larger than the given value.
24397
24398 In the file, Exim keeps a linear list of recipient addresses and the times at
24399 which they were sent messages. If the file is full when a new address needs to
24400 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24401 means that a given recipient may receive multiple messages, but at
24402 unpredictable intervals that depend on the rate of turnover of addresses in the
24403 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24404
24405
24406 .option once_file_size autoreply integer 0
24407 See &%once%& above.
24408
24409
24410 .option once_repeat autoreply time&!! 0s
24411 See &%once%& above.
24412 After expansion, the value of this option must be a valid time value.
24413
24414
24415 .option reply_to autoreply string&!! unset
24416 This specifies the contents of the &'Reply-To:'& header when the message is
24417 specified by the transport.
24418
24419
24420 .option return_message autoreply boolean false
24421 If this is set, a copy of the original message is returned with the new
24422 message, subject to the maximum size set in the &%return_size_limit%& global
24423 configuration option.
24424
24425
24426 .option subject autoreply string&!! unset
24427 This specifies the contents of the &'Subject:'& header when the message is
24428 specified by the transport. It is tempting to quote the original subject in
24429 automatic responses. For example:
24430 .code
24431 subject = Re: $h_subject:
24432 .endd
24433 There is a danger in doing this, however. It may allow a third party to
24434 subscribe your users to an opt-in mailing list, provided that the list accepts
24435 bounce messages as subscription confirmations. Well-managed lists require a
24436 non-bounce message to confirm a subscription, so the danger is relatively
24437 small.
24438
24439
24440
24441 .option text autoreply string&!! unset
24442 This specifies a single string to be used as the body of the message when the
24443 message is specified by the transport. If both &%text%& and &%file%& are set,
24444 the text comes first.
24445
24446
24447 .option to autoreply string&!! unset
24448 This specifies recipients of the message and the contents of the &'To:'& header
24449 when the message is specified by the transport.
24450 .ecindex IIDauttra1
24451 .ecindex IIDauttra2
24452
24453
24454
24455
24456 . ////////////////////////////////////////////////////////////////////////////
24457 . ////////////////////////////////////////////////////////////////////////////
24458
24459 .chapter "The lmtp transport" "CHAPLMTP"
24460 .cindex "transports" "&(lmtp)&"
24461 .cindex "&(lmtp)& transport"
24462 .cindex "LMTP" "over a pipe"
24463 .cindex "LMTP" "over a socket"
24464 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24465 specified command
24466 or by interacting with a Unix domain socket.
24467 This transport is something of a cross between the &(pipe)& and &(smtp)&
24468 transports. Exim also has support for using LMTP over TCP/IP; this is
24469 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24470 to be of minority interest, the default build-time configure in &_src/EDITME_&
24471 has it commented out. You need to ensure that
24472 .code
24473 TRANSPORT_LMTP=yes
24474 .endd
24475 .cindex "options" "&(lmtp)& transport"
24476 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24477 included in the Exim binary. The private options of the &(lmtp)& transport are
24478 as follows:
24479
24480 .option batch_id lmtp string&!! unset
24481 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24482
24483
24484 .option batch_max lmtp integer 1
24485 This limits the number of addresses that can be handled in a single delivery.
24486 Most LMTP servers can handle several addresses at once, so it is normally a
24487 good idea to increase this value. See the description of local delivery
24488 batching in chapter &<<CHAPbatching>>&.
24489
24490
24491 .option command lmtp string&!! unset
24492 This option must be set if &%socket%& is not set. The string is a command which
24493 is run in a separate process. It is split up into a command name and list of
24494 arguments, each of which is separately expanded (so expansion cannot change the
24495 number of arguments). The command is run directly, not via a shell. The message
24496 is passed to the new process using the standard input and output to operate the
24497 LMTP protocol.
24498
24499 .option ignore_quota lmtp boolean false
24500 .cindex "LMTP" "ignoring quota errors"
24501 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24502 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24503 in its response to the LHLO command.
24504
24505 .option socket lmtp string&!! unset
24506 This option must be set if &%command%& is not set. The result of expansion must
24507 be the name of a Unix domain socket. The transport connects to the socket and
24508 delivers the message to it using the LMTP protocol.
24509
24510
24511 .option timeout lmtp time 5m
24512 The transport is aborted if the created process or Unix domain socket does not
24513 respond to LMTP commands or message input within this timeout. Delivery
24514 is deferred, and will be tried again later. Here is an example of a typical
24515 LMTP transport:
24516 .code
24517 lmtp:
24518   driver = lmtp
24519   command = /some/local/lmtp/delivery/program
24520   batch_max = 20
24521   user = exim
24522 .endd
24523 This delivers up to 20 addresses at a time, in a mixture of domains if
24524 necessary, running as the user &'exim'&.
24525
24526
24527
24528 . ////////////////////////////////////////////////////////////////////////////
24529 . ////////////////////////////////////////////////////////////////////////////
24530
24531 .chapter "The pipe transport" "CHAPpipetransport"
24532 .scindex IIDpiptra1 "transports" "&(pipe)&"
24533 .scindex IIDpiptra2 "&(pipe)& transport"
24534 The &(pipe)& transport is used to deliver messages via a pipe to a command
24535 running in another process. One example is the use of &(pipe)& as a
24536 pseudo-remote transport for passing messages to some other delivery mechanism
24537 (such as UUCP). Another is the use by individual users to automatically process
24538 their incoming messages. The &(pipe)& transport can be used in one of the
24539 following ways:
24540
24541 .ilist
24542 .vindex "&$local_part$&"
24543 A router routes one address to a transport in the normal way, and the
24544 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24545 contains the local part of the address (as usual), and the command that is run
24546 is specified by the &%command%& option on the transport.
24547 .next
24548 .vindex "&$pipe_addresses$&"
24549 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24550 transport can handle more than one address in a single run. In this case, when
24551 more than one address is routed to the transport, &$local_part$& is not set
24552 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24553 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24554 that are routed to the transport.
24555 .next
24556 .vindex "&$address_pipe$&"
24557 A router redirects an address directly to a pipe command (for example, from an
24558 alias or forward file). In this case, &$address_pipe$& contains the text of the
24559 pipe command, and the &%command%& option on the transport is ignored unless
24560 &%force_command%& is set. If only one address is being transported
24561 (&%batch_max%& is not greater than one, or only one address was redirected to
24562 this pipe command), &$local_part$& contains the local part that was redirected.
24563 .endlist
24564
24565
24566 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24567 deliver messages over pipes using the LMTP interactive protocol. This is
24568 implemented by the &(lmtp)& transport.
24569
24570 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24571 &_.forward_& file, the command runs under the uid and gid of that user. In
24572 other cases, the uid and gid have to be specified explicitly, either on the
24573 transport or on the router that handles the address. Current and &"home"&
24574 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24575 details of the local delivery environment and chapter &<<CHAPbatching>>&
24576 for a discussion of local delivery batching.
24577
24578 .cindex "tainted data" "in pipe command"
24579 .cindex pipe "tainted data"
24580 Tainted data may not be used for the command name.
24581
24582
24583 .section "Concurrent delivery" "SECID140"
24584 If two messages arrive at almost the same time, and both are routed to a pipe
24585 delivery, the two pipe transports may be run concurrently. You must ensure that
24586 any pipe commands you set up are robust against this happening. If the commands
24587 write to a file, the &%exim_lock%& utility might be of use.
24588 Alternatively the &%max_parallel%& option could be used with a value
24589 of "1" to enforce serialization.
24590
24591
24592
24593
24594 .section "Returned status and data" "SECID141"
24595 .cindex "&(pipe)& transport" "returned data"
24596 If the command exits with a non-zero return code, the delivery is deemed to
24597 have failed, unless either the &%ignore_status%& option is set (in which case
24598 the return code is treated as zero), or the return code is one of those listed
24599 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24600 later"&. In this case, delivery is deferred. Details of a permanent failure are
24601 logged, but are not included in the bounce message, which merely contains
24602 &"local delivery failed"&.
24603
24604 If the command exits on a signal and the &%freeze_signal%& option is set then
24605 the message will be frozen in the queue. If that option is not set, a bounce
24606 will be sent as normal.
24607
24608 If the return code is greater than 128 and the command being run is a shell
24609 script, it normally means that the script was terminated by a signal whose
24610 value is the return code minus 128. The &%freeze_signal%& option does not
24611 apply in this case.
24612
24613 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24614 return code is set to 127. This is the value that a shell returns if it is
24615 asked to run a non-existent command. The wording for the log line suggests that
24616 a non-existent command may be the problem.
24617
24618 The &%return_output%& option can affect the result of a pipe delivery. If it is
24619 set and the command produces any output on its standard output or standard
24620 error streams, the command is considered to have failed, even if it gave a zero
24621 return code or if &%ignore_status%& is set. The output from the command is
24622 included as part of the bounce message. The &%return_fail_output%& option is
24623 similar, except that output is returned only when the command exits with a
24624 failure return code, that is, a value other than zero or a code that matches
24625 &%temp_errors%&.
24626
24627
24628
24629 .section "How the command is run" "SECThowcommandrun"
24630 .cindex "&(pipe)& transport" "path for command"
24631 The command line is (by default) broken down into a command name and arguments
24632 by the &(pipe)& transport itself. The &%allow_commands%& and
24633 &%restrict_to_path%& options can be used to restrict the commands that may be
24634 run.
24635
24636 .cindex "quoting" "in pipe command"
24637 Unquoted arguments are delimited by white space. If an argument appears in
24638 double quotes, backslash is interpreted as an escape character in the usual
24639 way. If an argument appears in single quotes, no escaping is done.
24640
24641 String expansion is applied to the command line except when it comes from a
24642 traditional &_.forward_& file (commands from a filter file are expanded). The
24643 expansion is applied to each argument in turn rather than to the whole line.
24644 For this reason, any string expansion item that contains white space must be
24645 quoted so as to be contained within a single argument. A setting such as
24646 .code
24647 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24648 .endd
24649 will not work, because the expansion item gets split between several
24650 arguments. You have to write
24651 .code
24652 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24653 .endd
24654 to ensure that it is all in one argument. The expansion is done in this way,
24655 argument by argument, so that the number of arguments cannot be changed as a
24656 result of expansion, and quotes or backslashes in inserted variables do not
24657 interact with external quoting. However, this leads to problems if you want to
24658 generate multiple arguments (or the command name plus arguments) from a single
24659 expansion. In this situation, the simplest solution is to use a shell. For
24660 example:
24661 .code
24662 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24663 .endd
24664
24665 .cindex "transport" "filter"
24666 .cindex "filter" "transport filter"
24667 .vindex "&$pipe_addresses$&"
24668 Special handling takes place when an argument consists of precisely the text
24669 &`$pipe_addresses`& (no quotes).
24670 This is not a general expansion variable; the only
24671 place this string is recognized is when it appears as an argument for a pipe or
24672 transport filter command. It causes each address that is being handled to be
24673 inserted in the argument list at that point &'as a separate argument'&. This
24674 avoids any problems with spaces or shell metacharacters, and is of use when a
24675 &(pipe)& transport is handling groups of addresses in a batch.
24676
24677 If &%force_command%& is enabled on the transport, special handling takes place
24678 for an argument that consists of precisely the text &`$address_pipe`&.  It
24679 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24680 argument is inserted in the argument list at that point
24681 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24682 the only item in the argument; in fact, if it were then &%force_command%&
24683 should behave as a no-op.  Rather, it should be used to adjust the command
24684 run while preserving the argument vector separation.
24685
24686 After splitting up into arguments and expansion, the resulting command is run
24687 in a subprocess directly from the transport, &'not'& under a shell. The
24688 message that is being delivered is supplied on the standard input, and the
24689 standard output and standard error are both connected to a single pipe that is
24690 read by Exim. The &%max_output%& option controls how much output the command
24691 may produce, and the &%return_output%& and &%return_fail_output%& options
24692 control what is done with it.
24693
24694 Not running the command under a shell (by default) lessens the security risks
24695 in cases when a command from a user's filter file is built out of data that was
24696 taken from an incoming message. If a shell is required, it can of course be
24697 explicitly specified as the command to be run. However, there are circumstances
24698 where existing commands (for example, in &_.forward_& files) expect to be run
24699 under a shell and cannot easily be modified. To allow for these cases, there is
24700 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24701 works. Instead of breaking up the command line as just described, it expands it
24702 as a single string and passes the result to &_/bin/sh_&. The
24703 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24704 with &%use_shell%&, and the whole mechanism is inherently less secure.
24705
24706
24707
24708 .section "Environment variables" "SECTpipeenv"
24709 .cindex "&(pipe)& transport" "environment for command"
24710 .cindex "environment" "&(pipe)& transport"
24711 The environment variables listed below are set up when the command is invoked.
24712 This list is a compromise for maximum compatibility with other MTAs. Note that
24713 the &%environment%& option can be used to add additional variables to this
24714 environment. The environment for the &(pipe)& transport is not subject
24715 to the &%add_environment%& and &%keep_environment%& main config options.
24716 &*Note*&: Using enviroment variables loses track of tainted data.
24717 Writers of &(pipe)& transport commands should be wary of data supplied
24718 by potential attackers.
24719 .display
24720 &`DOMAIN            `&   the domain of the address
24721 &`HOME              `&   the home directory, if set
24722 &`HOST              `&   the host name when called from a router (see below)
24723 &`LOCAL_PART        `&   see below
24724 &`LOCAL_PART_PREFIX `&   see below
24725 &`LOCAL_PART_SUFFIX `&   see below
24726 &`LOGNAME           `&   see below
24727 &`MESSAGE_ID        `&   Exim's local ID for the message
24728 &`PATH              `&   as specified by the &%path%& option below
24729 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24730 &`RECIPIENT         `&   the complete recipient address
24731 &`SENDER            `&   the sender of the message (empty if a bounce)
24732 &`SHELL             `&   &`/bin/sh`&
24733 &`TZ                `&   the value of the &%timezone%& option, if set
24734 &`USER              `&   see below
24735 .endd
24736 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24737 router, LOCAL_PART is set to the local part of the address. When it is
24738 called as a result of a forward or alias expansion, LOCAL_PART is set to
24739 the local part of the address that was expanded. In both cases, any affixes are
24740 removed from the local part, and made available in LOCAL_PART_PREFIX and
24741 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24742 same value as LOCAL_PART for compatibility with other MTAs.
24743
24744 .cindex "HOST"
24745 HOST is set only when a &(pipe)& transport is called from a router that
24746 associates hosts with an address, typically when using &(pipe)& as a
24747 pseudo-remote transport. HOST is set to the first host name specified by
24748 the router.
24749
24750 .cindex "HOME"
24751 If the transport's generic &%home_directory%& option is set, its value is used
24752 for the HOME environment variable. Otherwise, a home directory may be set
24753 by the router's &%transport_home_directory%& option, which defaults to the
24754 user's home directory if &%check_local_user%& is set.
24755
24756
24757 .section "Private options for pipe" "SECID142"
24758 .cindex "options" "&(pipe)& transport"
24759
24760
24761
24762 .option allow_commands pipe "string list&!!" unset
24763 .cindex "&(pipe)& transport" "permitted commands"
24764 The string is expanded, and is then interpreted as a colon-separated list of
24765 permitted commands. If &%restrict_to_path%& is not set, the only commands
24766 permitted are those in the &%allow_commands%& list. They need not be absolute
24767 paths; the &%path%& option is still used for relative paths. If
24768 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24769 in the &%allow_commands%& list, or a name without any slashes that is found on
24770 the path. In other words, if neither &%allow_commands%& nor
24771 &%restrict_to_path%& is set, there is no restriction on the command, but
24772 otherwise only commands that are permitted by one or the other are allowed. For
24773 example, if
24774 .code
24775 allow_commands = /usr/bin/vacation
24776 .endd
24777 and &%restrict_to_path%& is not set, the only permitted command is
24778 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24779 &%use_shell%& is set.
24780
24781
24782 .option batch_id pipe string&!! unset
24783 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24784
24785
24786 .option batch_max pipe integer 1
24787 This limits the number of addresses that can be handled in a single delivery.
24788 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24789
24790
24791 .option check_string pipe string unset
24792 As &(pipe)& writes the message, the start of each line is tested for matching
24793 &%check_string%&, and if it does, the initial matching characters are replaced
24794 by the contents of &%escape_string%&, provided both are set. The value of
24795 &%check_string%& is a literal string, not a regular expression, and the case of
24796 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24797 of &%check_string%& and &%escape_string%& are forced to values that implement
24798 the SMTP escaping protocol. Any settings made in the configuration file are
24799 ignored.
24800
24801
24802 .option command pipe string&!! unset
24803 This option need not be set when &(pipe)& is being used to deliver to pipes
24804 obtained directly from address redirections. In other cases, the option must be
24805 set, to provide a command to be run. It need not yield an absolute path (see
24806 the &%path%& option below). The command is split up into separate arguments by
24807 Exim, and each argument is separately expanded, as described in section
24808 &<<SECThowcommandrun>>& above.
24809
24810 .cindex "tainted data"
24811 No part of the resulting command may be tainted.
24812
24813
24814 .option environment pipe string&!! unset
24815 .cindex "&(pipe)& transport" "environment for command"
24816 .cindex "environment" "&(pipe)& transport"
24817 This option is used to add additional variables to the environment in which the
24818 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24819 a string which is expanded, and then interpreted as a colon-separated list of
24820 environment settings of the form <&'name'&>=<&'value'&>.
24821
24822
24823 .option escape_string pipe string unset
24824 See &%check_string%& above.
24825
24826
24827 .option freeze_exec_fail pipe boolean false
24828 .cindex "exec failure"
24829 .cindex "failure of exec"
24830 .cindex "&(pipe)& transport" "failure of exec"
24831 Failure to exec the command in a pipe transport is by default treated like
24832 any other failure while running the command. However, if &%freeze_exec_fail%&
24833 is set, failure to exec is treated specially, and causes the message to be
24834 frozen, whatever the setting of &%ignore_status%&.
24835
24836
24837 .option freeze_signal pipe boolean false
24838 .cindex "signal exit"
24839 .cindex "&(pipe)& transport", "signal exit"
24840 Normally if the process run by a command in a pipe transport exits on a signal,
24841 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24842 frozen in Exim's queue instead.
24843
24844
24845 .option force_command pipe boolean false
24846 .cindex "force command"
24847 .cindex "&(pipe)& transport", "force command"
24848 Normally when a router redirects an address directly to a pipe command
24849 the &%command%& option on the transport is ignored.  If &%force_command%&
24850 is set, the &%command%& option will used. This is especially
24851 useful for forcing a wrapper or additional argument to be added to the
24852 command. For example:
24853 .code
24854 command = /usr/bin/remote_exec myhost -- $address_pipe
24855 force_command
24856 .endd
24857
24858 Note that &$address_pipe$& is handled specially in &%command%& when
24859 &%force_command%& is set, expanding out to the original argument vector as
24860 separate items, similarly to a Unix shell &`"$@"`& construct.
24861
24862
24863 .option ignore_status pipe boolean false
24864 If this option is true, the status returned by the subprocess that is set up to
24865 run the command is ignored, and Exim behaves as if zero had been returned.
24866 Otherwise, a non-zero status or termination by signal causes an error return
24867 from the transport unless the status value is one of those listed in
24868 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24869
24870 &*Note*&: This option does not apply to timeouts, which do not return a status.
24871 See the &%timeout_defer%& option for how timeouts are handled.
24872
24873
24874 .option log_defer_output pipe boolean false
24875 .cindex "&(pipe)& transport" "logging output"
24876 If this option is set, and the status returned by the command is
24877 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24878 and any output was produced on stdout or stderr, the first line of it is
24879 written to the main log.
24880
24881
24882 .option log_fail_output pipe boolean false
24883 If this option is set, and the command returns any output on stdout or
24884 stderr, and also ends with a return code that is neither zero nor one of
24885 the return codes listed in &%temp_errors%& (that is, the delivery
24886 failed), the first line of output is written to the main log. This
24887 option and &%log_output%& are mutually exclusive.  Only one of them may
24888 be set.
24889
24890
24891 .option log_output pipe boolean false
24892 If this option is set and the command returns any output on stdout or
24893 stderr, the first line of output is written to the main log, whatever
24894 the return code. This option and &%log_fail_output%& are mutually
24895 exclusive. Only one of them may be set.
24896
24897
24898 .option max_output pipe integer 20K
24899 This specifies the maximum amount of output that the command may produce on its
24900 standard output and standard error file combined. If the limit is exceeded, the
24901 process running the command is killed. This is intended as a safety measure to
24902 catch runaway processes. The limit is applied independently of the settings of
24903 the options that control what is done with such output (for example,
24904 &%return_output%&). Because of buffering effects, the amount of output may
24905 exceed the limit by a small amount before Exim notices.
24906
24907
24908 .option message_prefix pipe string&!! "see below"
24909 The string specified here is expanded and output at the start of every message.
24910 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24911 .code
24912 message_prefix = \
24913   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24914   ${tod_bsdinbox}\n
24915 .endd
24916 .cindex "Cyrus"
24917 .cindex "&%tmail%&"
24918 .cindex "&""From""& line"
24919 This is required by the commonly used &_/usr/bin/vacation_& program.
24920 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24921 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24922 setting
24923 .code
24924 message_prefix =
24925 .endd
24926 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24927 &`\n`& to &`\r\n`& in &%message_prefix%&.
24928
24929
24930 .option message_suffix pipe string&!! "see below"
24931 The string specified here is expanded and output at the end of every message.
24932 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24933 The suffix can be suppressed by setting
24934 .code
24935 message_suffix =
24936 .endd
24937 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24938 &`\n`& to &`\r\n`& in &%message_suffix%&.
24939
24940
24941 .option path pipe string&!! "/bin:/usr/bin"
24942 This option is expanded and
24943 specifies the string that is set up in the PATH environment
24944 variable of the subprocess.
24945 If the &%command%& option does not yield an absolute path name, the command is
24946 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24947 apply to a command specified as a transport filter.
24948
24949
24950 .option permit_coredump pipe boolean false
24951 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24952 a core-dump of a pipe command, enable this command.  This enables core-dumps
24953 during delivery and affects both the Exim binary and the pipe command run.
24954 It is recommended that this option remain off unless and until you have a need
24955 for it and that this only be enabled when needed, as the risk of excessive
24956 resource consumption can be quite high.  Note also that Exim is typically
24957 installed as a setuid binary and most operating systems will inhibit coredumps
24958 of these by default, so further OS-specific action may be required.
24959
24960
24961 .option pipe_as_creator pipe boolean false
24962 .cindex "uid (user id)" "local delivery"
24963 If the generic &%user%& option is not set and this option is true, the delivery
24964 process is run under the uid that was in force when Exim was originally called
24965 to accept the message. If the group id is not otherwise set (via the generic
24966 &%group%& option), the gid that was in force when Exim was originally called to
24967 accept the message is used.
24968
24969
24970 .option restrict_to_path pipe boolean false
24971 When this option is set, any command name not listed in &%allow_commands%& must
24972 contain no slashes. The command is searched for only in the directories listed
24973 in the &%path%& option. This option is intended for use in the case when a pipe
24974 command has been generated from a user's &_.forward_& file. This is usually
24975 handled by a &(pipe)& transport called &%address_pipe%&.
24976
24977
24978 .option return_fail_output pipe boolean false
24979 If this option is true, and the command produced any output and ended with a
24980 return code other than zero or one of the codes listed in &%temp_errors%& (that
24981 is, the delivery failed), the output is returned in the bounce message.
24982 However, if the message has a null sender (that is, it is itself a bounce
24983 message), output from the command is discarded. This option and
24984 &%return_output%& are mutually exclusive. Only one of them may be set.
24985
24986
24987
24988 .option return_output pipe boolean false
24989 If this option is true, and the command produced any output, the delivery is
24990 deemed to have failed whatever the return code from the command, and the output
24991 is returned in the bounce message. Otherwise, the output is just discarded.
24992 However, if the message has a null sender (that is, it is a bounce message),
24993 output from the command is always discarded, whatever the setting of this
24994 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24995 of them may be set.
24996
24997
24998
24999 .option temp_errors pipe "string list" "see below"
25000 .cindex "&(pipe)& transport" "temporary failure"
25001 This option contains either a colon-separated list of numbers, or a single
25002 asterisk. If &%ignore_status%& is false
25003 and &%return_output%& is not set,
25004 and the command exits with a non-zero return code, the failure is treated as
25005 temporary and the delivery is deferred if the return code matches one of the
25006 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25007 codes are treated as permanent errors. The default setting contains the codes
25008 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25009 compiled on a system that does not define these macros, it assumes values of 75
25010 and 73, respectively.
25011
25012
25013 .option timeout pipe time 1h
25014 If the command fails to complete within this time, it is killed. This normally
25015 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25016 specifies no timeout. In order to ensure that any subprocesses created by the
25017 command are also killed, Exim makes the initial process a process group leader,
25018 and kills the whole process group on a timeout. However, this can be defeated
25019 if one of the processes starts a new process group.
25020
25021 .option timeout_defer pipe boolean false
25022 A timeout in a &(pipe)& transport, either in the command that the transport
25023 runs, or in a transport filter that is associated with it, is by default
25024 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25025 is set true, both kinds of timeout become temporary errors, causing the
25026 delivery to be deferred.
25027
25028 .option umask pipe "octal integer" 022
25029 This specifies the umask setting for the subprocess that runs the command.
25030
25031
25032 .option use_bsmtp pipe boolean false
25033 .cindex "envelope sender"
25034 If this option is set true, the &(pipe)& transport writes messages in &"batch
25035 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25036 commands. If you want to include a leading HELO command with such messages,
25037 you can do so by setting the &%message_prefix%& option. See section
25038 &<<SECTbatchSMTP>>& for details of batch SMTP.
25039
25040 .option use_classresources pipe boolean false
25041 .cindex "class resources (BSD)"
25042 This option is available only when Exim is running on FreeBSD, NetBSD, or
25043 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25044 resource limits when a &(pipe)& transport is run to perform a delivery. The
25045 limits for the uid under which the pipe is to run are obtained from the login
25046 class database.
25047
25048
25049 .option use_crlf pipe boolean false
25050 .cindex "carriage return"
25051 .cindex "linefeed"
25052 This option causes lines to be terminated with the two-character CRLF sequence
25053 (carriage return, linefeed) instead of just a linefeed character. In the case
25054 of batched SMTP, the byte sequence written to the pipe is then an exact image
25055 of what would be sent down a real SMTP connection.
25056
25057 The contents of the &%message_prefix%& and &%message_suffix%& options are
25058 written verbatim, so must contain their own carriage return characters if these
25059 are needed. When &%use_bsmtp%& is not set, the default values for both
25060 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25061 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25062
25063
25064 .option use_shell pipe boolean false
25065 .vindex "&$pipe_addresses$&"
25066 If this option is set, it causes the command to be passed to &_/bin/sh_&
25067 instead of being run directly from the transport, as described in section
25068 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25069 where the command is expected to be run under a shell and cannot easily be
25070 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25071 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25072 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25073 its &%-c%& option.
25074
25075
25076
25077 .section "Using an external local delivery agent" "SECID143"
25078 .cindex "local delivery" "using an external agent"
25079 .cindex "&'procmail'&"
25080 .cindex "external local delivery"
25081 .cindex "delivery" "&'procmail'&"
25082 .cindex "delivery" "by external agent"
25083 The &(pipe)& transport can be used to pass all messages that require local
25084 delivery to a separate local delivery agent such as &%procmail%&. When doing
25085 this, care must be taken to ensure that the pipe is run under an appropriate
25086 uid and gid. In some configurations one wants this to be a uid that is trusted
25087 by the delivery agent to supply the correct sender of the message. It may be
25088 necessary to recompile or reconfigure the delivery agent so that it trusts an
25089 appropriate user. The following is an example transport and router
25090 configuration for &%procmail%&:
25091 .code
25092 # transport
25093 procmail_pipe:
25094   driver = pipe
25095   command = /usr/local/bin/procmail -d $local_part_data
25096   return_path_add
25097   delivery_date_add
25098   envelope_to_add
25099   check_string = "From "
25100   escape_string = ">From "
25101   umask = 077
25102   user = $local_part_data
25103   group = mail
25104
25105 # router
25106 procmail:
25107   driver = accept
25108   check_local_user
25109   transport = procmail_pipe
25110 .endd
25111 In this example, the pipe is run as the local user, but with the group set to
25112 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25113 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25114 user to supply a correct sender address. If you do not specify either a
25115 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25116 home directory is the user's home directory by default.
25117
25118 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25119 .code
25120 IFS=" "
25121 .endd
25122 as shown in some &%procmail%& documentation, because Exim does not by default
25123 use a shell to run pipe commands.
25124
25125 .cindex "Cyrus"
25126 The next example shows a transport and a router for a system where local
25127 deliveries are handled by the Cyrus IMAP server.
25128 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25129 . but that suffix is tainted so cannot be used in a command arg
25130 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25131 .code
25132 # transport
25133 local_delivery_cyrus:
25134   driver = pipe
25135   command = /usr/cyrus/bin/deliver \
25136             -- $local_part_data
25137   user = cyrus
25138   group = mail
25139   return_output
25140   log_output
25141   message_prefix =
25142   message_suffix =
25143
25144 # router
25145 local_user_cyrus:
25146   driver = accept
25147   check_local_user
25148   transport = local_delivery_cyrus
25149 .endd
25150 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25151 &%return_output%& to cause any text written by Cyrus to be returned to the
25152 sender.
25153 .ecindex IIDpiptra1
25154 .ecindex IIDpiptra2
25155
25156
25157 . ////////////////////////////////////////////////////////////////////////////
25158 . ////////////////////////////////////////////////////////////////////////////
25159
25160 .chapter "The smtp transport" "CHAPsmtptrans"
25161 .scindex IIDsmttra1 "transports" "&(smtp)&"
25162 .scindex IIDsmttra2 "&(smtp)& transport"
25163 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25164 or LMTP protocol. The list of hosts to try can either be taken from the address
25165 that is being processed (having been set up by the router), or specified
25166 explicitly for the transport. Timeout and retry processing (see chapter
25167 &<<CHAPretry>>&) is applied to each IP address independently.
25168
25169
25170 .section "Multiple messages on a single connection" "SECID144"
25171 The sending of multiple messages over a single TCP/IP connection can arise in
25172 two ways:
25173
25174 .ilist
25175 If a message contains more than &%max_rcpt%& (see below) addresses that are
25176 routed to the same host, more than one copy of the message has to be sent to
25177 that host. In this situation, multiple copies may be sent in a single run of
25178 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25179 does when it has too many addresses to send in one message also depends on the
25180 value of the global &%remote_max_parallel%& option. Details are given in
25181 section &<<SECToutSMTPTCP>>&.)
25182 .next
25183 .cindex "hints database" "remembering routing"
25184 When a message has been successfully delivered over a TCP/IP connection, Exim
25185 looks in its hints database to see if there are any other messages awaiting a
25186 connection to the same host. If there are, a new delivery process is started
25187 for one of them, and the current TCP/IP connection is passed on to it. The new
25188 process may in turn send multiple copies and possibly create yet another
25189 process.
25190 .endlist
25191
25192
25193 For each copy sent over the same TCP/IP connection, a sequence counter is
25194 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25195 no further messages are sent over that connection.
25196
25197
25198
25199 .section "Use of the $host and $host_address variables" "SECID145"
25200 .vindex "&$host$&"
25201 .vindex "&$host_address$&"
25202 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25203 &$host_address$& are the name and IP address of the first host on the host list
25204 passed by the router. However, when the transport is about to connect to a
25205 specific host, and while it is connected to that host, &$host$& and
25206 &$host_address$& are set to the values for that host. These are the values
25207 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25208 &%serialize_hosts%&, and the various TLS options are expanded.
25209
25210
25211 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25212 .vindex &$tls_bits$&
25213 .vindex &$tls_cipher$&
25214 .vindex &$tls_peerdn$&
25215 .vindex &$tls_sni$&
25216 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25217 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25218 are the values that were set when the message was received.
25219 These are the values that are used for options that are expanded before any
25220 SMTP connections are made. Just before each connection is made, these four
25221 variables are emptied. If TLS is subsequently started, they are set to the
25222 appropriate values for the outgoing connection, and these are the values that
25223 are in force when any authenticators are run and when the
25224 &%authenticated_sender%& option is expanded.
25225
25226 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25227 and will be removed in a future release.
25228
25229
25230 .section "Private options for smtp" "SECID146"
25231 .cindex "options" "&(smtp)& transport"
25232 The private options of the &(smtp)& transport are as follows:
25233
25234
25235 .option address_retry_include_sender smtp boolean true
25236 .cindex "4&'xx'& responses" "retrying after"
25237 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25238 is the combination of sender and recipient that is delayed in subsequent queue
25239 runs until the retry time is reached. You can delay the recipient without
25240 reference to the sender (which is what earlier versions of Exim did), by
25241 setting &%address_retry_include_sender%& false. However, this can lead to
25242 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25243
25244 .option allow_localhost smtp boolean false
25245 .cindex "local host" "sending to"
25246 .cindex "fallback" "hosts specified on transport"
25247 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25248 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25249 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25250 the delivery anyway. This should be used only in special cases when the
25251 configuration ensures that no looping will result (for example, a differently
25252 configured Exim is listening on the port to which the message is sent).
25253
25254
25255 .option authenticated_sender smtp string&!! unset
25256 .cindex "Cyrus"
25257 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25258 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25259 overriding any existing authenticated sender value. If the string expansion is
25260 forced to fail, the option is ignored. Other expansion failures cause delivery
25261 to be deferred. If the result of expansion is an empty string, that is also
25262 ignored.
25263
25264 The expansion happens after the outgoing connection has been made and TLS
25265 started, if required. This means that the &$host$&, &$host_address$&,
25266 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25267 particular connection.
25268
25269 If the SMTP session is not authenticated, the expansion of
25270 &%authenticated_sender%& still happens (and can cause the delivery to be
25271 deferred if it fails), but no AUTH= item is added to MAIL commands
25272 unless &%authenticated_sender_force%& is true.
25273
25274 This option allows you to use the &(smtp)& transport in LMTP mode to
25275 deliver mail to Cyrus IMAP and provide the proper local part as the
25276 &"authenticated sender"&, via a setting such as:
25277 .code
25278 authenticated_sender = $local_part
25279 .endd
25280 This removes the need for IMAP subfolders to be assigned special ACLs to
25281 allow direct delivery to those subfolders.
25282
25283 Because of expected uses such as that just described for Cyrus (when no
25284 domain is involved), there is no checking on the syntax of the provided
25285 value.
25286
25287
25288 .option authenticated_sender_force smtp boolean false
25289 If this option is set true, the &%authenticated_sender%& option's value
25290 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25291 authenticated as a client.
25292
25293
25294 .option command_timeout smtp time 5m
25295 .cindex timeout "smtp transport command"
25296 This sets a timeout for receiving a response to an SMTP command that has been
25297 sent out. It is also used when waiting for the initial banner line from the
25298 remote host. Its value must not be zero.
25299
25300
25301 .option connect_timeout smtp time 5m
25302 .cindex timeout "smtp transport connect"
25303 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25304 to a remote host. A setting of zero allows the system timeout (typically
25305 several minutes) to act. To have any effect, the value of this option must be
25306 less than the system timeout. However, it has been observed that on some
25307 systems there is no system timeout, which is why the default value for this
25308 option is 5 minutes, a value recommended by RFC 1123.
25309
25310
25311 .option connection_max_messages smtp integer 500
25312 .cindex "SMTP" "passed connection"
25313 .cindex "SMTP" "multiple deliveries"
25314 .cindex "multiple SMTP deliveries"
25315 This controls the maximum number of separate message deliveries that are sent
25316 over a single TCP/IP connection. If the value is zero, there is no limit.
25317 For testing purposes, this value can be overridden by the &%-oB%& command line
25318 option.
25319
25320
25321 .option dane_require_tls_ciphers smtp string&!! unset
25322 .cindex "TLS" "requiring specific ciphers for DANE"
25323 .cindex "cipher" "requiring specific"
25324 .cindex DANE "TLS ciphers"
25325 This option may be used to override &%tls_require_ciphers%& for connections
25326 where DANE has been determined to be in effect.
25327 If not set, then &%tls_require_ciphers%& will be used.
25328 Normal SMTP delivery is not able to make strong demands of TLS cipher
25329 configuration, because delivery will fall back to plaintext.  Once DANE has
25330 been determined to be in effect, there is no plaintext fallback and making the
25331 TLS cipherlist configuration stronger will increase security, rather than
25332 counter-intuitively decreasing it.
25333 If the option expands to be empty or is forced to fail, then it will
25334 be treated as unset and &%tls_require_ciphers%& will be used instead.
25335
25336
25337 .option data_timeout smtp time 5m
25338 .cindex timeout "for transmitted SMTP data blocks"
25339 This sets a timeout for the transmission of each block in the data portion of
25340 the message. As a result, the overall timeout for a message depends on the size
25341 of the message. Its value must not be zero. See also &%final_timeout%&.
25342
25343
25344 .option dkim_canon smtp string&!! unset
25345 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25346 .option dkim_domain smtp "string list&!!" unset
25347 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25348 .option dkim_hash smtp string&!! sha256
25349 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25350 .option dkim_identity smtp string&!! unset
25351 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25352 .option dkim_private_key smtp string&!! unset
25353 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25354 .option dkim_selector smtp string&!! unset
25355 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25356 .option dkim_strict smtp string&!! unset
25357 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25358 .option dkim_sign_headers smtp string&!! "per RFC"
25359 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25360 .option dkim_timestamps smtp string&!! unset
25361 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25362
25363
25364 .option delay_after_cutoff smtp boolean true
25365 .cindex "final cutoff" "retries, controlling"
25366 .cindex retry "final cutoff"
25367 This option controls what happens when all remote IP addresses for a given
25368 domain have been inaccessible for so long that they have passed their retry
25369 cutoff times.
25370
25371 In the default state, if the next retry time has not been reached for any of
25372 them, the address is bounced without trying any deliveries. In other words,
25373 Exim delays retrying an IP address after the final cutoff time until a new
25374 retry time is reached, and can therefore bounce an address without ever trying
25375 a delivery, when machines have been down for a long time. Some people are
25376 unhappy at this prospect, so...
25377
25378 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25379 addresses are past their final cutoff time, Exim tries to deliver to those
25380 IP addresses that have not been tried since the message arrived. If there are
25381 none, of if they all fail, the address is bounced. In other words, it does not
25382 delay when a new message arrives, but immediately tries those expired IP
25383 addresses that haven't been tried since the message arrived. If there is a
25384 continuous stream of messages for the dead hosts, unsetting
25385 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25386 to them.
25387
25388
25389 .option dns_qualify_single smtp boolean true
25390 If the &%hosts%& or &%fallback_hosts%& option is being used,
25391 and the &%gethostbyname%& option is false,
25392 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25393 in chapter &<<CHAPdnslookup>>& for more details.
25394
25395
25396 .option dns_search_parents smtp boolean false
25397 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25398 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25399 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25400 details.
25401
25402
25403 .option dnssec_request_domains smtp "domain list&!!" *
25404 .cindex "MX record" "security"
25405 .cindex "DNSSEC" "MX lookup"
25406 .cindex "security" "MX lookup"
25407 .cindex "DNS" "DNSSEC"
25408 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25409 the DNSSEC request bit set. Setting this transport option is only useful if the
25410 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25411 router option.
25412
25413
25414
25415 .option dnssec_require_domains smtp "domain list&!!" unset
25416 .cindex "MX record" "security"
25417 .cindex "DNSSEC" "MX lookup"
25418 .cindex "security" "MX lookup"
25419 .cindex "DNS" "DNSSEC"
25420 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25421 the DNSSEC request bit set.  Setting this transport option is only
25422 useful if the transport overrides or sets the host names. See the
25423 &%dnssec_require_domains%& router option.
25424
25425
25426
25427 .option dscp smtp string&!! unset
25428 .cindex "DCSP" "outbound"
25429 This option causes the DSCP value associated with a socket to be set to one
25430 of a number of fixed strings or to numeric value.
25431 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25432 Common values include &`throughput`&, &`mincost`&, and on newer systems
25433 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25434
25435 The outbound packets from Exim will be marked with this value in the header
25436 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25437 that these values will have any effect, not be stripped by networking
25438 equipment, or do much of anything without cooperation with your Network
25439 Engineer and those of all network operators between the source and destination.
25440
25441
25442 .option fallback_hosts smtp "string list" unset
25443 .cindex "fallback" "hosts specified on transport"
25444 String expansion is not applied to this option. The argument must be a
25445 colon-separated list of host names or IP addresses, optionally also including
25446 port numbers, though the separator can be changed, as described in section
25447 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25448 item in a &%route_list%& setting for the &(manualroute)& router, as described
25449 in section &<<SECTformatonehostitem>>&.
25450
25451 Fallback hosts can also be specified on routers, which associate them with the
25452 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25453 &%fallback_hosts%& specified on the transport is used only if the address does
25454 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25455 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25456 However, &%hosts_randomize%& does apply to fallback host lists.
25457
25458 If Exim is unable to deliver to any of the hosts for a particular address, and
25459 the errors are not permanent rejections, the address is put on a separate
25460 transport queue with its host list replaced by the fallback hosts, unless the
25461 address was routed via MX records and the current host was in the original MX
25462 list. In that situation, the fallback host list is not used.
25463
25464 Once normal deliveries are complete, the fallback queue is delivered by
25465 re-running the same transports with the new host lists. If several failing
25466 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25467 copy of the message is sent.
25468
25469 The resolution of the host names on the fallback list is controlled by the
25470 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25471 both to cases when the host list comes with the address and when it is taken
25472 from &%hosts%&. This option provides a &"use a smart host only if delivery
25473 fails"& facility.
25474
25475
25476 .option final_timeout smtp time 10m
25477 .cindex timeout "for transmitted SMTP data accept"
25478 This is the timeout that applies while waiting for the response to the final
25479 line containing just &"."& that terminates a message. Its value must not be
25480 zero.
25481
25482 .option gethostbyname smtp boolean false
25483 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25484 being used, names are looked up using &[gethostbyname()]&
25485 (or &[getipnodebyname()]& when available)
25486 instead of using the DNS. Of course, that function may in fact use the DNS, but
25487 it may also consult other sources of information such as &_/etc/hosts_&.
25488
25489 .option gnutls_compat_mode smtp boolean unset
25490 This option controls whether GnuTLS is used in compatibility mode in an Exim
25491 server. This reduces security slightly, but improves interworking with older
25492 implementations of TLS.
25493
25494 .option helo_data smtp string&!! "see below"
25495 .cindex "HELO" "argument, setting"
25496 .cindex "EHLO" "argument, setting"
25497 .cindex "LHLO argument setting"
25498 The value of this option is expanded after a connection to a another host has
25499 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25500 command that starts the outgoing SMTP or LMTP session. The default value of the
25501 option is:
25502 .code
25503 $primary_hostname
25504 .endd
25505 During the expansion, the variables &$host$& and &$host_address$& are set to
25506 the identity of the remote host, and the variables &$sending_ip_address$& and
25507 &$sending_port$& are set to the local IP address and port number that are being
25508 used. These variables can be used to generate different values for different
25509 servers or different local IP addresses. For example, if you want the string
25510 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25511 interface address, you could use this:
25512 .code
25513 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25514   {${listextract{1}{<\n $value}}} \
25515   {$primary_hostname}}
25516 .endd
25517 The use of &%helo_data%& applies both to sending messages and when doing
25518 callouts.
25519
25520 .option host_name_extract smtp "string list&!!" "see below"
25521 .cindex "load balancer" "hosts behind"
25522 .cindex TLS resumption
25523 Some mail-accepting sites
25524 (notably Microsoft)
25525 operate many servers behind a network load-balancer.  When this is done,
25526 with separated TLS session caches, TLS session resuption becomes problematic.
25527 It will only succeed when the same server happens to be selected by the
25528 load-balancer, matching the session stored in the client's cache.
25529
25530 Exim can pull out a server name, if there is one, from the response to the
25531 client's SMTP EHLO command.
25532 The default value of this option:
25533 .code
25534     ${if and { {match {$host} {.outlook.com\$}} \
25535                {match {$item} {\N^250-([\w.]+)\s\N}} \
25536              } {$1}}
25537 .endd
25538 suffices for one known case.
25539 During the expansion of this option the &$item$& variable will have the
25540 server's EHLO response.
25541 The result of the option expansion is included in the key used to store and
25542 retrieve the TLS session, for session resumption.
25543
25544 Operators of high-load sites may wish to evaluate their logs for indications
25545 of other destination sites operating load-balancers, and develop a suitable
25546 expression for this option.
25547 The smtp:ehlo event and the &$tls_out_resumption$& variable
25548 will be useful for such work.
25549
25550 .option hosts smtp "string list&!!" unset
25551 Hosts are associated with an address by a router such as &(dnslookup)&, which
25552 finds the hosts by looking up the address domain in the DNS, or by
25553 &(manualroute)&, which has lists of hosts in its configuration. However,
25554 email addresses can be passed to the &(smtp)& transport by any router, and not
25555 all of them can provide an associated list of hosts.
25556
25557 The &%hosts%& option specifies a list of hosts to be used if the address being
25558 processed does not have any hosts associated with it. The hosts specified by
25559 &%hosts%& are also used, whether or not the address has its own hosts, if
25560 &%hosts_override%& is set.
25561
25562 The string is first expanded, before being interpreted as a colon-separated
25563 list of host names or IP addresses, possibly including port numbers. The
25564 separator may be changed to something other than colon, as described in section
25565 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25566 item in a &%route_list%& setting for the &(manualroute)& router, as described
25567 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25568 of the &(manualroute)& router is not available here.
25569
25570 If the expansion fails, delivery is deferred. Unless the failure was caused by
25571 the inability to complete a lookup, the error is logged to the panic log as
25572 well as the main log. Host names are looked up either by searching directly for
25573 address records in the DNS or by calling &[gethostbyname()]& (or
25574 &[getipnodebyname()]& when available), depending on the setting of the
25575 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25576 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25577 address are used.
25578
25579 During delivery, the hosts are tried in order, subject to their retry status,
25580 unless &%hosts_randomize%& is set.
25581
25582
25583 .option hosts_avoid_esmtp smtp "host list&!!" unset
25584 .cindex "ESMTP, avoiding use of"
25585 .cindex "HELO" "forcing use of"
25586 .cindex "EHLO" "avoiding use of"
25587 .cindex "PIPELINING" "avoiding the use of"
25588 This option is for use with broken hosts that announce ESMTP facilities (for
25589 example, PIPELINING) and then fail to implement them properly. When a host
25590 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25591 start of the SMTP session. This means that it cannot use any of the ESMTP
25592 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25593
25594
25595 .option hosts_avoid_pipelining smtp "host list&!!" unset
25596 .cindex "PIPELINING" "avoiding the use of"
25597 .cindex "ESMTP extensions" PIPELINING
25598 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25599 that matches this list, even if the server host advertises PIPELINING support.
25600
25601 .option hosts_pipe_connect smtp "host list&!!" unset
25602 .cindex "pipelining" "early connection"
25603 .cindex "pipelining" PIPECONNECT
25604 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25605 this option controls which to hosts the facility watched for
25606 and recorded, and used for subsequent connections.
25607
25608 The retry hints database is used for the record,
25609 and records are subject to the &%retry_data_expire%& option.
25610 When used, the pipelining saves on roundtrip times.
25611 It also turns SMTP into a client-first protocol
25612 so combines well with TCP Fast Open.
25613
25614 See also the &%pipelining_connect_advertise_hosts%& main option.
25615
25616 Note:
25617 When the facility is used, if the transport &%interface%& option is unset
25618 the &%helo_data%& option
25619 will be expanded before the &$sending_ip_address$& variable
25620 is filled in.
25621 A check is made for the use of that variable, without the
25622 presence of a &"def:"& test on it, but suitably complex coding
25623 can avoid the check and produce unexpected results.
25624 You have been warned.
25625
25626
25627 .option hosts_avoid_tls smtp "host list&!!" unset
25628 .cindex "TLS" "avoiding for certain hosts"
25629 Exim will not try to start a TLS session when delivering to any host that
25630 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25631
25632 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25633 .cindex "TLS" "avoiding for certain hosts"
25634 Exim will not try to start a TLS session for a verify callout,
25635 or when delivering in cutthrough mode,
25636 to any host that matches this list.
25637
25638
25639 .option hosts_max_try smtp integer 5
25640 .cindex "host" "maximum number to try"
25641 .cindex "limit" "number of hosts tried"
25642 .cindex "limit" "number of MX tried"
25643 .cindex "MX record" "maximum tried"
25644 This option limits the number of IP addresses that are tried for any one
25645 delivery in cases where there are temporary delivery errors. Section
25646 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25647
25648
25649 .option hosts_max_try_hardlimit smtp integer 50
25650 This is an additional check on the maximum number of IP addresses that Exim
25651 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25652 why it exists.
25653
25654
25655
25656 .option hosts_nopass_tls smtp "host list&!!" unset
25657 .cindex "TLS" "passing connection"
25658 .cindex "multiple SMTP deliveries"
25659 .cindex "TLS" "multiple message deliveries"
25660 For any host that matches this list, a connection on which a TLS session has
25661 been started will not be passed to a new delivery process for sending another
25662 message on the same connection. See section &<<SECTmulmessam>>& for an
25663 explanation of when this might be needed.
25664
25665 .option hosts_noproxy_tls smtp "host list&!!" unset
25666 .cindex "TLS" "passing connection"
25667 .cindex "multiple SMTP deliveries"
25668 .cindex "TLS" "multiple message deliveries"
25669 For any host that matches this list, a TLS session which has
25670 been started will not be passed to a new delivery process for sending another
25671 message on the same session.
25672
25673 The traditional implementation closes down TLS and re-starts it in the new
25674 process, on the same open TCP connection, for each successive message
25675 sent.  If permitted by this option a pipe to to the new process is set up
25676 instead, and the original process maintains the TLS connection and proxies
25677 the SMTP connection from and to the new process and any subsequents.
25678 The new process has no access to TLS information, so cannot include it in
25679 logging.
25680
25681
25682
25683 .option hosts_override smtp boolean false
25684 If this option is set and the &%hosts%& option is also set, any hosts that are
25685 attached to the address are ignored, and instead the hosts specified by the
25686 &%hosts%& option are always used. This option does not apply to
25687 &%fallback_hosts%&.
25688
25689
25690 .option hosts_randomize smtp boolean false
25691 .cindex "randomized host list"
25692 .cindex "host" "list of; randomized"
25693 .cindex "fallback" "randomized hosts"
25694 If this option is set, and either the list of hosts is taken from the
25695 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25696 were not obtained from MX records (this includes fallback hosts from the
25697 router), and were not randomized by the router, the order of trying the hosts
25698 is randomized each time the transport runs. Randomizing the order of a host
25699 list can be used to do crude load sharing.
25700
25701 When &%hosts_randomize%& is true, a host list may be split into groups whose
25702 order is separately randomized. This makes it possible to set up MX-like
25703 behaviour. The boundaries between groups are indicated by an item that is just
25704 &`+`& in the host list. For example:
25705 .code
25706 hosts = host1:host2:host3:+:host4:host5
25707 .endd
25708 The order of the first three hosts and the order of the last two hosts is
25709 randomized for each use, but the first three always end up before the last two.
25710 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25711
25712 .option hosts_require_auth smtp "host list&!!" unset
25713 .cindex "authentication" "required by client"
25714 This option provides a list of servers for which authentication must succeed
25715 before Exim will try to transfer a message. If authentication fails for
25716 servers which are not in this list, Exim tries to send unauthenticated. If
25717 authentication fails for one of these servers, delivery is deferred. This
25718 temporary error is detectable in the retry rules, so it can be turned into a
25719 hard failure if required. See also &%hosts_try_auth%&, and chapter
25720 &<<CHAPSMTPAUTH>>& for details of authentication.
25721
25722
25723 .option hosts_request_ocsp smtp "host list&!!" "see below"
25724 .cindex "TLS" "requiring for certain servers"
25725 Exim will request a Certificate Status on a
25726 TLS session for any host that matches this list.
25727 &%tls_verify_certificates%& should also be set for the transport.
25728
25729 .new
25730 The default is &"**"& if DANE is not in use for the connection,
25731 or if DANE-TA us used.
25732 It is empty if DANE-EE is used.
25733 .wen
25734
25735 .option hosts_require_alpn smtp "host list&!!" unset
25736 .cindex ALPN "require negotiation in client"
25737 .cindex TLS ALPN
25738 .cindex TLS "Application Layer Protocol Names"
25739 If the TLS library supports ALPN
25740 then a successful negotiation of ALPN will be required for any host
25741 matching the list, for TLS to be used.
25742 See also the &%tls_alpn%& option.
25743
25744 &*Note*&: prevention of fallback to in-clear connection is not
25745 managed by this option; see &%hosts_require_tls%&.
25746
25747 .option hosts_require_dane smtp "host list&!!" unset
25748 .cindex DANE "transport options"
25749 .cindex DANE "requiring for certain servers"
25750 If built with DANE support, Exim  will require that a DNSSEC-validated
25751 TLSA record is present for any host matching the list,
25752 and that a DANE-verified TLS connection is made.
25753 There will be no fallback to in-clear communication.
25754 See the &%dnssec_request_domains%& router and transport options.
25755 See section &<<SECDANE>>&.
25756
25757 .option hosts_require_ocsp smtp "host list&!!" unset
25758 .cindex "TLS" "requiring for certain servers"
25759 Exim will request, and check for a valid Certificate Status being given, on a
25760 TLS session for any host that matches this list.
25761 &%tls_verify_certificates%& should also be set for the transport.
25762
25763 .option hosts_require_tls smtp "host list&!!" unset
25764 .cindex "TLS" "requiring for certain servers"
25765 Exim will insist on using a TLS session when delivering to any host that
25766 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25767 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25768 incoming messages, use an appropriate ACL.
25769
25770 .option hosts_try_auth smtp "host list&!!" unset
25771 .cindex "authentication" "optional in client"
25772 This option provides a list of servers to which, provided they announce
25773 authentication support, Exim will attempt to authenticate as a client when it
25774 connects. If authentication fails
25775 and &%hosts_require_auth%& permits,
25776 Exim will try to transfer the message unauthenticated.
25777 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25778
25779 .option hosts_try_chunking smtp "host list&!!" *
25780 .cindex CHUNKING "enabling, in client"
25781 .cindex BDAT "SMTP command"
25782 .cindex "RFC 3030" "CHUNKING"
25783 This option provides a list of servers to which, provided they announce
25784 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25785 Unless DKIM signing is being done,
25786 BDAT will not be used in conjunction with a transport filter.
25787
25788 .option hosts_try_dane smtp "host list&!!" *
25789 .cindex DANE "transport options"
25790 .cindex DANE "attempting for certain servers"
25791 If built with DANE support, Exim  will look up a
25792 TLSA record for any host matching the list,
25793 If one is found and that lookup was DNSSEC-validated,
25794 then Exim requires that a DANE-verified TLS connection is made for that host;
25795 there will be no fallback to in-clear communication.
25796 See the &%dnssec_request_domains%& router and transport options.
25797 See section &<<SECDANE>>&.
25798
25799 .option hosts_try_fastopen smtp "host list&!!" *
25800 .cindex "fast open, TCP" "enabling, in client"
25801 .cindex "TCP Fast Open" "enabling, in client"
25802 .cindex "RFC 7413" "TCP Fast Open"
25803 This option provides a list of servers to which, provided
25804 the facility is supported by this system, Exim will attempt to
25805 perform a TCP Fast Open.
25806 No data is sent on the SYN segment but, if the remote server also
25807 supports the facility, it can send its SMTP banner immediately after
25808 the SYN,ACK segment.  This can save up to one round-trip time.
25809
25810 The facility is only active for previously-contacted servers,
25811 as the initiator must present a cookie in the SYN segment.
25812
25813 On (at least some) current Linux distributions the facility must be enabled
25814 in the kernel by the sysadmin before the support is usable.
25815 There is no option for control of the server side; if the system supports
25816 it it is always enabled.  Note that lengthy operations in the connect ACL,
25817 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25818
25819 .option hosts_try_prdr smtp "host list&!!" *
25820 .cindex "PRDR" "enabling, optional in client"
25821 .cindex "ESMTP extensions" PRDR
25822 This option provides a list of servers to which, provided they announce
25823 PRDR support, Exim will attempt to negotiate PRDR
25824 for multi-recipient messages.
25825 The option can usually be left as default.
25826
25827 .option interface smtp "string list&!!" unset
25828 .cindex "bind IP address"
25829 .cindex "IP address" "binding"
25830 .vindex "&$host$&"
25831 .vindex "&$host_address$&"
25832 This option specifies which interface to bind to when making an outgoing SMTP
25833 call. The value is an IP address, not an interface name such as
25834 &`eth0`&. Do not confuse this with the interface address that was used when a
25835 message was received, which is in &$received_ip_address$&, formerly known as
25836 &$interface_address$&. The name was changed to minimize confusion with the
25837 outgoing interface address. There is no variable that contains an outgoing
25838 interface address because, unless it is set by this option, its value is
25839 unknown.
25840
25841 During the expansion of the &%interface%& option the variables &$host$& and
25842 &$host_address$& refer to the host to which a connection is about to be made
25843 during the expansion of the string. Forced expansion failure, or an empty
25844 string result causes the option to be ignored. Otherwise, after expansion, the
25845 string must be a list of IP addresses, colon-separated by default, but the
25846 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25847 For example:
25848 .code
25849 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25850 .endd
25851 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25852 connection. If none of them are the correct type, the option is ignored. If
25853 &%interface%& is not set, or is ignored, the system's IP functions choose which
25854 interface to use if the host has more than one.
25855
25856
25857 .option keepalive smtp boolean true
25858 .cindex "keepalive" "on outgoing connection"
25859 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25860 connections. When set, it causes the kernel to probe idle connections
25861 periodically, by sending packets with &"old"& sequence numbers. The other end
25862 of the connection should send a acknowledgment if the connection is still okay
25863 or a reset if the connection has been aborted. The reason for doing this is
25864 that it has the beneficial effect of freeing up certain types of connection
25865 that can get stuck when the remote host is disconnected without tidying up the
25866 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25867 unreachable hosts.
25868
25869
25870 .option lmtp_ignore_quota smtp boolean false
25871 .cindex "LMTP" "ignoring quota errors"
25872 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25873 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25874 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25875
25876 .option max_rcpt smtp integer&!! 100
25877 .cindex "RCPT" "maximum number of outgoing"
25878 This option,
25879 .new
25880 after expansion,
25881 .wen
25882 limits the number of RCPT commands that are sent in a single
25883 SMTP message transaction.
25884 A value setting of zero disables the limit.
25885
25886 .new
25887 If a constant is given,
25888 .wen
25889 each set of addresses is treated independently, and
25890 so can cause parallel connections to the same host if &%remote_max_parallel%&
25891 permits this.
25892
25893
25894 .option message_linelength_limit smtp integer 998
25895 .cindex "line length" limit
25896 This option sets the maximum line length, in bytes, that the transport
25897 will send.  Any messages with lines exceeding the given value
25898 will fail and a failure-DSN ("bounce") message will if possible be returned
25899 to the sender.
25900 The default value is that defined by the SMTP standards.
25901
25902 It is generally wise to also check in the data ACL so that messages
25903 received via SMTP can be refused without producing a bounce.
25904
25905
25906 .option multi_domain smtp boolean&!! true
25907 .vindex "&$domain$&"
25908 When this option is set, the &(smtp)& transport can handle a number of
25909 addresses containing a mixture of different domains provided they all resolve
25910 to the same list of hosts. Turning the option off restricts the transport to
25911 handling only one domain at a time. This is useful if you want to use
25912 &$domain$& in an expansion for the transport, because it is set only when there
25913 is a single domain involved in a remote delivery.
25914
25915 It is expanded per-address and can depend on any of
25916 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25917 &$host$&, &$host_address$& and &$host_port$&.
25918
25919 If the connection is DANE-enabled then this option is ignored;
25920 only messages having the domain used for the DANE TLSA lookup are
25921 sent on the connection.
25922
25923 .option port smtp string&!! "see below"
25924 .cindex "port" "sending TCP/IP"
25925 .cindex "TCP/IP" "setting outgoing port"
25926 This option specifies the TCP/IP port on the server to which Exim connects.
25927 &*Note:*& Do not confuse this with the port that was used when a message was
25928 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25929 The name was changed to minimize confusion with the outgoing port. There is no
25930 variable that contains an outgoing port.
25931
25932 If the value of this option begins with a digit it is taken as a port number;
25933 otherwise it is looked up using &[getservbyname()]&. The default value is
25934 normally &"smtp"&,
25935 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25936 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25937 If the expansion fails, or if a port number cannot be found, delivery
25938 is deferred.
25939
25940 Note that at least one Linux distribution has been seen failing
25941 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25942
25943
25944
25945 .option protocol smtp string smtp
25946 .cindex "LMTP" "over TCP/IP"
25947 .cindex "ssmtp protocol" "outbound"
25948 .cindex "TLS" "SSL-on-connect outbound"
25949 .vindex "&$port$&"
25950 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25951 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25952 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25953 deliveries into closed message stores. Exim also has support for running LMTP
25954 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25955
25956 If this option is set to &"smtps"&, the default value for the &%port%& option
25957 changes to &"smtps"&, and the transport initiates TLS immediately after
25958 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25959 The Internet standards bodies used to strongly discourage use of this mode,
25960 but as of RFC 8314 it is preferred over STARTTLS for message submission
25961 (as distinct from MTA-MTA communication).
25962
25963
25964 .option retry_include_ip_address smtp boolean&!! true
25965 Exim normally includes both the host name and the IP address in the key it
25966 constructs for indexing retry data after a temporary delivery failure. This
25967 means that when one of several IP addresses for a host is failing, it gets
25968 tried periodically (controlled by the retry rules), but use of the other IP
25969 addresses is not affected.
25970
25971 However, in some dialup environments hosts are assigned a different IP address
25972 each time they connect. In this situation the use of the IP address as part of
25973 the retry key leads to undesirable behaviour. Setting this option false causes
25974 Exim to use only the host name.
25975 Since it is expanded it can be made to depend on the host or domain.
25976
25977
25978 .option serialize_hosts smtp "host list&!!" unset
25979 .cindex "serializing connections"
25980 .cindex "host" "serializing connections"
25981 Because Exim operates in a distributed manner, if several messages for the same
25982 host arrive at around the same time, more than one simultaneous connection to
25983 the remote host can occur. This is not usually a problem except when there is a
25984 slow link between the hosts. In that situation it may be helpful to restrict
25985 Exim to one connection at a time. This can be done by setting
25986 &%serialize_hosts%& to match the relevant hosts.
25987
25988 .cindex "hints database" "serializing deliveries to a host"
25989 Exim implements serialization by means of a hints database in which a record is
25990 written whenever a process connects to one of the restricted hosts. The record
25991 is deleted when the connection is completed. Obviously there is scope for
25992 records to get left lying around if there is a system or program crash. To
25993 guard against this, Exim ignores any records that are more than six hours old.
25994
25995 If you set up this kind of serialization, you should also arrange to delete the
25996 relevant hints database whenever your system reboots. The names of the files
25997 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25998 may be one or two files, depending on the type of DBM in use. The same files
25999 are used for ETRN serialization.
26000
26001 See also the &%max_parallel%& generic transport option.
26002
26003
26004 .option size_addition smtp integer 1024
26005 .cindex "SIZE" "ESMTP extension"
26006 .cindex "message" "size issue for transport filter"
26007 .cindex "size" "of message"
26008 .cindex "transport" "filter"
26009 .cindex "filter" "transport filter"
26010 If a remote SMTP server indicates that it supports the SIZE option of the
26011 MAIL command, Exim uses this to pass over the message size at the start of
26012 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26013 sends, to allow for headers and other text that may be added during delivery by
26014 configuration options or in a transport filter. It may be necessary to increase
26015 this if a lot of text is added to messages.
26016
26017 Alternatively, if the value of &%size_addition%& is set negative, it disables
26018 the use of the SIZE option altogether.
26019
26020
26021 .option socks_proxy smtp string&!! unset
26022 .cindex proxy SOCKS
26023 This option enables use of SOCKS proxies for connections made by the
26024 transport.  For details see section &<<SECTproxySOCKS>>&.
26025
26026
26027 .option tls_alpn smtp string&!! unset
26028 .cindex TLS "Application Layer Protocol Names"
26029 .cindex TLS ALPN
26030 .cindex ALPN "set name in client"
26031 If this option is set
26032 and the TLS library supports ALPN,
26033 the value given is used.
26034
26035 As of writing no value has been standardised for email use.
26036 The authors suggest using &"smtp"&.
26037
26038
26039
26040 .option tls_certificate smtp string&!! unset
26041 .cindex "TLS" "client certificate, location of"
26042 .cindex "certificate" "client, location of"
26043 .vindex "&$host$&"
26044 .vindex "&$host_address$&"
26045 The value of this option must be the absolute path to a file which contains the
26046 client's certificate, for possible use when sending a message over an encrypted
26047 connection. The values of &$host$& and &$host_address$& are set to the name and
26048 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26049 details of TLS.
26050
26051 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26052 certificate when sending messages as a client. The global option of the same
26053 name specifies the certificate for Exim as a server; it is not automatically
26054 assumed that the same certificate should be used when Exim is operating as a
26055 client.
26056
26057
26058 .option tls_crl smtp string&!! unset
26059 .cindex "TLS" "client certificate revocation list"
26060 .cindex "certificate" "revocation list for client"
26061 This option specifies a certificate revocation list. The expanded value must
26062 be the name of a file that contains a CRL in PEM format.
26063
26064
26065 .option tls_dh_min_bits smtp integer 1024
26066 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26067 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26068 key agreement is negotiated, the server will provide a large prime number
26069 for use.  This option establishes the minimum acceptable size of that number.
26070 If the parameter offered by the server is too small, then the TLS handshake
26071 will fail.
26072
26073 Only supported when using GnuTLS.
26074
26075
26076 .option tls_privatekey smtp string&!! unset
26077 .cindex "TLS" "client private key, location of"
26078 .vindex "&$host$&"
26079 .vindex "&$host_address$&"
26080 The value of this option must be the absolute path to a file which contains the
26081 client's private key. This is used when sending a message over an encrypted
26082 connection using a client certificate. The values of &$host$& and
26083 &$host_address$& are set to the name and address of the server during the
26084 expansion. If this option is unset, or the expansion is forced to fail, or the
26085 result is an empty string, the private key is assumed to be in the same file as
26086 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26087
26088
26089 .option tls_require_ciphers smtp string&!! unset
26090 .cindex "TLS" "requiring specific ciphers"
26091 .cindex "cipher" "requiring specific"
26092 .vindex "&$host$&"
26093 .vindex "&$host_address$&"
26094 The value of this option must be a list of permitted cipher suites, for use
26095 when setting up an outgoing encrypted connection. (There is a global option of
26096 the same name for controlling incoming connections.) The values of &$host$& and
26097 &$host_address$& are set to the name and address of the server during the
26098 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26099 is used in different ways by OpenSSL and GnuTLS (see sections
26100 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26101 ciphers is a preference order.
26102
26103
26104 .option tls_resumption_hosts smtp "host list&!!" unset
26105 .cindex TLS resumption
26106 This option controls which connections to use the TLS resumption feature.
26107 See &<<SECTresumption>>& for details.
26108
26109
26110
26111 .option tls_sni smtp string&!! unset
26112 .cindex "TLS" "Server Name Indication"
26113 .cindex "TLS" SNI
26114 .cindex SNI "setting in client"
26115 .vindex "&$tls_sni$&"
26116 If this option is set
26117 and the connection is not DANE-validated
26118 then it sets the $tls_out_sni variable and causes any
26119 TLS session to pass this value as the Server Name Indication extension to
26120 the remote side, which can be used by the remote side to select an appropriate
26121 certificate and private key for the session.
26122
26123 See &<<SECTtlssni>>& for more information.
26124
26125 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26126 TLS extensions.
26127
26128
26129
26130
26131 .option tls_tempfail_tryclear smtp boolean true
26132 .cindex "4&'xx'& responses" "to STARTTLS"
26133 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26134 setting up a TLS session, this option determines whether or not Exim should try
26135 to deliver the message unencrypted. If it is set false, delivery to the
26136 current host is deferred; if there are other hosts, they are tried. If this
26137 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26138 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26139 TLS negotiation fails, Exim closes the current connection (because it is in an
26140 unknown state), opens a new one to the same host, and then tries the delivery
26141 in clear.
26142
26143
26144 .option tls_try_verify_hosts smtp "host list&!!" *
26145 .cindex "TLS" "server certificate verification"
26146 .cindex "certificate" "verification of server"
26147 This option gives a list of hosts for which, on encrypted connections,
26148 certificate verification will be tried but need not succeed.
26149 The &%tls_verify_certificates%& option must also be set.
26150 Note that unless the host is in this list
26151 TLS connections will be denied to hosts using self-signed certificates
26152 when &%tls_verify_certificates%& is matched.
26153 The &$tls_out_certificate_verified$& variable is set when
26154 certificate verification succeeds.
26155
26156
26157 .option tls_verify_cert_hostnames smtp "host list&!!" *
26158 .cindex "TLS" "server certificate hostname verification"
26159 .cindex "certificate" "verification of server"
26160 This option give a list of hosts for which,
26161 while verifying the server certificate,
26162 checks will be included on the host name
26163 (note that this will generally be the result of a DNS MX lookup)
26164 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
26165 limited to being the initial component of a 3-or-more component FQDN.
26166
26167 There is no equivalent checking on client certificates.
26168
26169
26170 .option tls_verify_certificates smtp string&!! system
26171 .cindex "TLS" "server certificate verification"
26172 .cindex "certificate" "verification of server"
26173 .vindex "&$host$&"
26174 .vindex "&$host_address$&"
26175 The value of this option must be either the
26176 word "system"
26177 or the absolute path to
26178 a file or directory containing permitted certificates for servers,
26179 for use when setting up an encrypted connection.
26180
26181 The "system" value for the option will use a location compiled into the SSL library.
26182 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26183 is taken as empty and an explicit location
26184 must be specified.
26185
26186 The use of a directory for the option value is not available for GnuTLS versions
26187 preceding 3.3.6 and a single file must be used.
26188
26189 With OpenSSL the certificates specified
26190 explicitly
26191 either by file or directory
26192 are added to those given by the system default location.
26193
26194 The values of &$host$& and
26195 &$host_address$& are set to the name and address of the server during the
26196 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26197
26198 For back-compatibility,
26199 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26200 (a single-colon empty list counts as being set)
26201 and certificate verification fails the TLS connection is closed.
26202
26203
26204 .option tls_verify_hosts smtp "host list&!!" unset
26205 .cindex "TLS" "server certificate verification"
26206 .cindex "certificate" "verification of server"
26207 This option gives a list of hosts for which, on encrypted connections,
26208 certificate verification must succeed.
26209 The &%tls_verify_certificates%& option must also be set.
26210 If both this option and &%tls_try_verify_hosts%& are unset
26211 operation is as if this option selected all hosts.
26212 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26213 that connections use TLS.
26214 Fallback to in-clear communication will be done unless restricted by
26215 the &%hosts_require_tls%& option.
26216
26217 .option utf8_downconvert smtp integer&!! -1
26218 .cindex utf8 "address downconversion"
26219 .cindex i18n "utf8 address downconversion"
26220 If built with internationalization support,
26221 this option controls conversion of UTF-8 in message envelope addresses
26222 to a-label form.
26223 If, after expansion, the value is 1, 0, or -1 then this value overrides
26224 any value previously set for the message.  Otherwise, any previously
26225 set value is used.  To permit use of a previous value,
26226 set this option to an empty string.
26227 For details on the values see section &<<SECTi18nMTA>>&.
26228
26229
26230
26231
26232 .section "How the limits for the number of hosts to try are used" &&&
26233          "SECTvalhosmax"
26234 .cindex "host" "maximum number to try"
26235 .cindex "limit" "hosts; maximum number tried"
26236 There are two options that are concerned with the number of hosts that are
26237 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26238 &%hosts_max_try_hardlimit%&.
26239
26240
26241 The &%hosts_max_try%& option limits the number of hosts that are tried
26242 for a single delivery. However, despite the term &"host"& in its name, the
26243 option actually applies to each IP address independently. In other words, a
26244 multihomed host is treated as several independent hosts, just as it is for
26245 retrying.
26246
26247 Many of the larger ISPs have multiple MX records which often point to
26248 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26249 created as a result of routing one of these domains.
26250
26251 Trying every single IP address on such a long list does not seem sensible; if
26252 several at the top of the list fail, it is reasonable to assume there is some
26253 problem that is likely to affect all of them. Roughly speaking, the value of
26254 &%hosts_max_try%& is the maximum number that are tried before deferring the
26255 delivery. However, the logic cannot be quite that simple.
26256
26257 Firstly, IP addresses that are skipped because their retry times have not
26258 arrived do not count, and in addition, addresses that are past their retry
26259 limits are also not counted, even when they are tried. This means that when
26260 some IP addresses are past their retry limits, more than the value of
26261 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26262 that all IP addresses are considered before timing out an email address (but
26263 see below for an exception).
26264
26265 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26266 list to see if there is a subsequent host with a different (higher valued) MX.
26267 If there is, that host is considered next, and the current IP address is used
26268 but not counted. This behaviour helps in the case of a domain with a retry rule
26269 that hardly ever delays any hosts, as is now explained:
26270
26271 Consider the case of a long list of hosts with one MX value, and a few with a
26272 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26273 hosts at the top of the list are tried at first. With the default retry rule,
26274 which specifies increasing retry times, the higher MX hosts are eventually
26275 tried when those at the top of the list are skipped because they have not
26276 reached their retry times.
26277
26278 However, it is common practice to put a fixed short retry time on domains for
26279 large ISPs, on the grounds that their servers are rarely down for very long.
26280 Unfortunately, these are exactly the domains that tend to resolve to long lists
26281 of hosts. The short retry time means that the lowest MX hosts are tried every
26282 time. The attempts may be in a different order because of random sorting, but
26283 without the special MX check, the higher MX hosts would never be tried until
26284 all the lower MX hosts had timed out (which might be several days), because
26285 there are always some lower MX hosts that have reached their retry times. With
26286 the special check, Exim considers at least one IP address from each MX value at
26287 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26288 reached.
26289
26290 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26291 particular, Exim normally eventually tries all the IP addresses before timing
26292 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26293 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26294 been set up with hundreds of IP addresses for some domains. It can
26295 take a very long time indeed for an address to time out in these cases.
26296
26297 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26298 Exim never tries more than this number of IP addresses; if it hits this limit
26299 and they are all timed out, the email address is bounced, even though not all
26300 possible IP addresses have been tried.
26301 .ecindex IIDsmttra1
26302 .ecindex IIDsmttra2
26303
26304
26305
26306
26307
26308 . ////////////////////////////////////////////////////////////////////////////
26309 . ////////////////////////////////////////////////////////////////////////////
26310
26311 .chapter "Address rewriting" "CHAPrewrite"
26312 .scindex IIDaddrew "rewriting" "addresses"
26313 There are some circumstances in which Exim automatically rewrites domains in
26314 addresses. The two most common are when an address is given without a domain
26315 (referred to as an &"unqualified address"&) or when an address contains an
26316 abbreviated domain that is expanded by DNS lookup.
26317
26318 Unqualified envelope addresses are accepted only for locally submitted
26319 messages, or for messages that are received from hosts matching
26320 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26321 appropriate. Unqualified addresses in header lines are qualified if they are in
26322 locally submitted messages, or messages from hosts that are permitted to send
26323 unqualified envelope addresses. Otherwise, unqualified addresses in header
26324 lines are neither qualified nor rewritten.
26325
26326 One situation in which Exim does &'not'& automatically rewrite a domain is
26327 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26328 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26329 do this. The new RFCs do not contain this suggestion.
26330
26331
26332 .section "Explicitly configured address rewriting" "SECID147"
26333 This chapter describes the rewriting rules that can be used in the
26334 main rewrite section of the configuration file, and also in the generic
26335 &%headers_rewrite%& option that can be set on any transport.
26336
26337 Some people believe that configured address rewriting is a Mortal Sin.
26338 Others believe that life is not possible without it. Exim provides the
26339 facility; you do not have to use it.
26340
26341 The main rewriting rules that appear in the &"rewrite"& section of the
26342 configuration file are applied to addresses in incoming messages, both envelope
26343 addresses and addresses in header lines. Each rule specifies the types of
26344 address to which it applies.
26345
26346 Whether or not addresses in header lines are rewritten depends on the origin of
26347 the headers and the type of rewriting. Global rewriting, that is, rewriting
26348 rules from the rewrite section of the configuration file, is applied only to
26349 those headers that were received with the message. Header lines that are added
26350 by ACLs or by a system filter or by individual routers or transports (which
26351 are specific to individual recipient addresses) are not rewritten by the global
26352 rules.
26353
26354 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26355 applies all headers except those added by routers and transports. That is, as
26356 well as the headers that were received with the message, it also applies to
26357 headers that were added by an ACL or a system filter.
26358
26359
26360 In general, rewriting addresses from your own system or domain has some
26361 legitimacy. Rewriting other addresses should be done only with great care and
26362 in special circumstances. The author of Exim believes that rewriting should be
26363 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26364 Although it can sometimes be used as a routing tool, this is very strongly
26365 discouraged.
26366
26367 There are two commonly encountered circumstances where rewriting is used, as
26368 illustrated by these examples:
26369
26370 .ilist
26371 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26372 exchange mail with each other behind a firewall, but there is only a single
26373 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26374 &'hitch.fict.example'& when sending mail off-site.
26375 .next
26376 A host rewrites the local parts of its own users so that, for example,
26377 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26378 .endlist
26379
26380
26381
26382 .section "When does rewriting happen?" "SECID148"
26383 .cindex "rewriting" "timing of"
26384 .cindex "&ACL;" "rewriting addresses in"
26385 Configured address rewriting can take place at several different stages of a
26386 message's processing.
26387
26388 .vindex "&$sender_address$&"
26389 At the start of an ACL for MAIL, the sender address may have been rewritten
26390 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26391 ordinary rewrite rules have yet been applied. If, however, the sender address
26392 is verified in the ACL, it is rewritten before verification, and remains
26393 rewritten thereafter. The subsequent value of &$sender_address$& is the
26394 rewritten address. This also applies if sender verification happens in a
26395 RCPT ACL. Otherwise, when the sender address is not verified, it is
26396 rewritten as soon as a message's header lines have been received.
26397
26398 .vindex "&$domain$&"
26399 .vindex "&$local_part$&"
26400 Similarly, at the start of an ACL for RCPT, the current recipient's address
26401 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26402 rewrite rules have yet been applied to it. However, the behaviour is different
26403 from the sender address when a recipient is verified. The address is rewritten
26404 for the verification, but the rewriting is not remembered at this stage. The
26405 value of &$local_part$& and &$domain$& after verification are always the same
26406 as they were before (that is, they contain the unrewritten &-- except for
26407 SMTP-time rewriting &-- address).
26408
26409 As soon as a message's header lines have been received, all the envelope
26410 recipient addresses are permanently rewritten, and rewriting is also applied to
26411 the addresses in the header lines (if configured). This happens before adding
26412 any header lines that were specified in MAIL or RCPT ACLs, and
26413 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26414 before the DATA ACL and &[local_scan()]& functions are run.
26415
26416 When an address is being routed, either for delivery or for verification,
26417 rewriting is applied immediately to child addresses that are generated by
26418 redirection, unless &%no_rewrite%& is set on the router.
26419
26420 .cindex "envelope from"
26421 .cindex "envelope sender" "rewriting at transport time"
26422 .cindex "rewriting" "at transport time"
26423 .cindex "header lines" "rewriting at transport time"
26424 At transport time, additional rewriting of addresses in header lines can be
26425 specified by setting the generic &%headers_rewrite%& option on a transport.
26426 This option contains rules that are identical in form to those in the rewrite
26427 section of the configuration file. They are applied to the original message
26428 header lines and any that were added by ACLs or a system filter. They are not
26429 applied to header lines that are added by routers or the transport.
26430
26431 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26432 transport option. However, it is not possible to rewrite envelope recipients at
26433 transport time.
26434
26435
26436
26437
26438 .section "Testing the rewriting rules that apply on input" "SECID149"
26439 .cindex "rewriting" "testing"
26440 .cindex "testing" "rewriting"
26441 Exim's input rewriting configuration appears in a part of the runtime
26442 configuration file headed by &"begin rewrite"&. It can be tested by the
26443 &%-brw%& command line option. This takes an address (which can be a full RFC
26444 2822 address) as its argument. The output is a list of how the address would be
26445 transformed by the rewriting rules for each of the different places it might
26446 appear in an incoming message, that is, for each different header and for the
26447 envelope sender and recipient fields. For example,
26448 .code
26449 exim -brw ph10@exim.workshop.example
26450 .endd
26451 might produce the output
26452 .code
26453 sender: Philip.Hazel@exim.workshop.example
26454 from: Philip.Hazel@exim.workshop.example
26455 to: ph10@exim.workshop.example
26456 cc: ph10@exim.workshop.example
26457 bcc: ph10@exim.workshop.example
26458 reply-to: Philip.Hazel@exim.workshop.example
26459 env-from: Philip.Hazel@exim.workshop.example
26460 env-to: ph10@exim.workshop.example
26461 .endd
26462 which shows that rewriting has been set up for that address when used in any of
26463 the source fields, but not when it appears as a recipient address. At the
26464 present time, there is no equivalent way of testing rewriting rules that are
26465 set for a particular transport.
26466
26467
26468 .section "Rewriting rules" "SECID150"
26469 .cindex "rewriting" "rules"
26470 The rewrite section of the configuration file consists of lines of rewriting
26471 rules in the form
26472 .display
26473 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26474 .endd
26475 Rewriting rules that are specified for the &%headers_rewrite%& generic
26476 transport option are given as a colon-separated list. Each item in the list
26477 takes the same form as a line in the main rewriting configuration (except that
26478 any colons must be doubled, of course).
26479
26480 The formats of source patterns and replacement strings are described below.
26481 Each is terminated by white space, unless enclosed in double quotes, in which
26482 case normal quoting conventions apply inside the quotes. The flags are single
26483 characters which may appear in any order. Spaces and tabs between them are
26484 ignored.
26485
26486 For each address that could potentially be rewritten, the rules are scanned in
26487 order, and replacements for the address from earlier rules can themselves be
26488 replaced by later rules (but see the &"q"& and &"R"& flags).
26489
26490 The order in which addresses are rewritten is undefined, may change between
26491 releases, and must not be relied on, with one exception: when a message is
26492 received, the envelope sender is always rewritten first, before any header
26493 lines are rewritten. For example, the replacement string for a rewrite of an
26494 address in &'To:'& must not assume that the message's address in &'From:'& has
26495 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26496 that the envelope sender has already been rewritten.
26497
26498 .vindex "&$domain$&"
26499 .vindex "&$local_part$&"
26500 The variables &$local_part$& and &$domain$& can be used in the replacement
26501 string to refer to the address that is being rewritten. Note that lookup-driven
26502 rewriting can be done by a rule of the form
26503 .code
26504 *@*   ${lookup ...
26505 .endd
26506 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26507 refer to the address that is being rewritten.
26508
26509
26510 .section "Rewriting patterns" "SECID151"
26511 .cindex "rewriting" "patterns"
26512 .cindex "address list" "in a rewriting pattern"
26513 The source pattern in a rewriting rule is any item which may appear in an
26514 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26515 single-item address list, which means that it is expanded before being tested
26516 against the address. As always, if you use a regular expression as a pattern,
26517 you must take care to escape dollar and backslash characters, or use the &`\N`&
26518 facility to suppress string expansion within the regular expression.
26519
26520 Domains in patterns should be given in lower case. Local parts in patterns are
26521 case-sensitive. If you want to do case-insensitive matching of local parts, you
26522 can use a regular expression that starts with &`^(?i)`&.
26523
26524 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26525 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26526 depending on the type of match which occurred. These can be used in the
26527 replacement string to insert portions of the incoming address. &$0$& always
26528 refers to the complete incoming address. When a regular expression is used, the
26529 numerical variables are set from its capturing subexpressions. For other types
26530 of pattern they are set as follows:
26531
26532 .ilist
26533 If a local part or domain starts with an asterisk, the numerical variables
26534 refer to the character strings matched by asterisks, with &$1$& associated with
26535 the first asterisk, and &$2$& with the second, if present. For example, if the
26536 pattern
26537 .code
26538 *queen@*.fict.example
26539 .endd
26540 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26541 .code
26542 $0 = hearts-queen@wonderland.fict.example
26543 $1 = hearts-
26544 $2 = wonderland
26545 .endd
26546 Note that if the local part does not start with an asterisk, but the domain
26547 does, it is &$1$& that contains the wild part of the domain.
26548
26549 .next
26550 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26551 of the domain are placed in the next available numerical variables. Suppose,
26552 for example, that the address &'foo@bar.baz.example'& is processed by a
26553 rewriting rule of the form
26554 .display
26555 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26556 .endd
26557 and the key in the file that matches the domain is &`*.baz.example`&. Then
26558 .code
26559 $1 = foo
26560 $2 = bar
26561 $3 = baz.example
26562 .endd
26563 If the address &'foo@baz.example'& is looked up, this matches the same
26564 wildcard file entry, and in this case &$2$& is set to the empty string, but
26565 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26566 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26567 whole domain. For non-partial domain lookups, no numerical variables are set.
26568 .endlist
26569
26570
26571 .section "Rewriting replacements" "SECID152"
26572 .cindex "rewriting" "replacements"
26573 If the replacement string for a rule is a single asterisk, addresses that
26574 match the pattern and the flags are &'not'& rewritten, and no subsequent
26575 rewriting rules are scanned. For example,
26576 .code
26577 hatta@lookingglass.fict.example  *  f
26578 .endd
26579 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26580 &'From:'& headers.
26581
26582 .vindex "&$domain$&"
26583 .vindex "&$local_part$&"
26584 If the replacement string is not a single asterisk, it is expanded, and must
26585 yield a fully qualified address. Within the expansion, the variables
26586 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26587 Any letters they contain retain their original case &-- they are not lower
26588 cased. The numerical variables are set up according to the type of pattern that
26589 matched the address, as described above. If the expansion is forced to fail by
26590 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26591 current rule is abandoned, but subsequent rules may take effect. Any other
26592 expansion failure causes the entire rewriting operation to be abandoned, and an
26593 entry written to the panic log.
26594
26595
26596
26597 .subsection "Rewriting flags" "SSECID153"
26598 There are three different kinds of flag that may appear on rewriting rules:
26599
26600 .ilist
26601 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26602 c, f, h, r, s, t.
26603 .next
26604 A flag that specifies rewriting at SMTP time: S.
26605 .next
26606 Flags that control the rewriting process: Q, q, R, w.
26607 .endlist
26608
26609 For rules that are part of the &%headers_rewrite%& generic transport option,
26610 E, F, T, and S are not permitted.
26611
26612
26613
26614 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26615          "SSECID154"
26616 .cindex rewriting flags
26617 If none of the following flag letters, nor the &"S"& flag (see section
26618 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26619 and to both the sender and recipient fields of the envelope, whereas a
26620 transport-time rewriting rule just applies to all headers. Otherwise, the
26621 rewriting rule is skipped unless the relevant addresses are being processed.
26622 .display
26623 &`E`&       rewrite all envelope fields
26624 &`F`&       rewrite the envelope From field
26625 &`T`&       rewrite the envelope To field
26626 &`b`&       rewrite the &'Bcc:'& header
26627 &`c`&       rewrite the &'Cc:'& header
26628 &`f`&       rewrite the &'From:'& header
26629 &`h`&       rewrite all headers
26630 &`r`&       rewrite the &'Reply-To:'& header
26631 &`s`&       rewrite the &'Sender:'& header
26632 &`t`&       rewrite the &'To:'& header
26633 .endd
26634 "All headers" means all of the headers listed above that can be selected
26635 individually, plus their &'Resent-'& versions. It does not include
26636 other headers such as &'Subject:'& etc.
26637
26638 You should be particularly careful about rewriting &'Sender:'& headers, and
26639 restrict this to special known cases in your own domains.
26640
26641
26642 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26643 .cindex SMTP "rewriting malformed addresses"
26644 .cindex RCPT "rewriting argument of"
26645 .cindex MAIL "rewriting argument of"
26646 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26647 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26648 before any other processing; even before syntax checking. The pattern is
26649 required to be a regular expression, and it is matched against the whole of the
26650 data for the command, including any surrounding angle brackets.
26651
26652 .vindex "&$domain$&"
26653 .vindex "&$local_part$&"
26654 This form of rewrite rule allows for the handling of addresses that are not
26655 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26656 input). Because the input is not required to be a syntactically valid address,
26657 the variables &$local_part$& and &$domain$& are not available during the
26658 expansion of the replacement string. The result of rewriting replaces the
26659 original address in the MAIL or RCPT command.
26660
26661
26662 .subsection "Flags controlling the rewriting process" SSECID155
26663 There are four flags which control the way the rewriting process works. These
26664 take effect only when a rule is invoked, that is, when the address is of the
26665 correct type (matches the flags) and matches the pattern:
26666
26667 .ilist
26668 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26669 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26670 absence of &"Q"& the rewritten address must always include a domain.
26671 .next
26672 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26673 even if no rewriting actually takes place because of a &"fail"& in the
26674 expansion. The &"q"& flag is not effective if the address is of the wrong type
26675 (does not match the flags) or does not match the pattern.
26676 .next
26677 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26678 address, up to ten times. It can be combined with the &"q"& flag, to stop
26679 rewriting once it fails to match (after at least one successful rewrite).
26680 .next
26681 .cindex "rewriting" "whole addresses"
26682 When an address in a header is rewritten, the rewriting normally applies only
26683 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26684 left unchanged. For example, rewriting might change
26685 .code
26686 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26687 .endd
26688 into
26689 .code
26690 From: Ford Prefect <prefectf@hitch.fict.example>
26691 .endd
26692 .cindex "RFC 2047"
26693 Sometimes there is a need to replace the whole address item, and this can be
26694 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26695 causes an address in a header line to be rewritten, the entire address is
26696 replaced, not just the working part. The replacement must be a complete RFC
26697 2822 address, including the angle brackets if necessary. If text outside angle
26698 brackets contains a character whose value is greater than 126 or less than 32
26699 (except for tab), the text is encoded according to RFC 2047. The character set
26700 is taken from &%headers_charset%&, which gets its default at build time.
26701
26702 When the &"w"& flag is set on a rule that causes an envelope address to be
26703 rewritten, all but the working part of the replacement address is discarded.
26704 .endlist
26705
26706
26707 .section "Rewriting examples" "SECID156"
26708 Here is an example of the two common rewriting paradigms:
26709 .code
26710 *@*.hitch.fict.example  $1@hitch.fict.example
26711 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26712                      {$value}fail}@hitch.fict.example bctfrF
26713 .endd
26714 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26715 the string expansion to fail if the lookup does not succeed. In this context it
26716 has the effect of leaving the original address unchanged, but Exim goes on to
26717 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26718 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26719 explicitly, which would cause the rewritten address to be the same as before,
26720 at the cost of a small bit of processing. Not supplying either of these is an
26721 error, since the rewritten address would then contain no local part.
26722
26723 The first example above replaces the domain with a superior, more general
26724 domain. This may not be desirable for certain local parts. If the rule
26725 .code
26726 root@*.hitch.fict.example  *
26727 .endd
26728 were inserted before the first rule, rewriting would be suppressed for the
26729 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26730
26731 Rewriting can be made conditional on a number of tests, by making use of
26732 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26733 messages that originate outside the local host:
26734 .code
26735 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26736                          {$1@hitch.fict.example}fail}"
26737 .endd
26738 The replacement string is quoted in this example because it contains white
26739 space.
26740
26741 .cindex "rewriting" "bang paths"
26742 .cindex "bang paths" "rewriting"
26743 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26744 an address it treats it as an unqualified local part which it qualifies with
26745 the local qualification domain (if the source of the message is local or if the
26746 remote host is permitted to send unqualified addresses). Rewriting can
26747 sometimes be used to handle simple bang paths with a fixed number of
26748 components. For example, the rule
26749 .code
26750 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26751 .endd
26752 rewrites a two-component bang path &'host.name!user'& as the domain address
26753 &'user@host.name'&. However, there is a security implication in using this as
26754 a global rewriting rule for envelope addresses. It can provide a backdoor
26755 method for using your system as a relay, because the incoming addresses appear
26756 to be local. If the bang path addresses are received via SMTP, it is safer to
26757 use the &"S"& flag to rewrite them as they are received, so that relay checking
26758 can be done on the rewritten addresses.
26759 .ecindex IIDaddrew
26760
26761
26762
26763
26764
26765 . ////////////////////////////////////////////////////////////////////////////
26766 . ////////////////////////////////////////////////////////////////////////////
26767
26768 .chapter "Retry configuration" "CHAPretry"
26769 .scindex IIDretconf1 "retry" "configuration, description of"
26770 .scindex IIDregconf2 "configuration file" "retry section"
26771 The &"retry"& section of the runtime configuration file contains a list of
26772 retry rules that control how often Exim tries to deliver messages that cannot
26773 be delivered at the first attempt. If there are no retry rules (the section is
26774 empty or not present), there are no retries. In this situation, temporary
26775 errors are treated as permanent. The default configuration contains a single,
26776 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26777 line option can be used to test which retry rule will be used for a given
26778 address, domain and error.
26779
26780 The most common cause of retries is temporary failure to deliver to a remote
26781 host because the host is down, or inaccessible because of a network problem.
26782 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26783 address) basis, not on a per-message basis. Thus, if one message has recently
26784 been delayed, delivery of a new message to the same host is not immediately
26785 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26786 log selector is set, the message
26787 .cindex "retry" "time not reached"
26788 &"retry time not reached"& is written to the main log whenever a delivery is
26789 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26790 the handling of errors during remote deliveries.
26791
26792 Retry processing applies to routing as well as to delivering, except as covered
26793 in the next paragraph. The retry rules do not distinguish between these
26794 actions. It is not possible, for example, to specify different behaviour for
26795 failures to route the domain &'snark.fict.example'& and failures to deliver to
26796 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26797 added complication, so did not implement it. However, although they share the
26798 same retry rule, the actual retry times for routing and transporting a given
26799 domain are maintained independently.
26800
26801 When a delivery is not part of a queue run (typically an immediate delivery on
26802 receipt of a message), the routers are always run, and local deliveries are
26803 always attempted, even if retry times are set for them. This makes for better
26804 behaviour if one particular message is causing problems (for example, causing
26805 quota overflow, or provoking an error in a filter file). If such a delivery
26806 suffers a temporary failure, the retry data is updated as normal, and
26807 subsequent delivery attempts from queue runs occur only when the retry time for
26808 the local address is reached.
26809
26810 .section "Changing retry rules" "SECID157"
26811 If you change the retry rules in your configuration, you should consider
26812 whether or not to delete the retry data that is stored in Exim's spool area in
26813 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26814 always safe; that is why they are called &"hints"&.
26815
26816 The hints retry data contains suggested retry times based on the previous
26817 rules. In the case of a long-running problem with a remote host, it might
26818 record the fact that the host has timed out. If your new rules increase the
26819 timeout time for such a host, you should definitely remove the old retry data
26820 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26821 messages that it should now be retaining.
26822
26823
26824
26825 .section "Format of retry rules" "SECID158"
26826 .cindex "retry" "rules"
26827 Each retry rule occupies one line and consists of three or four parts,
26828 separated by white space: a pattern, an error name, an optional list of sender
26829 addresses, and a list of retry parameters. The pattern and sender lists must be
26830 enclosed in double quotes if they contain white space. The rules are searched
26831 in order until one is found where the pattern, error name, and sender list (if
26832 present) match the failing host or address, the error that occurred, and the
26833 message's sender, respectively.
26834
26835
26836 The pattern is any single item that may appear in an address list (see section
26837 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26838 which means that it is expanded before being tested against the address that
26839 has been delayed. A negated address list item is permitted. Address
26840 list processing treats a plain domain name as if it were preceded by &"*@"&,
26841 which makes it possible for many retry rules to start with just a domain. For
26842 example,
26843 .code
26844 lookingglass.fict.example        *  F,24h,30m;
26845 .endd
26846 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26847 whereas
26848 .code
26849 alice@lookingglass.fict.example  *  F,24h,30m;
26850 .endd
26851 applies only to temporary failures involving the local part &%alice%&.
26852 In practice, almost all rules start with a domain name pattern without a local
26853 part.
26854
26855 .cindex "regular expressions" "in retry rules"
26856 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26857 must match a complete address, not just a domain, because that is how regular
26858 expressions work in address lists.
26859 .display
26860 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26861 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26862 .endd
26863
26864
26865 .section "Choosing which retry rule to use for address errors" "SECID159"
26866 When Exim is looking for a retry rule after a routing attempt has failed (for
26867 example, after a DNS timeout), each line in the retry configuration is tested
26868 against the complete address only if &%retry_use_local_part%& is set for the
26869 router. Otherwise, only the domain is used, except when matching against a
26870 regular expression, when the local part of the address is replaced with &"*"&.
26871 A domain on its own can match a domain pattern, or a pattern that starts with
26872 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26873 &%check_local_user%& is true, and false for other routers.
26874
26875 Similarly, when Exim is looking for a retry rule after a local delivery has
26876 failed (for example, after a mailbox full error), each line in the retry
26877 configuration is tested against the complete address only if
26878 &%retry_use_local_part%& is set for the transport (it defaults true for all
26879 local transports).
26880
26881 .cindex "4&'xx'& responses" "retry rules for"
26882 However, when Exim is looking for a retry rule after a remote delivery attempt
26883 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26884 whole address is always used as the key when searching the retry rules. The
26885 rule that is found is used to create a retry time for the combination of the
26886 failing address and the message's sender. It is the combination of sender and
26887 recipient that is delayed in subsequent queue runs until its retry time is
26888 reached. You can delay the recipient without regard to the sender by setting
26889 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26890 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26891 commands.
26892
26893
26894
26895 .section "Choosing which retry rule to use for host and message errors" &&&
26896          "SECID160"
26897 For a temporary error that is not related to an individual address (for
26898 example, a connection timeout), each line in the retry configuration is checked
26899 twice. First, the name of the remote host is used as a domain name (preceded by
26900 &"*@"& when matching a regular expression). If this does not match the line,
26901 the domain from the email address is tried in a similar fashion. For example,
26902 suppose the MX records for &'a.b.c.example'& are
26903 .code
26904 a.b.c.example  MX  5  x.y.z.example
26905                MX  6  p.q.r.example
26906                MX  7  m.n.o.example
26907 .endd
26908 and the retry rules are
26909 .code
26910 p.q.r.example    *      F,24h,30m;
26911 a.b.c.example    *      F,4d,45m;
26912 .endd
26913 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26914 first rule matches neither the host nor the domain, so Exim looks at the second
26915 rule. This does not match the host, but it does match the domain, so it is used
26916 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26917 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26918 first retry rule is used, because it matches the host.
26919
26920 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26921 first rule to determine retry times, but for all the other hosts for the domain
26922 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26923 routing to &'a.b.c.example'& suffers a temporary failure.
26924
26925 &*Note*&: The host name is used when matching the patterns, not its IP address.
26926 However, if a message is routed directly to an IP address without the use of a
26927 host name, for example, if a &(manualroute)& router contains a setting such as:
26928 .code
26929 route_list = *.a.example  192.168.34.23
26930 .endd
26931 then the &"host name"& that is used when searching for a retry rule is the
26932 textual form of the IP address.
26933
26934 .section "Retry rules for specific errors" "SECID161"
26935 .cindex "retry" "specific errors; specifying"
26936 The second field in a retry rule is the name of a particular error, or an
26937 asterisk, which matches any error. The errors that can be tested for are:
26938
26939 .vlist
26940 .vitem &%auth_failed%&
26941 Authentication failed when trying to send to a host in the
26942 &%hosts_require_auth%& list in an &(smtp)& transport.
26943
26944 .vitem &%data_4xx%&
26945 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26946 after the command, or after sending the message's data.
26947
26948 .vitem &%mail_4xx%&
26949 A 4&'xx'& error was received for an outgoing MAIL command.
26950
26951 .vitem &%rcpt_4xx%&
26952 A 4&'xx'& error was received for an outgoing RCPT command.
26953 .endlist
26954
26955 For the three 4&'xx'& errors, either the first or both of the x's can be given
26956 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26957 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26958 and have retries every ten minutes with a one-hour timeout, you could set up a
26959 retry rule of this form:
26960 .code
26961 the.domain.name  rcpt_452   F,1h,10m
26962 .endd
26963 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26964 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26965
26966 .vlist
26967 .vitem &%lost_connection%&
26968 A server unexpectedly closed the SMTP connection. There may, of course,
26969 legitimate reasons for this (host died, network died), but if it repeats a lot
26970 for the same host, it indicates something odd.
26971
26972 .vitem &%lookup%&
26973 A DNS lookup for a host failed.
26974 Note that a &%dnslookup%& router will need to have matched
26975 its &%fail_defer_domains%& option for this retry type to be usable.
26976 Also note that a &%manualroute%& router will probably need
26977 its &%host_find_failed%& option set to &%defer%&.
26978
26979 .vitem &%refused_MX%&
26980 A connection to a host obtained from an MX record was refused.
26981
26982 .vitem &%refused_A%&
26983 A connection to a host not obtained from an MX record was refused.
26984
26985 .vitem &%refused%&
26986 A connection was refused.
26987
26988 .vitem &%timeout_connect_MX%&
26989 A connection attempt to a host obtained from an MX record timed out.
26990
26991 .vitem &%timeout_connect_A%&
26992 A connection attempt to a host not obtained from an MX record timed out.
26993
26994 .vitem &%timeout_connect%&
26995 A connection attempt timed out.
26996
26997 .vitem &%timeout_MX%&
26998 There was a timeout while connecting or during an SMTP session with a host
26999 obtained from an MX record.
27000
27001 .vitem &%timeout_A%&
27002 There was a timeout while connecting or during an SMTP session with a host not
27003 obtained from an MX record.
27004
27005 .vitem &%timeout%&
27006 There was a timeout while connecting or during an SMTP session.
27007
27008 .vitem &%tls_required%&
27009 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27010 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27011 to STARTTLS, or there was a problem setting up the TLS connection.
27012
27013 .vitem &%quota%&
27014 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27015 transport.
27016
27017 .vitem &%quota_%&<&'time'&>
27018 .cindex "quota" "error testing in retry rule"
27019 .cindex "retry" "quota error testing"
27020 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27021 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27022 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27023 for four days.
27024 .endlist
27025
27026 .cindex "mailbox" "time of last read"
27027 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27028 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27029 it should be based on the last time that the user accessed the mailbox.
27030 However, it is not always possible to determine this. Exim uses the following
27031 heuristic rules:
27032
27033 .ilist
27034 If the mailbox is a single file, the time of last access (the &"atime"&) is
27035 used. As no new messages are being delivered (because the mailbox is over
27036 quota), Exim does not access the file, so this is the time of last user access.
27037 .next
27038 .cindex "maildir format" "time of last read"
27039 For a maildir delivery, the time of last modification of the &_new_&
27040 subdirectory is used. As the mailbox is over quota, no new files are created in
27041 the &_new_& subdirectory, because no new messages are being delivered. Any
27042 change to the &_new_& subdirectory is therefore assumed to be the result of an
27043 MUA moving a new message to the &_cur_& directory when it is first read. The
27044 time that is used is therefore the last time that the user read a new message.
27045 .next
27046 For other kinds of multi-file mailbox, the time of last access cannot be
27047 obtained, so a retry rule that uses this type of error field is never matched.
27048 .endlist
27049
27050 The quota errors apply both to system-enforced quotas and to Exim's own quota
27051 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27052 when a local delivery is deferred because a partition is full (the ENOSPC
27053 error).
27054
27055
27056
27057 .section "Retry rules for specified senders" "SECID162"
27058 .cindex "retry" "rules; sender-specific"
27059 You can specify retry rules that apply only when the failing message has a
27060 specific sender. In particular, this can be used to define retry rules that
27061 apply only to bounce messages. The third item in a retry rule can be of this
27062 form:
27063 .display
27064 &`senders=`&<&'address list'&>
27065 .endd
27066 The retry timings themselves are then the fourth item. For example:
27067 .code
27068 *   rcpt_4xx   senders=:   F,1h,30m
27069 .endd
27070 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27071 host. If the address list contains white space, it must be enclosed in quotes.
27072 For example:
27073 .code
27074 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27075 .endd
27076 &*Warning*&: This facility can be unhelpful if it is used for host errors
27077 (which do not depend on the recipient). The reason is that the sender is used
27078 only to match the retry rule. Once the rule has been found for a host error,
27079 its contents are used to set a retry time for the host, and this will apply to
27080 all messages, not just those with specific senders.
27081
27082 When testing retry rules using &%-brt%&, you can supply a sender using the
27083 &%-f%& command line option, like this:
27084 .code
27085 exim -f "" -brt user@dom.ain
27086 .endd
27087 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27088 list is never matched.
27089
27090
27091
27092
27093
27094 .section "Retry parameters" "SECID163"
27095 .cindex "retry" "parameters in rules"
27096 The third (or fourth, if a senders list is present) field in a retry rule is a
27097 sequence of retry parameter sets, separated by semicolons. Each set consists of
27098 .display
27099 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27100 .endd
27101 The letter identifies the algorithm for computing a new retry time; the cutoff
27102 time is the time beyond which this algorithm no longer applies, and the
27103 arguments vary the algorithm's action. The cutoff time is measured from the
27104 time that the first failure for the domain (combined with the local part if
27105 relevant) was detected, not from the time the message was received.
27106
27107 .cindex "retry" "algorithms"
27108 .cindex "retry" "fixed intervals"
27109 .cindex "retry" "increasing intervals"
27110 .cindex "retry" "random intervals"
27111 The available algorithms are:
27112
27113 .ilist
27114 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27115 the interval.
27116 .next
27117 &'G'&: retry at geometrically increasing intervals. The first argument
27118 specifies a starting value for the interval, and the second a multiplier, which
27119 is used to increase the size of the interval at each retry.
27120 .next
27121 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27122 retry, the previous interval is multiplied by the factor in order to get a
27123 maximum for the next interval. The minimum interval is the first argument of
27124 the parameter, and an actual interval is chosen randomly between them. Such a
27125 rule has been found to be helpful in cluster configurations when all the
27126 members of the cluster restart at once, and may therefore synchronize their
27127 queue processing times.
27128 .endlist
27129
27130 When computing the next retry time, the algorithm definitions are scanned in
27131 order until one whose cutoff time has not yet passed is reached. This is then
27132 used to compute a new retry time that is later than the current time. In the
27133 case of fixed interval retries, this simply means adding the interval to the
27134 current time. For geometrically increasing intervals, retry intervals are
27135 computed from the rule's parameters until one that is greater than the previous
27136 interval is found. The main configuration variable
27137 .cindex "limit" "retry interval"
27138 .cindex "retry" "interval, maximum"
27139 .oindex "&%retry_interval_max%&"
27140 &%retry_interval_max%& limits the maximum interval between retries. It
27141 cannot be set greater than &`24h`&, which is its default value.
27142
27143 A single remote domain may have a number of hosts associated with it, and each
27144 host may have more than one IP address. Retry algorithms are selected on the
27145 basis of the domain name, but are applied to each IP address independently. If,
27146 for example, a host has two IP addresses and one is unusable, Exim will
27147 generate retry times for it and will not try to use it until its next retry
27148 time comes. Thus the good IP address is likely to be tried first most of the
27149 time.
27150
27151 .cindex "hints database" "use for retrying"
27152 Retry times are hints rather than promises. Exim does not make any attempt to
27153 run deliveries exactly at the computed times. Instead, a queue runner process
27154 starts delivery processes for delayed messages periodically, and these attempt
27155 new deliveries only for those addresses that have passed their next retry time.
27156 If a new message arrives for a deferred address, an immediate delivery attempt
27157 occurs only if the address has passed its retry time. In the absence of new
27158 messages, the minimum time between retries is the interval between queue runner
27159 processes. There is not much point in setting retry times of five minutes if
27160 your queue runners happen only once an hour, unless there are a significant
27161 number of incoming messages (which might be the case on a system that is
27162 sending everything to a smart host, for example).
27163
27164 The data in the retry hints database can be inspected by using the
27165 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27166 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27167 &'exinext'& utility script can be used to find out what the next retry times
27168 are for the hosts associated with a particular mail domain, and also for local
27169 deliveries that have been deferred.
27170
27171
27172 .section "Retry rule examples" "SECID164"
27173 Here are some example retry rules:
27174 .code
27175 alice@wonderland.fict.example quota_5d  F,7d,3h
27176 wonderland.fict.example       quota_5d
27177 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27178 lookingglass.fict.example     *         F,24h,30m;
27179 *                 refused_A   F,2h,20m;
27180 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27181 .endd
27182 The first rule sets up special handling for mail to
27183 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27184 mailbox has not been read for at least 5 days. Retries continue every three
27185 hours for 7 days. The second rule handles over-quota errors for all other local
27186 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27187 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27188 fail are bounced immediately if the mailbox has not been read for at least 5
27189 days.
27190
27191 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27192 happen every 15 minutes for an hour, then with geometrically increasing
27193 intervals until two days have passed since a delivery first failed. After the
27194 first hour there is a delay of one hour, then two hours, then four hours, and
27195 so on (this is a rather extreme example).
27196
27197 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27198 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27199 all other domains, with special action for connection refusal from hosts that
27200 were not obtained from an MX record.
27201
27202 The final rule in a retry configuration should always have asterisks in the
27203 first two fields so as to provide a general catch-all for any addresses that do
27204 not have their own special handling. This example tries every 15 minutes for 2
27205 hours, then with intervals starting at one hour and increasing by a factor of
27206 1.5 up to 16 hours, then every 8 hours up to 5 days.
27207
27208
27209
27210 .section "Timeout of retry data" "SECID165"
27211 .cindex "timeout" "of retry data"
27212 .oindex "&%retry_data_expire%&"
27213 .cindex "hints database" "data expiry"
27214 .cindex "retry" "timeout of data"
27215 Exim timestamps the data that it writes to its retry hints database. When it
27216 consults the data during a delivery it ignores any that is older than the value
27217 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27218 been tried for 7 days, Exim will try to deliver to it immediately a message
27219 arrives, and if that fails, it will calculate a retry time as if it were
27220 failing for the first time.
27221
27222 This improves the behaviour for messages routed to rarely-used hosts such as MX
27223 backups. If such a host was down at one time, and happens to be down again when
27224 Exim tries a month later, using the old retry data would imply that it had been
27225 down all the time, which is not a justified assumption.
27226
27227 If a host really is permanently dead, this behaviour causes a burst of retries
27228 every now and again, but only if messages routed to it are rare. If there is a
27229 message at least once every 7 days the retry data never expires.
27230
27231
27232
27233
27234 .section "Long-term failures" "SECID166"
27235 .cindex "delivery failure, long-term"
27236 .cindex "retry" "after long-term failure"
27237 Special processing happens when an email address has been failing for so long
27238 that the cutoff time for the last algorithm is reached. For example, using the
27239 default retry rule:
27240 .code
27241 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27242 .endd
27243 the cutoff time is four days. Reaching the retry cutoff is independent of how
27244 long any specific message has been failing; it is the length of continuous
27245 failure for the recipient address that counts.
27246
27247 When the cutoff time is reached for a local delivery, or for all the IP
27248 addresses associated with a remote delivery, a subsequent delivery failure
27249 causes Exim to give up on the address, and a bounce message is generated.
27250 In order to cater for new messages that use the failing address, a next retry
27251 time is still computed from the final algorithm, and is used as follows:
27252
27253 For local deliveries, one delivery attempt is always made for any subsequent
27254 messages. If this delivery fails, the address fails immediately. The
27255 post-cutoff retry time is not used.
27256
27257 .cindex "final cutoff" "retries, controlling"
27258 .cindex retry "final cutoff"
27259 If the delivery is remote, there are two possibilities, controlled by the
27260 .oindex "&%delay_after_cutoff%&"
27261 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27262 default. Until the post-cutoff retry time for one of the IP addresses,
27263 as set by the &%retry_data_expire%& option, is
27264 reached, the failing email address is bounced immediately, without a delivery
27265 attempt taking place. After that time, one new delivery attempt is made to
27266 those IP addresses that are past their retry times, and if that still fails,
27267 the address is bounced and new retry times are computed.
27268
27269 In other words, when all the hosts for a given email address have been failing
27270 for a long time, Exim bounces rather then defers until one of the hosts' retry
27271 times is reached. Then it tries once, and bounces if that attempt fails. This
27272 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27273 to a broken destination, but if the host does recover, Exim will eventually
27274 notice.
27275
27276 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27277 addresses are past their final cutoff time, Exim tries to deliver to those IP
27278 addresses that have not been tried since the message arrived. If there are
27279 no suitable IP addresses, or if they all fail, the address is bounced. In other
27280 words, it does not delay when a new message arrives, but tries the expired
27281 addresses immediately, unless they have been tried since the message arrived.
27282 If there is a continuous stream of messages for the failing domains, setting
27283 &%delay_after_cutoff%& false means that there will be many more attempts to
27284 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27285 true.
27286
27287 .section "Deliveries that work intermittently" "SECID167"
27288 .cindex "retry" "intermittently working deliveries"
27289 Some additional logic is needed to cope with cases where a host is
27290 intermittently available, or when a message has some attribute that prevents
27291 its delivery when others to the same address get through. In this situation,
27292 because some messages are successfully delivered, the &"retry clock"& for the
27293 host or address keeps getting reset by the successful deliveries, and so
27294 failing messages remain in the queue for ever because the cutoff time is never
27295 reached.
27296
27297 Two exceptional actions are applied to prevent this happening. The first
27298 applies to errors that are related to a message rather than a remote host.
27299 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27300 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27301 commands, and quota failures. For this type of error, if a message's arrival
27302 time is earlier than the &"first failed"& time for the error, the earlier time
27303 is used when scanning the retry rules to decide when to try next and when to
27304 time out the address.
27305
27306 The exceptional second action applies in all cases. If a message has been on
27307 the queue for longer than the cutoff time of any applicable retry rule for a
27308 given address, a delivery is attempted for that address, even if it is not yet
27309 time, and if this delivery fails, the address is timed out. A new retry time is
27310 not computed in this case, so that other messages for the same address are
27311 considered immediately.
27312 .ecindex IIDretconf1
27313 .ecindex IIDregconf2
27314
27315
27316
27317
27318
27319
27320 . ////////////////////////////////////////////////////////////////////////////
27321 . ////////////////////////////////////////////////////////////////////////////
27322
27323 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27324 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27325 .scindex IIDauthconf2 "authentication"
27326 The &"authenticators"& section of Exim's runtime configuration is concerned
27327 with SMTP authentication. This facility is an extension to the SMTP protocol,
27328 described in RFC 2554, which allows a client SMTP host to authenticate itself
27329 to a server. This is a common way for a server to recognize clients that are
27330 permitted to use it as a relay. SMTP authentication is not of relevance to the
27331 transfer of mail between servers that have no managerial connection with each
27332 other.
27333
27334 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27335 prior to Exim 4.95 names would be silently truncated at this length, but now
27336 it is enforced.
27337
27338 .cindex "AUTH" "description of"
27339 .cindex "ESMTP extensions" AUTH
27340 Very briefly, the way SMTP authentication works is as follows:
27341
27342 .olist
27343 The server advertises a number of authentication &'mechanisms'& in response to
27344 the client's EHLO command.
27345 .next
27346 The client issues an AUTH command, naming a specific mechanism. The command
27347 may, optionally, contain some authentication data.
27348 .next
27349 The server may issue one or more &'challenges'&, to which the client must send
27350 appropriate responses. In simple authentication mechanisms, the challenges are
27351 just prompts for user names and passwords. The server does not have to issue
27352 any challenges &-- in some mechanisms the relevant data may all be transmitted
27353 with the AUTH command.
27354 .next
27355 The server either accepts or denies authentication.
27356 .next
27357 If authentication succeeds, the client may optionally make use of the AUTH
27358 option on the MAIL command to pass an authenticated sender in subsequent
27359 mail transactions. Authentication lasts for the remainder of the SMTP
27360 connection.
27361 .next
27362 If authentication fails, the client may give up, or it may try a different
27363 authentication mechanism, or it may try transferring mail over the
27364 unauthenticated connection.
27365 .endlist
27366
27367 If you are setting up a client, and want to know which authentication
27368 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27369 SMTP port) on the server, and issue an EHLO command. The response to this
27370 includes the list of supported mechanisms. For example:
27371 .display
27372 &`$ `&&*&`telnet server.example 25`&*&
27373 &`Trying 192.168.34.25...`&
27374 &`Connected to server.example.`&
27375 &`Escape character is &#x0027;^]&#x0027;.`&
27376 &`220 server.example ESMTP Exim 4.20 ...`&
27377 &*&`ehlo client.example`&*&
27378 &`250-server.example Hello client.example [10.8.4.5]`&
27379 &`250-SIZE 52428800`&
27380 &`250-PIPELINING`&
27381 &`250-AUTH PLAIN`&
27382 &`250 HELP`&
27383 .endd
27384 The second-last line of this example output shows that the server supports
27385 authentication using the PLAIN mechanism. In Exim, the different authentication
27386 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27387 routers and transports, which authenticators are included in the binary is
27388 controlled by build-time definitions. The following are currently available,
27389 included by setting
27390 .code
27391 AUTH_CRAM_MD5=yes
27392 AUTH_CYRUS_SASL=yes
27393 AUTH_DOVECOT=yes
27394 AUTH_EXTERNAL=yes
27395 AUTH_GSASL=yes
27396 AUTH_HEIMDAL_GSSAPI=yes
27397 AUTH_PLAINTEXT=yes
27398 AUTH_SPA=yes
27399 AUTH_TLS=yes
27400 .endd
27401 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27402 authentication mechanism (RFC 2195), and the second provides an interface to
27403 the Cyrus SASL authentication library.
27404 The third is an interface to Dovecot's authentication system, delegating the
27405 work via a socket interface.
27406 The fourth provides for negotiation of authentication done via non-SMTP means,
27407 as defined by RFC 4422 Appendix A.
27408 The fifth provides an interface to the GNU SASL authentication library, which
27409 provides mechanisms but typically not data sources.
27410 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27411 supporting setting a server keytab.
27412 The seventh can be configured to support
27413 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27414 not formally documented, but used by several MUAs.
27415 The eighth authenticator
27416 supports Microsoft's &'Secure Password Authentication'& mechanism.
27417 The last is an Exim authenticator but not an SMTP one;
27418 instead it can use information from a TLS negotiation.
27419
27420 The authenticators are configured using the same syntax as other drivers (see
27421 section &<<SECTfordricon>>&). If no authenticators are required, no
27422 authentication section need be present in the configuration file. Each
27423 authenticator can in principle have both server and client functions. When Exim
27424 is receiving SMTP mail, it is acting as a server; when it is sending out
27425 messages over SMTP, it is acting as a client. Authenticator configuration
27426 options are provided for use in both these circumstances.
27427
27428 To make it clear which options apply to which situation, the prefixes
27429 &%server_%& and &%client_%& are used on option names that are specific to
27430 either the server or the client function, respectively. Server and client
27431 functions are disabled if none of their options are set. If an authenticator is
27432 to be used for both server and client functions, a single definition, using
27433 both sets of options, is required. For example:
27434 .code
27435 cram:
27436   driver = cram_md5
27437   public_name = CRAM-MD5
27438   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27439   client_name = ph10
27440   client_secret = secret2
27441 .endd
27442 The &%server_%& option is used when Exim is acting as a server, and the
27443 &%client_%& options when it is acting as a client.
27444
27445 Descriptions of the individual authenticators are given in subsequent chapters.
27446 The remainder of this chapter covers the generic options for the
27447 authenticators, followed by general discussion of the way authentication works
27448 in Exim.
27449
27450 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27451 per-mechanism basis.  Please read carefully to determine which variables hold
27452 account labels such as usercodes and which hold passwords or other
27453 authenticating data.
27454
27455 Note that some mechanisms support two different identifiers for accounts: the
27456 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27457 and &'authz'& are commonly encountered.  The American spelling is standard here.
27458 Conceptually, authentication data such as passwords are tied to the identifier
27459 used to authenticate; servers may have rules to permit one user to act as a
27460 second user, so that after login the session is treated as though that second
27461 user had logged in.  That second user is the &'authorization id'&.  A robust
27462 configuration might confirm that the &'authz'& field is empty or matches the
27463 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27464 as verified data, the &'authz'& as an unverified request which the server might
27465 choose to honour.
27466
27467 A &'realm'& is a text string, typically a domain name, presented by a server
27468 to a client to help it select an account and credentials to use.  In some
27469 mechanisms, the client and server provably agree on the realm, but clients
27470 typically can not treat the realm as secure data to be blindly trusted.
27471
27472
27473
27474 .section "Generic options for authenticators" "SECID168"
27475 .cindex "authentication" "generic options"
27476 .cindex "options" "generic; for authenticators"
27477
27478 .option client_condition authenticators string&!! unset
27479 When Exim is authenticating as a client, it skips any authenticator whose
27480 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27481 used, for example, to skip plain text authenticators when the connection is not
27482 encrypted by a setting such as:
27483 .code
27484 client_condition = ${if !eq{$tls_out_cipher}{}}
27485 .endd
27486
27487
27488 .option client_set_id authenticators string&!! unset
27489 When client authentication succeeds, this condition is expanded; the
27490 result is used in the log lines for outbound messages.
27491 Typically it will be the user name used for authentication.
27492
27493
27494 .option driver authenticators string unset
27495 This option must always be set. It specifies which of the available
27496 authenticators is to be used.
27497
27498
27499 .option public_name authenticators string unset
27500 This option specifies the name of the authentication mechanism that the driver
27501 implements, and by which it is known to the outside world. These names should
27502 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27503 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27504 defaults to the driver's instance name.
27505
27506
27507 .option server_advertise_condition authenticators string&!! unset
27508 When a server is about to advertise an authentication mechanism, the condition
27509 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27510 mechanism is not advertised.
27511 If the expansion fails, the mechanism is not advertised. If the failure was not
27512 forced, and was not caused by a lookup defer, the incident is logged.
27513 See section &<<SECTauthexiser>>& below for further discussion.
27514
27515
27516 .option server_condition authenticators string&!! unset
27517 This option must be set for a &%plaintext%& server authenticator, where it
27518 is used directly to control authentication. See section &<<SECTplainserver>>&
27519 for details.
27520
27521 For the &(gsasl)& authenticator, this option is required for various
27522 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27523
27524 For the other authenticators, &%server_condition%& can be used as an additional
27525 authentication or authorization mechanism that is applied after the other
27526 authenticator conditions succeed. If it is set, it is expanded when the
27527 authenticator would otherwise return a success code. If the expansion is forced
27528 to fail, authentication fails. Any other expansion failure causes a temporary
27529 error code to be returned. If the result of a successful expansion is an empty
27530 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27531 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27532 other result, a temporary error code is returned, with the expanded string as
27533 the error text.
27534
27535
27536 .option server_debug_print authenticators string&!! unset
27537 If this option is set and authentication debugging is enabled (see the &%-d%&
27538 command line option), the string is expanded and included in the debugging
27539 output when the authenticator is run as a server. This can help with checking
27540 out the values of variables.
27541 If expansion of the string fails, the error message is written to the debugging
27542 output, and Exim carries on processing.
27543
27544
27545 .option server_set_id authenticators string&!! unset
27546 .vindex "&$authenticated_id$&"
27547 .vindex "&$authenticated_fail_id$&"
27548 When an Exim server successfully authenticates a client, this string is
27549 expanded using data from the authentication, and preserved for any incoming
27550 messages in the variable &$authenticated_id$&. It is also included in the log
27551 lines for incoming messages. For example, a user/password authenticator
27552 configuration might preserve the user name that was used to authenticate, and
27553 refer to it subsequently during delivery of the message.
27554 On a failing authentication the expansion result is instead saved in
27555 the &$authenticated_fail_id$& variable.
27556 If expansion fails, the option is ignored.
27557
27558
27559 .option server_mail_auth_condition authenticators string&!! unset
27560 This option allows a server to discard authenticated sender addresses supplied
27561 as part of MAIL commands in SMTP connections that are authenticated by the
27562 driver on which &%server_mail_auth_condition%& is set. The option is not used
27563 as part of the authentication process; instead its (unexpanded) value is
27564 remembered for later use.
27565 How it is used is described in the following section.
27566
27567
27568
27569
27570
27571 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27572 .cindex "authentication" "sender; authenticated"
27573 .cindex "AUTH" "on MAIL command"
27574 When a client supplied an AUTH= item on a MAIL command, Exim applies
27575 the following checks before accepting it as the authenticated sender of the
27576 message:
27577
27578 .ilist
27579 If the connection is not using extended SMTP (that is, HELO was used rather
27580 than EHLO), the use of AUTH= is a syntax error.
27581 .next
27582 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27583 .next
27584 .vindex "&$authenticated_sender$&"
27585 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27586 running, the value of &$authenticated_sender$& is set to the value obtained
27587 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27588 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27589 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27590 given for the MAIL command.
27591 .next
27592 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27593 is accepted and placed in &$authenticated_sender$& only if the client has
27594 authenticated.
27595 .next
27596 If the AUTH= value was accepted by either of the two previous rules, and
27597 the client has authenticated, and the authenticator has a setting for the
27598 &%server_mail_auth_condition%&, the condition is checked at this point. The
27599 valued that was saved from the authenticator is expanded. If the expansion
27600 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27601 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27602 the value of &$authenticated_sender$& is retained and passed on with the
27603 message.
27604 .endlist
27605
27606
27607 When &$authenticated_sender$& is set for a message, it is passed on to other
27608 hosts to which Exim authenticates as a client. Do not confuse this value with
27609 &$authenticated_id$&, which is a string obtained from the authentication
27610 process, and which is not usually a complete email address.
27611
27612 .vindex "&$sender_address$&"
27613 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27614 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27615 therefore make use of &$authenticated_sender$&. The converse is not true: the
27616 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27617 ACL is run.
27618
27619
27620
27621 .section "Authentication on an Exim server" "SECTauthexiser"
27622 .cindex "authentication" "on an Exim server"
27623 When Exim receives an EHLO command, it advertises the public names of those
27624 authenticators that are configured as servers, subject to the following
27625 conditions:
27626
27627 .ilist
27628 The client host must match &%auth_advertise_hosts%& (default *).
27629 .next
27630 If the &%server_advertise_condition%& option is set, its expansion must not
27631 yield the empty string, &"0"&, &"no"&, or &"false"&.
27632 .endlist
27633
27634 The order in which the authenticators are defined controls the order in which
27635 the mechanisms are advertised.
27636
27637 Some mail clients (for example, some versions of Netscape) require the user to
27638 provide a name and password for authentication whenever AUTH is advertised,
27639 even though authentication may not in fact be needed (for example, Exim may be
27640 set up to allow unconditional relaying from the client by an IP address check).
27641 You can make such clients more friendly by not advertising AUTH to them.
27642 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27643 that runs for RCPT) to relay without authentication, you should set
27644 .code
27645 auth_advertise_hosts = ! 10.9.8.0/24
27646 .endd
27647 so that no authentication mechanisms are advertised to them.
27648
27649 The &%server_advertise_condition%& controls the advertisement of individual
27650 authentication mechanisms. For example, it can be used to restrict the
27651 advertisement of a particular mechanism to encrypted connections, by a setting
27652 such as:
27653 .code
27654 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27655 .endd
27656 .vindex "&$tls_in_cipher$&"
27657 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27658 yields &"yes"&, which allows the advertisement to happen.
27659
27660 When an Exim server receives an AUTH command from a client, it rejects it
27661 immediately if AUTH was not advertised in response to an earlier EHLO
27662 command. This is the case if
27663
27664 .ilist
27665 The client host does not match &%auth_advertise_hosts%&; or
27666 .next
27667 No authenticators are configured with server options; or
27668 .next
27669 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27670 server authenticators.
27671 .endlist
27672
27673
27674 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27675 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27676 AUTH is accepted from any client host.
27677
27678 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27679 server authentication mechanism that was advertised in response to EHLO and
27680 that matches the one named in the AUTH command. If it finds one, it runs
27681 the appropriate authentication protocol, and authentication either succeeds or
27682 fails. If there is no matching advertised mechanism, the AUTH command is
27683 rejected with a 504 error.
27684
27685 .vindex "&$received_protocol$&"
27686 .vindex "&$sender_host_authenticated$&"
27687 When a message is received from an authenticated host, the value of
27688 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27689 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27690 public name) of the authenticator driver that successfully authenticated the
27691 client from which the message was received. This variable is empty if there was
27692 no successful authentication.
27693
27694 .cindex authentication "expansion item"
27695 Successful authentication sets up information used by the
27696 &%authresults%& expansion item.
27697
27698 .new
27699 .cindex authentication "failure event, server"
27700 If an authenticator is run and does not succeed,
27701 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27702 While the event is being processed the variables
27703 &$sender_host_authenticated$& (with the authenticator name)
27704 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27705 will be valid.
27706 If the event is serviced and a string is returned then the string will be logged
27707 instead of the default log line.
27708 See <<CHAPevents>> for details on events.
27709 .wen
27710
27711
27712 .section "Testing server authentication" "SECID169"
27713 .cindex "authentication" "testing a server"
27714 .cindex "AUTH" "testing a server"
27715 .cindex "base64 encoding" "creating authentication test data"
27716 Exim's &%-bh%& option can be useful for testing server authentication
27717 configurations. The data for the AUTH command has to be sent using base64
27718 encoding. A quick way to produce such data for testing is the following Perl
27719 script:
27720 .code
27721 use MIME::Base64;
27722 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27723 .endd
27724 .cindex "binary zero" "in authentication data"
27725 This interprets its argument as a Perl string, and then encodes it. The
27726 interpretation as a Perl string allows binary zeros, which are required for
27727 some kinds of authentication, to be included in the data. For example, a
27728 command line to run this script on such data might be
27729 .code
27730 encode '\0user\0password'
27731 .endd
27732 Note the use of single quotes to prevent the shell interpreting the
27733 backslashes, so that they can be interpreted by Perl to specify characters
27734 whose code value is zero.
27735
27736 &*Warning 1*&: If either of the user or password strings starts with an octal
27737 digit, you must use three zeros instead of one after the leading backslash. If
27738 you do not, the octal digit that starts your string will be incorrectly
27739 interpreted as part of the code for the first character.
27740
27741 &*Warning 2*&: If there are characters in the strings that Perl interprets
27742 specially, you must use a Perl escape to prevent them being misinterpreted. For
27743 example, a command such as
27744 .code
27745 encode '\0user@domain.com\0pas$$word'
27746 .endd
27747 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27748
27749 If you have the &%mimencode%& command installed, another way to produce
27750 base64-encoded strings is to run the command
27751 .code
27752 echo -e -n `\0user\0password' | mimencode
27753 .endd
27754 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27755 in the argument, and the &%-n%& option specifies no newline at the end of its
27756 output. However, not all versions of &%echo%& recognize these options, so you
27757 should check your version before relying on this suggestion.
27758
27759
27760
27761 .section "Authentication by an Exim client" "SECID170"
27762 .cindex "authentication" "on an Exim client"
27763 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27764 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27765 announces support for authentication, and the host matches an entry in either
27766 of these options, Exim (as a client) tries to authenticate as follows:
27767
27768 .ilist
27769 For each authenticator that is configured as a client, in the order in which
27770 they are defined in the configuration, it searches the authentication
27771 mechanisms announced by the server for one whose name matches the public name
27772 of the authenticator.
27773 .next
27774 .vindex "&$host$&"
27775 .vindex "&$host_address$&"
27776 When it finds one that matches, it runs the authenticator's client code. The
27777 variables &$host$& and &$host_address$& are available for any string expansions
27778 that the client might do. They are set to the server's name and IP address. If
27779 any expansion is forced to fail, the authentication attempt is abandoned, and
27780 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27781 delivery to be deferred.
27782 .next
27783 If the result of the authentication attempt is a temporary error or a timeout,
27784 Exim abandons trying to send the message to the host for the moment. It will
27785 try again later. If there are any backup hosts available, they are tried in the
27786 usual way.
27787
27788 .new
27789 .next
27790 .cindex authentication "failure event, client"
27791 If the response to authentication is a permanent error (5&'xx'& code),
27792 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27793 While the event is being processed the variable
27794 &$sender_host_authenticated$& (with the authenticator name)
27795 will be valid.
27796 If the event is serviced and a string is returned then the string will be logged.
27797 See <<CHAPevents>> for details on events.
27798 .wen
27799
27800 .next
27801 If the response to authentication is a permanent error (5&'xx'& code), Exim
27802 carries on searching the list of authenticators and tries another one if
27803 possible. If all authentication attempts give permanent errors, or if there are
27804 no attempts because no mechanisms match (or option expansions force failure),
27805 what happens depends on whether the host matches &%hosts_require_auth%& or
27806 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27807 delivery is deferred. The error can be detected in the retry rules, and thereby
27808 turned into a permanent error if you wish. In the second case, Exim tries to
27809 deliver the message unauthenticated.
27810 .endlist
27811
27812 Note that the hostlist test for whether to do authentication can be
27813 confused if name-IP lookups change between the time the peer is decided
27814 upon and the time that the transport runs.  For example, with a manualroute
27815 router given a host name, and with DNS "round-robin" used by that name: if
27816 the local resolver cache times out between the router and the transport
27817 running, the transport may get an IP for the name for its authentication
27818 check which does not match the connection peer IP.
27819 No authentication will then be done, despite the names being identical.
27820
27821 For such cases use a separate transport which always authenticates.
27822
27823 .cindex "AUTH" "on MAIL command"
27824 When Exim has authenticated itself to a remote server, it adds the AUTH
27825 parameter to the MAIL commands it sends, if it has an authenticated sender for
27826 the message. If the message came from a remote host, the authenticated sender
27827 is the one that was receiving on an incoming MAIL command, provided that the
27828 incoming connection was authenticated and the &%server_mail_auth%& condition
27829 allowed the authenticated sender to be retained. If a local process calls Exim
27830 to send a message, the sender address that is built from the login name and
27831 &%qualify_domain%& is treated as authenticated. However, if the
27832 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27833 the authenticated sender that was received with the message.
27834 .ecindex IIDauthconf1
27835 .ecindex IIDauthconf2
27836
27837
27838
27839
27840
27841
27842 . ////////////////////////////////////////////////////////////////////////////
27843 . ////////////////////////////////////////////////////////////////////////////
27844
27845 .chapter "The plaintext authenticator" "CHAPplaintext"
27846 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27847 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27848 The &(plaintext)& authenticator can be configured to support the PLAIN and
27849 LOGIN authentication mechanisms, both of which transfer authentication data as
27850 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27851 security risk; you are strongly advised to insist on the use of SMTP encryption
27852 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27853 use unencrypted plain text, you should not use the same passwords for SMTP
27854 connections as you do for login accounts.
27855
27856 .section "Avoiding cleartext use" "SECTplain_TLS"
27857 The following generic option settings will disable &(plaintext)& authenticators when
27858 TLS is not being used:
27859 .code
27860   server_advertise_condition = ${if def:tls_in_cipher }
27861   client_condition =           ${if def:tls_out_cipher}
27862 .endd
27863
27864 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27865 but is still vulnerable to a Man In The Middle attack unless certificates
27866 (including their names) have been properly verified.
27867
27868 .section "Plaintext server options" "SECID171"
27869 .cindex "options" "&(plaintext)& authenticator (server)"
27870 When configured as a server, &(plaintext)& uses the following options:
27871
27872 .option server_condition authenticators string&!! unset
27873 This is actually a global authentication option, but it must be set in order to
27874 configure the &(plaintext)& driver as a server. Its use is described below.
27875
27876 .option server_prompts plaintext "string list&!!" unset
27877 The contents of this option, after expansion, must be a colon-separated list of
27878 prompt strings. If expansion fails, a temporary authentication rejection is
27879 given.
27880
27881 .section "Using plaintext in a server" "SECTplainserver"
27882 .cindex "AUTH" "in &(plaintext)& authenticator"
27883 .cindex "binary zero" "in &(plaintext)& authenticator"
27884 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27885         "in &(plaintext)& authenticator"
27886 .vindex "&$auth1$&, &$auth2$&, etc"
27887 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27888
27889 When running as a server, &(plaintext)& performs the authentication test by
27890 expanding a string. The data sent by the client with the AUTH command, or in
27891 response to subsequent prompts, is base64 encoded, and so may contain any byte
27892 values when decoded. If any data is supplied with the command, it is treated as
27893 a list of strings, separated by NULs (binary zeros), the first three of which
27894 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27895 (neither LOGIN nor PLAIN uses more than three strings).
27896
27897 For compatibility with previous releases of Exim, the values are also placed in
27898 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27899 variables for this purpose is now deprecated, as it can lead to confusion in
27900 string expansions that also use them for other things.
27901
27902 If there are more strings in &%server_prompts%& than the number of strings
27903 supplied with the AUTH command, the remaining prompts are used to obtain more
27904 data. Each response from the client may be a list of NUL-separated strings.
27905
27906 .vindex "&$authenticated_id$&"
27907 Once a sufficient number of data strings have been received,
27908 &%server_condition%& is expanded. If the expansion is forced to fail,
27909 authentication fails. Any other expansion failure causes a temporary error code
27910 to be returned. If the result of a successful expansion is an empty string,
27911 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27912 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27913 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27914 For any other result, a temporary error code is returned, with the expanded
27915 string as the error text.
27916
27917 &*Warning*&: If you use a lookup in the expansion to find the user's
27918 password, be sure to make the authentication fail if the user is unknown.
27919 There are good and bad examples at the end of the next section.
27920
27921
27922
27923 .section "The PLAIN authentication mechanism" "SECID172"
27924 .cindex "PLAIN authentication mechanism"
27925 .cindex authentication PLAIN
27926 .cindex "binary zero" "in &(plaintext)& authenticator"
27927 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27928 sent as one item of data (that is, one combined string containing two NUL
27929 separators). The data is sent either as part of the AUTH command, or
27930 subsequently in response to an empty prompt from the server.
27931
27932 The second and third strings are a user name and a corresponding password.
27933 Using a single fixed user name and password as an example, this could be
27934 configured as follows:
27935 .code
27936 fixed_plain:
27937   driver = plaintext
27938   public_name = PLAIN
27939   server_prompts = :
27940   server_condition = \
27941     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27942   server_set_id = $auth2
27943 .endd
27944 Note that the default result strings from &%if%& (&"true"& or an empty string)
27945 are exactly what we want here, so they need not be specified. Obviously, if the
27946 password contains expansion-significant characters such as dollar, backslash,
27947 or closing brace, they have to be escaped.
27948
27949 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27950 the end of a string list are ignored). If all the data comes as part of the
27951 AUTH command, as is commonly the case, the prompt is not used. This
27952 authenticator is advertised in the response to EHLO as
27953 .code
27954 250-AUTH PLAIN
27955 .endd
27956 and a client host can authenticate itself by sending the command
27957 .code
27958 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27959 .endd
27960 As this contains three strings (more than the number of prompts), no further
27961 data is required from the client. Alternatively, the client may just send
27962 .code
27963 AUTH PLAIN
27964 .endd
27965 to initiate authentication, in which case the server replies with an empty
27966 prompt. The client must respond with the combined data string.
27967
27968 The data string is base64 encoded, as required by the RFC. This example,
27969 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27970 represents a zero byte. This is split up into three strings, the first of which
27971 is empty. The &%server_condition%& option in the authenticator checks that the
27972 second two are &`username`& and &`mysecret`& respectively.
27973
27974 Having just one fixed user name and password, as in this example, is not very
27975 realistic, though for a small organization with only a handful of
27976 authenticating clients it could make sense.
27977
27978 A more sophisticated instance of this authenticator could use the user name in
27979 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27980 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27981 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27982 This is an incorrect example:
27983 .code
27984 server_condition = \
27985   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27986 .endd
27987 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27988 which it then compares to the supplied password (&$auth3$&). Why is this example
27989 incorrect? It works fine for existing users, but consider what happens if a
27990 non-existent user name is given. The lookup fails, but as no success/failure
27991 strings are given for the lookup, it yields an empty string. Thus, to defeat
27992 the authentication, all a client has to do is to supply a non-existent user
27993 name and an empty password. The correct way of writing this test is:
27994 .code
27995 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27996   {${if eq{$value}{$auth3}}} {false}}
27997 .endd
27998 In this case, if the lookup succeeds, the result is checked; if the lookup
27999 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28000 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28001 always fails if its second argument is empty. However, the second way of
28002 writing the test makes the logic clearer.
28003
28004
28005 .section "The LOGIN authentication mechanism" "SECID173"
28006 .cindex "LOGIN authentication mechanism"
28007 .cindex authentication LOGIN
28008 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28009 in a number of programs. No data is sent with the AUTH command. Instead, a
28010 user name and password are supplied separately, in response to prompts. The
28011 plaintext authenticator can be configured to support this as in this example:
28012 .code
28013 fixed_login:
28014   driver = plaintext
28015   public_name = LOGIN
28016   server_prompts = User Name : Password
28017   server_condition = \
28018     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28019   server_set_id = $auth1
28020 .endd
28021 Because of the way plaintext operates, this authenticator accepts data supplied
28022 with the AUTH command (in contravention of the specification of LOGIN), but
28023 if the client does not supply it (as is the case for LOGIN clients), the prompt
28024 strings are used to obtain two data items.
28025
28026 Some clients are very particular about the precise text of the prompts. For
28027 example, Outlook Express is reported to recognize only &"Username:"& and
28028 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28029 strings. It uses the &%ldapauth%& expansion condition to check the user
28030 name and password by binding to an LDAP server:
28031 .code
28032 login:
28033   driver = plaintext
28034   public_name = LOGIN
28035   server_prompts = Username:: : Password::
28036   server_condition = ${if and{{ \
28037     !eq{}{$auth1} }{ \
28038     ldapauth{\
28039       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28040       pass=${quote:$auth2} \
28041       ldap://ldap.example.org/} }} }
28042   server_set_id = uid=$auth1,ou=people,o=example.org
28043 .endd
28044 We have to check that the username is not empty before using it, because LDAP
28045 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28046 operator to correctly quote the DN for authentication. However, the basic
28047 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28048 correct one to use for the password, because quoting is needed only to make
28049 the password conform to the Exim syntax. At the LDAP level, the password is an
28050 uninterpreted string.
28051
28052
28053 .section "Support for different kinds of authentication" "SECID174"
28054 A number of string expansion features are provided for the purpose of
28055 interfacing to different ways of user authentication. These include checking
28056 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28057 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28058 &<<SECTexpcond>>&.
28059
28060
28061
28062
28063 .section "Using plaintext in a client" "SECID175"
28064 .cindex "options" "&(plaintext)& authenticator (client)"
28065 The &(plaintext)& authenticator has two client options:
28066
28067 .option client_ignore_invalid_base64 plaintext boolean false
28068 If the client receives a server prompt that is not a valid base64 string,
28069 authentication is abandoned by default. However, if this option is set true,
28070 the error in the challenge is ignored and the client sends the response as
28071 usual.
28072
28073 .option client_send plaintext string&!! unset
28074 The string is a colon-separated list of authentication data strings. Each
28075 string is independently expanded before being sent to the server. The first
28076 string is sent with the AUTH command; any more strings are sent in response
28077 to prompts from the server. Before each string is expanded, the value of the
28078 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28079 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28080 way. Thus, the prompt that is received in response to sending the first string
28081 (with the AUTH command) can be used in the expansion of the second string, and
28082 so on. If an invalid base64 string is received when
28083 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28084 &$auth$&<&'n'&> variable.
28085
28086 &*Note*&: You cannot use expansion to create multiple strings, because
28087 splitting takes priority and happens first.
28088
28089 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28090 the data, further processing is applied to each string before it is sent. If
28091 there are any single circumflex characters in the string, they are converted to
28092 NULs. Should an actual circumflex be required as data, it must be doubled in
28093 the string.
28094
28095 This is an example of a client configuration that implements the PLAIN
28096 authentication mechanism with a fixed user name and password:
28097 .code
28098 fixed_plain:
28099   driver = plaintext
28100   public_name = PLAIN
28101   client_send = ^username^mysecret
28102 .endd
28103 The lack of colons means that the entire text is sent with the AUTH
28104 command, with the circumflex characters converted to NULs.
28105 Note that due to the ambiguity of parsing three consectutive circumflex characters
28106 there is no way to provide a password having a leading circumflex.
28107
28108
28109 A similar example
28110 that uses the LOGIN mechanism is:
28111 .code
28112 fixed_login:
28113   driver = plaintext
28114   public_name = LOGIN
28115   client_send = : username : mysecret
28116 .endd
28117 The initial colon means that the first string is empty, so no data is sent with
28118 the AUTH command itself. The remaining strings are sent in response to
28119 prompts.
28120 .ecindex IIDplaiauth1
28121 .ecindex IIDplaiauth2
28122
28123
28124
28125
28126 . ////////////////////////////////////////////////////////////////////////////
28127 . ////////////////////////////////////////////////////////////////////////////
28128
28129 .chapter "The cram_md5 authenticator" "CHID9"
28130 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28131 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28132 .cindex "CRAM-MD5 authentication mechanism"
28133 .cindex authentication CRAM-MD5
28134 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28135 sends a challenge string to the client, and the response consists of a user
28136 name and the CRAM-MD5 digest of the challenge string combined with a secret
28137 string (password) which is known to both server and client. Thus, the secret
28138 is not sent over the network as plain text, which makes this authenticator more
28139 secure than &(plaintext)&. However, the downside is that the secret has to be
28140 available in plain text at either end.
28141
28142
28143 .section "Using cram_md5 as a server" "SECID176"
28144 .cindex "options" "&(cram_md5)& authenticator (server)"
28145 This authenticator has one server option, which must be set to configure the
28146 authenticator as a server:
28147
28148 .option server_secret cram_md5 string&!! unset
28149 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28150 When the server receives the client's response, the user name is placed in
28151 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28152 obtain the password for that user. The server then computes the CRAM-MD5 digest
28153 that the client should have sent, and checks that it received the correct
28154 string. If the expansion of &%server_secret%& is forced to fail, authentication
28155 fails. If the expansion fails for some other reason, a temporary error code is
28156 returned to the client.
28157
28158 For compatibility with previous releases of Exim, the user name is also placed
28159 in &$1$&. However, the use of this variables for this purpose is now
28160 deprecated, as it can lead to confusion in string expansions that also use
28161 numeric variables for other things.
28162
28163 For example, the following authenticator checks that the user name given by the
28164 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28165 user name, authentication fails.
28166 .code
28167 fixed_cram:
28168   driver = cram_md5
28169   public_name = CRAM-MD5
28170   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28171   server_set_id = $auth1
28172 .endd
28173 .vindex "&$authenticated_id$&"
28174 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28175 name in &$authenticated_id$&. A more typical configuration might look up the
28176 secret string in a file, using the user name as the key. For example:
28177 .code
28178 lookup_cram:
28179   driver = cram_md5
28180   public_name = CRAM-MD5
28181   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28182                   {$value}fail}
28183   server_set_id = $auth1
28184 .endd
28185 Note that this expansion explicitly forces failure if the lookup fails
28186 because &$auth1$& contains an unknown user name.
28187
28188 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28189 using the relevant libraries, you need to know the realm to specify in the
28190 lookup and then ask for the &"userPassword"& attribute for that user in that
28191 realm, with:
28192 .code
28193 cyrusless_crammd5:
28194   driver = cram_md5
28195   public_name = CRAM-MD5
28196   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28197                   dbmjz{/etc/sasldb2}{$value}fail}
28198   server_set_id = $auth1
28199 .endd
28200
28201 .section "Using cram_md5 as a client" "SECID177"
28202 .cindex "options" "&(cram_md5)& authenticator (client)"
28203 When used as a client, the &(cram_md5)& authenticator has two options:
28204
28205
28206
28207 .option client_name cram_md5 string&!! "the primary host name"
28208 This string is expanded, and the result used as the user name data when
28209 computing the response to the server's challenge.
28210
28211
28212 .option client_secret cram_md5 string&!! unset
28213 This option must be set for the authenticator to work as a client. Its value is
28214 expanded and the result used as the secret string when computing the response.
28215
28216
28217 .vindex "&$host$&"
28218 .vindex "&$host_address$&"
28219 Different user names and secrets can be used for different servers by referring
28220 to &$host$& or &$host_address$& in the options. Forced failure of either
28221 expansion string is treated as an indication that this authenticator is not
28222 prepared to handle this case. Exim moves on to the next configured client
28223 authenticator. Any other expansion failure causes Exim to give up trying to
28224 send the message to the current server.
28225
28226 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28227 strings, is:
28228 .code
28229 fixed_cram:
28230   driver = cram_md5
28231   public_name = CRAM-MD5
28232   client_name = ph10
28233   client_secret = secret
28234 .endd
28235 .ecindex IIDcramauth1
28236 .ecindex IIDcramauth2
28237
28238
28239
28240 . ////////////////////////////////////////////////////////////////////////////
28241 . ////////////////////////////////////////////////////////////////////////////
28242
28243 .chapter "The cyrus_sasl authenticator" "CHID10"
28244 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28245 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28246 .cindex "Cyrus" "SASL library"
28247 .cindex "Kerberos"
28248 The code for this authenticator was provided by Matthew Byng-Maddick while
28249 at A L Digital Ltd.
28250
28251 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28252 library implementation of the RFC 2222 (&"Simple Authentication and Security
28253 Layer"&). This library supports a number of authentication mechanisms,
28254 including PLAIN and LOGIN, but also several others that Exim does not support
28255 directly. In particular, there is support for Kerberos authentication.
28256
28257 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28258 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28259 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28260 name of the driver to determine which mechanism to support.
28261
28262 Where access to some kind of secret file is required, for example, in GSSAPI
28263 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28264 user, and that the Cyrus SASL library has no way of escalating privileges
28265 by default. You may also find you need to set environment variables,
28266 depending on the driver you are using.
28267
28268 The application name provided by Exim is &"exim"&, so various SASL options may
28269 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28270 Kerberos, note that because of limitations in the GSSAPI interface,
28271 changing the server keytab might need to be communicated down to the Kerberos
28272 layer independently. The mechanism for doing so is dependent upon the Kerberos
28273 implementation.
28274
28275 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28276 may be set to point to an alternative keytab file. Exim will pass this
28277 variable through from its own inherited environment when started as root or the
28278 Exim user. The keytab file needs to be readable by the Exim user.
28279 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28280 environment variable.  In practice, for those releases, the Cyrus authenticator
28281 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28282 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28283
28284
28285 .section "Using cyrus_sasl as a server" "SECID178"
28286 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28287 (on a successful authentication) into &$auth1$&. For compatibility with
28288 previous releases of Exim, the username is also placed in &$1$&. However, the
28289 use of this variable for this purpose is now deprecated, as it can lead to
28290 confusion in string expansions that also use numeric variables for other
28291 things.
28292
28293
28294 .option server_hostname cyrus_sasl string&!! "see below"
28295 This option selects the hostname that is used when communicating with the
28296 library. The default value is &`$primary_hostname`&. It is up to the underlying
28297 SASL plug-in what it does with this data.
28298
28299
28300 .option server_mech cyrus_sasl string "see below"
28301 This option selects the authentication mechanism this driver should use. The
28302 default is the value of the generic &%public_name%& option. This option allows
28303 you to use a different underlying mechanism from the advertised name. For
28304 example:
28305 .code
28306 sasl:
28307   driver = cyrus_sasl
28308   public_name = X-ANYTHING
28309   server_mech = CRAM-MD5
28310   server_set_id = $auth1
28311 .endd
28312
28313 .option server_realm cyrus_sasl string&!! unset
28314 This specifies the SASL realm that the server claims to be in.
28315
28316
28317 .option server_service cyrus_sasl string &`smtp`&
28318 This is the SASL service that the server claims to implement.
28319
28320
28321 For straightforward cases, you do not need to set any of the authenticator's
28322 private options. All you need to do is to specify an appropriate mechanism as
28323 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28324 PLAIN, you could have two authenticators as follows:
28325 .code
28326 sasl_cram_md5:
28327   driver = cyrus_sasl
28328   public_name = CRAM-MD5
28329   server_set_id = $auth1
28330
28331 sasl_plain:
28332   driver = cyrus_sasl
28333   public_name = PLAIN
28334   server_set_id = $auth2
28335 .endd
28336 Cyrus SASL does implement the LOGIN authentication method, even though it is
28337 not a standard method. It is disabled by default in the source distribution,
28338 but it is present in many binary distributions.
28339 .ecindex IIDcyrauth1
28340 .ecindex IIDcyrauth2
28341
28342
28343
28344
28345 . ////////////////////////////////////////////////////////////////////////////
28346 . ////////////////////////////////////////////////////////////////////////////
28347 .chapter "The dovecot authenticator" "CHAPdovecot"
28348 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28349 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28350 This authenticator is an interface to the authentication facility of the
28351 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28352 Note that Dovecot must be configured to use auth-client not auth-userdb.
28353 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28354 to use the same mechanisms for SMTP authentication. This is a server
28355 authenticator only. There is only one non-generic option:
28356
28357 .option server_socket dovecot string unset
28358
28359 This option must specify the UNIX socket that is the interface to Dovecot
28360 authentication. The &%public_name%& option must specify an authentication
28361 mechanism that Dovecot is configured to support. You can have several
28362 authenticators for different mechanisms. For example:
28363 .code
28364 dovecot_plain:
28365   driver = dovecot
28366   public_name = PLAIN
28367   server_advertise_condition = ${if def:tls_in_cipher}
28368   server_socket = /var/run/dovecot/auth-client
28369   server_set_id = $auth1
28370
28371 dovecot_ntlm:
28372   driver = dovecot
28373   public_name = NTLM
28374   server_socket = /var/run/dovecot/auth-client
28375   server_set_id = $auth1
28376 .endd
28377
28378 .new
28379 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28380 should not be advertised on cleartext SMTP connections.
28381 See the discussion in section &<<SECTplain_TLS>>&.
28382 .wen
28383
28384 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28385 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28386 option is passed in the Dovecot authentication command. If, for a TLS
28387 connection, a client certificate has been verified, the &"valid-client-cert"&
28388 option is passed. When authentication succeeds, the identity of the user
28389 who authenticated is placed in &$auth1$&.
28390
28391 The Dovecot configuration to match the above will look
28392 something like:
28393 .code
28394 conf.d/10-master.conf :-
28395
28396 service auth {
28397 ...
28398 #SASL
28399   unix_listener auth-client {
28400     mode = 0660
28401     user = mail
28402   }
28403 ...
28404 }
28405
28406 conf.d/10-auth.conf :-
28407
28408 auth_mechanisms = plain login ntlm
28409 .endd
28410
28411 .ecindex IIDdcotauth1
28412 .ecindex IIDdcotauth2
28413
28414
28415 . ////////////////////////////////////////////////////////////////////////////
28416 . ////////////////////////////////////////////////////////////////////////////
28417 .chapter "The gsasl authenticator" "CHAPgsasl"
28418 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28419 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28420 .cindex "authentication" "GNU SASL"
28421 .cindex "authentication" "SASL"
28422 .cindex "authentication" "EXTERNAL"
28423 .cindex "authentication" "ANONYMOUS"
28424 .cindex "authentication" "PLAIN"
28425 .cindex "authentication" "LOGIN"
28426 .cindex "authentication" "DIGEST-MD5"
28427 .cindex "authentication" "CRAM-MD5"
28428 .cindex "authentication" "SCRAM family"
28429 The &(gsasl)& authenticator provides integration for the GNU SASL
28430 library and the mechanisms it provides.  This is new as of the 4.80 release
28431 and there are a few areas where the library does not let Exim smoothly
28432 scale to handle future authentication mechanisms, so no guarantee can be
28433 made that any particular new authentication mechanism will be supported
28434 without code changes in Exim.
28435
28436 The library is expected to add support in an upcoming
28437 realease for the SCRAM-SHA-256 method.
28438 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28439 when this happens.
28440
28441 To see the list of mechanisms supported by the library run Exim with "auth" debug
28442 enabled and look for a line containing "GNU SASL supports".
28443 Note however that some may not have been tested from Exim.
28444
28445
28446 .option client_authz gsasl string&!! unset
28447 This option can be used to supply an &'authorization id'&
28448 which is different to the &'authentication_id'& provided
28449 by &%client_username%& option.
28450 If unset or (after expansion) empty it is not used,
28451 which is the common case.
28452
28453 .option client_channelbinding gsasl boolean false
28454 See &%server_channelbinding%& below.
28455
28456 .option client_password gsasl string&!! unset
28457 This option is exapanded before use, and should result in
28458 the password to be used, in clear.
28459
28460 .option client_username gsasl string&!! unset
28461 This option is exapanded before use, and should result in
28462 the account name to be used.
28463
28464
28465 .option client_spassword gsasl string&!! unset
28466 This option is only supported for library versions 1.9.1 and greater.
28467 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28468
28469 If a SCRAM mechanism is being used and this option is set
28470 and correctly sized
28471 it is used in preference to &%client_password%&.
28472 The value after expansion should be
28473 a 40 (for SHA-1) or 64 (for SHA-256) character string
28474 with the PBKDF2-prepared password, hex-encoded.
28475
28476 Note that this value will depend on the salt and iteration-count
28477 supplied by the server.
28478 The option is expanded before use.
28479 During the expansion &$auth1$& is set with the client username,
28480 &$auth2$& with the iteration count, and
28481 &$auth3$& with the salt.
28482
28483 The intent of this option
28484 is to support clients that can cache thes salted password
28485 to save on recalculation costs.
28486 The cache lookup should return an unusable value
28487 (eg. an empty string)
28488 if the salt or iteration count has changed
28489
28490 If the authentication succeeds then the above variables are set,
28491 .vindex "&$auth4$&"
28492 plus the calculated salted password value value in &$auth4$&,
28493 during the expansion of the &%client_set_id%& option.
28494 A side-effect of this expansion can be used to prime the cache.
28495
28496
28497 .option server_channelbinding gsasl boolean false
28498 Some authentication mechanisms are able to use external context at both ends
28499 of the session to bind the authentication to that context, and fail the
28500 authentication process if that context differs.  Specifically, some TLS
28501 ciphersuites can provide identifying information about the cryptographic
28502 context.
28503
28504 This should have meant that certificate identity and verification becomes a
28505 non-issue, as a man-in-the-middle attack will cause the correct client and
28506 server to see different identifiers and authentication will fail.
28507
28508 This is
28509 only usable by mechanisms which support "channel binding"; at time of
28510 writing, that's the SCRAM family.
28511 When using this feature the "-PLUS" variants of the method names need to be used.
28512
28513 This defaults off to ensure smooth upgrade across Exim releases, in case
28514 this option causes some clients to start failing.  Some future release
28515 of Exim might have switched the default to be true.
28516
28517 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28518 . Do not plan to rely upon this feature for security, ever, without consulting
28519 . with a subject matter expert (a cryptographic engineer).
28520
28521 This option was deprecated in previous releases due to doubts over
28522 the "Triple Handshake" vulnerability.
28523 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28524 Session Resumption was used) for safety.
28525
28526
28527 .option server_hostname gsasl string&!! "see below"
28528 This option selects the hostname that is used when communicating with the
28529 library. The default value is &`$primary_hostname`&.
28530 Some mechanisms will use this data.
28531
28532
28533 .option server_mech gsasl string "see below"
28534 This option selects the authentication mechanism this driver should use. The
28535 default is the value of the generic &%public_name%& option. This option allows
28536 you to use a different underlying mechanism from the advertised name. For
28537 example:
28538 .code
28539 sasl:
28540   driver = gsasl
28541   public_name = X-ANYTHING
28542   server_mech = CRAM-MD5
28543   server_set_id = $auth1
28544 .endd
28545
28546
28547 .option server_password gsasl string&!! unset
28548 Various mechanisms need access to the cleartext password on the server, so
28549 that proof-of-possession can be demonstrated on the wire, without sending
28550 the password itself.
28551
28552 The data available for lookup varies per mechanism.
28553 In all cases, &$auth1$& is set to the &'authentication id'&.
28554 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28555 if available, else the empty string.
28556 The &$auth3$& variable will always be the &'realm'& if available,
28557 else the empty string.
28558
28559 A forced failure will cause authentication to defer.
28560
28561 If using this option, it may make sense to set the &%server_condition%&
28562 option to be simply "true".
28563
28564
28565 .option server_realm gsasl string&!! unset
28566 This specifies the SASL realm that the server claims to be in.
28567 Some mechanisms will use this data.
28568
28569
28570 .option server_scram_iter gsasl string&!! 4096
28571 This option provides data for the SCRAM family of mechanisms.
28572 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28573 when this option is expanded.
28574
28575 The result of expansion should be a decimal number,
28576 and represents both a lower-bound on the security, and
28577 a compute cost factor imposed on the client
28578 (if it does not cache results, or the server changes
28579 either the iteration count or the salt).
28580 A minimum value of 4096 is required by the standards
28581 for all current SCRAM mechanism variants.
28582
28583 .option server_scram_salt gsasl string&!! unset
28584 This option provides data for the SCRAM family of mechanisms.
28585 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28586 when this option is expanded.
28587 The value should be a base64-encoded string,
28588 of random data typically 4-to-16 bytes long.
28589 If unset or empty after expansion the library will provides a value for the
28590 protocol conversation.
28591
28592
28593 .option server_key gsasl string&!! unset
28594 .option server_skey gsasl string&!! unset
28595 These options can be used for the SCRAM family of mechanisms
28596 to provide stored information related to a password,
28597 the storage of which is preferable to plaintext.
28598
28599 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28600 &%server_skey%& is StoredKey.
28601
28602 They are only available for version 1.9.0 (or later) of the gsasl library.
28603 When this is so, the macros
28604 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28605 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28606 will be defined.
28607
28608 The &$authN$& variables are available when these options are expanded.
28609
28610 If set, the results of expansion should for each
28611 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28612 of base64-coded data, and will be used in preference to the
28613 &%server_password%& option.
28614 If unset or not of the right length, &%server_password%& will be used.
28615
28616 The libgsasl library release includes a utility &'gsasl'& which can be used
28617 to generate these values.
28618
28619
28620 .option server_service gsasl string &`smtp`&
28621 This is the SASL service that the server claims to implement.
28622 Some mechanisms will use this data.
28623
28624
28625 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28626 .vindex "&$auth1$&, &$auth2$&, etc"
28627 These may be set when evaluating specific options, as detailed above.
28628 They will also be set when evaluating &%server_condition%&.
28629
28630 Unless otherwise stated below, the &(gsasl)& integration will use the following
28631 meanings for these variables:
28632
28633 .ilist
28634 .vindex "&$auth1$&"
28635 &$auth1$&: the &'authentication id'&
28636 .next
28637 .vindex "&$auth2$&"
28638 &$auth2$&: the &'authorization id'&
28639 .next
28640 .vindex "&$auth3$&"
28641 &$auth3$&: the &'realm'&
28642 .endlist
28643
28644 On a per-mechanism basis:
28645
28646 .ilist
28647 .cindex "authentication" "EXTERNAL"
28648 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28649 the &%server_condition%& option must be present.
28650 .next
28651 .cindex "authentication" "ANONYMOUS"
28652 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28653 the &%server_condition%& option must be present.
28654 .next
28655 .cindex "authentication" "GSSAPI"
28656 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28657 &$auth2$& will be set to the &'authorization id'&,
28658 the &%server_condition%& option must be present.
28659 .endlist
28660
28661 An &'anonymous token'& is something passed along as an unauthenticated
28662 identifier; this is analogous to FTP anonymous authentication passing an
28663 email address, or software-identifier@, as the "password".
28664
28665
28666 An example showing the password having the realm specified in the callback
28667 and demonstrating a Cyrus SASL to GSASL migration approach is:
28668 .code
28669 gsasl_cyrusless_crammd5:
28670   driver = gsasl
28671   public_name = CRAM-MD5
28672   server_realm = imap.example.org
28673   server_password = ${lookup{$auth1:$auth3:userPassword}\
28674                     dbmjz{/etc/sasldb2}{$value}fail}
28675   server_set_id = ${quote:$auth1}
28676   server_condition = yes
28677 .endd
28678
28679
28680 . ////////////////////////////////////////////////////////////////////////////
28681 . ////////////////////////////////////////////////////////////////////////////
28682
28683 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28684 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28685 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28686 .cindex "authentication" "GSSAPI"
28687 .cindex "authentication" "Kerberos"
28688 The &(heimdal_gssapi)& authenticator provides server integration for the
28689 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28690 reliably.
28691
28692 .option server_hostname heimdal_gssapi string&!! "see below"
28693 This option selects the hostname that is used, with &%server_service%&,
28694 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28695 identifier.  The default value is &`$primary_hostname`&.
28696
28697 .option server_keytab heimdal_gssapi string&!! unset
28698 If set, then Heimdal will not use the system default keytab (typically
28699 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28700 The value should be a pathname, with no &"file:"& prefix.
28701
28702 .option server_service heimdal_gssapi string&!! "smtp"
28703 This option specifies the service identifier used, in conjunction with
28704 &%server_hostname%&, for building the identifier for finding credentials
28705 from the keytab.
28706
28707
28708 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28709 Beware that these variables will typically include a realm, thus will appear
28710 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28711 not verified, so a malicious client can set it to anything.
28712
28713 The &$auth1$& field should be safely trustable as a value from the Key
28714 Distribution Center.  Note that these are not quite email addresses.
28715 Each identifier is for a role, and so the left-hand-side may include a
28716 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28717
28718 .vindex "&$auth1$&, &$auth2$&, etc"
28719 .ilist
28720 .vindex "&$auth1$&"
28721 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28722 .next
28723 .vindex "&$auth2$&"
28724 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28725 authentication.  If that was empty, this will also be set to the
28726 GSS Display Name.
28727 .endlist
28728
28729
28730 . ////////////////////////////////////////////////////////////////////////////
28731 . ////////////////////////////////////////////////////////////////////////////
28732
28733 .chapter "The spa authenticator" "CHAPspa"
28734 .scindex IIDspaauth1 "&(spa)& authenticator"
28735 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28736 .cindex "authentication" "Microsoft Secure Password"
28737 .cindex "authentication" "NTLM"
28738 .cindex "Microsoft Secure Password Authentication"
28739 .cindex "NTLM authentication"
28740 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28741 Password Authentication'& mechanism,
28742 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28743 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28744 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28745 server side was subsequently contributed by Tom Kistner. The mechanism works as
28746 follows:
28747
28748 .ilist
28749 After the AUTH command has been accepted, the client sends an SPA
28750 authentication request based on the user name and optional domain.
28751 .next
28752 The server sends back a challenge.
28753 .next
28754 The client builds a challenge response which makes use of the user's password
28755 and sends it to the server, which then accepts or rejects it.
28756 .endlist
28757
28758 Encryption is used to protect the password in transit.
28759
28760
28761
28762 .section "Using spa as a server" "SECID179"
28763 .cindex "options" "&(spa)& authenticator (server)"
28764 The &(spa)& authenticator has just one server option:
28765
28766 .option server_password spa string&!! unset
28767 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28768 This option is expanded, and the result must be the cleartext password for the
28769 authenticating user, whose name is at this point in &$auth1$&. For
28770 compatibility with previous releases of Exim, the user name is also placed in
28771 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28772 it can lead to confusion in string expansions that also use numeric variables
28773 for other things. For example:
28774 .code
28775 spa:
28776   driver = spa
28777   public_name = NTLM
28778   server_password = \
28779     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28780 .endd
28781 If the expansion is forced to fail, authentication fails. Any other expansion
28782 failure causes a temporary error code to be returned.
28783
28784
28785
28786
28787
28788 .section "Using spa as a client" "SECID180"
28789 .cindex "options" "&(spa)& authenticator (client)"
28790 The &(spa)& authenticator has the following client options:
28791
28792
28793
28794 .option client_domain spa string&!! unset
28795 This option specifies an optional domain for the authentication.
28796
28797
28798 .option client_password spa string&!! unset
28799 This option specifies the user's password, and must be set.
28800
28801
28802 .option client_username spa string&!! unset
28803 This option specifies the user name, and must be set. Here is an example of a
28804 configuration of this authenticator for use with the mail servers at
28805 &'msn.com'&:
28806 .code
28807 msn:
28808   driver = spa
28809   public_name = MSN
28810   client_username = msn/msn_username
28811   client_password = msn_plaintext_password
28812   client_domain = DOMAIN_OR_UNSET
28813 .endd
28814 .ecindex IIDspaauth1
28815 .ecindex IIDspaauth2
28816
28817
28818
28819
28820
28821 . ////////////////////////////////////////////////////////////////////////////
28822 . ////////////////////////////////////////////////////////////////////////////
28823
28824 .chapter "The external authenticator" "CHAPexternauth"
28825 .scindex IIDexternauth1 "&(external)& authenticator"
28826 .scindex IIDexternauth2 "authenticators" "&(external)&"
28827 .cindex "authentication" "Client Certificate"
28828 .cindex "authentication" "X509"
28829 .cindex "Certificate-based authentication"
28830 The &(external)& authenticator provides support for
28831 authentication based on non-SMTP information.
28832 The specification is in RFC 4422 Appendix A
28833 (&url(https://tools.ietf.org/html/rfc4422)).
28834 It is only a transport and negotiation mechanism;
28835 the process of authentication is entirely controlled
28836 by the server configuration.
28837
28838 The client presents an identity in-clear.
28839 It is probably wise for a server to only advertise,
28840 and for clients to only attempt,
28841 this authentication method on a secure (eg. under TLS) connection.
28842
28843 One possible use, compatible with the
28844 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28845 is for using X509 client certificates.
28846
28847 It thus overlaps in function with the TLS authenticator
28848 (see &<<CHAPtlsauth>>&)
28849 but is a full SMTP SASL authenticator
28850 rather than being implicit for TLS-connection carried
28851 client certificates only.
28852
28853 The examples and discussion in this chapter assume that
28854 client-certificate authentication is being done.
28855
28856 The client must present a certificate,
28857 for which it must have been requested via the
28858 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28859 (see &<<CHAPTLS>>&).
28860 For authentication to be effective the certificate should be
28861 verifiable against a trust-anchor certificate known to the server.
28862
28863 .section "External options" "SECTexternsoptions"
28864 .cindex "options" "&(external)& authenticator (server)"
28865 The &(external)& authenticator has two server options:
28866
28867 .option server_param2 external string&!! unset
28868 .option server_param3 external string&!! unset
28869 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28870 These options are expanded before the &%server_condition%& option
28871 and the result are placed in &$auth2$& and &$auth3$& resectively.
28872 If the expansion is forced to fail, authentication fails. Any other expansion
28873 failure causes a temporary error code to be returned.
28874
28875 They can be used to clarify the coding of a complex &%server_condition%&.
28876
28877 .section "Using external in a server" "SECTexternserver"
28878 .cindex "AUTH" "in &(external)& authenticator"
28879 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28880         "in &(external)& authenticator"
28881 .vindex "&$auth1$&, &$auth2$&, etc"
28882 .cindex "base64 encoding" "in &(external)& authenticator"
28883
28884 When running as a server, &(external)& performs the authentication test by
28885 expanding a string. The data sent by the client with the AUTH command, or in
28886 response to subsequent prompts, is base64 encoded, and so may contain any byte
28887 values when decoded. The decoded value is treated as
28888 an identity for authentication and
28889 placed in the expansion variable &$auth1$&.
28890
28891 For compatibility with previous releases of Exim, the value is also placed in
28892 the expansion variable &$1$&. However, the use of this
28893 variable for this purpose is now deprecated, as it can lead to confusion in
28894 string expansions that also use them for other things.
28895
28896 .vindex "&$authenticated_id$&"
28897 Once an identity has been received,
28898 &%server_condition%& is expanded. If the expansion is forced to fail,
28899 authentication fails. Any other expansion failure causes a temporary error code
28900 to be returned. If the result of a successful expansion is an empty string,
28901 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28902 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28903 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28904 For any other result, a temporary error code is returned, with the expanded
28905 string as the error text.
28906
28907 Example:
28908 .code
28909 ext_ccert_san_mail:
28910   driver =            external
28911   public_name =       EXTERNAL
28912
28913   server_advertise_condition = $tls_in_certificate_verified
28914   server_param2 =     ${certextract {subj_altname,mail,>:} \
28915                                     {$tls_in_peercert}}
28916   server_condition =  ${if forany {$auth2} \
28917                             {eq {$item}{$auth1}}}
28918   server_set_id =     $auth1
28919 .endd
28920 This accepts a client certificate that is verifiable against any
28921 of your configured trust-anchors
28922 (which usually means the full set of public CAs)
28923 and which has a mail-SAN matching the claimed identity sent by the client.
28924
28925 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28926 The account name is therefore guessable by an opponent.
28927 TLS 1.3 protects both server and client certificates, and is not vulnerable
28928 in this way.
28929
28930
28931 .section "Using external in a client" "SECTexternclient"
28932 .cindex "options" "&(external)& authenticator (client)"
28933 The &(external)& authenticator has one client option:
28934
28935 .option client_send external string&!! unset
28936 This option is expanded and sent with the AUTH command as the
28937 identity being asserted.
28938
28939 Example:
28940 .code
28941 ext_ccert:
28942   driver =      external
28943   public_name = EXTERNAL
28944
28945   client_condition = ${if !eq{$tls_out_cipher}{}}
28946   client_send = myaccount@smarthost.example.net
28947 .endd
28948
28949
28950 .ecindex IIDexternauth1
28951 .ecindex IIDexternauth2
28952
28953
28954
28955
28956
28957 . ////////////////////////////////////////////////////////////////////////////
28958 . ////////////////////////////////////////////////////////////////////////////
28959
28960 .chapter "The tls authenticator" "CHAPtlsauth"
28961 .scindex IIDtlsauth1 "&(tls)& authenticator"
28962 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28963 .cindex "authentication" "Client Certificate"
28964 .cindex "authentication" "X509"
28965 .cindex "Certificate-based authentication"
28966 The &(tls)& authenticator provides server support for
28967 authentication based on client certificates.
28968
28969 It is not an SMTP authentication mechanism and is not
28970 advertised by the server as part of the SMTP EHLO response.
28971 It is an Exim authenticator in the sense that it affects
28972 the protocol element of the log line, can be tested for
28973 by the &%authenticated%& ACL condition, and can set
28974 the &$authenticated_id$& variable.
28975
28976 The client must present a verifiable certificate,
28977 for which it must have been requested via the
28978 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28979 (see &<<CHAPTLS>>&).
28980
28981 If an authenticator of this type is configured it is
28982 run before any SMTP-level communication is done,
28983 and can authenticate the connection.
28984 If it does, SMTP authentication is not offered.
28985
28986 A maximum of one authenticator of this type may be present.
28987
28988
28989 .cindex "options" "&(tls)& authenticator (server)"
28990 The &(tls)& authenticator has three server options:
28991
28992 .option server_param1 tls string&!! unset
28993 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28994 This option is expanded after the TLS negotiation and
28995 the result is placed in &$auth1$&.
28996 If the expansion is forced to fail, authentication fails. Any other expansion
28997 failure causes a temporary error code to be returned.
28998
28999 .option server_param2 tls string&!! unset
29000 .option server_param3 tls string&!! unset
29001 As above, for &$auth2$& and &$auth3$&.
29002
29003 &%server_param1%& may also be spelled &%server_param%&.
29004
29005
29006 Example:
29007 .code
29008 tls:
29009   driver = tls
29010   server_param1 =     ${certextract {subj_altname,mail,>:} \
29011                                     {$tls_in_peercert}}
29012   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29013                                  {forany {$auth1} \
29014                             {!= {0} \
29015                                 {${lookup ldap{ldap:///\
29016                          mailname=${quote_ldap_dn:${lc:$item}},\
29017                          ou=users,LDAP_DC?mailid} {$value}{0} \
29018                        }    }  } }}}
29019   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29020 .endd
29021 This accepts a client certificate that is verifiable against any
29022 of your configured trust-anchors
29023 (which usually means the full set of public CAs)
29024 and which has a SAN with a good account name.
29025
29026 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29027 The account name is therefore guessable by an opponent.
29028 TLS 1.3 protects both server and client certificates, and is not vulnerable
29029 in this way.
29030 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29031
29032 . An alternative might use
29033 . .code
29034 .   server_param1 = ${sha256:$tls_in_peercert}
29035 . .endd
29036 . to require one of a set of specific certs that define a given account
29037 . (the verification is still required, but mostly irrelevant).
29038 . This would help for per-device use.
29039 .
29040 . However, for the future we really need support for checking a
29041 . user cert in LDAP - which probably wants a base-64 DER.
29042
29043 .ecindex IIDtlsauth1
29044 .ecindex IIDtlsauth2
29045
29046
29047 Note that because authentication is traditionally an SMTP operation,
29048 the &%authenticated%& ACL condition cannot be used in
29049 a connect- or helo-ACL.
29050
29051
29052
29053 . ////////////////////////////////////////////////////////////////////////////
29054 . ////////////////////////////////////////////////////////////////////////////
29055
29056 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29057          "Encrypted SMTP connections"
29058 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29059 .scindex IIDencsmtp2 "SMTP" "encryption"
29060 .cindex "TLS" "on SMTP connection"
29061 .cindex "OpenSSL"
29062 .cindex "GnuTLS"
29063 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29064 Sockets Layer), is implemented by making use of the OpenSSL library or the
29065 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29066 cryptographic code in the Exim distribution itself for implementing TLS. In
29067 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29068 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29069 You also need to understand the basic concepts of encryption at a managerial
29070 level, and in particular, the way that public keys, private keys, and
29071 certificates are used.
29072
29073 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29074 connection is established, the client issues a STARTTLS command. If the
29075 server accepts this, the client and the server negotiate an encryption
29076 mechanism. If the negotiation succeeds, the data that subsequently passes
29077 between them is encrypted.
29078
29079 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29080 and if so, what cipher suite is in use, whether the client supplied a
29081 certificate, and whether or not that certificate was verified. This makes it
29082 possible for an Exim server to deny or accept certain commands based on the
29083 encryption state.
29084
29085 &*Warning*&: Certain types of firewall and certain anti-virus products can
29086 disrupt TLS connections. You need to turn off SMTP scanning for these products
29087 in order to get TLS to work.
29088
29089
29090
29091 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29092          "SECID284"
29093 .cindex "submissions protocol"
29094 .cindex "ssmtp protocol"
29095 .cindex "smtps protocol"
29096 .cindex "SMTP" "submissions protocol"
29097 .cindex "SMTP" "ssmtp protocol"
29098 .cindex "SMTP" "smtps protocol"
29099 The history of port numbers for TLS in SMTP is a little messy and has been
29100 contentious.  As of RFC 8314, the common practice of using the historically
29101 allocated port 465 for "email submission but with TLS immediately upon connect
29102 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29103 by them in preference to STARTTLS.
29104
29105 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29106 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29107 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29108
29109 This approach was, for a while, officially abandoned when encrypted SMTP was
29110 standardized, but many clients kept using it, even as the TCP port number was
29111 reassigned for other use.
29112 Thus you may encounter guidance claiming that you shouldn't enable use of
29113 this port.
29114 In practice, a number of mail-clients have only ever supported submissions,
29115 not submission with STARTTLS upgrade.
29116 Ideally, offer both submission (587) and submissions (465) service.
29117
29118 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29119 global option. Its value must be a list of port numbers;
29120 the most common use is expected to be:
29121 .code
29122 tls_on_connect_ports = 465
29123 .endd
29124 The port numbers specified by this option apply to all SMTP connections, both
29125 via the daemon and via &'inetd'&. You still need to specify all the ports that
29126 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29127 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29128 an extra port &-- rather, it specifies different behaviour on a port that is
29129 defined elsewhere.
29130
29131 There is also a &%-tls-on-connect%& command line option. This overrides
29132 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29133
29134
29135
29136
29137
29138
29139 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29140 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29141 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29142 To build Exim to use OpenSSL you need to set
29143 .code
29144 USE_OPENSSL=yes
29145 .endd
29146 in Local/Makefile.
29147
29148 To build Exim to use GnuTLS, you need to set
29149 .code
29150 USE_GNUTLS=yes
29151 .endd
29152 in Local/Makefile.
29153
29154 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29155 include files and libraries for GnuTLS can be found.
29156
29157 There are some differences in usage when using GnuTLS instead of OpenSSL:
29158
29159 .ilist
29160 The &%tls_verify_certificates%& option
29161 cannot be the path of a directory
29162 for GnuTLS versions before 3.3.6
29163 (for later versions, or OpenSSL, it can be either).
29164 .next
29165 The default value for &%tls_dhparam%& differs for historical reasons.
29166 .next
29167 .vindex "&$tls_in_peerdn$&"
29168 .vindex "&$tls_out_peerdn$&"
29169 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29170 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29171 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29172 .next
29173 OpenSSL identifies cipher suites using hyphens as separators, for example:
29174 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29175 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29176 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29177 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29178 to handle its own older variants) when processing lists of cipher suites in the
29179 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29180 option).
29181 .next
29182 The &%tls_require_ciphers%& options operate differently, as described in the
29183 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29184 .next
29185 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29186 When using OpenSSL, this option is ignored.
29187 (If an API is found to let OpenSSL be configured in this way,
29188 let the Exim Maintainers know and we'll likely use it).
29189 .next
29190 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29191 main option, it must be ordered to match the &%tls_certificate%& list.
29192 .next
29193 Some other recently added features may only be available in one or the other.
29194 This should be documented with the feature.  If the documentation does not
29195 explicitly state that the feature is infeasible in the other TLS
29196 implementation, then patches are welcome.
29197 .next
29198 The output from "exim -bV" will show which (if any) support was included
29199 in the build.
29200 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29201 .endlist
29202
29203
29204 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29205 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29206 an explicit path; if the latter, then the text about generation still applies,
29207 but not the chosen filename.
29208 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29209 See the documentation of &%tls_dhparam%& for more information.
29210
29211 GnuTLS uses D-H parameters that may take a substantial amount of time
29212 to compute. It is unreasonable to re-compute them for every TLS session.
29213 Therefore, Exim keeps this data in a file in its spool directory, called
29214 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29215 of bits requested.
29216 The file is owned by the Exim user and is readable only by
29217 its owner. Every Exim process that start up GnuTLS reads the D-H
29218 parameters from this file. If the file does not exist, the first Exim process
29219 that needs it computes the data and writes it to a temporary file which is
29220 renamed once it is complete. It does not matter if several Exim processes do
29221 this simultaneously (apart from wasting a few resources). Once a file is in
29222 place, new Exim processes immediately start using it.
29223
29224 For maximum security, the parameters that are stored in this file should be
29225 recalculated periodically, the frequency depending on your paranoia level.
29226 If you are avoiding using the fixed D-H primes published in RFCs, then you
29227 are concerned about some advanced attacks and will wish to do this; if you do
29228 not regenerate then you might as well stick to the standard primes.
29229
29230 Arranging this is easy in principle; just delete the file when you want new
29231 values to be computed. However, there may be a problem. The calculation of new
29232 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29233 If the system is not very active, &_/dev/random_& may delay returning data
29234 until enough randomness (entropy) is available. This may cause Exim to hang for
29235 a substantial amount of time, causing timeouts on incoming connections.
29236
29237 The solution is to generate the parameters externally to Exim. They are stored
29238 in &_gnutls-params-N_& in PEM format, which means that they can be
29239 generated externally using the &(certtool)& command that is part of GnuTLS.
29240
29241 To replace the parameters with new ones, instead of deleting the file
29242 and letting Exim re-create it, you can generate new parameters using
29243 &(certtool)& and, when this has been done, replace Exim's cache file by
29244 renaming. The relevant commands are something like this:
29245 .code
29246 # ls
29247 [ look for file; assume gnutls-params-2236 is the most recent ]
29248 # rm -f new-params
29249 # touch new-params
29250 # chown exim:exim new-params
29251 # chmod 0600 new-params
29252 # certtool --generate-dh-params --bits 2236 >>new-params
29253 # openssl dhparam -noout -text -in new-params | head
29254 [ check the first line, make sure it's not more than 2236;
29255   if it is, then go back to the start ("rm") and repeat
29256   until the size generated is at most the size requested ]
29257 # chmod 0400 new-params
29258 # mv new-params gnutls-params-2236
29259 .endd
29260 If Exim never has to generate the parameters itself, the possibility of
29261 stalling is removed.
29262
29263 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29264 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29265 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29266 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29267 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29268 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29269 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29270 which applies to all D-H usage, client or server.  If the value returned by
29271 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29272 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29273 limit, which is still much higher than Exim historically used.
29274
29275 The filename and bits used will change as the GnuTLS maintainers change the
29276 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29277 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29278 2432 bits, while NSS is limited to 2236 bits.
29279
29280 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29281 increase the chance of the generated prime actually being within acceptable
29282 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29283 procedure above.  There is no sane procedure available to Exim to double-check
29284 the size of the generated prime, so it might still be too large.
29285
29286
29287 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29288 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29289 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29290 There is a function in the OpenSSL library that can be passed a list of cipher
29291 suites before the cipher negotiation takes place. This specifies which ciphers
29292 are acceptable for TLS versions prior to 1.3.
29293 The list is colon separated and may contain names like
29294 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29295 directly to this function call.
29296 Many systems will install the OpenSSL manual-pages, so you may have
29297 &'ciphers(1)'& available to you.
29298 The following quotation from the OpenSSL
29299 documentation specifies what forms of item are allowed in the cipher string:
29300
29301 .ilist
29302 It can consist of a single cipher suite such as RC4-SHA.
29303 .next
29304 It can represent a list of cipher suites containing a certain algorithm,
29305 or cipher suites of a certain type. For example SHA1 represents all
29306 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29307 SSL v3 algorithms.
29308 .next
29309 Lists of cipher suites can be combined in a single cipher string using
29310 the + character. This is used as a logical and operation. For example
29311 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29312 algorithms.
29313 .endlist
29314
29315 Each cipher string can be optionally preceded by one of the characters &`!`&,
29316 &`-`& or &`+`&.
29317 .ilist
29318 If &`!`& is used, the ciphers are permanently deleted from the list. The
29319 ciphers deleted can never reappear in the list even if they are explicitly
29320 stated.
29321 .next
29322 If &`-`& is used, the ciphers are deleted from the list, but some or all
29323 of the ciphers can be added again by later options.
29324 .next
29325 If &`+`& is used, the ciphers are moved to the end of the list. This
29326 option does not add any new ciphers; it just moves matching existing ones.
29327 .endlist
29328
29329 If none of these characters is present, the string is interpreted as
29330 a list of ciphers to be appended to the current preference list. If the list
29331 includes any ciphers already present they will be ignored: that is, they will
29332 not be moved to the end of the list.
29333 .endlist
29334
29335 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29336 string:
29337 .code
29338 # note single-quotes to get ! past any shell history expansion
29339 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29340 .endd
29341
29342 This example will let the library defaults be permitted on the MX port, where
29343 there's probably no identity verification anyway, but ups the ante on the
29344 submission ports where the administrator might have some influence on the
29345 choice of clients used:
29346 .code
29347 # OpenSSL variant; see man ciphers(1)
29348 tls_require_ciphers = ${if =={$received_port}{25}\
29349                            {DEFAULT}\
29350                            {HIGH:!MD5:!SHA1}}
29351 .endd
29352
29353 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29354 .code
29355 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29356 .endd
29357
29358 For TLS version 1.3 the control available is less fine-grained
29359 and Exim does not provide access to it at present.
29360 The value of the &%tls_require_ciphers%& option is ignored when
29361 TLS version 1.3 is negotiated.
29362
29363 As of writing the library default cipher suite list for TLSv1.3 is
29364 .code
29365 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29366 .endd
29367
29368
29369 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29370          "SECTreqciphgnu"
29371 .cindex "GnuTLS" "specifying parameters for"
29372 .cindex "TLS" "specifying ciphers (GnuTLS)"
29373 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29374 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29375 .cindex "TLS" "specifying protocols (GnuTLS)"
29376 .cindex "TLS" "specifying priority string (GnuTLS)"
29377 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29378 The GnuTLS library allows the caller to provide a "priority string", documented
29379 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29380 ciphersuite specification in OpenSSL.
29381
29382 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29383 and controls both protocols and ciphers.
29384
29385 The &%tls_require_ciphers%& option is available both as an global option,
29386 controlling how Exim behaves as a server, and also as an option of the
29387 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29388 the value is string expanded.  The resulting string is not an Exim list and
29389 the string is given to the GnuTLS library, so that Exim does not need to be
29390 aware of future feature enhancements of GnuTLS.
29391
29392 Documentation of the strings accepted may be found in the GnuTLS manual, under
29393 "Priority strings".  This is online as
29394 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29395 but beware that this relates to GnuTLS 3, which may be newer than the version
29396 installed on your system.  If you are using GnuTLS 3,
29397 then the example code
29398 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29399 on that site can be used to test a given string.
29400
29401 For example:
29402 .code
29403 # Disable older versions of protocols
29404 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29405 .endd
29406
29407 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29408 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29409 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29410
29411 This example will let the library defaults be permitted on the MX port, where
29412 there's probably no identity verification anyway, and lowers security further
29413 by increasing compatibility; but this ups the ante on the submission ports
29414 where the administrator might have some influence on the choice of clients
29415 used:
29416 .code
29417 # GnuTLS variant
29418 tls_require_ciphers = ${if =={$received_port}{25}\
29419                            {NORMAL:%COMPAT}\
29420                            {SECURE128}}
29421 .endd
29422
29423
29424 .section "Configuring an Exim server to use TLS" "SECID182"
29425 .cindex "TLS" "configuring an Exim server"
29426 .cindex "ESMTP extensions" STARTTLS
29427 When Exim has been built with TLS support, it advertises the availability of
29428 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29429 but not to any others. The default value of this option is *, which means
29430 that STARTTLS is always advertised.  Set it to blank to never advertise;
29431 this is reasonable for systems that want to use TLS only as a client.
29432
29433 If STARTTLS is to be used you
29434 need to set some other options in order to make TLS available.
29435
29436 If a client issues a STARTTLS command and there is some configuration
29437 problem in the server, the command is rejected with a 454 error. If the client
29438 persists in trying to issue SMTP commands, all except QUIT are rejected
29439 with the error
29440 .code
29441 554 Security failure
29442 .endd
29443 If a STARTTLS command is issued within an existing TLS session, it is
29444 rejected with a 554 error code.
29445
29446 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29447 must be set to match some hosts. The default is * which matches all hosts.
29448
29449 If this is all you do, TLS encryption will be enabled but not authentication -
29450 meaning that the peer has no assurance it is actually you he is talking to.
29451 You gain protection from a passive sniffer listening on the wire but not
29452 from someone able to intercept the communication.
29453
29454 Further protection requires some further configuration at the server end.
29455
29456 To make TLS work you need to set, in the server,
29457 .code
29458 tls_certificate = /some/file/name
29459 tls_privatekey = /some/file/name
29460 .endd
29461 These options are, in fact, expanded strings, so you can make them depend on
29462 the identity of the client that is connected if you wish. The first file
29463 contains the server's X509 certificate, and the second contains the private key
29464 that goes with it. These files need to be
29465 PEM format and readable by the Exim user, and must
29466 always be given as full path names.
29467 The key must not be password-protected.
29468 They can be the same file if both the
29469 certificate and the key are contained within it. If &%tls_privatekey%& is not
29470 set, or if its expansion is forced to fail or results in an empty string, this
29471 is assumed to be the case. The certificate file may also contain intermediate
29472 certificates that need to be sent to the client to enable it to authenticate
29473 the server's certificate.
29474
29475 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29476 colon-separated lists of file paths.  Ciphers using given authentication
29477 algorithms require the presence of a suitable certificate to supply the
29478 public-key.  The server selects among the certificates to present to the
29479 client depending on the selected cipher, hence the priority ordering for
29480 ciphers will affect which certificate is used.
29481
29482 If you do not understand about certificates and keys, please try to find a
29483 source of this background information, which is not Exim-specific. (There are a
29484 few comments below in section &<<SECTcerandall>>&.)
29485
29486 &*Note*&: These options do not apply when Exim is operating as a client &--
29487 they apply only in the case of a server. If you need to use a certificate in an
29488 Exim client, you must set the options of the same names in an &(smtp)&
29489 transport.
29490
29491 With just these options, an Exim server will be able to use TLS. It does not
29492 require the client to have a certificate (but see below for how to insist on
29493 this). There is one other option that may be needed in other situations. If
29494 .code
29495 tls_dhparam = /some/file/name
29496 .endd
29497 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29498 with the parameters contained in the file.
29499 Set this to &`none`& to disable use of DH entirely, by making no prime
29500 available:
29501 .code
29502 tls_dhparam = none
29503 .endd
29504 This may also be set to a string identifying a standard prime to be used for
29505 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29506 used is &`ike23`&.  There are a few standard primes available, see the
29507 documentation for &%tls_dhparam%& for the complete list.
29508
29509 See the command
29510 .code
29511 openssl dhparam
29512 .endd
29513 for a way of generating file data.
29514
29515 The strings supplied for these three options are expanded every time a client
29516 host connects. It is therefore possible to use different certificates and keys
29517 for different hosts, if you so wish, by making use of the client's IP address
29518 in &$sender_host_address$& to control the expansion. If a string expansion is
29519 forced to fail, Exim behaves as if the option is not set.
29520
29521 .cindex "cipher" "logging"
29522 .cindex "log" "TLS cipher"
29523 .vindex "&$tls_in_cipher$&"
29524 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29525 an incoming TLS connection. It is included in the &'Received:'& header of an
29526 incoming message (by default &-- you can, of course, change this), and it is
29527 also included in the log line that records a message's arrival, keyed by
29528 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29529 condition can be used to test for specific cipher suites in ACLs.
29530
29531 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29532 can check the name of the cipher suite and vary their actions accordingly. The
29533 cipher suite names vary, depending on which TLS library is being used. For
29534 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29535 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29536 documentation for more details.
29537
29538 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29539 (again depending on the &%tls_cipher%& log selector).
29540
29541
29542 .subsection "Requesting and verifying client certificates"
29543 .cindex "certificate" "verification of client"
29544 .cindex "TLS" "client certificate verification"
29545 If you want an Exim server to request a certificate when negotiating a TLS
29546 session with a client, you must set either &%tls_verify_hosts%& or
29547 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29548 apply to all TLS connections. For any host that matches one of these options,
29549 Exim requests a certificate as part of the setup of the TLS session. The
29550 contents of the certificate are verified by comparing it with a list of
29551 expected trust-anchors or certificates.
29552 These may be the system default set (depending on library version),
29553 an explicit file or,
29554 depending on library version, a directory, identified by
29555 &%tls_verify_certificates%&.
29556
29557 A file can contain multiple certificates, concatenated end to end. If a
29558 directory is used
29559 (OpenSSL only),
29560 each certificate must be in a separate file, with a name (or a symbolic link)
29561 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29562 certificate. You can compute the relevant hash by running the command
29563 .code
29564 openssl x509 -hash -noout -in /cert/file
29565 .endd
29566 where &_/cert/file_& contains a single certificate.
29567
29568 There is no checking of names of the client against the certificate
29569 Subject Name or Subject Alternate Names.
29570
29571 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29572 what happens if the client does not supply a certificate, or if the certificate
29573 does not match any of the certificates in the collection named by
29574 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29575 attempt to set up a TLS session is aborted, and the incoming connection is
29576 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29577 session continues. ACLs that run for subsequent SMTP commands can detect the
29578 fact that no certificate was verified, and vary their actions accordingly. For
29579 example, you can insist on a certificate before accepting a message for
29580 relaying, but not when the message is destined for local delivery.
29581
29582 .vindex "&$tls_in_peerdn$&"
29583 When a client supplies a certificate (whether it verifies or not), the value of
29584 the Distinguished Name of the certificate is made available in the variable
29585 &$tls_in_peerdn$& during subsequent processing of the message.
29586
29587 .cindex "log" "distinguished name"
29588 Because it is often a long text string, it is not included in the log line or
29589 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29590 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29591 &%received_header_text%& to change the &'Received:'& header. When no
29592 certificate is supplied, &$tls_in_peerdn$& is empty.
29593
29594
29595 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29596 .cindex certificate caching
29597 .cindex privatekey caching
29598 .cindex crl caching
29599 .cindex ocsp caching
29600 .cindex ciphers caching
29601 .cindex "CA bundle" caching
29602 .cindex "certificate authorities" caching
29603 .cindex tls_certificate caching
29604 .cindex tls_privatekey caching
29605 .cindex tls_crl caching
29606 .cindex tls_ocsp_file caching
29607 .cindex tls_require_ciphers caching
29608 .cindex tls_verify_certificate caching
29609 .cindex caching certificate
29610 .cindex caching privatekey
29611 .cindex caching crl
29612 .cindex caching ocsp
29613 .cindex caching ciphers
29614 .cindex caching "certificate authorities
29615 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29616 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29617 expandable elements,
29618 then the associated information is loaded at daemon startup.
29619 It is made available
29620 to child processes forked for handling received SMTP connections.
29621
29622 This caching is currently only supported under Linux and FreeBSD.
29623
29624 If caching is not possible, for example if an item has to be dependent
29625 on the peer host so contains a &$sender_host_name$& expansion, the load
29626 of the associated information is done at the startup of the TLS connection.
29627
29628 The cache is invalidated and reloaded after any changes to the directories
29629 containing files specified by these options.
29630
29631 The information specified by the main option &%tls_verify_certificates%&
29632 is similarly cached so long as it specifies files explicitly
29633 or (under GnuTLS) is the string &"system,cache"&.
29634 The latter case is not automatically invalidated;
29635 it is the operator's responsibility to arrange for a daemon restart
29636 any time the system certificate authority bundle is updated.
29637 A HUP signal is sufficient for this.
29638 The value &"system"& results in no caching under GnuTLS.
29639
29640 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29641 is acceptable in configurations for the Exim executavble.
29642
29643 Caching of the system Certificate Authorities bundle can
29644 save siginificant time and processing on every TLS connection
29645 accepted by Exim.
29646
29647
29648
29649
29650 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29651 .cindex "cipher" "logging"
29652 .cindex "log" "TLS cipher"
29653 .cindex "log" "distinguished name"
29654 .cindex "TLS" "configuring an Exim client"
29655 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29656 deliveries as well as to incoming, the latter one causing logging of the
29657 server certificate's DN. The remaining client configuration for TLS is all
29658 within the &(smtp)& transport.
29659
29660 .cindex "ESMTP extensions" STARTTLS
29661 It is not necessary to set any options to have TLS work in the &(smtp)&
29662 transport. If Exim is built with TLS support, and TLS is advertised by a
29663 server, the &(smtp)& transport always tries to start a TLS session. However,
29664 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29665 transport) to a list of server hosts for which TLS should not be used.
29666
29667 If you do not want Exim to attempt to send messages unencrypted when an attempt
29668 to set up an encrypted connection fails in any way, you can set
29669 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29670 those hosts, delivery is always deferred if an encrypted connection cannot be
29671 set up. If there are any other hosts for the address, they are tried in the
29672 usual way.
29673
29674 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29675 the message unencrypted. It always does this if the response to STARTTLS is
29676 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29677 session after a success response code, what happens is controlled by the
29678 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29679 delivery to this host is deferred, and other hosts (if available) are tried. If
29680 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29681 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29682 negotiation fails, Exim closes the current connection (because it is in an
29683 unknown state), opens a new one to the same host, and then tries the delivery
29684 unencrypted.
29685
29686 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29687 transport provide the client with a certificate, which is passed to the server
29688 if it requests it.
29689 This is an optional thing for TLS connections, although either end
29690 may insist on it.
29691 If the server is Exim, it will request a certificate only if
29692 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29693
29694 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29695 for client use (they are usable for server use).
29696 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29697 in failed connections.
29698
29699 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29700 specifies a collection of expected server certificates.
29701 These may be
29702 the system default set (depending on library version),
29703 a file,
29704 or (depending on library version) a directory.
29705 The client verifies the server's certificate
29706 against this collection, taking into account any revoked certificates that are
29707 in the list defined by &%tls_crl%&.
29708 Failure to verify fails the TLS connection unless either of the
29709 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29710
29711 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29712 certificate verification to the listed servers.  Verification either must
29713 or need not succeed respectively.
29714
29715 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29716 name checks are made on the server certificate.
29717 The match against this list is, as per other Exim usage, the
29718 IP for the host.  That is most closely associated with the
29719 name on the DNS A (or AAAA) record for the host.
29720 However, the name that needs to be in the certificate
29721 is the one at the head of any CNAME chain leading to the A record.
29722 The option defaults to always checking.
29723
29724 The &(smtp)& transport has two OCSP-related options:
29725 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29726 is requested and required for the connection to proceed.  The default
29727 value is empty.
29728 &%hosts_request_ocsp%&; a host-list for which (additionally)
29729 a Certificate Status is requested (but not necessarily verified).  The default
29730 value is "*" meaning that requests are made unless configured
29731 otherwise.
29732
29733 The host(s) should also be in &%hosts_require_tls%&, and
29734 &%tls_verify_certificates%& configured for the transport,
29735 for OCSP to be relevant.
29736
29737 If
29738 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29739 list of permitted cipher suites. If either of these checks fails, delivery to
29740 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29741 alternative hosts, if any.
29742
29743  &*Note*&:
29744 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29745 is operating as a client. Exim does not assume that a server certificate (set
29746 by the global options of the same name) should also be used when operating as a
29747 client.
29748
29749 .vindex "&$host$&"
29750 .vindex "&$host_address$&"
29751 All the TLS options in the &(smtp)& transport are expanded before use, with
29752 &$host$& and &$host_address$& containing the name and address of the server to
29753 which the client is connected. Forced failure of an expansion causes Exim to
29754 behave as if the relevant option were unset.
29755
29756 .vindex &$tls_out_bits$&
29757 .vindex &$tls_out_cipher$&
29758 .vindex &$tls_out_peerdn$&
29759 .vindex &$tls_out_sni$&
29760 Before an SMTP connection is established, the
29761 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29762 variables are emptied. (Until the first connection, they contain the values
29763 that were set when the message was received.) If STARTTLS is subsequently
29764 successfully obeyed, these variables are set to the relevant values for the
29765 outgoing connection.
29766
29767
29768
29769 .subsection "Caching of static client configuration items" SECTclientTLScache
29770 .cindex certificate caching
29771 .cindex privatekey caching
29772 .cindex crl caching
29773 .cindex ciphers caching
29774 .cindex "CA bundle" caching
29775 .cindex "certificate authorities" caching
29776 .cindex tls_certificate caching
29777 .cindex tls_privatekey caching
29778 .cindex tls_crl caching
29779 .cindex tls_require_ciphers caching
29780 .cindex tls_verify_certificate caching
29781 .cindex caching certificate
29782 .cindex caching privatekey
29783 .cindex caching crl
29784 .cindex caching ciphers
29785 .cindex caching "certificate authorities
29786 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29787 and &%tls_crl%& have values with no
29788 expandable elements,
29789 then the associated information is loaded per smtp transport
29790 at daemon startup, at the start of a queue run, or on a
29791 command-line specified message delivery.
29792 It is made available
29793 to child processes forked for handling making SMTP connections.
29794
29795 This caching is currently only supported under Linux.
29796
29797 If caching is not possible, the load
29798 of the associated information is done at the startup of the TLS connection.
29799
29800 The cache is invalidated in the daemon
29801 and reloaded after any changes to the directories
29802 containing files specified by these options.
29803
29804 The information specified by the main option &%tls_verify_certificates%&
29805 is similarly cached so long as it specifies files explicitly
29806 or (under GnuTLS) is the string &"system,cache"&.
29807 The latter case is not automatically invaludated;
29808 it is the operator's responsibility to arrange for a daemon restart
29809 any time the system certificate authority bundle is updated.
29810 A HUP signal is sufficient for this.
29811 The value &"system"& results in no caching under GnuTLS.
29812
29813 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29814 is acceptable in configurations for the Exim executavble.
29815
29816 Caching of the system Certificate Authorities bundle can
29817 save siginificant time and processing on every TLS connection
29818 initiated by Exim.
29819
29820
29821
29822
29823 .section "Use of TLS Server Name Indication" "SECTtlssni"
29824 .cindex "TLS" "Server Name Indication"
29825 .cindex "TLS" SNI
29826 .cindex SNI
29827 .vindex "&$tls_in_sni$&"
29828 .oindex "&%tls_in_sni%&"
29829 With TLS1.0 or above, there is an extension mechanism by which extra
29830 information can be included at various points in the protocol.  One of these
29831 extensions, documented in RFC 6066 (and before that RFC 4366) is
29832 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29833 client in the initial handshake, so that the server can examine the servername
29834 within and possibly choose to use different certificates and keys (and more)
29835 for this session.
29836
29837 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29838 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29839 address.
29840
29841 With SMTP to MX, there are the same problems here as in choosing the identity
29842 against which to validate a certificate: you can't rely on insecure DNS to
29843 provide the identity which you then cryptographically verify.  So this will
29844 be of limited use in that environment.
29845
29846 With SMTP to Submission, there is a well-defined hostname which clients are
29847 connecting to and can validate certificates against.  Thus clients &*can*&
29848 choose to include this information in the TLS negotiation.  If this becomes
29849 wide-spread, then hosters can choose to present different certificates to
29850 different clients.  Or even negotiate different cipher suites.
29851
29852 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29853 if not empty, will be sent on a TLS session as part of the handshake.  There's
29854 nothing more to it.  Choosing a sensible value not derived insecurely is the
29855 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29856 for the lifetime of the client connection (including during authentication).
29857
29858 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29859 is forced to the name of the destination host, after any MX- or CNAME-following.
29860
29861 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29862 received from a client.
29863 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29864
29865 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29866 option (prior to expansion) then the following options will be re-expanded
29867 during TLS session handshake, to permit alternative values to be chosen:
29868
29869 .ilist
29870 &%tls_certificate%&
29871 .next
29872 &%tls_crl%&
29873 .next
29874 &%tls_privatekey%&
29875 .next
29876 &%tls_verify_certificates%&
29877 .next
29878 &%tls_ocsp_file%&
29879 .endlist
29880
29881 Great care should be taken to deal with matters of case, various injection
29882 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29883 can always be referenced; it is important to remember that &$tls_in_sni$& is
29884 arbitrary unverified data provided prior to authentication.
29885 Further, the initial certificate is loaded before SNI has arrived, so
29886 an expansion for &%tls_certificate%& must have a default which is used
29887 when &$tls_in_sni$& is empty.
29888
29889 The Exim developers are proceeding cautiously and so far no other TLS options
29890 are re-expanded.
29891
29892 When Exim is built against OpenSSL, OpenSSL must have been built with support
29893 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29894 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29895 see &`-servername`& in the output, then OpenSSL has support.
29896
29897 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29898 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29899 built, then you have SNI support).
29900
29901 .subsection ALPN
29902 .cindex TLS ALPN
29903 .cindex ALPN "general information"
29904 .cindex TLS "Application Layer Protocol Names"
29905 There is a TLS feature related to SNI
29906 called Application Layer Protocol Name (ALPN).
29907 This is intended to declare, or select, what protocol layer will be using a TLS
29908 connection.
29909 The client for the connection proposes a set of protocol names, and
29910 the server responds with a selected one.
29911 It is not, as of 2021, commonly used for SMTP connections.
29912 However, to guard against misdirected or malicious use of web clients
29913 (which often do use ALPN) against MTA ports, Exim by default check that
29914 there is no incompatible ALPN specified by a client for a TLS connection.
29915 If there is, the connection is rejected.
29916
29917 As a client Exim does not supply ALPN by default.
29918 The behaviour of both client and server can be configured using the options
29919 &%tls_alpn%& and &%hosts_require_alpn%&.
29920 There are no variables providing observability.
29921 Some feature-specific logging may appear on denied connections, but this
29922 depends on the behaviour of the peer
29923 (not all peers can send a feature-specific TLS Alert).
29924
29925 This feature is available when Exim is built with
29926 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29927 the macro _HAVE_TLS_ALPN will be defined when this is so.
29928
29929
29930
29931 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29932          "SECTmulmessam"
29933 .cindex "multiple SMTP deliveries with TLS"
29934 .cindex "TLS" "multiple message deliveries"
29935 Exim sends multiple messages down the same TCP/IP connection by starting up
29936 an entirely new delivery process for each message, passing the socket from
29937 one process to the next. This implementation does not fit well with the use
29938 of TLS, because there is quite a lot of state information associated with a TLS
29939 connection, not just a socket identification. Passing all the state information
29940 to a new process is not feasible. Consequently, for sending using TLS Exim
29941 starts an additional proxy process for handling the encryption, piping the
29942 unencrypted data stream from and to the delivery processes.
29943
29944 An older mode of operation can be enabled on a per-host basis by the
29945 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29946 this list the proxy process described above is not used; instead Exim
29947 shuts down an existing TLS session being run by the delivery process
29948 before passing the socket to a new process. The new process may then
29949 try to start a new TLS session, and if successful, may try to re-authenticate
29950 if AUTH is in use, before sending the next message.
29951
29952 The RFC is not clear as to whether or not an SMTP session continues in clear
29953 after TLS has been shut down, or whether TLS may be restarted again later, as
29954 just described. However, if the server is Exim, this shutdown and
29955 reinitialization works. It is not known which (if any) other servers operate
29956 successfully if the client closes a TLS session and continues with unencrypted
29957 SMTP, but there are certainly some that do not work. For such servers, Exim
29958 should not pass the socket to another process, because the failure of the
29959 subsequent attempt to use it would cause Exim to record a temporary host error,
29960 and delay other deliveries to that host.
29961
29962 To test for this case, Exim sends an EHLO command to the server after
29963 closing down the TLS session. If this fails in any way, the connection is
29964 closed instead of being passed to a new delivery process, but no retry
29965 information is recorded.
29966
29967 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29968 &(smtp)& transport to match those hosts for which Exim should not pass
29969 connections to new processes if TLS has been used.
29970
29971
29972
29973
29974 .section "Certificates and all that" "SECTcerandall"
29975 .cindex "certificate" "references to discussion"
29976 In order to understand fully how TLS works, you need to know about
29977 certificates, certificate signing, and certificate authorities.
29978 This is a large topic and an introductory guide is unsuitable for the Exim
29979 reference manual, so instead we provide pointers to existing documentation.
29980
29981 The Apache web-server was for a long time the canonical guide, so their
29982 documentation is a good place to start; their SSL module's Introduction
29983 document is currently at
29984 .display
29985 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29986 .endd
29987 and their FAQ is at
29988 .display
29989 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29990 .endd
29991
29992 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29993 0-201-61598-3) in 2001, contains both introductory and more in-depth
29994 descriptions.
29995 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29996 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29997 Ivan is the author of the popular TLS testing tools at
29998 &url(https://www.ssllabs.com/).
29999
30000
30001 .subsection "Certificate chains" SECID186
30002 A file named by &%tls_certificate%& may contain more than one
30003 certificate. This is useful in the case where the certificate that is being
30004 sent is validated by an intermediate certificate which the other end does
30005 not have. Multiple certificates must be in the correct order in the file.
30006 First the host's certificate itself, then the first intermediate
30007 certificate to validate the issuer of the host certificate, then the next
30008 intermediate certificate to validate the issuer of the first intermediate
30009 certificate, and so on, until finally (optionally) the root certificate.
30010 The root certificate must already be trusted by the recipient for
30011 validation to succeed, of course, but if it's not preinstalled, sending the
30012 root certificate along with the rest makes it available for the user to
30013 install if the receiving end is a client MUA that can interact with a user.
30014
30015 Note that certificates using MD5 are unlikely to work on today's Internet;
30016 even if your libraries allow loading them for use in Exim when acting as a
30017 server, increasingly clients will not accept such certificates.  The error
30018 diagnostics in such a case can be frustratingly vague.
30019
30020
30021
30022 .subsection "Self-signed certificates" SECID187
30023 .cindex "certificate" "self-signed"
30024 You can create a self-signed certificate using the &'req'& command provided
30025 with OpenSSL, like this:
30026 . ==== Do not shorten the duration here without reading and considering
30027 . ==== the text below.  Please leave it at 9999 days.
30028 .code
30029 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30030             -days 9999 -nodes
30031 .endd
30032 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30033 delimited and so can be identified independently. The &%-days%& option
30034 specifies a period for which the certificate is valid. The &%-nodes%& option is
30035 important: if you do not set it, the key is encrypted with a passphrase
30036 that you are prompted for, and any use that is made of the key causes more
30037 prompting for the passphrase. This is not helpful if you are going to use
30038 this certificate and key in an MTA, where prompting is not possible.
30039
30040 . ==== I expect to still be working 26 years from now.  The less technical
30041 . ==== debt I create, in terms of storing up trouble for my later years, the
30042 . ==== happier I will be then.  We really have reached the point where we
30043 . ==== should start, at the very least, provoking thought and making folks
30044 . ==== pause before proceeding, instead of leaving all the fixes until two
30045 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30046 . ==== -pdp, 2012
30047 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30048 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30049 the above command might produce a date in the past.  Think carefully about
30050 the lifetime of the systems you're deploying, and either reduce the duration
30051 of the certificate or reconsider your platform deployment.  (At time of
30052 writing, reducing the duration is the most likely choice, but the inexorable
30053 progression of time takes us steadily towards an era where this will not
30054 be a sensible resolution).
30055
30056 A self-signed certificate made in this way is sufficient for testing, and
30057 may be adequate for all your requirements if you are mainly interested in
30058 encrypting transfers, and not in secure identification.
30059
30060 However, many clients require that the certificate presented by the server be a
30061 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30062 certificate. In this situation, the self-signed certificate described above
30063 must be installed on the client host as a trusted root &'certification
30064 authority'& (CA), and the certificate used by Exim must be a user certificate
30065 signed with that self-signed certificate.
30066
30067 For information on creating self-signed CA certificates and using them to sign
30068 user certificates, see the &'General implementation overview'& chapter of the
30069 Open-source PKI book, available online at
30070 &url(https://sourceforge.net/projects/ospkibook/).
30071
30072
30073 .subsection "Revoked certificates"
30074 .cindex "TLS" "revoked certificates"
30075 .cindex "revocation list"
30076 .cindex "certificate" "revocation list"
30077 .cindex "OCSP" "stapling"
30078 There are three ways for a certificate to be made unusable
30079 before its expiry.
30080
30081 .ilist
30082 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30083 certificates are revoked. If you have such a list, you can pass it to an Exim
30084 server using the global option called &%tls_crl%& and to an Exim client using
30085 an identically named option for the &(smtp)& transport. In each case, the value
30086 of the option is expanded and must then be the name of a file that contains a
30087 CRL in PEM format.
30088 The downside is that clients have to periodically re-download a potentially huge
30089 file from every certificate authority they know of.
30090
30091 .next
30092 The way with most moving parts at query time is Online Certificate
30093 Status Protocol (OCSP), where the client verifies the certificate
30094 against an OCSP server run by the CA.  This lets the CA track all
30095 usage of the certs.  It requires running software with access to the
30096 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30097 is based on HTTP and can be proxied accordingly.
30098
30099 The only widespread OCSP server implementation (known to this writer)
30100 comes as part of OpenSSL and aborts on an invalid request, such as
30101 connecting to the port and then disconnecting.  This requires
30102 re-entering the passphrase each time some random client does this.
30103
30104 .next
30105 The third way is OCSP Stapling; in this, the server using a certificate
30106 issued by the CA periodically requests an OCSP proof of validity from
30107 the OCSP server, then serves it up inline as part of the TLS
30108 negotiation.   This approach adds no extra round trips, does not let the
30109 CA track users, scales well with number of certs issued by the CA and is
30110 resilient to temporary OCSP server failures, as long as the server
30111 starts retrying to fetch an OCSP proof some time before its current
30112 proof expires.  The downside is that it requires server support.
30113
30114 Unless Exim is built with the support disabled,
30115 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30116 support for OCSP stapling is included.
30117
30118 There is a global option called &%tls_ocsp_file%&.
30119 The file specified therein is expected to be in DER format, and contain
30120 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30121 option will be re-expanded for SNI, if the &%tls_certificate%& option
30122 contains &`tls_in_sni`&, as per other TLS options.
30123
30124 Exim does not at this time implement any support for fetching a new OCSP
30125 proof.  The burden is on the administrator to handle this, outside of
30126 Exim.  The file specified should be replaced atomically, so that the
30127 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30128 on each connection, so a new file will be handled transparently on the
30129 next connection.
30130
30131 When built with OpenSSL Exim will check for a valid next update timestamp
30132 in the OCSP proof; if not present, or if the proof has expired, it will be
30133 ignored.
30134
30135 For the client to be able to verify the stapled OCSP the server must
30136 also supply, in its stapled information, any intermediate
30137 certificates for the chain leading to the OCSP proof from the signer
30138 of the server certificate.  There may be zero or one such. These
30139 intermediate certificates should be added to the server OCSP stapling
30140 file named by &%tls_ocsp_file%&.
30141
30142 Note that the proof only covers the terminal server certificate,
30143 not any of the chain from CA to it.
30144
30145 There is no current way to staple a proof for a client certificate.
30146
30147 .code
30148   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30149   OCSP server is supplied.  The server URL may be included in the
30150   server certificate, if the CA is helpful.
30151
30152   One failure mode seen was the OCSP Signer cert expiring before the end
30153   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30154   noted this as invalid overall, but the re-fetch script did not.
30155 .endd
30156 .endlist
30157
30158
30159 .ecindex IIDencsmtp1
30160 .ecindex IIDencsmtp2
30161
30162
30163 .section "TLS Resumption" "SECTresumption"
30164 .cindex TLS resumption
30165 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30166 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30167 (or later).
30168
30169 Session resumption (this is the "stateless" variant) involves the server sending
30170 a "session ticket" to the client on one connection, which can be stored by the
30171 client and used for a later session.  The ticket contains sufficient state for
30172 the server to reconstruct the TLS session, avoiding some expensive crypto
30173 calculation and (on TLS1.2) one full packet roundtrip time.
30174
30175 .ilist
30176 Operational cost/benefit:
30177
30178  The extra data being transmitted costs a minor amount, and the client has
30179  extra costs in storing and retrieving the data.
30180
30181  In the Exim/Gnutls implementation the extra cost on an initial connection
30182  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30183  The saved cost on a subsequent connection is about 4ms; three or more
30184  connections become a net win.  On longer network paths, two or more
30185  connections will have an average lower startup time thanks to the one
30186  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30187  packet roundtrips.
30188
30189 .cindex "hints database" tls
30190  Since a new hints DB is used on the TLS client,
30191  the hints DB maintenance should be updated to additionally handle "tls".
30192
30193 .next
30194 Security aspects:
30195
30196  The session ticket is encrypted, but is obviously an additional security
30197  vulnarability surface.  An attacker able to decrypt it would have access
30198  all connections using the resumed session.
30199  The session ticket encryption key is not committed to storage by the server
30200  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30201  overlap; GnuTLS 6hr but does not specify any overlap).
30202  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30203  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30204
30205  There is a question-mark over the security of the Diffie-Helman parameters
30206  used for session negotiation.
30207
30208 .next
30209 Observability:
30210
30211  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30212  element.
30213
30214  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30215  have bits 0-4 indicating respectively
30216  support built, client requested ticket, client offered session,
30217  server issued ticket, resume used.  A suitable decode list is provided
30218  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30219
30220 .next
30221 Control:
30222
30223 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30224 exim, operating as a server, will offer resumption to clients.
30225 Current best practice is to not offer the feature to MUA connection.
30226 Commonly this can be done like this:
30227 .code
30228 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30229 .endd
30230 If the peer host matches the list after expansion then resumption
30231 is offered and/or accepted.
30232
30233 The &%tls_resumption_hosts%& smtp transport option performs the
30234 equivalent function for operation as a client.
30235 If the peer host matches the list after expansion then resumption
30236 is attempted (if a stored session is available) or the information
30237 stored (if supplied by the peer).
30238
30239
30240 .next
30241 Issues:
30242
30243  In a resumed session:
30244 .ilist
30245   The variables &$tls_{in,out}_cipher$& will have values different
30246  to the original (under GnuTLS).
30247 .next
30248   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30249  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30250 . XXX need to do something with that hosts_require_ocsp
30251 .endlist
30252
30253 .endlist
30254
30255
30256 .section DANE "SECDANE"
30257 .cindex DANE
30258 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30259 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30260 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30261 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30262 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30263 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30264
30265 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30266 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30267 by (a) is thought to be smaller than that of the set of root CAs.
30268
30269 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30270 fail to pass on a server's STARTTLS.
30271
30272 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30273 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30274 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30275
30276 DANE requires a server operator to do three things:
30277 .olist
30278 Run DNSSEC.  This provides assurance to clients
30279 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30280 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30281 DNSSEC.
30282 .next
30283 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30284 .next
30285 Offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30286 .endlist
30287
30288 There are no changes to Exim specific to server-side operation of DANE.
30289 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30290 in &_Local/Makefile_&.
30291 If it has been included, the macro "_HAVE_DANE" will be defined.
30292
30293 .subsection "DNS records"
30294 A TLSA record consist of 4 fields, the "Certificate Usage", the
30295 "Selector", the "Matching type", and the "Certificate Association Data".
30296 For a detailed description of the TLSA record see
30297 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30298
30299 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30300 These are the "Trust Anchor" and "End Entity" variants.
30301 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30302 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30303 this is appropriate for a single system, using a self-signed certificate.
30304 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30305 well-known one.
30306 A private CA at simplest is just a self-signed certificate (with certain
30307 attributes) which is used to sign server certificates, but running one securely
30308 does require careful arrangement.
30309 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30310 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30311 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30312 all of which point to a single TLSA record.
30313 DANE-TA and DANE-EE can both be used together.
30314
30315 Our recommendation is to use DANE with a certificate from a public CA,
30316 because this enables a variety of strategies for remote clients to verify
30317 your certificate.
30318 You can then publish information both via DANE and another technology,
30319 "MTA-STS", described below.
30320
30321 When you use DANE-TA to publish trust anchor information, you ask entities
30322 outside your administrative control to trust the Certificate Authority for
30323 connections to you.
30324 If using a private CA then you should expect others to still apply the
30325 technical criteria they'd use for a public CA to your certificates.
30326 In particular, you should probably try to follow current best practices for CA
30327 operation around hash algorithms and key sizes.
30328 Do not expect other organizations to lower their security expectations just
30329 because a particular profile might be reasonable for your own internal use.
30330
30331 When this text was last updated, this in practice means to avoid use of SHA-1
30332 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30333 than 4096, for interoperability); to use keyUsage fields correctly; to use
30334 random serial numbers.
30335 The list of requirements is subject to change as best practices evolve.
30336 If you're not already using a private CA, or it doesn't meet these
30337 requirements, then we encourage you to avoid all these issues and use a public
30338 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30339
30340 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30341 a "Matching Type" (3rd) field of SHA2-512(2).
30342
30343 For the "Certificate Authority Data" (4th) field, commands like
30344
30345 .code
30346   openssl x509 -pubkey -noout <certificate.pem \
30347   | openssl rsa -outform der -pubin 2>/dev/null \
30348   | openssl sha512 \
30349   | awk '{print $2}'
30350 .endd
30351
30352 are workable to create a hash of the certificate's public key.
30353
30354 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30355
30356 .code
30357   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30358 .endd
30359
30360 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30361 is useful for quickly generating TLSA records.
30362
30363
30364 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30365
30366 The Certificate issued by the CA published in the DANE-TA model should be
30367 issued using a strong hash algorithm.
30368 Exim, and importantly various other MTAs sending to you, will not
30369 re-enable hash algorithms which have been disabled by default in TLS
30370 libraries.
30371 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30372 interoperability (and probably the maximum too, in 2018).
30373
30374 .subsection "Interaction with OCSP"
30375 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30376 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30377 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30378
30379 .code
30380   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30381                                  {= {4}{$tls_out_tlsa_usage}} } \
30382                          {*}{}}
30383 .endd
30384
30385 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30386 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30387 found. If the definition of &%hosts_request_ocsp%& includes the
30388 string "tls_out_tlsa_usage", they are re-expanded in time to
30389 control the OCSP request.
30390
30391 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30392 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30393
30394
30395 .subsection "Client configuration"
30396 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30397 and &%dane_require_tls_ciphers%&.
30398 The &"require"& variant will result in failure if the target host is not
30399 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30400 the &%dnssec_request_domains%& router or transport option.
30401
30402 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30403
30404 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30405 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30406 will be required for the host.  If it does not, the host will not
30407 be used; there is no fallback to non-DANE or non-TLS.
30408
30409 If DANE is requested and usable, then the TLS cipher list configuration
30410 prefers to use the option &%dane_require_tls_ciphers%& and falls
30411 back to &%tls_require_ciphers%& only if that is unset.
30412 This lets you configure "decent crypto" for DANE and "better than nothing
30413 crypto" as the default.  Note though that while GnuTLS lets the string control
30414 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30415 limited to ciphersuite constraints.
30416
30417 If DANE is requested and useable (see above) the following transport options are ignored:
30418 .code
30419   hosts_require_tls
30420   tls_verify_hosts
30421   tls_try_verify_hosts
30422   tls_verify_certificates
30423   tls_crl
30424   tls_verify_cert_hostnames
30425   tls_sni
30426 .endd
30427
30428 If DANE is not usable, whether requested or not, and CA-anchored
30429 verification evaluation is wanted, the above variables should be set appropriately.
30430
30431 The router and transport option &%dnssec_request_domains%& must not be
30432 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30433
30434 .subsection Observability
30435 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30436
30437 There is a new variable &$tls_out_dane$& which will have "yes" if
30438 verification succeeded using DANE and "no" otherwise (only useful
30439 in combination with events; see &<<CHAPevents>>&),
30440 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30441
30442 .cindex DANE reporting
30443 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30444 to achieve DANE-verified connection, if one was either requested and offered, or
30445 required.  This is intended to support TLS-reporting as defined in
30446 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30447 The &$event_data$& will be one of the Result Types defined in
30448 Section 4.3 of that document.
30449
30450 .subsection General
30451 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30452
30453 DANE is specified in published RFCs and decouples certificate authority trust
30454 selection from a "race to the bottom" of "you must trust everything for mail
30455 to get through".
30456 There is an alternative technology called MTA-STS, which
30457 instead publishes MX trust anchor information on an HTTPS website.  At the
30458 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30459 Exim has no support for MTA-STS as a client, but Exim mail server operators
30460 can choose to publish information describing their TLS configuration using
30461 MTA-STS to let those clients who do use that protocol derive trust
30462 information.
30463
30464 The MTA-STS design requires a certificate from a public Certificate Authority
30465 which is recognized by clients sending to you.
30466 That selection of which CAs are trusted by others is outside your control.
30467
30468 The most interoperable course of action is probably to use
30469 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30470 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30471 records for DANE clients (such as Exim and Postfix) and to publish anchor
30472 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30473 domain itself (with caveats around occasionally broken MTA-STS because of
30474 incompatible specification changes prior to reaching RFC status).
30475
30476
30477
30478 . ////////////////////////////////////////////////////////////////////////////
30479 . ////////////////////////////////////////////////////////////////////////////
30480
30481 .chapter "Access control lists" "CHAPACL"
30482 .scindex IIDacl "&ACL;" "description"
30483 .cindex "control of incoming mail"
30484 .cindex "message" "controlling incoming"
30485 .cindex "policy control" "access control lists"
30486 Access Control Lists (ACLs) are defined in a separate section of the runtime
30487 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30488 name, terminated by a colon. Here is a complete ACL section that contains just
30489 one very small ACL:
30490 .code
30491 begin acl
30492 small_acl:
30493   accept   hosts = one.host.only
30494 .endd
30495 You can have as many lists as you like in the ACL section, and the order in
30496 which they appear does not matter. The lists are self-terminating.
30497
30498 The majority of ACLs are used to control Exim's behaviour when it receives
30499 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30500 when a local process submits a message using SMTP by specifying the &%-bs%&
30501 option. The most common use is for controlling which recipients are accepted
30502 in incoming messages. In addition, you can define an ACL that is used to check
30503 local non-SMTP messages. The default configuration file contains an example of
30504 a realistic ACL for checking RCPT commands. This is discussed in chapter
30505 &<<CHAPdefconfil>>&.
30506
30507
30508 .section "Testing ACLs" "SECID188"
30509 The &%-bh%& command line option provides a way of testing your ACL
30510 configuration locally by running a fake SMTP session with which you interact.
30511
30512
30513 .section "Specifying when ACLs are used" "SECID189"
30514 .cindex "&ACL;" "options for specifying"
30515 In order to cause an ACL to be used, you have to name it in one of the relevant
30516 options in the main part of the configuration. These options are:
30517 .cindex "AUTH" "ACL for"
30518 .cindex "DATA" "ACLs for"
30519 .cindex "ETRN" "ACL for"
30520 .cindex "EXPN" "ACL for"
30521 .cindex "HELO" "ACL for"
30522 .cindex "EHLO" "ACL for"
30523 .cindex "DKIM" "ACL for"
30524 .cindex "MAIL" "ACL for"
30525 .cindex "QUIT, ACL for"
30526 .cindex "RCPT" "ACL for"
30527 .cindex "STARTTLS, ACL for"
30528 .cindex "VRFY" "ACL for"
30529 .cindex "SMTP" "connection, ACL for"
30530 .cindex "non-SMTP messages" "ACLs for"
30531 .cindex "MIME content scanning" "ACL for"
30532 .cindex "PRDR" "ACL for"
30533
30534 .table2 140pt
30535 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30536 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30537 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30538 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30539 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30540 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30541 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30542 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30543 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30544 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30545 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30546 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30547 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30548 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30549 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30550 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30551 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30552 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30553 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30554 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30555 .endtable
30556
30557 For example, if you set
30558 .code
30559 acl_smtp_rcpt = small_acl
30560 .endd
30561 the little ACL defined above is used whenever Exim receives a RCPT command
30562 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30563 done when RCPT commands arrive. A rejection of RCPT should cause the
30564 sending MTA to give up on the recipient address contained in the RCPT
30565 command, whereas rejection at other times may cause the client MTA to keep on
30566 trying to deliver the message. It is therefore recommended that you do as much
30567 testing as possible at RCPT time.
30568
30569
30570 .subsection "The non-SMTP ACLs" SECID190
30571 .cindex "non-SMTP messages" "ACLs for"
30572 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30573 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30574 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30575 the state of the SMTP connection such as encryption and authentication) are not
30576 relevant and are forbidden in these ACLs. However, the sender and recipients
30577 are known, so the &%senders%& and &%sender_domains%& conditions and the
30578 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30579 &$authenticated_sender$& are also available. You can specify added header lines
30580 in any of these ACLs.
30581
30582 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30583 non-SMTP message, before any of the message has been read. (This is the
30584 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30585 batched SMTP input, it runs after the DATA command has been reached. The
30586 result of this ACL is ignored; it cannot be used to reject a message. If you
30587 really need to, you could set a value in an ACL variable here and reject based
30588 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30589 controls, and in particular, it can be used to set
30590 .code
30591 control = suppress_local_fixups
30592 .endd
30593 This cannot be used in the other non-SMTP ACLs because by the time they are
30594 run, it is too late.
30595
30596 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30597 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30598
30599 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30600 kind of rejection is treated as permanent, because there is no way of sending a
30601 temporary error for these kinds of message.
30602
30603
30604 .subsection "The SMTP connect ACL" SECID191
30605 .cindex "SMTP" "connection, ACL for"
30606 .oindex &%smtp_banner%&
30607 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30608 session, after the test specified by &%host_reject_connection%& (which is now
30609 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30610 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30611 the message override the banner message that is otherwise specified by the
30612 &%smtp_banner%& option.
30613
30614 .new
30615 For tls-on-connect connections, the ACL is run before the TLS connection
30616 is accepted; if the ACL does not accept then the TCP connection is dropped without
30617 any TLS startup attempt and without any SMTP response being transmitted.
30618 .wen
30619
30620
30621 .subsection "The EHLO/HELO ACL" SECID192
30622 .cindex "EHLO" "ACL for"
30623 .cindex "HELO" "ACL for"
30624 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30625 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30626 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30627 Note that a client may issue more than one EHLO or HELO command in an SMTP
30628 session, and indeed is required to issue a new EHLO or HELO after successfully
30629 setting up encryption following a STARTTLS command.
30630
30631 Note also that a deny neither forces the client to go away nor means that
30632 mail will be refused on the connection.  Consider checking for
30633 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30634
30635 If the command is accepted by an &%accept%& verb that has a &%message%&
30636 modifier, the message may not contain more than one line (it will be truncated
30637 at the first newline and a panic logged if it does). Such a message cannot
30638 affect the EHLO options that are listed on the second and subsequent lines of
30639 an EHLO response.
30640
30641
30642 .subsection "The DATA ACLs" SECID193
30643 .cindex "DATA" "ACLs for"
30644 Two ACLs are associated with the DATA command, because it is two-stage
30645 command, with two responses being sent to the client.
30646 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30647 is obeyed. This gives you control after all the RCPT commands, but before
30648 the message itself is received. It offers the opportunity to give a negative
30649 response to the DATA command before the data is transmitted. Header lines
30650 added by MAIL or RCPT ACLs are not visible at this time, but any that
30651 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30652
30653 You cannot test the contents of the message, for example, to verify addresses
30654 in the headers, at RCPT time or when the DATA command is received. Such
30655 tests have to appear in the ACL that is run after the message itself has been
30656 received, before the final response to the DATA command is sent. This is
30657 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30658 associated with the DATA command.
30659
30660 .cindex CHUNKING "BDAT command"
30661 .cindex BDAT "SMTP command"
30662 .cindex "RFC 3030" CHUNKING
30663 If CHUNKING was advertised and a BDAT command sequence is received,
30664 the &%acl_smtp_predata%& ACL is not run.
30665 . XXX why not?  It should be possible, for the first BDAT.
30666 The &%acl_smtp_data%& is run after the last BDAT command and all of
30667 the data specified is received.
30668
30669 For both of these ACLs, it is not possible to reject individual recipients. An
30670 error response rejects the entire message. Unfortunately, it is known that some
30671 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30672 before or after the data) correctly &-- they keep the message on their queues
30673 and try again later, but that is their problem, though it does waste some of
30674 your resources.
30675
30676 The &%acl_smtp_data%& ACL is run after
30677 the &%acl_smtp_data_prdr%&,
30678 the &%acl_smtp_dkim%&
30679 and the &%acl_smtp_mime%& ACLs.
30680
30681 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30682 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30683 enabled (which is the default).
30684
30685 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30686 received, and is executed for each DKIM signature found in a message.  If not
30687 otherwise specified, the default action is to accept.
30688
30689 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30690
30691 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30692
30693
30694 .subsection "The SMTP MIME ACL" SECID194
30695 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30696 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30697
30698 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30699
30700
30701 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30702 .cindex "PRDR" "ACL for"
30703 .oindex "&%prdr_enable%&"
30704 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30705 with PRDR support enabled (which is the default).
30706 It becomes active only when the PRDR feature is negotiated between
30707 client and server for a message, and more than one recipient
30708 has been accepted.
30709
30710 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30711 has been received, and is executed once for each recipient of the message
30712 with &$local_part$& and &$domain$& valid.
30713 The test may accept, defer or deny for individual recipients.
30714 The &%acl_smtp_data%& will still be called after this ACL and
30715 can reject the message overall, even if this ACL has accepted it
30716 for some or all recipients.
30717
30718 PRDR may be used to support per-user content filtering.  Without it
30719 one must defer any recipient after the first that has a different
30720 content-filter configuration.  With PRDR, the RCPT-time check
30721 .cindex "PRDR" "variable for"
30722 for this can be disabled when the variable &$prdr_requested$&
30723 is &"yes"&.
30724 Any required difference in behaviour of the main DATA-time
30725 ACL should however depend on the PRDR-time ACL having run, as Exim
30726 will avoid doing so in some situations (e.g. single-recipient mails).
30727
30728 See also the &%prdr_enable%& global option
30729 and the &%hosts_try_prdr%& smtp transport option.
30730
30731 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30732 If the ACL is not defined, processing completes as if
30733 the feature was not requested by the client.
30734
30735 .subsection "The QUIT ACL" SECTQUITACL
30736 .cindex "QUIT, ACL for"
30737 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30738 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30739 does not in fact control any access.
30740 For this reason, it may only accept
30741 or warn as its final result.
30742
30743 This ACL can be used for tasks such as custom logging at the end of an SMTP
30744 session. For example, you can use ACL variables in other ACLs to count
30745 messages, recipients, etc., and log the totals at QUIT time using one or
30746 more &%logwrite%& modifiers on a &%warn%& verb.
30747
30748 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30749 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30750
30751 You do not need to have a final &%accept%&, but if you do, you can use a
30752 &%message%& modifier to specify custom text that is sent as part of the 221
30753 response to QUIT.
30754
30755 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30756 failure (for example, failure to open a log file, or when Exim is bombing out
30757 because it has detected an unrecoverable error), all SMTP commands from the
30758 client are given temporary error responses until QUIT is received or the
30759 connection is closed. In these special cases, the QUIT ACL does not run.
30760
30761
30762 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30763 .vindex &$acl_smtp_notquit$&
30764 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30765 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30766 trouble, such as being unable to write to its log files, this ACL is not run,
30767 because it might try to do things (such as write to log files) that make the
30768 situation even worse.
30769
30770 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30771 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30772 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30773 and &%warn%&.
30774
30775 .vindex &$smtp_notquit_reason$&
30776 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30777 to a string that indicates the reason for the termination of the SMTP
30778 connection. The possible values are:
30779 .table2
30780 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30781 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30782 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30783 .irow &`connection-lost`&          "The SMTP connection has been lost"
30784 .irow &`data-timeout`&             "Timeout while reading message data"
30785 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30786 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30787 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30788 .irow &`synchronization-error`&    "SMTP synchronization error"
30789 .irow &`tls-failed`&               "TLS failed to start"
30790 .endtable
30791 In most cases when an SMTP connection is closed without having received QUIT,
30792 Exim sends an SMTP response message before actually closing the connection.
30793 With the exception of the &`acl-drop`& case, the default message can be
30794 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30795 &%drop%& verb in another ACL, it is the message from the other ACL that is
30796 used.
30797
30798
30799 .section "Finding an ACL to use" "SECID195"
30800 .cindex "&ACL;" "finding which to use"
30801 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30802 you can use different ACLs in different circumstances. For example,
30803 .code
30804 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30805                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30806 .endd
30807 In the default configuration file there are some example settings for
30808 providing an RFC 4409 message &"submission"& service on port 587 and
30809 an RFC 8314 &"submissions"& service on port 465. You can use a string
30810 expansion like this to choose an ACL for MUAs on these ports which is
30811 more appropriate for this purpose than the default ACL on port 25.
30812
30813 The expanded string does not have to be the name of an ACL in the
30814 configuration file; there are other possibilities. Having expanded the
30815 string, Exim searches for an ACL as follows:
30816
30817 .ilist
30818 If the string begins with a slash, Exim uses it as a filename, and reads its
30819 contents as an ACL. The lines are processed in the same way as lines in the
30820 Exim configuration file. In particular, continuation lines are supported, blank
30821 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30822 If the file does not exist or cannot be read, an error occurs (typically
30823 causing a temporary failure of whatever caused the ACL to be run). For example:
30824 .code
30825 acl_smtp_data = /etc/acls/\
30826   ${lookup{$sender_host_address}lsearch\
30827   {/etc/acllist}{$value}{default}}
30828 .endd
30829 This looks up an ACL file to use on the basis of the host's IP address, falling
30830 back to a default if the lookup fails. If an ACL is successfully read from a
30831 file, it is retained in memory for the duration of the Exim process, so that it
30832 can be re-used without having to re-read the file.
30833 .next
30834 If the string does not start with a slash, and does not contain any spaces,
30835 Exim searches the ACL section of the configuration for an ACL whose name
30836 matches the string.
30837 .next
30838 If no named ACL is found, or if the string contains spaces, Exim parses
30839 the string as an inline ACL. This can save typing in cases where you just
30840 want to have something like
30841 .code
30842 acl_smtp_vrfy = accept
30843 .endd
30844 in order to allow free use of the VRFY command. Such a string may contain
30845 newlines; it is processed in the same way as an ACL that is read from a file.
30846 .endlist
30847
30848
30849
30850
30851 .section "ACL return codes" "SECID196"
30852 .cindex "&ACL;" "return codes"
30853 Except for the QUIT ACL, which does not affect the SMTP return code (see
30854 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30855 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30856 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30857 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30858 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30859 This also causes a 4&'xx'& return code.
30860
30861 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30862 &"deny"&, because there is no mechanism for passing temporary errors to the
30863 submitters of non-SMTP messages.
30864
30865
30866 ACLs that are relevant to message reception may also return &"discard"&. This
30867 has the effect of &"accept"&, but causes either the entire message or an
30868 individual recipient address to be discarded. In other words, it is a
30869 blackholing facility. Use it with care.
30870
30871 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30872 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30873 RCPT ACL is to discard just the one recipient address. If there are no
30874 recipients left when the message's data is received, the DATA ACL is not
30875 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30876 remaining recipients. The &"discard"& return is not permitted for the
30877 &%acl_smtp_predata%& ACL.
30878
30879 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30880 is done on the address and the result determines the SMTP response.
30881
30882
30883 .cindex "&[local_scan()]& function" "when all recipients discarded"
30884 The &[local_scan()]& function is always run, even if there are no remaining
30885 recipients; it may create new recipients.
30886
30887
30888
30889 .section "Unset ACL options" "SECID197"
30890 .cindex "&ACL;" "unset options"
30891 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30892 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30893 not defined at all. For any defined ACL, the default action when control
30894 reaches the end of the ACL statements is &"deny"&.
30895
30896 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30897 these two are ACLs that are used only for their side effects. They cannot be
30898 used to accept or reject anything.
30899
30900 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30901 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30902 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30903 when the ACL is not defined is &"accept"&.
30904
30905 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30906 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30907 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30908 messages over an SMTP connection. For an example, see the ACL in the default
30909 configuration file.
30910
30911
30912
30913
30914 .section "Data for message ACLs" "SECID198"
30915 .cindex "&ACL;" "data for message ACL"
30916 .vindex &$domain$&
30917 .vindex &$local_part$&
30918 .vindex &$sender_address$&
30919 .vindex &$sender_host_address$&
30920 .vindex &$smtp_command$&
30921 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30922 that contain information about the host and the message's sender (for example,
30923 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30924 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30925 &$local_part$& are set from the argument address. The entire SMTP command
30926 is available in &$smtp_command$&.
30927
30928 When an ACL for the AUTH parameter of MAIL is running, the variables that
30929 contain information about the host are set, but &$sender_address$& is not yet
30930 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30931 how it is used.
30932
30933 .vindex "&$message_size$&"
30934 The &$message_size$& variable is set to the value of the SIZE parameter on
30935 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30936 that parameter is not given. The value is updated to the true message size by
30937 the time the final DATA ACL is run (after the message data has been
30938 received).
30939
30940 .vindex "&$rcpt_count$&"
30941 .vindex "&$recipients_count$&"
30942 The &$rcpt_count$& variable increases by one for each RCPT command received.
30943 The &$recipients_count$& variable increases by one each time a RCPT command is
30944 accepted, so while an ACL for RCPT is being processed, it contains the number
30945 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30946 &$rcpt_count$& contains the total number of RCPT commands, and
30947 &$recipients_count$& contains the total number of accepted recipients.
30948
30949
30950
30951
30952
30953 .section "Data for non-message ACLs" "SECTdatfornon"
30954 .cindex "&ACL;" "data for non-message ACL"
30955 .vindex &$smtp_command_argument$&
30956 .vindex &$smtp_command$&
30957 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30958 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30959 and the entire SMTP command is available in &$smtp_command$&.
30960 These variables can be tested using a &%condition%& condition. For example,
30961 here is an ACL for use with AUTH, which insists that either the session is
30962 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30963 does not permit authentication methods that use cleartext passwords on
30964 unencrypted connections.
30965 .code
30966 acl_check_auth:
30967   accept encrypted = *
30968   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30969                      {CRAM-MD5}}
30970   deny   message   = TLS encryption or CRAM-MD5 required
30971 .endd
30972 (Another way of applying this restriction is to arrange for the authenticators
30973 that use cleartext passwords not to be advertised when the connection is not
30974 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30975 option to do this.)
30976
30977
30978
30979 .section "Format of an ACL" "SECID199"
30980 .cindex "&ACL;" "format of"
30981 .cindex "&ACL;" "verbs, definition of"
30982 An individual ACL consists of a number of statements. Each statement starts
30983 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30984 Modifiers can change the way the verb operates, define error and log messages,
30985 set variables, insert delays, and vary the processing of accepted messages.
30986
30987 If all the conditions are met, the verb is obeyed. The same condition may be
30988 used (with different arguments) more than once in the same statement. This
30989 provides a means of specifying an &"and"& conjunction between conditions. For
30990 example:
30991 .code
30992 deny  dnslists = list1.example
30993       dnslists = list2.example
30994 .endd
30995 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30996 the conditions and modifiers when it reaches a condition that fails. What
30997 happens then depends on the verb (and in one case, on a special modifier). Not
30998 all the conditions make sense at every testing point. For example, you cannot
30999 test a sender address in the ACL that is run for a VRFY command.
31000
31001
31002 .section "ACL verbs" "SECID200"
31003 The ACL verbs are as follows:
31004
31005 .ilist
31006 .cindex "&%accept%& ACL verb"
31007 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31008 of the conditions are not met, what happens depends on whether &%endpass%&
31009 appears among the conditions (for syntax see below). If the failing condition
31010 is before &%endpass%&, control is passed to the next ACL statement; if it is
31011 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31012 check a RCPT command:
31013 .code
31014 accept domains = +local_domains
31015        endpass
31016        verify = recipient
31017 .endd
31018 If the recipient domain does not match the &%domains%& condition, control
31019 passes to the next statement. If it does match, the recipient is verified, and
31020 the command is accepted if verification succeeds. However, if verification
31021 fails, the ACL yields &"deny"&, because the failing condition is after
31022 &%endpass%&.
31023
31024 The &%endpass%& feature has turned out to be confusing to many people, so its
31025 use is not recommended nowadays. It is always possible to rewrite an ACL so
31026 that &%endpass%& is not needed, and it is no longer used in the default
31027 configuration.
31028
31029 .cindex "&%message%& ACL modifier" "with &%accept%&"
31030 If a &%message%& modifier appears on an &%accept%& statement, its action
31031 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31032 (when an &%accept%& verb either accepts or passes control to the next
31033 statement), &%message%& can be used to vary the message that is sent when an
31034 SMTP command is accepted. For example, in a RCPT ACL you could have:
31035 .display
31036 &`accept  `&<&'some conditions'&>
31037 &`        message = OK, I will allow you through today`&
31038 .endd
31039 You can specify an SMTP response code, optionally followed by an &"extended
31040 response code"& at the start of the message, but the first digit must be the
31041 same as would be sent by default, which is 2 for an &%accept%& verb.
31042
31043 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31044 an error message that is used when access is denied. This behaviour is retained
31045 for backward compatibility, but current &"best practice"& is to avoid the use
31046 of &%endpass%&.
31047
31048
31049 .next
31050 .cindex "&%defer%& ACL verb"
31051 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31052 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31053 &%defer%& is the same as &%deny%&, because there is no way of sending a
31054 temporary error. For a RCPT command, &%defer%& is much the same as using a
31055 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31056 be used in any ACL, and even for a recipient it might be a simpler approach.
31057
31058
31059 .next
31060 .cindex "&%deny%& ACL verb"
31061 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31062 the conditions are not met, control is passed to the next ACL statement. For
31063 example,
31064 .code
31065 deny dnslists = blackholes.mail-abuse.org
31066 .endd
31067 rejects commands from hosts that are on a DNS black list.
31068
31069
31070 .next
31071 .cindex "&%discard%& ACL verb"
31072 &%discard%&: This verb behaves like &%accept%&, except that it returns
31073 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31074 that are concerned with receiving messages. When all the conditions are true,
31075 the sending entity receives a &"success"& response. However, &%discard%& causes
31076 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31077 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31078 message's recipients are discarded. Recipients that are discarded before DATA
31079 do not appear in the log line when the &%received_recipients%& log selector is set.
31080
31081 If the &%log_message%& modifier is set when &%discard%& operates,
31082 its contents are added to the line that is automatically written to the log.
31083 The &%message%& modifier operates exactly as it does for &%accept%&.
31084
31085
31086 .next
31087 .cindex "&%drop%& ACL verb"
31088 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31089 forcibly closed after the 5&'xx'& error message has been sent. For example:
31090 .code
31091 drop   condition = ${if > {$rcpt_count}{20}}
31092        message   = I don't take more than 20 RCPTs
31093 .endd
31094 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31095 The connection is always dropped after sending a 550 response.
31096
31097 .next
31098 .cindex "&%require%& ACL verb"
31099 &%require%&: If all the conditions are met, control is passed to the next ACL
31100 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31101 example, when checking a RCPT command,
31102 .code
31103 require message = Sender did not verify
31104         verify  = sender
31105 .endd
31106 passes control to subsequent statements only if the message's sender can be
31107 verified. Otherwise, it rejects the command. Note the positioning of the
31108 &%message%& modifier, before the &%verify%& condition. The reason for this is
31109 discussed in section &<<SECTcondmodproc>>&.
31110
31111 .next
31112 .cindex "&%warn%& ACL verb"
31113 &%warn%&: If all the conditions are true, a line specified by the
31114 &%log_message%& modifier is written to Exim's main log. Control always passes
31115 to the next ACL statement. If any condition is false, the log line is not
31116 written. If an identical log line is requested several times in the same
31117 message, only one copy is actually written to the log. If you want to force
31118 duplicates to be written, use the &%logwrite%& modifier instead.
31119
31120 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31121 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31122 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31123 first failing condition. There is more about adding header lines in section
31124 &<<SECTaddheadacl>>&.
31125
31126 If any condition on a &%warn%& statement cannot be completed (that is, there is
31127 some sort of defer), the log line specified by &%log_message%& is not written.
31128 This does not include the case of a forced failure from a lookup, which
31129 is considered to be a successful completion. After a defer, no further
31130 conditions or modifiers in the &%warn%& statement are processed. The incident
31131 is logged, and the ACL continues to be processed, from the next statement
31132 onwards.
31133
31134
31135 .vindex "&$acl_verify_message$&"
31136 When one of the &%warn%& conditions is an address verification that fails, the
31137 text of the verification failure message is in &$acl_verify_message$&. If you
31138 want this logged, you must set it up explicitly. For example:
31139 .code
31140 warn   !verify = sender
31141        log_message = sender verify failed: $acl_verify_message
31142 .endd
31143 .endlist
31144
31145 At the end of each ACL there is an implicit unconditional &%deny%&.
31146
31147 As you can see from the examples above, the conditions and modifiers are
31148 written one to a line, with the first one on the same line as the verb, and
31149 subsequent ones on following lines. If you have a very long condition, you can
31150 continue it onto several physical lines by the usual backslash continuation
31151 mechanism. It is conventional to align the conditions vertically.
31152
31153
31154
31155 .section "ACL variables" "SECTaclvariables"
31156 .cindex "&ACL;" "variables"
31157 There are some special variables that can be set during ACL processing. They
31158 can be used to pass information between different ACLs, different invocations
31159 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31160 transports, and filters that are used to deliver a message. The names of these
31161 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31162 an underscore, but the remainder of the name can be any sequence of
31163 alphanumeric characters and underscores that you choose. There is no limit on
31164 the number of ACL variables. The two sets act as follows:
31165 .ilist
31166 The values of those variables whose names begin with &$acl_c$& persist
31167 throughout an SMTP connection. They are never reset. Thus, a value that is set
31168 while receiving one message is still available when receiving the next message
31169 on the same SMTP connection.
31170 .next
31171 The values of those variables whose names begin with &$acl_m$& persist only
31172 while a message is being received. They are reset afterwards. They are also
31173 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31174 .endlist
31175
31176 When a message is accepted, the current values of all the ACL variables are
31177 preserved with the message and are subsequently made available at delivery
31178 time. The ACL variables are set by a modifier called &%set%&. For example:
31179 .code
31180 accept hosts = whatever
31181        set acl_m4 = some value
31182 accept authenticated = *
31183        set acl_c_auth = yes
31184 .endd
31185 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31186 be set. If you want to set a variable without taking any action, you can use a
31187 &%warn%& verb without any other modifiers or conditions.
31188
31189 .oindex &%strict_acl_vars%&
31190 What happens if a syntactically valid but undefined ACL variable is
31191 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31192 false (the default), an empty string is substituted; if it is true, an
31193 error is generated.
31194
31195 Versions of Exim before 4.64 have a limited set of numbered variables, but
31196 their names are compatible, so there is no problem with upgrading.
31197
31198
31199 .section "Condition and modifier processing" "SECTcondmodproc"
31200 .cindex "&ACL;" "conditions; processing"
31201 .cindex "&ACL;" "modifiers; processing"
31202 An exclamation mark preceding a condition negates its result. For example:
31203 .code
31204 deny   domains = *.dom.example
31205       !verify  = recipient
31206 .endd
31207 causes the ACL to return &"deny"& if the recipient domain ends in
31208 &'dom.example'& and the recipient address cannot be verified. Sometimes
31209 negation can be used on the right-hand side of a condition. For example, these
31210 two statements are equivalent:
31211 .code
31212 deny  hosts = !192.168.3.4
31213 deny !hosts =  192.168.3.4
31214 .endd
31215 However, for many conditions (&%verify%& being a good example), only left-hand
31216 side negation of the whole condition is possible.
31217
31218 The arguments of conditions and modifiers are expanded. A forced failure
31219 of an expansion causes a condition to be ignored, that is, it behaves as if the
31220 condition is true. Consider these two statements:
31221 .code
31222 accept  senders = ${lookup{$host_name}lsearch\
31223                   {/some/file}{$value}fail}
31224 accept  senders = ${lookup{$host_name}lsearch\
31225                   {/some/file}{$value}{}}
31226 .endd
31227 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31228 the returned list is searched, but if the lookup fails the behaviour is
31229 different in the two cases. The &%fail%& in the first statement causes the
31230 condition to be ignored, leaving no further conditions. The &%accept%& verb
31231 therefore succeeds. The second statement, however, generates an empty list when
31232 the lookup fails. No sender can match an empty list, so the condition fails,
31233 and therefore the &%accept%& also fails.
31234
31235 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31236 specify actions that are taken as the conditions for a statement are checked;
31237 others specify text for messages that are used when access is denied or a
31238 warning is generated. The &%control%& modifier affects the way an incoming
31239 message is handled.
31240
31241 The positioning of the modifiers in an ACL statement is important, because the
31242 processing of a verb ceases as soon as its outcome is known. Only those
31243 modifiers that have already been encountered will take effect. For example,
31244 consider this use of the &%message%& modifier:
31245 .code
31246 require message = Can't verify sender
31247         verify  = sender
31248         message = Can't verify recipient
31249         verify  = recipient
31250         message = This message cannot be used
31251 .endd
31252 If sender verification fails, Exim knows that the result of the statement is
31253 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31254 so its text is used as the error message. If sender verification succeeds, but
31255 recipient verification fails, the second message is used. If recipient
31256 verification succeeds, the third message becomes &"current"&, but is never used
31257 because there are no more conditions to cause failure.
31258
31259 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31260 modifier that is used, because all the conditions must be true for rejection to
31261 happen. Specifying more than one &%message%& modifier does not make sense, and
31262 the message can even be specified after all the conditions. For example:
31263 .code
31264 deny   hosts = ...
31265       !senders = *@my.domain.example
31266        message = Invalid sender from client host
31267 .endd
31268 The &"deny"& result does not happen until the end of the statement is reached,
31269 by which time Exim has set up the message.
31270
31271
31272
31273 .section "ACL modifiers" "SECTACLmodi"
31274 .cindex "&ACL;" "modifiers; list of"
31275 The ACL modifiers are as follows:
31276
31277 .vlist
31278 .vitem &*add_header*&&~=&~<&'text'&>
31279 This modifier specifies one or more header lines that are to be added to an
31280 incoming message, assuming, of course, that the message is ultimately
31281 accepted. For details, see section &<<SECTaddheadacl>>&.
31282
31283 .vitem &*continue*&&~=&~<&'text'&>
31284 .cindex "&%continue%& ACL modifier"
31285 .cindex "database" "updating in ACL"
31286 This modifier does nothing of itself, and processing of the ACL always
31287 continues with the next condition or modifier. The value of &%continue%& is in
31288 the side effects of expanding its argument. Typically this could be used to
31289 update a database. It is really just a syntactic tidiness, to avoid having to
31290 write rather ugly lines like this:
31291 .display
31292 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31293 .endd
31294 Instead, all you need is
31295 .display
31296 &`continue = `&<&'some expansion'&>
31297 .endd
31298
31299 .vitem &*control*&&~=&~<&'text'&>
31300 .cindex "&%control%& ACL modifier"
31301 This modifier affects the subsequent processing of the SMTP connection or of an
31302 incoming message that is accepted. The effect of the first type of control
31303 lasts for the duration of the connection, whereas the effect of the second type
31304 lasts only until the current message has been received. The message-specific
31305 controls always apply to the whole message, not to individual recipients,
31306 even if the &%control%& modifier appears in a RCPT ACL.
31307
31308 As there are now quite a few controls that can be applied, they are described
31309 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31310 in several different ways. For example:
31311
31312 . ==== As this is a nested list, any displays it contains must be indented
31313 . ==== as otherwise they are too far to the left. That comment applies only
31314 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31315 . ==== way.
31316
31317 .ilist
31318 It can be at the end of an &%accept%& statement:
31319 .code
31320     accept  ...some conditions
31321             control = queue
31322 .endd
31323 In this case, the control is applied when this statement yields &"accept"&, in
31324 other words, when the conditions are all true.
31325
31326 .next
31327 It can be in the middle of an &%accept%& statement:
31328 .code
31329     accept  ...some conditions...
31330             control = queue
31331             ...some more conditions...
31332 .endd
31333 If the first set of conditions are true, the control is applied, even if the
31334 statement does not accept because one of the second set of conditions is false.
31335 In this case, some subsequent statement must yield &"accept"& for the control
31336 to be relevant.
31337
31338 .next
31339 It can be used with &%warn%& to apply the control, leaving the
31340 decision about accepting or denying to a subsequent verb. For
31341 example:
31342 .code
31343     warn    ...some conditions...
31344             control = freeze
31345     accept  ...
31346 .endd
31347 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31348 &%logwrite%&, so it does not add anything to the message and does not write a
31349 log entry.
31350
31351 .next
31352 If you want to apply a control unconditionally, you can use it with a
31353 &%require%& verb. For example:
31354 .code
31355     require  control = no_multiline_responses
31356 .endd
31357 .endlist
31358
31359 .vitem &*delay*&&~=&~<&'time'&>
31360 .cindex "&%delay%& ACL modifier"
31361 .oindex "&%-bh%&"
31362 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31363 the time interval before proceeding. However, when testing Exim using the
31364 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31365 output instead). The time is given in the usual Exim notation, and the delay
31366 happens as soon as the modifier is processed. In an SMTP session, pending
31367 output is flushed before the delay is imposed.
31368
31369 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31370 example:
31371 .code
31372 deny    ...some conditions...
31373         delay = 30s
31374 .endd
31375 The delay happens if all the conditions are true, before the statement returns
31376 &"deny"&. Compare this with:
31377 .code
31378 deny    delay = 30s
31379         ...some conditions...
31380 .endd
31381 which waits for 30s before processing the conditions. The &%delay%& modifier
31382 can also be used with &%warn%& and together with &%control%&:
31383 .code
31384 warn    ...some conditions...
31385         delay = 2m
31386         control = freeze
31387 accept  ...
31388 .endd
31389
31390 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31391 responses to several commands are no longer buffered and sent in one packet (as
31392 they would normally be) because all output is flushed before imposing the
31393 delay. This optimization is disabled so that a number of small delays do not
31394 appear to the client as one large aggregated delay that might provoke an
31395 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31396 using a &%control%& modifier to set &%no_delay_flush%&.
31397
31398
31399 .vitem &*endpass*&
31400 .cindex "&%endpass%& ACL modifier"
31401 This modifier, which has no argument, is recognized only in &%accept%& and
31402 &%discard%& statements. It marks the boundary between the conditions whose
31403 failure causes control to pass to the next statement, and the conditions whose
31404 failure causes the ACL to return &"deny"&. This concept has proved to be
31405 confusing to some people, so the use of &%endpass%& is no longer recommended as
31406 &"best practice"&. See the description of &%accept%& above for more details.
31407
31408
31409 .vitem &*log_message*&&~=&~<&'text'&>
31410 .cindex "&%log_message%& ACL modifier"
31411 This modifier sets up a message that is used as part of the log message if the
31412 ACL denies access or a &%warn%& statement's conditions are true. For example:
31413 .code
31414 require log_message = wrong cipher suite $tls_in_cipher
31415         encrypted   = DES-CBC3-SHA
31416 .endd
31417 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31418 example:
31419 .display
31420 &`discard `&<&'some conditions'&>
31421 &`        log_message = Discarded $local_part@$domain because...`&
31422 .endd
31423 When access is denied, &%log_message%& adds to any underlying error message
31424 that may exist because of a condition failure. For example, while verifying a
31425 recipient address, a &':fail:'& redirection might have already set up a
31426 message.
31427
31428 The message may be defined before the conditions to which it applies, because
31429 the string expansion does not happen until Exim decides that access is to be
31430 denied. This means that any variables that are set by the condition are
31431 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31432 variables are set after a DNS black list lookup succeeds. If the expansion of
31433 &%log_message%& fails, or if the result is an empty string, the modifier is
31434 ignored.
31435
31436 .vindex "&$acl_verify_message$&"
31437 If you want to use a &%warn%& statement to log the result of an address
31438 verification, you can use &$acl_verify_message$& to include the verification
31439 error message.
31440
31441 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31442 the start of the logged message. If the same warning log message is requested
31443 more than once while receiving  a single email message, only one copy is
31444 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31445 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31446 is logged for a successful &%warn%& statement.
31447
31448 If &%log_message%& is not present and there is no underlying error message (for
31449 example, from the failure of address verification), but &%message%& is present,
31450 the &%message%& text is used for logging rejections. However, if any text for
31451 logging contains newlines, only the first line is logged. In the absence of
31452 both &%log_message%& and &%message%&, a default built-in message is used for
31453 logging rejections.
31454
31455
31456 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31457 .cindex "&%log_reject_target%& ACL modifier"
31458 .cindex "logging in ACL" "specifying which log"
31459 This modifier makes it possible to specify which logs are used for messages
31460 about ACL rejections. Its argument is a colon-separated list of words that can
31461 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31462 may be empty, in which case a rejection is not logged at all. For example, this
31463 ACL fragment writes no logging information when access is denied:
31464 .display
31465 &`deny `&<&'some conditions'&>
31466 &`     log_reject_target =`&
31467 .endd
31468 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31469 permanent and temporary rejections. Its effect lasts for the rest of the
31470 current ACL.
31471
31472
31473 .vitem &*logwrite*&&~=&~<&'text'&>
31474 .cindex "&%logwrite%& ACL modifier"
31475 .cindex "logging in ACL" "immediate"
31476 This modifier writes a message to a log file as soon as it is encountered when
31477 processing an ACL. (Compare &%log_message%&, which, except in the case of
31478 &%warn%& and &%discard%&, is used only if the ACL statement denies
31479 access.) The &%logwrite%& modifier can be used to log special incidents in
31480 ACLs. For example:
31481 .display
31482 &`accept `&<&'some special conditions'&>
31483 &`       control  = freeze`&
31484 &`       logwrite = froze message because ...`&
31485 .endd
31486 By default, the message is written to the main log. However, it may begin
31487 with a colon, followed by a comma-separated list of log names, and then
31488 another colon, to specify exactly which logs are to be written. For
31489 example:
31490 .code
31491 logwrite = :main,reject: text for main and reject logs
31492 logwrite = :panic: text for panic log only
31493 .endd
31494
31495
31496 .vitem &*message*&&~=&~<&'text'&>
31497 .cindex "&%message%& ACL modifier"
31498 This modifier sets up a text string that is expanded and used as a response
31499 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31500 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31501 there is some complication if &%endpass%& is involved; see the description of
31502 &%accept%& for details.)
31503
31504 The expansion of the message happens at the time Exim decides that the ACL is
31505 to end, not at the time it processes &%message%&. If the expansion fails, or
31506 generates an empty string, the modifier is ignored. Here is an example where
31507 &%message%& must be specified first, because the ACL ends with a rejection if
31508 the &%hosts%& condition fails:
31509 .code
31510 require  message = Host not recognized
31511          hosts = 10.0.0.0/8
31512 .endd
31513 (Once a condition has failed, no further conditions or modifiers are
31514 processed.)
31515
31516 .cindex "SMTP" "error codes"
31517 .oindex "&%smtp_banner%&
31518 For ACLs that are triggered by SMTP commands, the message is returned as part
31519 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31520 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31521 is accepted. In the case of the connect ACL, accepting with a message modifier
31522 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31523 accept message may not contain more than one line (otherwise it will be
31524 truncated at the first newline and a panic logged), and it cannot affect the
31525 EHLO options.
31526
31527 When SMTP is involved, the message may begin with an overriding response code,
31528 consisting of three digits optionally followed by an &"extended response code"&
31529 of the form &'n.n.n'&, each code being followed by a space. For example:
31530 .code
31531 deny  message = 599 1.2.3 Host not welcome
31532       hosts = 192.168.34.0/24
31533 .endd
31534 The first digit of the supplied response code must be the same as would be sent
31535 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31536 access, but for the predata ACL, note that the default success code is 354, not
31537 2&'xx'&.
31538
31539 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31540 the message modifier cannot override the 221 response code.
31541
31542 The text in a &%message%& modifier is literal; any quotes are taken as
31543 literals, but because the string is expanded, backslash escapes are processed
31544 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31545 response.
31546
31547 .vindex "&$acl_verify_message$&"
31548 While the text is being expanded, the &$acl_verify_message$& variable
31549 contains any message previously set.
31550 Afterwards, &$acl_verify_message$& is cleared.
31551
31552 If &%message%& is used on a statement that verifies an address, the message
31553 specified overrides any message that is generated by the verification process.
31554 However, the original message is available in the variable
31555 &$acl_verify_message$&, so you can incorporate it into your message if you
31556 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31557 routers to be passed back as part of the SMTP response, you should either not
31558 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31559
31560 For compatibility with previous releases of Exim, a &%message%& modifier that
31561 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31562 modifier, but this usage is now deprecated. However, &%message%& acts only when
31563 all the conditions are true, wherever it appears in an ACL command, whereas
31564 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31565 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31566 effect.
31567
31568
31569 .vitem &*queue*&&~=&~<&'text'&>
31570 .cindex "&%queue%& ACL modifier"
31571 .cindex "named queues" "selecting in ACL"
31572 This modifier specifies the use of a named queue for spool files
31573 for the message.
31574 It can only be used before the message is received (i.e. not in
31575 the DATA ACL).
31576 This could be used, for example, for known high-volume burst sources
31577 of traffic, or for quarantine of messages.
31578 Separate queue-runner processes will be needed for named queues.
31579 If the text after expansion is empty, the default queue is used.
31580
31581
31582 .vitem &*remove_header*&&~=&~<&'text'&>
31583 This modifier specifies one or more header names in a colon-separated list
31584  that are to be removed from an incoming message, assuming, of course, that
31585 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31586
31587
31588 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31589 .cindex "&%set%& ACL modifier"
31590 This modifier puts a value into one of the ACL variables (see section
31591 &<<SECTaclvariables>>&).
31592
31593
31594 .vitem &*udpsend*&&~=&~<&'parameters'&>
31595 .cindex "UDP communications"
31596 This modifier sends a UDP packet, for purposes such as statistics
31597 collection or behaviour monitoring. The parameters are expanded, and
31598 the result of the expansion must be a colon-separated list consisting
31599 of a destination server, port number, and the packet contents. The
31600 server can be specified as a host name or IPv4 or IPv6 address. The
31601 separator can be changed with the usual angle bracket syntax. For
31602 example, you might want to collect information on which hosts connect
31603 when:
31604 .code
31605 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31606              $tod_zulu $sender_host_address
31607 .endd
31608 .endlist
31609
31610
31611
31612
31613 .section "Use of the control modifier" "SECTcontrols"
31614 .cindex "&%control%& ACL modifier"
31615 The &%control%& modifier supports the following settings:
31616
31617 .vlist
31618 .vitem &*control&~=&~allow_auth_unadvertised*&
31619 This modifier allows a client host to use the SMTP AUTH command even when it
31620 has not been advertised in response to EHLO. Furthermore, because there are
31621 apparently some really broken clients that do this, Exim will accept AUTH after
31622 HELO (rather than EHLO) when this control is set. It should be used only if you
31623 really need it, and you should limit its use to those broken clients that do
31624 not work without it. For example:
31625 .code
31626 warn hosts   = 192.168.34.25
31627      control = allow_auth_unadvertised
31628 .endd
31629 Normally, when an Exim server receives an AUTH command, it checks the name of
31630 the authentication mechanism that is given in the command to ensure that it
31631 matches an advertised mechanism. When this control is set, the check that a
31632 mechanism has been advertised is bypassed. Any configured mechanism can be used
31633 by the client. This control is permitted only in the connection and HELO ACLs.
31634
31635
31636 .vitem &*control&~=&~caseful_local_part*& &&&
31637        &*control&~=&~caselower_local_part*&
31638 .cindex "&ACL;" "case of local part in"
31639 .cindex "case of local parts"
31640 .vindex "&$local_part$&"
31641 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31642 (that is, during RCPT processing). By default, the contents of &$local_part$&
31643 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31644 any uppercase letters in the original local part are restored in &$local_part$&
31645 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31646 is encountered.
31647
31648 These controls affect only the current recipient. Moreover, they apply only to
31649 local part handling that takes place directly in the ACL (for example, as a key
31650 in lookups). If a test to verify the recipient is obeyed, the case-related
31651 handling of the local part during the verification is controlled by the router
31652 configuration (see the &%caseful_local_part%& generic router option).
31653
31654 This facility could be used, for example, to add a spam score to local parts
31655 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31656 spam score:
31657 .code
31658 warn  control = caseful_local_part
31659       set acl_m4 = ${eval:\
31660                      $acl_m4 + \
31661                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31662                     }
31663       control = caselower_local_part
31664 .endd
31665 Notice that we put back the lower cased version afterwards, assuming that
31666 is what is wanted for subsequent tests.
31667
31668
31669 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31670 .cindex "&ACL;" "cutthrough routing"
31671 .cindex "cutthrough" "requesting"
31672 This option requests delivery be attempted while the item is being received.
31673
31674 The option is usable in the RCPT ACL.
31675 If enabled for a message received via smtp and routed to an smtp transport,
31676 and only one transport, interface, destination host and port combination
31677 is used for all recipients of the message,
31678 then the delivery connection is made while the receiving connection is open
31679 and data is copied from one to the other.
31680
31681 An attempt to set this option for any recipient but the first
31682 for a mail will be quietly ignored.
31683 If a recipient-verify callout
31684 (with use_sender)
31685 connection is subsequently
31686 requested in the same ACL it is held open and used for
31687 any subsequent recipients and the data,
31688 otherwise one is made after the initial RCPT ACL completes.
31689
31690 Note that routers are used in verify mode,
31691 and cannot depend on content of received headers.
31692 Note also that headers cannot be
31693 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31694 Headers may be modified by routers (subject to the above) and transports.
31695 The &'Received-By:'& header is generated as soon as the body reception starts,
31696 rather than the traditional time after the full message is received;
31697 this will affect the timestamp.
31698
31699 All the usual ACLs are called; if one results in the message being
31700 rejected, all effort spent in delivery (including the costs on
31701 the ultimate destination) will be wasted.
31702 Note that in the case of data-time ACLs this includes the entire
31703 message body.
31704
31705 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31706 of outgoing messages is done, because it sends data to the ultimate destination
31707 before the entire message has been received from the source.
31708 It is not supported for messages received with the SMTP PRDR
31709 or CHUNKING
31710 options in use.
31711
31712 Should the ultimate destination system positively accept or reject the mail,
31713 a corresponding indication is given to the source system and nothing is queued.
31714 If the item is successfully delivered in cutthrough mode
31715 the delivery log lines are tagged with ">>" rather than "=>" and appear
31716 before the acceptance "<=" line.
31717
31718 If there is a temporary error the item is queued for later delivery in the
31719 usual fashion.
31720 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31721 to the control; the default value is &"spool"& and the alternate value
31722 &"pass"& copies an SMTP defer response from the target back to the initiator
31723 and does not queue the message.
31724 Note that this is independent of any recipient verify conditions in the ACL.
31725
31726 Delivery in this mode avoids the generation of a bounce mail to a
31727 (possibly faked)
31728 sender when the destination system is doing content-scan based rejection.
31729
31730
31731 .vitem &*control&~=&~debug/*&<&'options'&>
31732 .cindex "&ACL;" "enabling debug logging"
31733 .cindex "debugging" "enabling from an ACL"
31734 This control turns on debug logging, almost as though Exim had been invoked
31735 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31736 by default called &'debuglog'&.
31737
31738 Logging set up by the control will be maintained across spool residency.
31739
31740 Options are a slash-separated list.
31741 If an option takes an argument, the option name and argument are separated by
31742 an equals character.
31743 Several options are supported:
31744 .display
31745 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31746                      The argument, which may access any variables already defined,
31747                      is appended to the default name.
31748
31749 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31750                      using the same values as the &`-d`& command-line option.
31751
31752 stop                 Logging started with this control may be
31753                      stopped by using this option.
31754
31755 kill                 Logging started with this control may be
31756                      stopped by using this option.
31757                      Additionally the debug file will be removed,
31758                      providing one means for speculative debug tracing.
31759
31760 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31761                      for pre-trigger debug capture.
31762                      Debug lines are recorded in the buffer until
31763                      and if) a trigger occurs; at which time they are
31764                      dumped to the debug file.  Newer lines displace the
31765                      oldest if the buffer is full.  After a trigger,
31766                      immediate writes to file are done as normal.
31767
31768 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31769                      see above) to be copied to file.  A reason of &*now*&
31770                      take effect immediately; one of &*paniclog*& triggers
31771                      on a write to the panic log.
31772 .endd
31773
31774 Some examples (which depend on variables that don't exist in all
31775 contexts):
31776 .code
31777       control = debug
31778       control = debug/tag=.$sender_host_address
31779       control = debug/opts=+expand+acl
31780       control = debug/tag=.$message_exim_id/opts=+expand
31781       control = debug/kill
31782       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31783       control = debug/trigger=now
31784 .endd
31785
31786
31787 .vitem &*control&~=&~dkim_disable_verify*&
31788 .cindex "disable DKIM verify"
31789 .cindex "DKIM" "disable verify"
31790 This control turns off DKIM verification processing entirely.  For details on
31791 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31792
31793
31794 .vitem &*control&~=&~dmarc_disable_verify*&
31795 .cindex "disable DMARC verify"
31796 .cindex "DMARC" "disable verify"
31797 This control turns off DMARC verification processing entirely.  For details on
31798 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31799
31800
31801 .vitem &*control&~=&~dscp/*&<&'value'&>
31802 .cindex "&ACL;" "setting DSCP value"
31803 .cindex "DSCP" "inbound"
31804 This option causes the DSCP value associated with the socket for the inbound
31805 connection to be adjusted to a given value, given as one of a number of fixed
31806 strings or to numeric value.
31807 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31808 Common values include &`throughput`&, &`mincost`&, and on newer systems
31809 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31810
31811 The outbound packets from Exim will be marked with this value in the header
31812 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31813 that these values will have any effect, not be stripped by networking
31814 equipment, or do much of anything without cooperation with your Network
31815 Engineer and those of all network operators between the source and destination.
31816
31817
31818 .vitem &*control&~=&~enforce_sync*& &&&
31819        &*control&~=&~no_enforce_sync*&
31820 .cindex "SMTP" "synchronization checking"
31821 .cindex "synchronization checking in SMTP"
31822 These controls make it possible to be selective about when SMTP synchronization
31823 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31824 state of the switch (it is true by default). See the description of this option
31825 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31826
31827 The effect of these two controls lasts for the remainder of the SMTP
31828 connection. They can appear in any ACL except the one for the non-SMTP
31829 messages. The most straightforward place to put them is in the ACL defined by
31830 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31831 before the first synchronization check. The expected use is to turn off the
31832 synchronization checks for badly-behaved hosts that you nevertheless need to
31833 work with.
31834
31835
31836 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31837 .cindex "fake defer"
31838 .cindex "defer, fake"
31839 This control works in exactly the same way as &%fakereject%& (described below)
31840 except that it causes an SMTP 450 response after the message data instead of a
31841 550 response. You must take care when using &%fakedefer%& because it causes the
31842 messages to be duplicated when the sender retries. Therefore, you should not
31843 use &%fakedefer%& if the message is to be delivered normally.
31844
31845 .vitem &*control&~=&~fakereject/*&<&'message'&>
31846 .cindex "fake rejection"
31847 .cindex "rejection, fake"
31848 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31849 words, only when an SMTP message is being received. If Exim accepts the
31850 message, instead the final 250 response, a 550 rejection message is sent.
31851 However, Exim proceeds to deliver the message as normal. The control applies
31852 only to the current message, not to any subsequent ones that may be received in
31853 the same SMTP connection.
31854
31855 The text for the 550 response is taken from the &%control%& modifier. If no
31856 message is supplied, the following is used:
31857 .code
31858 550-Your message has been rejected but is being
31859 550-kept for evaluation.
31860 550-If it was a legitimate message, it may still be
31861 550 delivered to the target recipient(s).
31862 .endd
31863 This facility should be used with extreme caution.
31864
31865 .vitem &*control&~=&~freeze*&
31866 .cindex "frozen messages" "forcing in ACL"
31867 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31868 other words, only when a message is being received. If the message is accepted,
31869 it is placed on Exim's queue and frozen. The control applies only to the
31870 current message, not to any subsequent ones that may be received in the same
31871 SMTP connection.
31872
31873 This modifier can optionally be followed by &`/no_tell`&. If the global option
31874 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31875 is told about the freezing), provided all the &*control=freeze*& modifiers that
31876 are obeyed for the current message have the &`/no_tell`& option.
31877
31878 .vitem &*control&~=&~no_delay_flush*&
31879 .cindex "SMTP" "output flushing, disabling for delay"
31880 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31881 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31882 use. This control, as long as it is encountered before the &%delay%& modifier,
31883 disables such output flushing.
31884
31885 .vitem &*control&~=&~no_callout_flush*&
31886 .cindex "SMTP" "output flushing, disabling for callout"
31887 Exim normally flushes SMTP output before performing a callout in an ACL, to
31888 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31889 use. This control, as long as it is encountered before the &%verify%& condition
31890 that causes the callout, disables such output flushing.
31891
31892 .vitem &*control&~=&~no_mbox_unspool*&
31893 This control is available when Exim is compiled with the content scanning
31894 extension. Content scanning may require a copy of the current message, or parts
31895 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31896 or spam scanner. Normally, such copies are deleted when they are no longer
31897 needed. If this control is set, the copies are not deleted. The control applies
31898 only to the current message, not to any subsequent ones that may be received in
31899 the same SMTP connection. It is provided for debugging purposes and is unlikely
31900 to be useful in production.
31901
31902 .vitem &*control&~=&~no_multiline_responses*&
31903 .cindex "multiline responses, suppressing"
31904 This control is permitted for any ACL except the one for non-SMTP messages.
31905 It seems that there are broken clients in use that cannot handle multiline
31906 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31907
31908 If this control is set, multiline SMTP responses from ACL rejections are
31909 suppressed. One way of doing this would have been to put out these responses as
31910 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31911 (&"use multiline responses for more"& it says &-- ha!), and some of the
31912 responses might get close to that. So this facility, which is after all only a
31913 sop to broken clients, is implemented by doing two very easy things:
31914
31915 .ilist
31916 Extra information that is normally output as part of a rejection caused by
31917 sender verification failure is omitted. Only the final line (typically &"sender
31918 verification failed"&) is sent.
31919 .next
31920 If a &%message%& modifier supplies a multiline response, only the first
31921 line is output.
31922 .endlist
31923
31924 The setting of the switch can, of course, be made conditional on the
31925 calling host. Its effect lasts until the end of the SMTP connection.
31926
31927 .vitem &*control&~=&~no_pipelining*&
31928 .cindex "PIPELINING" "suppressing advertising"
31929 .cindex "ESMTP extensions" PIPELINING
31930 This control turns off the advertising of the PIPELINING extension to SMTP in
31931 the current session. To be useful, it must be obeyed before Exim sends its
31932 response to an EHLO command. Therefore, it should normally appear in an ACL
31933 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31934 &%pipelining_advertise_hosts%&.
31935
31936 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31937        &*control&~=&~queue_only*&
31938 .oindex "&%queue%&"
31939 .oindex "&%queue_only%&"
31940 .cindex "queueing incoming messages"
31941 .cindex queueing "forcing in ACL"
31942 .cindex "first pass routing"
31943 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31944 other words, only when a message is being received. If the message is accepted,
31945 it is placed on Exim's queue and left there for delivery by a subsequent queue
31946 runner.
31947 If used with no options set,
31948 no immediate delivery process is started. In other words, it has the
31949 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31950
31951 If the &'first_pass_route'& option is given then
31952 the behaviour is like the command-line &'-oqds'& option;
31953 a delivery process is started which stops short of making
31954 any SMTP delivery.  The benefit is that the hints database will be updated for
31955 the message being waiting for a specific host, and a later queue run will be
31956 able to send all such messages on a single connection.
31957
31958 The control only applies to the current message, not to any subsequent ones that
31959  may be received in the same SMTP connection.
31960
31961 .vitem &*control&~=&~submission/*&<&'options'&>
31962 .cindex "message" "submission"
31963 .cindex "submission mode"
31964 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31965 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31966 the current message is a submission from a local MUA. In this case, Exim
31967 operates in &"submission mode"&, and applies certain fixups to the message if
31968 necessary. For example, it adds a &'Date:'& header line if one is not present.
31969 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31970 late (the message has already been created).
31971
31972 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31973 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31974 submission mode; the available options for this control are described there.
31975 The control applies only to the current message, not to any subsequent ones
31976 that may be received in the same SMTP connection.
31977
31978 .vitem &*control&~=&~suppress_local_fixups*&
31979 .cindex "submission fixups, suppressing"
31980 This control applies to locally submitted (non TCP/IP) messages, and is the
31981 complement of &`control = submission`&. It disables the fixups that are
31982 normally applied to locally-submitted messages. Specifically:
31983
31984 .ilist
31985 Any &'Sender:'& header line is left alone (in this respect, it is a
31986 dynamic version of &%local_sender_retain%&).
31987 .next
31988 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31989 .next
31990 There is no check that &'From:'& corresponds to the actual sender.
31991 .endlist ilist
31992
31993 This control may be useful when a remotely-originated message is accepted,
31994 passed to some scanning program, and then re-submitted for delivery. It can be
31995 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31996 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31997 data is read.
31998
31999 &*Note:*& This control applies only to the current message, not to any others
32000 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32001
32002 .vitem &*control&~=&~utf8_downconvert*&
32003 This control enables conversion of UTF-8 in message envelope addresses
32004 to a-label form.
32005 For details see section &<<SECTi18nMTA>>&.
32006 .endlist vlist
32007
32008
32009 .section "Summary of message fixup control" "SECTsummesfix"
32010 All four possibilities for message fixups can be specified:
32011
32012 .ilist
32013 Locally submitted, fixups applied: the default.
32014 .next
32015 Locally submitted, no fixups applied: use
32016 &`control = suppress_local_fixups`&.
32017 .next
32018 Remotely submitted, no fixups applied: the default.
32019 .next
32020 Remotely submitted, fixups applied: use &`control = submission`&.
32021 .endlist
32022
32023
32024
32025 .section "Adding header lines in ACLs" "SECTaddheadacl"
32026 .cindex "header lines" "adding in an ACL"
32027 .cindex "header lines" "position of added lines"
32028 .cindex "&%add_header%& ACL modifier"
32029 The &%add_header%& modifier can be used to add one or more extra header lines
32030 to an incoming message, as in this example:
32031 .code
32032 warn dnslists = sbl.spamhaus.org : \
32033                 dialup.mail-abuse.org
32034      add_header = X-blacklisted-at: $dnslist_domain
32035 .endd
32036 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32037 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32038 receiving a message). The message must ultimately be accepted for
32039 &%add_header%& to have any significant effect. You can use &%add_header%& with
32040 any ACL verb, including &%deny%& (though this is potentially useful only in a
32041 RCPT ACL).
32042
32043 Headers will not be added to the message if the modifier is used in
32044 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32045
32046 Leading and trailing newlines are removed from
32047 the data for the &%add_header%& modifier; if it then
32048 contains one or more newlines that
32049 are not followed by a space or a tab, it is assumed to contain multiple header
32050 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32051 front of any line that is not a valid header line.
32052
32053 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32054 They are added to the message before processing the DATA and MIME ACLs.
32055 However, if an identical header line is requested more than once, only one copy
32056 is actually added to the message. Further header lines may be accumulated
32057 during the DATA and MIME ACLs, after which they are added to the message, again
32058 with duplicates suppressed. Thus, it is possible to add two identical header
32059 lines to an SMTP message, but only if one is added before DATA and one after.
32060 In the case of non-SMTP messages, new headers are accumulated during the
32061 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32062 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32063 are included in the entry that is written to the reject log.
32064
32065 .cindex "header lines" "added; visibility of"
32066 Header lines are not visible in string expansions
32067 of message headers
32068 until they are added to the
32069 message. It follows that header lines defined in the MAIL, RCPT, and predata
32070 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32071 header lines that are added by the DATA or MIME ACLs are not visible in those
32072 ACLs. Because of this restriction, you cannot use header lines as a way of
32073 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32074 this, you can use ACL variables, as described in section
32075 &<<SECTaclvariables>>&.
32076
32077 The list of headers yet to be added is given by the &%$headers_added%& variable.
32078
32079 The &%add_header%& modifier acts immediately as it is encountered during the
32080 processing of an ACL. Notice the difference between these two cases:
32081 .display
32082 &`accept add_header = ADDED: some text`&
32083 &`       `&<&'some condition'&>
32084
32085 &`accept `&<&'some condition'&>
32086 &`       add_header = ADDED: some text`&
32087 .endd
32088 In the first case, the header line is always added, whether or not the
32089 condition is true. In the second case, the header line is added only if the
32090 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32091 ACL statement. All those that are encountered before a condition fails are
32092 honoured.
32093
32094 .cindex "&%warn%& ACL verb"
32095 For compatibility with previous versions of Exim, a &%message%& modifier for a
32096 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32097 effect only if all the conditions are true, even if it appears before some of
32098 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32099 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32100 are present on a &%warn%& verb, both are processed according to their
32101 specifications.
32102
32103 By default, new header lines are added to a message at the end of the existing
32104 header lines. However, you can specify that any particular header line should
32105 be added right at the start (before all the &'Received:'& lines), immediately
32106 after the first block of &'Received:'& lines, or immediately before any line
32107 that is not a &'Received:'& or &'Resent-something:'& header.
32108
32109 This is done by specifying &":at_start:"&, &":after_received:"&, or
32110 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32111 header line, respectively. (Header text cannot start with a colon, as there has
32112 to be a header name first.) For example:
32113 .code
32114 warn add_header = \
32115        :after_received:X-My-Header: something or other...
32116 .endd
32117 If more than one header line is supplied in a single &%add_header%& modifier,
32118 each one is treated independently and can therefore be placed differently. If
32119 you add more than one line at the start, or after the Received: block, they end
32120 up in reverse order.
32121
32122 &*Warning*&: This facility currently applies only to header lines that are
32123 added in an ACL. It does NOT work for header lines that are added in a
32124 system filter or in a router or transport.
32125
32126
32127
32128 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32129 .cindex "header lines" "removing in an ACL"
32130 .cindex "header lines" "position of removed lines"
32131 .cindex "&%remove_header%& ACL modifier"
32132 The &%remove_header%& modifier can be used to remove one or more header lines
32133 from an incoming message, as in this example:
32134 .code
32135 warn   message        = Remove internal headers
32136        remove_header  = x-route-mail1 : x-route-mail2
32137 .endd
32138 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32139 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32140 receiving a message). The message must ultimately be accepted for
32141 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32142 with any ACL verb, including &%deny%&, though this is really not useful for
32143 any verb that doesn't result in a delivered message.
32144
32145 Headers will not be removed from the message if the modifier is used in
32146 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32147
32148 More than one header can be removed at the same time by using a colon separated
32149 list of header specifiers.
32150 .new
32151 If a specifier does not start with a circumflex (^)
32152 then it is treated as a header name.
32153 The header name matching is case insensitive.
32154 If it does, then it is treated as a (front-anchored)
32155 regular expression applied to the whole header.
32156
32157 &*Note*&: The colon terminating a header name will need to be doubled
32158 if used in an RE, and there can legitimately be whitepace before it.
32159
32160 Example:
32161 .code
32162 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32163 .endd
32164 .wen
32165
32166 List expansion is not performed, so you cannot use hostlists to
32167 create a list of headers, however both connection and message variable expansion
32168 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32169 .code
32170 warn   hosts           = +internal_hosts
32171        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32172 warn   message         = Remove internal headers
32173        remove_header   = $acl_c_ihdrs
32174 .endd
32175 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32176 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32177 If multiple header lines match, all are removed.
32178 There is no harm in attempting to remove the same header twice nor in removing
32179 a non-existent header. Further header specifiers for removal may be accumulated
32180 during the DATA and MIME ACLs, after which matching headers are removed
32181 if present. In the case of non-SMTP messages, remove speifiers are
32182 accumulated during the non-SMTP ACLs, and are acted on after
32183 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32184 ACL, there really is no effect because there is no logging of what headers
32185 would have been removed.
32186
32187 .cindex "header lines" "removed; visibility of"
32188 Header lines are not visible in string expansions until the DATA phase when it
32189 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32190 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32191 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32192 this restriction, you cannot use header lines as a way of controlling data
32193 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32194 you should instead use ACL variables, as described in section
32195 &<<SECTaclvariables>>&.
32196
32197 The &%remove_header%& modifier acts immediately as it is encountered during the
32198 processing of an ACL. Notice the difference between these two cases:
32199 .display
32200 &`accept remove_header = X-Internal`&
32201 &`       `&<&'some condition'&>
32202
32203 &`accept `&<&'some condition'&>
32204 &`       remove_header = X-Internal`&
32205 .endd
32206 In the first case, the header line is always removed, whether or not the
32207 condition is true. In the second case, the header line is removed only if the
32208 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32209 same ACL statement. All those that are encountered before a condition fails
32210 are honoured.
32211
32212 &*Warning*&: This facility currently applies only to header lines that are
32213 present during ACL processing. It does NOT remove header lines that are added
32214 in a system filter or in a router or transport.
32215
32216
32217
32218
32219 .section "ACL conditions" "SECTaclconditions"
32220 .cindex "&ACL;" "conditions; list of"
32221 Some of the conditions listed in this section are available only when Exim is
32222 compiled with the content-scanning extension. They are included here briefly
32223 for completeness. More detailed descriptions can be found in the discussion on
32224 content scanning in chapter &<<CHAPexiscan>>&.
32225
32226 Not all conditions are relevant in all circumstances. For example, testing
32227 senders and recipients does not make sense in an ACL that is being run as the
32228 result of the arrival of an ETRN command, and checks on message headers can be
32229 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32230 can use the same condition (with different parameters) more than once in the
32231 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32232 The conditions are as follows:
32233
32234
32235 .vlist
32236 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32237 .cindex "&ACL;" "nested"
32238 .cindex "&ACL;" "indirect"
32239 .cindex "&ACL;" "arguments"
32240 .cindex "&%acl%& ACL condition"
32241 The possible values of the argument are the same as for the
32242 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32243 &"accept"& the condition is true; if it returns &"deny"& the condition is
32244 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32245 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32246 condition false. This means that further processing of the &%warn%& verb
32247 ceases, but processing of the ACL continues.
32248
32249 If the argument is a named ACL, up to nine space-separated optional values
32250 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32251 and $acl_narg is set to the count of values.
32252 Previous values of these variables are restored after the call returns.
32253 The name and values are expanded separately.
32254 Note that spaces in complex expansions which are used as arguments
32255 will act as argument separators.
32256
32257 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32258 the connection is dropped. If it returns &"discard"&, the verb must be
32259 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32260 conditions are tested.
32261
32262 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32263 loops. This condition allows you to use different ACLs in different
32264 circumstances. For example, different ACLs can be used to handle RCPT commands
32265 for different local users or different local domains.
32266
32267 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32268 .cindex "&%authenticated%& ACL condition"
32269 .cindex "authentication" "ACL checking"
32270 .cindex "&ACL;" "testing for authentication"
32271 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32272 the name of the authenticator is tested against the list. To test for
32273 authentication by any authenticator, you can set
32274 .code
32275 authenticated = *
32276 .endd
32277
32278 .vitem &*condition&~=&~*&<&'string'&>
32279 .cindex "&%condition%& ACL condition"
32280 .cindex "customizing" "ACL condition"
32281 .cindex "&ACL;" "customized test"
32282 .cindex "&ACL;" "testing, customized"
32283 This feature allows you to make up custom conditions. If the result of
32284 expanding the string is an empty string, the number zero, or one of the strings
32285 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32286 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32287 any other value, some error is assumed to have occurred, and the ACL returns
32288 &"defer"&. However, if the expansion is forced to fail, the condition is
32289 ignored. The effect is to treat it as true, whether it is positive or
32290 negative.
32291
32292 .vitem &*decode&~=&~*&<&'location'&>
32293 .cindex "&%decode%& ACL condition"
32294 This condition is available only when Exim is compiled with the
32295 content-scanning extension, and it is allowed only in the ACL defined by
32296 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32297 If all goes well, the condition is true. It is false only if there are
32298 problems such as a syntax error or a memory shortage. For more details, see
32299 chapter &<<CHAPexiscan>>&.
32300
32301 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32302 .cindex "&%dnslists%& ACL condition"
32303 .cindex "DNS list" "in ACL"
32304 .cindex "black list (DNS)"
32305 .cindex "&ACL;" "testing a DNS list"
32306 This condition checks for entries in DNS black lists. These are also known as
32307 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32308 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32309 different variants of this condition to describe briefly here. See sections
32310 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32311
32312 .vitem &*domains&~=&~*&<&'domain&~list'&>
32313 .cindex "&%domains%& ACL condition"
32314 .cindex "domain" "ACL checking"
32315 .cindex "&ACL;" "testing a recipient domain"
32316 .vindex "&$domain_data$&"
32317 This condition is relevant only in a RCPT ACL. It checks that the domain
32318 of the recipient address is in the domain list. If percent-hack processing is
32319 enabled, it is done before this test is done. If the check succeeds with a
32320 lookup, the result of the lookup is placed in &$domain_data$& until the next
32321 &%domains%& test.
32322
32323 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32324 use &%domains%& in a DATA ACL.
32325
32326
32327 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32328 .cindex "&%encrypted%& ACL condition"
32329 .cindex "encryption" "checking in an ACL"
32330 .cindex "&ACL;" "testing for encryption"
32331 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32332 name of the cipher suite in use is tested against the list. To test for
32333 encryption without testing for any specific cipher suite(s), set
32334 .code
32335 encrypted = *
32336 .endd
32337
32338
32339 .vitem &*hosts&~=&~*&<&'host&~list'&>
32340 .cindex "&%hosts%& ACL condition"
32341 .cindex "host" "ACL checking"
32342 .cindex "&ACL;" "testing the client host"
32343 This condition tests that the calling host matches the host list. If you have
32344 name lookups or wildcarded host names and IP addresses in the same host list,
32345 you should normally put the IP addresses first. For example, you could have:
32346 .code
32347 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32348 .endd
32349 The lookup in this example uses the host name for its key. This is implied by
32350 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32351 and it wouldn't matter which way round you had these two items.)
32352
32353 The reason for the problem with host names lies in the left-to-right way that
32354 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32355 but when it reaches an item that requires a host name, it fails if it cannot
32356 find a host name to compare with the pattern. If the above list is given in the
32357 opposite order, the &%accept%& statement fails for a host whose name cannot be
32358 found, even if its IP address is 10.9.8.7.
32359
32360 If you really do want to do the name check first, and still recognize the IP
32361 address even if the name lookup fails, you can rewrite the ACL like this:
32362 .code
32363 accept hosts = dbm;/etc/friendly/hosts
32364 accept hosts = 10.9.8.7
32365 .endd
32366 The default action on failing to find the host name is to assume that the host
32367 is not in the list, so the first &%accept%& statement fails. The second
32368 statement can then check the IP address.
32369
32370 .vindex "&$host_data$&"
32371 If a &%hosts%& condition is satisfied by means of a lookup, the result
32372 of the lookup is made available in the &$host_data$& variable. This
32373 allows you, for example, to set up a statement like this:
32374 .code
32375 deny  hosts = net-lsearch;/some/file
32376       message = $host_data
32377 .endd
32378 which gives a custom error message for each denied host.
32379
32380 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32381 .cindex "&%local_parts%& ACL condition"
32382 .cindex "local part" "ACL checking"
32383 .cindex "&ACL;" "testing a local part"
32384 .vindex "&$local_part_data$&"
32385 This condition is relevant only in a RCPT ACL. It checks that the local
32386 part of the recipient address is in the list. If percent-hack processing is
32387 enabled, it is done before this test. If the check succeeds with a lookup, the
32388 result of the lookup is placed in &$local_part_data$&, which remains set until
32389 the next &%local_parts%& test.
32390
32391 .vitem &*malware&~=&~*&<&'option'&>
32392 .cindex "&%malware%& ACL condition"
32393 .cindex "&ACL;" "virus scanning"
32394 .cindex "&ACL;" "scanning for viruses"
32395 This condition is available only when Exim is compiled with the
32396 content-scanning extension
32397 and only after a DATA command.
32398 It causes the incoming message to be scanned for
32399 viruses. For details, see chapter &<<CHAPexiscan>>&.
32400
32401 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32402 .cindex "&%mime_regex%& ACL condition"
32403 .cindex "&ACL;" "testing by regex matching"
32404 This condition is available only when Exim is compiled with the
32405 content-scanning extension, and it is allowed only in the ACL defined by
32406 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32407 with any of the regular expressions. For details, see chapter
32408 &<<CHAPexiscan>>&.
32409
32410 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32411 .cindex "rate limiting"
32412 This condition can be used to limit the rate at which a user or host submits
32413 messages. Details are given in section &<<SECTratelimiting>>&.
32414
32415 .vitem &*recipients&~=&~*&<&'address&~list'&>
32416 .cindex "&%recipients%& ACL condition"
32417 .cindex "recipient" "ACL checking"
32418 .cindex "&ACL;" "testing a recipient"
32419 This condition is relevant only in a RCPT ACL. It checks the entire
32420 recipient address against a list of recipients.
32421
32422 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32423 .cindex "&%regex%& ACL condition"
32424 .cindex "&ACL;" "testing by regex matching"
32425 This condition is available only when Exim is compiled with the
32426 content-scanning extension, and is available only in the DATA, MIME, and
32427 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32428 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32429
32430 .vitem &*seen&~=&~*&<&'parameters'&>
32431 .cindex "&%seen%& ACL condition"
32432 This condition can be used to test if a situation has been previously met,
32433 for example for greylisting.
32434 Details are given in section &<<SECTseen>>&.
32435
32436 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32437 .cindex "&%sender_domains%& ACL condition"
32438 .cindex "sender" "ACL checking"
32439 .cindex "&ACL;" "testing a sender domain"
32440 .vindex "&$domain$&"
32441 .vindex "&$sender_address_domain$&"
32442 This condition tests the domain of the sender of the message against the given
32443 domain list. &*Note*&: The domain of the sender address is in
32444 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32445 of this condition. This is an exception to the general rule for testing domain
32446 lists. It is done this way so that, if this condition is used in an ACL for a
32447 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32448 influence the sender checking.
32449
32450 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32451 relaying, because sender addresses are easily, and commonly, forged.
32452
32453 .vitem &*senders&~=&~*&<&'address&~list'&>
32454 .cindex "&%senders%& ACL condition"
32455 .cindex "sender" "ACL checking"
32456 .cindex "&ACL;" "testing a sender"
32457 This condition tests the sender of the message against the given list. To test
32458 for a bounce message, which has an empty sender, set
32459 .code
32460 senders = :
32461 .endd
32462 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32463 relaying, because sender addresses are easily, and commonly, forged.
32464
32465 .vitem &*spam&~=&~*&<&'username'&>
32466 .cindex "&%spam%& ACL condition"
32467 .cindex "&ACL;" "scanning for spam"
32468 This condition is available only when Exim is compiled with the
32469 content-scanning extension. It causes the incoming message to be scanned by
32470 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32471
32472 .vitem &*verify&~=&~certificate*&
32473 .cindex "&%verify%& ACL condition"
32474 .cindex "TLS" "client certificate verification"
32475 .cindex "certificate" "verification of client"
32476 .cindex "&ACL;" "certificate verification"
32477 .cindex "&ACL;" "testing a TLS certificate"
32478 This condition is true in an SMTP session if the session is encrypted, and a
32479 certificate was received from the client, and the certificate was verified. The
32480 server requests a certificate only if the client matches &%tls_verify_hosts%&
32481 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32482
32483 .vitem &*verify&~=&~csa*&
32484 .cindex "CSA verification"
32485 This condition checks whether the sending host (the client) is authorized to
32486 send email. Details of how this works are given in section
32487 &<<SECTverifyCSA>>&.
32488
32489 .vitem &*verify&~=&~header_names_ascii*&
32490 .cindex "&%verify%& ACL condition"
32491 .cindex "&ACL;" "verifying header names only ASCII"
32492 .cindex "header lines" "verifying header names only ASCII"
32493 .cindex "verifying" "header names only ASCII"
32494 This condition is relevant only in an ACL that is run after a message has been
32495 received.
32496 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32497 It checks all header names (not the content) to make sure
32498 there are no non-ASCII characters, also excluding control characters.  The
32499 allowable characters are decimal ASCII values 33 through 126.
32500
32501 Exim itself will handle headers with non-ASCII characters, but it can cause
32502 problems for downstream applications, so this option will allow their
32503 detection and rejection in the DATA ACL's.
32504
32505 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32506 .cindex "&%verify%& ACL condition"
32507 .cindex "&ACL;" "verifying sender in the header"
32508 .cindex "header lines" "verifying the sender in"
32509 .cindex "sender" "verifying in header"
32510 .cindex "verifying" "sender in header"
32511 This condition is relevant only in an ACL that is run after a message has been
32512 received, that is, in an ACL specified by &%acl_smtp_data%& or
32513 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32514 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32515 is loosely thought of as a &"sender"& address (hence the name of the test).
32516 However, an address that appears in one of these headers need not be an address
32517 that accepts bounce messages; only sender addresses in envelopes are required
32518 to accept bounces. Therefore, if you use the callout option on this check, you
32519 might want to arrange for a non-empty address in the MAIL command.
32520
32521 Details of address verification and the options are given later, starting at
32522 section &<<SECTaddressverification>>& (callouts are described in section
32523 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32524 condition to restrict it to bounce messages only:
32525 .code
32526 deny    senders = :
32527        !verify  = header_sender
32528         message = A valid sender header is required for bounces
32529 .endd
32530
32531 .vitem &*verify&~=&~header_syntax*&
32532 .cindex "&%verify%& ACL condition"
32533 .cindex "&ACL;" "verifying header syntax"
32534 .cindex "header lines" "verifying syntax"
32535 .cindex "verifying" "header syntax"
32536 This condition is relevant only in an ACL that is run after a message has been
32537 received, that is, in an ACL specified by &%acl_smtp_data%& or
32538 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32539 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32540 and &'Bcc:'&), returning true if there are no problems.
32541 Unqualified addresses (local parts without domains) are
32542 permitted only in locally generated messages and from hosts that match
32543 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32544 appropriate.
32545
32546 Note that this condition is a syntax check only. However, a common spamming
32547 ploy used to be to send syntactically invalid headers such as
32548 .code
32549 To: @
32550 .endd
32551 and this condition can be used to reject such messages, though they are not as
32552 common as they used to be.
32553
32554 .vitem &*verify&~=&~helo*&
32555 .cindex "&%verify%& ACL condition"
32556 .cindex "&ACL;" "verifying HELO/EHLO"
32557 .cindex "HELO" "verifying"
32558 .cindex "EHLO" "verifying"
32559 .cindex "verifying" "EHLO"
32560 .cindex "verifying" "HELO"
32561 This condition is true if a HELO or EHLO command has been received from the
32562 client host, and its contents have been verified. If there has been no previous
32563 attempt to verify the HELO/EHLO contents, it is carried out when this
32564 condition is encountered. See the description of the &%helo_verify_hosts%& and
32565 &%helo_try_verify_hosts%& options for details of how to request verification
32566 independently of this condition, and for detail of the verification.
32567
32568 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32569 option), this condition is always true.
32570
32571
32572 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32573 .cindex "verifying" "not blind"
32574 .cindex "bcc recipients, verifying none"
32575 This condition checks that there are no blind (bcc) recipients in the message.
32576 Every envelope recipient must appear either in a &'To:'& header line or in a
32577 &'Cc:'& header line for this condition to be true. Local parts are checked
32578 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32579 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32580 used only in a DATA or non-SMTP ACL.
32581
32582 There is one possible option, &`case_insensitive`&.  If this is present then
32583 local parts are checked case-insensitively.
32584
32585 There are, of course, many legitimate messages that make use of blind (bcc)
32586 recipients. This check should not be used on its own for blocking messages.
32587
32588
32589 .vitem &*verify&~=&~recipient/*&<&'options'&>
32590 .cindex "&%verify%& ACL condition"
32591 .cindex "&ACL;" "verifying recipient"
32592 .cindex "recipient" "verifying"
32593 .cindex "verifying" "recipient"
32594 .vindex "&$address_data$&"
32595 This condition is relevant only after a RCPT command. It verifies the current
32596 recipient. Details of address verification are given later, starting at section
32597 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32598 of &$address_data$& is the last value that was set while routing the address.
32599 This applies even if the verification fails. When an address that is being
32600 verified is redirected to a single address, verification continues with the new
32601 address, and in that case, the subsequent value of &$address_data$& is the
32602 value for the child address.
32603
32604 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32605 .cindex "&%verify%& ACL condition"
32606 .cindex "&ACL;" "verifying host reverse lookup"
32607 .cindex "host" "verifying reverse lookup"
32608 This condition ensures that a verified host name has been looked up from the IP
32609 address of the client host. (This may have happened already if the host name
32610 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32611 Verification ensures that the host name obtained from a reverse DNS lookup, or
32612 one of its aliases, does, when it is itself looked up in the DNS, yield the
32613 original IP address.
32614
32615 There is one possible option, &`defer_ok`&.  If this is present and a
32616 DNS operation returns a temporary error, the verify condition succeeds.
32617
32618 If this condition is used for a locally generated message (that is, when there
32619 is no client host involved), it always succeeds.
32620
32621 .vitem &*verify&~=&~sender/*&<&'options'&>
32622 .cindex "&%verify%& ACL condition"
32623 .cindex "&ACL;" "verifying sender"
32624 .cindex "sender" "verifying"
32625 .cindex "verifying" "sender"
32626 This condition is relevant only after a MAIL or RCPT command, or after a
32627 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32628 the message's sender is empty (that is, this is a bounce message), the
32629 condition is true. Otherwise, the sender address is verified.
32630
32631 .vindex "&$address_data$&"
32632 .vindex "&$sender_address_data$&"
32633 If there is data in the &$address_data$& variable at the end of routing, its
32634 value is placed in &$sender_address_data$& at the end of verification. This
32635 value can be used in subsequent conditions and modifiers in the same ACL
32636 statement. It does not persist after the end of the current statement. If you
32637 want to preserve the value for longer, you can save it in an ACL variable.
32638
32639 Details of verification are given later, starting at section
32640 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32641 to avoid doing it more than once per message.
32642
32643 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32644 .cindex "&%verify%& ACL condition"
32645 This is a variation of the previous option, in which a modified address is
32646 verified as a sender.
32647
32648 Note that '/' is legal in local-parts; if the address may have such
32649 (eg. is generated from the received message)
32650 they must be protected from the options parsing by doubling:
32651 .code
32652 verify = sender=${listquote{/}{${address:$h_sender:}}}
32653 .endd
32654 .endlist
32655
32656
32657
32658 .section "Using DNS lists" "SECTmorednslists"
32659 .cindex "DNS list" "in ACL"
32660 .cindex "black list (DNS)"
32661 .cindex "&ACL;" "testing a DNS list"
32662 In its simplest form, the &%dnslists%& condition tests whether the calling host
32663 is on at least one of a number of DNS lists by looking up the inverted IP
32664 address in one or more DNS domains. (Note that DNS list domains are not mail
32665 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32666 special options instead.) For example, if the calling host's IP
32667 address is 192.168.62.43, and the ACL statement is
32668 .code
32669 deny dnslists = blackholes.mail-abuse.org : \
32670                 dialups.mail-abuse.org
32671 .endd
32672 the following records are looked up:
32673 .code
32674 43.62.168.192.blackholes.mail-abuse.org
32675 43.62.168.192.dialups.mail-abuse.org
32676 .endd
32677 As soon as Exim finds an existing DNS record, processing of the list stops.
32678 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32679 to test that a host is on more than one list (an &"and"& conjunction), you can
32680 use two separate conditions:
32681 .code
32682 deny dnslists = blackholes.mail-abuse.org
32683      dnslists = dialups.mail-abuse.org
32684 .endd
32685 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32686 behaves as if the host does not match the list item, that is, as if the DNS
32687 record does not exist. If there are further items in the DNS list, they are
32688 processed.
32689
32690 This is usually the required action when &%dnslists%& is used with &%deny%&
32691 (which is the most common usage), because it prevents a DNS failure from
32692 blocking mail. However, you can change this behaviour by putting one of the
32693 following special items in the list:
32694 .itable none 0 0 2 25* left 75* left
32695 .irow "+include_unknown"   "behave as if the item is on the list"
32696 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32697 .irow "+defer_unknown  "   "give a temporary error"
32698 .endtable
32699 .cindex "&`+include_unknown`&"
32700 .cindex "&`+exclude_unknown`&"
32701 .cindex "&`+defer_unknown`&"
32702 Each of these applies to any subsequent items on the list. For example:
32703 .code
32704 deny dnslists = +defer_unknown : foo.bar.example
32705 .endd
32706 Testing the list of domains stops as soon as a match is found. If you want to
32707 warn for one list and block for another, you can use two different statements:
32708 .code
32709 deny  dnslists = blackholes.mail-abuse.org
32710 warn  dnslists = dialups.mail-abuse.org
32711       message  = X-Warn: sending host is on dialups list
32712 .endd
32713 .cindex caching "of dns lookup"
32714 .cindex DNS TTL
32715 DNS list lookups are cached by Exim for the duration of the SMTP session
32716 (but limited by the DNS return TTL value),
32717 so a lookup based on the IP address is done at most once for any incoming
32718 connection (assuming long-enough TTL).
32719 Exim does not share information between multiple incoming
32720 connections (but your local name server cache should be active).
32721
32722 There are a number of DNS lists to choose from, some commercial, some free,
32723 or free for small deployments.  An overview can be found at
32724 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32725
32726
32727
32728 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32729 .cindex "DNS list" "keyed by explicit IP address"
32730 By default, the IP address that is used in a DNS list lookup is the IP address
32731 of the calling host. However, you can specify another IP address by listing it
32732 after the domain name, introduced by a slash. For example:
32733 .code
32734 deny dnslists = black.list.tld/192.168.1.2
32735 .endd
32736 This feature is not very helpful with explicit IP addresses; it is intended for
32737 use with IP addresses that are looked up, for example, the IP addresses of the
32738 MX hosts or nameservers of an email sender address. For an example, see section
32739 &<<SECTmulkeyfor>>& below.
32740
32741
32742
32743
32744 .subsection "DNS lists keyed on domain names" SECID202
32745 .cindex "DNS list" "keyed by domain name"
32746 There are some lists that are keyed on domain names rather than inverted IP
32747 addresses (see, e.g., the &'domain based zones'& link at
32748 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32749 with these lists. You can change the name that is looked up in a DNS list by
32750 listing it after the domain name, introduced by a slash. For example,
32751 .code
32752 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32753       message  = Sender's domain is listed at $dnslist_domain
32754 .endd
32755 This particular example is useful only in ACLs that are obeyed after the
32756 RCPT or DATA commands, when a sender address is available. If (for
32757 example) the message's sender is &'user@tld.example'& the name that is looked
32758 up by this example is
32759 .code
32760 tld.example.dsn.rfc-ignorant.org
32761 .endd
32762 A single &%dnslists%& condition can contain entries for both names and IP
32763 addresses. For example:
32764 .code
32765 deny dnslists = sbl.spamhaus.org : \
32766                 dsn.rfc-ignorant.org/$sender_address_domain
32767 .endd
32768 The first item checks the sending host's IP address; the second checks a domain
32769 name. The whole condition is true if either of the DNS lookups succeeds.
32770
32771
32772
32773
32774 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32775 .cindex "DNS list" "multiple keys for"
32776 The syntax described above for looking up explicitly-defined values (either
32777 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32778 name for the DNS list, what follows the slash can in fact be a list of items.
32779 As with all lists in Exim, the default separator is a colon. However, because
32780 this is a sublist within the list of DNS blacklist domains, it is necessary
32781 either to double the separators like this:
32782 .code
32783 dnslists = black.list.tld/name.1::name.2
32784 .endd
32785 or to change the separator character, like this:
32786 .code
32787 dnslists = black.list.tld/<;name.1;name.2
32788 .endd
32789 If an item in the list is an IP address, it is inverted before the DNS
32790 blacklist domain is appended. If it is not an IP address, no inversion
32791 occurs. Consider this condition:
32792 .code
32793 dnslists = black.list.tld/<;192.168.1.2;a.domain
32794 .endd
32795 The DNS lookups that occur are:
32796 .code
32797 2.1.168.192.black.list.tld
32798 a.domain.black.list.tld
32799 .endd
32800 Once a DNS record has been found (that matches a specific IP return
32801 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32802 are done. If there is a temporary DNS error, the rest of the sublist of domains
32803 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32804 only if no other DNS lookup in this sublist succeeds. In other words, a
32805 successful lookup for any of the items in the sublist overrides a temporary
32806 error for a previous item.
32807
32808 The ability to supply a list of items after the slash is in some sense just a
32809 syntactic convenience. These two examples have the same effect:
32810 .code
32811 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32812 dnslists = black.list.tld/a.domain::b.domain
32813 .endd
32814 However, when the data for the list is obtained from a lookup, the second form
32815 is usually much more convenient. Consider this example:
32816 .code
32817 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32818                                    ${lookup dnsdb {>|mxh=\
32819                                    $sender_address_domain} }} }
32820      message  = The mail servers for the domain \
32821                 $sender_address_domain \
32822                 are listed at $dnslist_domain ($dnslist_value); \
32823                 see $dnslist_text.
32824 .endd
32825 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32826 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32827 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32828 of expanding the condition might be something like this:
32829 .code
32830 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32831 .endd
32832 Thus, this example checks whether or not the IP addresses of the sender
32833 domain's mail servers are on the Spamhaus black list.
32834
32835 The key that was used for a successful DNS list lookup is put into the variable
32836 &$dnslist_matched$& (see section &<<SECID204>>&).
32837
32838
32839
32840
32841 .subsection "Data returned by DNS lists" SECID203
32842 .cindex "DNS list" "data returned from"
32843 DNS lists are constructed using address records in the DNS. The original RBL
32844 just used the address 127.0.0.1 on the right hand side of each record, but the
32845 RBL+ list and some other lists use a number of values with different meanings.
32846 The values used on the RBL+ list are:
32847 .itable none 0 0 2 20* left 80* left
32848 .irow 127.1.0.1  "RBL"
32849 .irow 127.1.0.2  "DUL"
32850 .irow 127.1.0.3  "DUL and RBL"
32851 .irow 127.1.0.4  "RSS"
32852 .irow 127.1.0.5  "RSS and RBL"
32853 .irow 127.1.0.6  "RSS and DUL"
32854 .irow 127.1.0.7  "RSS and DUL and RBL"
32855 .endtable
32856 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32857 different values. Some DNS lists may return more than one address record;
32858 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32859
32860 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32861 range. If a DNSBL operator loses control of the domain, lookups on it
32862 may start returning other addresses.  Because of this, Exim now ignores
32863 returned values outside the 127/8 region.
32864
32865
32866 .subsection "Variables set from DNS lists" SECID204
32867 .cindex "expansion" "variables, set from DNS list"
32868 .cindex "DNS list" "variables set from"
32869 .vindex "&$dnslist_domain$&"
32870 .vindex "&$dnslist_matched$&"
32871 .vindex "&$dnslist_text$&"
32872 .vindex "&$dnslist_value$&"
32873 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32874 the name of the overall domain that matched (for example,
32875 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32876 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32877 the DNS record. When the key is an IP address, it is not reversed in
32878 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32879 cases, for example:
32880 .code
32881 deny dnslists = spamhaus.example
32882 .endd
32883 the key is also available in another variable (in this case,
32884 &$sender_host_address$&). In more complicated cases, however, this is not true.
32885 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32886 might generate a dnslists lookup like this:
32887 .code
32888 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32889 .endd
32890 If this condition succeeds, the value in &$dnslist_matched$& might be
32891 &`192.168.6.7`& (for example).
32892
32893 If more than one address record is returned by the DNS lookup, all the IP
32894 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32895 The variable &$dnslist_text$& contains the contents of any associated TXT
32896 record. For lists such as RBL+ the TXT record for a merged entry is often not
32897 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32898 information.
32899
32900 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32901 &-- even if these appear before the condition in the ACL, they are not
32902 expanded until after it has failed. For example:
32903 .code
32904 deny    hosts = !+local_networks
32905         message = $sender_host_address is listed \
32906                   at $dnslist_domain
32907         dnslists = rbl-plus.mail-abuse.example
32908 .endd
32909
32910
32911
32912 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32913 .cindex "DNS list" "matching specific returned data"
32914 You can add an equals sign and an IP address after a &%dnslists%& domain name
32915 in order to restrict its action to DNS records with a matching right hand side.
32916 For example,
32917 .code
32918 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32919 .endd
32920 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32921 any address record is considered to be a match. For the moment, we assume
32922 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32923 describes how multiple records are handled.
32924
32925 More than one IP address may be given for checking, using a comma as a
32926 separator. These are alternatives &-- if any one of them matches, the
32927 &%dnslists%& condition is true. For example:
32928 .code
32929 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32930 .endd
32931 If you want to specify a constraining address list and also specify names or IP
32932 addresses to be looked up, the constraining address list must be specified
32933 first. For example:
32934 .code
32935 deny dnslists = dsn.rfc-ignorant.org\
32936                 =127.0.0.2/$sender_address_domain
32937 .endd
32938
32939 If the character &`&&`& is used instead of &`=`&, the comparison for each
32940 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32941 In other words, the listed addresses are used as bit masks. The comparison is
32942 true if all the bits in the mask are present in the address that is being
32943 tested. For example:
32944 .code
32945 dnslists = a.b.c&0.0.0.3
32946 .endd
32947 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32948 want to test whether one bit or another bit is present (as opposed to both
32949 being present), you must use multiple values. For example:
32950 .code
32951 dnslists = a.b.c&0.0.0.1,0.0.0.2
32952 .endd
32953 matches if the final component of the address is an odd number or two times
32954 an odd number.
32955
32956
32957
32958 .subsection "Negated DNS matching conditions" SECID205
32959 You can supply a negative list of IP addresses as part of a &%dnslists%&
32960 condition. Whereas
32961 .code
32962 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32963 .endd
32964 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32965 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32966 .code
32967 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32968 .endd
32969 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32970 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32971 words, the result of the test is inverted if an exclamation mark appears before
32972 the &`=`& (or the &`&&`&) sign.
32973
32974 &*Note*&: This kind of negation is not the same as negation in a domain,
32975 host, or address list (which is why the syntax is different).
32976
32977 If you are using just one list, the negation syntax does not gain you much. The
32978 previous example is precisely equivalent to
32979 .code
32980 deny  dnslists = a.b.c
32981      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32982 .endd
32983 However, if you are using multiple lists, the negation syntax is clearer.
32984 Consider this example:
32985 .code
32986 deny  dnslists = sbl.spamhaus.org : \
32987                  list.dsbl.org : \
32988                  dnsbl.njabl.org!=127.0.0.3 : \
32989                  relays.ordb.org
32990 .endd
32991 Using only positive lists, this would have to be:
32992 .code
32993 deny  dnslists = sbl.spamhaus.org : \
32994                  list.dsbl.org
32995 deny  dnslists = dnsbl.njabl.org
32996      !dnslists = dnsbl.njabl.org=127.0.0.3
32997 deny  dnslists = relays.ordb.org
32998 .endd
32999 which is less clear, and harder to maintain.
33000
33001 Negation can also be used with a bitwise-and restriction.
33002 The dnslists condition with only be trus if a result is returned
33003 by the lookup which, anded with the restriction, is all zeroes.
33004 For example:
33005 .code
33006 deny dnslists = zen.spamhaus.org!&0.255.255.0
33007 .endd
33008
33009
33010
33011
33012 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33013 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33014 thereby providing more than one IP address. When an item in a &%dnslists%& list
33015 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33016 the match to specific results from the DNS lookup, there are two ways in which
33017 the checking can be handled. For example, consider the condition:
33018 .code
33019 dnslists = a.b.c=127.0.0.1
33020 .endd
33021 What happens if the DNS lookup for the incoming IP address yields both
33022 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33023 condition true because at least one given value was found, or is it false
33024 because at least one of the found values was not listed? And how does this
33025 affect negated conditions? Both possibilities are provided for with the help of
33026 additional separators &`==`& and &`=&&`&.
33027
33028 .ilist
33029 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33030 IP addresses matches one of the listed addresses. For the example above, the
33031 condition is true because 127.0.0.1 matches.
33032 .next
33033 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33034 looked up IP addresses matches one of the listed addresses. If the condition is
33035 changed to:
33036 .code
33037 dnslists = a.b.c==127.0.0.1
33038 .endd
33039 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33040 false because 127.0.0.2 is not listed. You would need to have:
33041 .code
33042 dnslists = a.b.c==127.0.0.1,127.0.0.2
33043 .endd
33044 for the condition to be true.
33045 .endlist
33046
33047 When &`!`& is used to negate IP address matching, it inverts the result, giving
33048 the precise opposite of the behaviour above. Thus:
33049 .ilist
33050 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33051 addresses matches one of the listed addresses. Consider:
33052 .code
33053 dnslists = a.b.c!&0.0.0.1
33054 .endd
33055 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33056 false because 127.0.0.1 matches.
33057 .next
33058 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33059 looked up IP address that does not match. Consider:
33060 .code
33061 dnslists = a.b.c!=&0.0.0.1
33062 .endd
33063 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33064 true, because 127.0.0.2 does not match. You would need to have:
33065 .code
33066 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33067 .endd
33068 for the condition to be false.
33069 .endlist
33070 When the DNS lookup yields only a single IP address, there is no difference
33071 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33072
33073
33074
33075
33076 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33077 .cindex "DNS list" "information from merged"
33078 When the facility for restricting the matching IP values in a DNS list is used,
33079 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33080 the true reason for rejection. This happens when lists are merged and the IP
33081 address in the A record is used to distinguish them; unfortunately there is
33082 only one TXT record. One way round this is not to use merged lists, but that
33083 can be inefficient because it requires multiple DNS lookups where one would do
33084 in the vast majority of cases when the host of interest is not on any of the
33085 lists.
33086
33087 A less inefficient way of solving this problem is available. If
33088 two domain names, comma-separated, are given, the second is used first to
33089 do an initial check, making use of any IP value restrictions that are set.
33090 If there is a match, the first domain is used, without any IP value
33091 restrictions, to get the TXT record. As a byproduct of this, there is also
33092 a check that the IP being tested is indeed on the first list. The first
33093 domain is the one that is put in &$dnslist_domain$&. For example:
33094 .code
33095 deny   dnslists = \
33096          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33097          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33098        message  = \
33099          rejected because $sender_host_address is blacklisted \
33100          at $dnslist_domain\n$dnslist_text
33101 .endd
33102 For the first blacklist item, this starts by doing a lookup in
33103 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33104 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33105 value, and as long as something is found, it looks for the corresponding TXT
33106 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33107 The second blacklist item is processed similarly.
33108
33109 If you are interested in more than one merged list, the same list must be
33110 given several times, but because the results of the DNS lookups are cached,
33111 the DNS calls themselves are not repeated. For example:
33112 .code
33113 deny dnslists = \
33114          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33115          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33116          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33117          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33118 .endd
33119 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33120 values matches (or if no record is found), this is the only lookup that is
33121 done. Only if there is a match is one of the more specific lists consulted.
33122
33123
33124
33125 .subsection "DNS lists and IPv6" SECTmorednslistslast
33126 .cindex "IPv6" "DNS black lists"
33127 .cindex "DNS list" "IPv6 usage"
33128 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33129 nibble by nibble. For example, if the calling host's IP address is
33130 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33131 .code
33132 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33133   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33134 .endd
33135 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33136 lists contain wildcard records, intended for IPv4, that interact badly with
33137 IPv6. For example, the DNS entry
33138 .code
33139 *.3.some.list.example.    A    127.0.0.1
33140 .endd
33141 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33142 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33143
33144 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33145 &%condition%& condition, as in this example:
33146 .code
33147 deny   condition = ${if isip4{$sender_host_address}}
33148        dnslists  = some.list.example
33149 .endd
33150
33151 If an explicit key is being used for a DNS lookup and it may be an IPv6
33152 address you should specify alternate list separators for both the outer
33153 (DNS list name) list and inner (lookup keys) list:
33154 .code
33155        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33156 .endd
33157
33158
33159 .section "Previously seen user and hosts" "SECTseen"
33160 .cindex "&%seen%& ACL condition"
33161 .cindex greylisting
33162 The &%seen%& ACL condition can be used to test whether a
33163 situation has been previously met.
33164 It uses a hints database to record a timestamp against a key.
33165 The syntax of the condition is:
33166 .display
33167 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33168 .endd
33169
33170 For example,
33171 .code
33172 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33173 .endd
33174 in a RCPT ACL will implement simple greylisting.
33175
33176 The parameters for the condition are
33177 a possible minus sign,
33178 then an interval,
33179 then, slash-separated, a list of options.
33180 The interval is taken as an offset before the current time,
33181 and used for the test.
33182 If the interval is preceded by a minus sign then the condition returns
33183 whether a record is found which is before the test time.
33184 Otherwise, the condition returns whether one is found which is since the
33185 test time.
33186
33187 Options are read in order with later ones overriding earlier ones.
33188
33189 The default key is &$sender_host_address$&.
33190 An explicit key can be set using a &%key=value%& option.
33191
33192 If a &%readonly%& option is given then
33193 no record create or update is done.
33194 If a &%write%& option is given then
33195 a record create or update is always done.
33196 An update is done if the test is for &"since"&.
33197 If none of those hold and there was no existing record,
33198 a record is created.
33199
33200 Creates and updates are marked with the current time.
33201
33202 Finally, a &"before"& test which succeeds, and for which the record
33203 is old enough, will be refreshed with a timestamp of the test time.
33204 This can prevent tidying of the database from removing the entry.
33205 The interval for this is, by default, 10 days.
33206 An explicit interval can be set using a
33207 &%refresh=value%& option.
33208
33209 Note that &"seen"& should be added to the list of hints databases
33210 for maintenance if this ACL condition is used.
33211
33212
33213 .section "Rate limiting incoming messages" "SECTratelimiting"
33214 .cindex "rate limiting" "client sending"
33215 .cindex "limiting client sending rates"
33216 .oindex "&%smtp_ratelimit_*%&"
33217 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33218 which clients can send email. This is more powerful than the
33219 &%smtp_ratelimit_*%& options, because those options control the rate of
33220 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33221 works across all connections (concurrent and sequential) from the same client
33222 host. The syntax of the &%ratelimit%& condition is:
33223 .display
33224 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33225 .endd
33226 If the average client sending rate is less than &'m'& messages per time
33227 period &'p'& then the condition is false; otherwise it is true.
33228
33229 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33230 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33231 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33232 of &'p'&.
33233
33234 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33235 time interval, for example, &`8h`& for eight hours. A larger time constant
33236 means that it takes Exim longer to forget a client's past behaviour. The
33237 parameter &'m'& is the maximum number of messages that a client is permitted to
33238 send in each time interval. It also specifies the number of messages permitted
33239 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33240 constant, you can allow a client to send more messages in a burst without
33241 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33242 both small, messages must be sent at an even rate.
33243
33244 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33245 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33246 when deploying the &%ratelimit%& ACL condition. The script prints usage
33247 instructions when it is run with no arguments.
33248
33249 The key is used to look up the data for calculating the client's average
33250 sending rate. This data is stored in Exim's spool directory, alongside the
33251 retry and other hints databases. The default key is &$sender_host_address$&,
33252 which means Exim computes the sending rate of each client host IP address.
33253 By changing the key you can change how Exim identifies clients for the purpose
33254 of ratelimiting. For example, to limit the sending rate of each authenticated
33255 user, independent of the computer they are sending from, set the key to
33256 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33257 example, &$authenticated_id$& is only meaningful if the client has
33258 authenticated (which you can check with the &%authenticated%& ACL condition).
33259
33260 The lookup key does not have to identify clients: If you want to limit the
33261 rate at which a recipient receives messages, you can use the key
33262 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33263 ACL.
33264
33265 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33266 specifies what Exim measures the rate of, for example, messages or recipients
33267 or bytes. You can adjust the measurement using the &%unique=%& and/or
33268 &%count=%& options. You can also control when Exim updates the recorded rate
33269 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33270 separated by a slash, like the other parameters. They may appear in any order.
33271
33272 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33273 any options that alter the meaning of the stored data. The limit &'m'& is not
33274 stored, so you can alter the configured maximum rate and Exim will still
33275 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33276 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33277 behaviour. The lookup key is not affected by changes to the update mode and
33278 the &%count=%& option.
33279
33280
33281 .subsection "Ratelimit options for what is being measured" ratoptmea
33282 .cindex "rate limiting" "per_* options"
33283 .vlist
33284 .vitem per_conn
33285 .cindex "rate limiting" per_conn
33286 This option limits the client's connection rate. It is not
33287 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33288 &%acl_not_smtp_start%& ACLs.
33289
33290 .vitem per_mail
33291 .cindex "rate limiting" per_conn
33292 This option limits the client's rate of sending messages. This is
33293 the default if none of the &%per_*%& options is specified. It can be used in
33294 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33295 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33296
33297 .vitem per_byte
33298 .cindex "rate limiting" per_conn
33299 This option limits the sender's email bandwidth. It can be used in
33300 the same ACLs as the &%per_mail%& option, though it is best to use this option
33301 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33302 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33303 in its MAIL command, which may be inaccurate or completely missing. You can
33304 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33305 in kilobytes, megabytes, or gigabytes, respectively.
33306
33307 .vitem per_rcpt
33308 .cindex "rate limiting" per_rcpt
33309 This option causes Exim to limit the rate at which recipients are
33310 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33311 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33312 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33313 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33314 in either case the rate limiting engine will see a message with many
33315 recipients as a large high-speed burst.
33316
33317 .vitem per_addr
33318 .cindex "rate limiting" per_addr
33319 This option is like the &%per_rcpt%& option, except it counts the
33320 number of different recipients that the client has sent messages to in the
33321 last time period. That is, if the client repeatedly sends messages to the same
33322 recipient, its measured rate is not increased. This option can only be used in
33323 &%acl_smtp_rcpt%&.
33324
33325 .vitem per_cmd
33326 .cindex "rate limiting" per_cmd
33327 This option causes Exim to recompute the rate every time the
33328 condition is processed. This can be used to limit the rate of any SMTP
33329 command. If it is used in multiple ACLs it can limit the aggregate rate of
33330 multiple different commands.
33331
33332 .vitem count
33333 .cindex "rate limiting" count
33334 This option can be used to alter how much Exim adds to the client's
33335 measured rate.
33336 A value is required, after an equals sign.
33337 For example, the &%per_byte%& option is equivalent to
33338 &`per_mail/count=$message_size`&.
33339 If there is no &%count=%& option, Exim
33340 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33341 other than &%acl_smtp_rcpt%&).
33342 The count does not have to be an integer.
33343
33344 .vitem unique
33345 .cindex "rate limiting" unique
33346 This option is described in section &<<ratoptuniq>>& below.
33347 .endlist
33348
33349
33350 .subsection "Ratelimit update modes" ratoptupd
33351 .cindex "rate limiting" "reading data without updating"
33352 You can specify one of three options with the &%ratelimit%& condition to
33353 control when its database is updated. This section describes the &%readonly%&
33354 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33355
33356 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33357 previously-computed rate to check against the limit.
33358
33359 For example, you can test the client's sending rate and deny it access (when
33360 it is too fast) in the connect ACL. If the client passes this check then it
33361 can go on to send a message, in which case its recorded rate will be updated
33362 in the MAIL ACL. Subsequent connections from the same client will check this
33363 new rate.
33364 .code
33365 acl_check_connect:
33366  deny ratelimit = 100 / 5m / readonly
33367       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33368                   (max $sender_rate_limit)
33369 # ...
33370 acl_check_mail:
33371  warn ratelimit = 100 / 5m / strict
33372       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33373                   (max $sender_rate_limit)
33374 .endd
33375
33376 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33377 processing a message then it may increase the client's measured rate more than
33378 it should. For example, this will happen if you check the &%per_rcpt%& option
33379 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33380 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33381 multiple update problems by using the &%readonly%& option on later ratelimit
33382 checks.
33383
33384 The &%per_*%& options described above do not make sense in some ACLs. If you
33385 use a &%per_*%& option in an ACL where it is not normally permitted then the
33386 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33387 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33388 next section) so you must specify the &%readonly%& option explicitly.
33389
33390
33391 .subsection "Ratelimit options for handling fast clients" ratoptfast
33392 .cindex "rate limiting" "strict and leaky modes"
33393 If a client's average rate is greater than the maximum, the rate limiting
33394 engine can react in two possible ways, depending on the presence of the
33395 &%strict%& or &%leaky%& update modes. This is independent of the other
33396 counter-measures (such as rejecting the message) that may be specified by the
33397 rest of the ACL.
33398
33399 The &%leaky%& (default) option means that the client's recorded rate is not
33400 updated if it is above the limit. The effect of this is that Exim measures the
33401 client's average rate of successfully sent email,
33402 up to the given limit.
33403 This is appropriate if the countermeasure when the condition is true
33404 consists of refusing the message, and
33405 is generally the better choice if you have clients that retry automatically.
33406 If the action when true is anything more complex then this option is
33407 likely not what is wanted.
33408
33409 The &%strict%& option means that the client's recorded rate is always
33410 updated. The effect of this is that Exim measures the client's average rate
33411 of attempts to send email, which can be much higher than the maximum it is
33412 actually allowed. If the client is over the limit it may be subjected to
33413 counter-measures by the ACL. It must slow down and allow sufficient time to
33414 pass that its computed rate falls below the maximum before it can send email
33415 again. The time (the number of smoothing periods) it must wait and not
33416 attempt to send mail can be calculated with this formula:
33417 .code
33418         ln(peakrate/maxrate)
33419 .endd
33420
33421
33422 .subsection "Limiting the rate of different events" ratoptuniq
33423 .cindex "rate limiting" "counting unique events"
33424 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33425 rate of different events. For example, the &%per_addr%& option uses this
33426 mechanism to count the number of different recipients that the client has
33427 sent messages to in the last time period; it is equivalent to
33428 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33429 measure the rate that a client uses different sender addresses with the
33430 options &`per_mail/unique=$sender_address`&.
33431
33432 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33433 has seen for that key. The whole set is thrown away when it is older than the
33434 rate smoothing period &'p'&, so each different event is counted at most once
33435 per period. In the &%leaky%& update mode, an event that causes the client to
33436 go over the limit is not added to the set, in the same way that the client's
33437 recorded rate is not updated in the same situation.
33438
33439 When you combine the &%unique=%& and &%readonly%& options, the specific
33440 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33441 rate.
33442
33443 The &%unique=%& mechanism needs more space in the ratelimit database than the
33444 other &%ratelimit%& options in order to store the event set. The number of
33445 unique values is potentially as large as the rate limit, so the extra space
33446 required increases with larger limits.
33447
33448 The uniqueification is not perfect: there is a small probability that Exim
33449 will think a new event has happened before. If the sender's rate is less than
33450 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33451 the measured rate can go above the limit, in which case Exim may under-count
33452 events by a significant margin. Fortunately, if the rate is high enough (2.7
33453 times the limit) that the false positive rate goes above 9%, then Exim will
33454 throw away the over-full event set before the measured rate falls below the
33455 limit. Therefore the only harm should be that exceptionally high sending rates
33456 are logged incorrectly; any countermeasures you configure will be as effective
33457 as intended.
33458
33459
33460 .subsection "Using rate limiting" useratlim
33461 Exim's other ACL facilities are used to define what counter-measures are taken
33462 when the rate limit is exceeded. This might be anything from logging a warning
33463 (for example, while measuring existing sending rates in order to define
33464 policy), through time delays to slow down fast senders, up to rejecting the
33465 message. For example:
33466 .code
33467 # Log all senders' rates
33468 warn ratelimit = 0 / 1h / strict
33469      log_message = Sender rate $sender_rate / $sender_rate_period
33470
33471 # Slow down fast senders; note the need to truncate $sender_rate
33472 # at the decimal point.
33473 warn ratelimit = 100 / 1h / per_rcpt / strict
33474      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33475                    $sender_rate_limit }s
33476
33477 # Keep authenticated users under control
33478 deny authenticated = *
33479      ratelimit = 100 / 1d / strict / $authenticated_id
33480
33481 # System-wide rate limit
33482 defer ratelimit = 10 / 1s / $primary_hostname
33483       message = Sorry, too busy. Try again later.
33484
33485 # Restrict incoming rate from each host, with a default
33486 # set using a macro and special cases looked up in a table.
33487 defer ratelimit = ${lookup {$sender_host_address} \
33488                    cdb {DB/ratelimits.cdb} \
33489                    {$value} {RATELIMIT} }
33490       message = Sender rate exceeds $sender_rate_limit \
33491                messages per $sender_rate_period
33492 .endd
33493 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33494 especially with the &%per_rcpt%& option, you may suffer from a performance
33495 bottleneck caused by locking on the ratelimit hints database. Apart from
33496 making your ACLs less complicated, you can reduce the problem by using a
33497 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33498 this means that Exim will lose its hints data after a reboot (including retry
33499 hints, the callout cache, and ratelimit data).
33500
33501
33502
33503 .section "Address verification" "SECTaddressverification"
33504 .cindex "verifying address" "options for"
33505 .cindex "policy control" "address verification"
33506 Several of the &%verify%& conditions described in section
33507 &<<SECTaclconditions>>& cause addresses to be verified. Section
33508 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33509 The verification conditions can be followed by options that modify the
33510 verification process. The options are separated from the keyword and from each
33511 other by slashes, and some of them contain parameters. For example:
33512 .code
33513 verify = sender/callout
33514 verify = recipient/defer_ok/callout=10s,defer_ok
33515 .endd
33516 The first stage of address verification, which always happens, is to run the
33517 address through the routers, in &"verify mode"&. Routers can detect the
33518 difference between verification and routing for delivery, and their actions can
33519 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33520 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33521 The available options are as follows:
33522
33523 .ilist
33524 If the &%callout%& option is specified, successful routing to one or more
33525 remote hosts is followed by a &"callout"& to those hosts as an additional
33526 check. Callouts and their sub-options are discussed in the next section.
33527 .next
33528 If there is a defer error while doing verification routing, the ACL
33529 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33530 options, the condition is forced to be true instead. Note that this is a main
33531 verification option as well as a suboption for callouts.
33532 .next
33533 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33534 discusses the reporting of sender address verification failures.
33535 .next
33536 The &%success_on_redirect%& option causes verification always to succeed
33537 immediately after a successful redirection. By default, if a redirection
33538 generates just one address, that address is also verified. See further
33539 discussion in section &<<SECTredirwhilveri>>&.
33540 .next
33541 If the &%quota%& option is specified for recipient verify,
33542 successful routing to an appendfile transport is followed by a call into
33543 the transport to evaluate the quota status for the recipient.
33544 No actual delivery is done, but verification will succeed if the quota
33545 is sufficient for the message (if the sender gave a message size) or
33546 not already exceeded (otherwise).
33547 .endlist
33548
33549 .cindex "verifying address" "differentiating failures"
33550 .vindex "&$recipient_verify_failure$&"
33551 .vindex "&$sender_verify_failure$&"
33552 .vindex "&$acl_verify_message$&"
33553 After an address verification failure, &$acl_verify_message$& contains the
33554 error message that is associated with the failure. It can be preserved by
33555 coding like this:
33556 .code
33557 warn  !verify = sender
33558        set acl_m0 = $acl_verify_message
33559 .endd
33560 If you are writing your own custom rejection message or log message when
33561 denying access, you can use this variable to include information about the
33562 verification failure.
33563 This variable is cleared at the end of processing the ACL verb.
33564
33565 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33566 appropriate) contains one of the following words:
33567
33568 .ilist
33569 &%qualify%&: The address was unqualified (no domain), and the message
33570 was neither local nor came from an exempted host.
33571 .next
33572 &%route%&: Routing failed.
33573 .next
33574 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33575 occurred at or before the MAIL command (that is, on initial
33576 connection, HELO, or MAIL).
33577 .next
33578 &%recipient%&: The RCPT command in a callout was rejected.
33579 .next
33580 &%postmaster%&: The postmaster check in a callout was rejected.
33581 .next
33582 &%quota%&: The quota check for a local recipient did non pass.
33583 .endlist
33584
33585 The main use of these variables is expected to be to distinguish between
33586 rejections of MAIL and rejections of RCPT in callouts.
33587
33588 The above variables may also be set after a &*successful*&
33589 address verification to:
33590
33591 .ilist
33592 &%random%&: A random local-part callout succeeded
33593 .endlist
33594
33595
33596
33597
33598 .section "Callout verification" "SECTcallver"
33599 .cindex "verifying address" "by callout"
33600 .cindex "callout" "verification"
33601 .cindex "SMTP" "callout verification"
33602 For non-local addresses, routing verifies the domain, but is unable to do any
33603 checking of the local part. There are situations where some means of verifying
33604 the local part is desirable. One way this can be done is to make an SMTP
33605 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33606 a subsequent host for a recipient address, to see if the host accepts the
33607 address. We use the term &'callout'& to cover both cases. Note that for a
33608 sender address, the callback is not to the client host that is trying to
33609 deliver the message, but to one of the hosts that accepts incoming mail for the
33610 sender's domain.
33611
33612 Exim does not do callouts by default. If you want them to happen, you must
33613 request them by setting appropriate options on the &%verify%& condition, as
33614 described below. This facility should be used with care, because it can add a
33615 lot of resource usage to the cost of verifying an address. However, Exim does
33616 cache the results of callouts, which helps to reduce the cost. Details of
33617 caching are in section &<<SECTcallvercache>>&.
33618
33619 Recipient callouts are usually used only between hosts that are controlled by
33620 the same administration. For example, a corporate gateway host could use
33621 callouts to check for valid recipients on an internal mailserver. A successful
33622 callout does not guarantee that a real delivery to the address would succeed;
33623 on the other hand, a failing callout does guarantee that a delivery would fail.
33624
33625 If the &%callout%& option is present on a condition that verifies an address, a
33626 second stage of verification occurs if the address is successfully routed to
33627 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33628 &(manualroute)& router, where the router specifies the hosts. However, if a
33629 router that does not set up hosts routes to an &(smtp)& transport with a
33630 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33631 &%hosts_override%& set, its hosts are always used, whether or not the router
33632 supplies a host list.
33633 Callouts are only supported on &(smtp)& transports.
33634
33635 The port that is used is taken from the transport, if it is specified and is a
33636 remote transport. (For routers that do verification only, no transport need be
33637 specified.) Otherwise, the default SMTP port is used. If a remote transport
33638 specifies an outgoing interface, this is used; otherwise the interface is not
33639 specified. Likewise, the text that is used for the HELO command is taken from
33640 the transport's &%helo_data%& option; if there is no transport, the value of
33641 &$smtp_active_hostname$& is used.
33642
33643 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33644 test whether a bounce message could be delivered to the sender address. The
33645 following SMTP commands are sent:
33646 .display
33647 &`HELO `&<&'local host name'&>
33648 &`MAIL FROM:<>`&
33649 &`RCPT TO:`&<&'the address to be tested'&>
33650 &`QUIT`&
33651 .endd
33652 LHLO is used instead of HELO if the transport's &%protocol%& option is
33653 set to &"lmtp"&.
33654
33655 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33656 settings.
33657
33658 A recipient callout check is similar. By default, it also uses an empty address
33659 for the sender. This default is chosen because most hosts do not make use of
33660 the sender address when verifying a recipient. Using the same address means
33661 that a single cache entry can be used for each recipient. Some sites, however,
33662 do make use of the sender address when verifying. These are catered for by the
33663 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33664
33665 If the response to the RCPT command is a 2&'xx'& code, the verification
33666 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33667 Exim tries the next host, if any. If there is a problem with all the remote
33668 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33669 &%callout%& option is given, in which case the condition is forced to succeed.
33670
33671 .cindex "SMTP" "output flushing, disabling for callout"
33672 A callout may take a little time. For this reason, Exim normally flushes SMTP
33673 output before performing a callout in an ACL, to avoid unexpected timeouts in
33674 clients when the SMTP PIPELINING extension is in use. The flushing can be
33675 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33676
33677 .cindex "tainted data" "de-tainting"
33678 .cindex "de-tainting" "using recipient verify"
33679 A recipient callout which gets a 2&'xx'& code
33680 will assign untainted values to the
33681 &$domain_data$& and &$local_part_data$& variables,
33682 corresponding to the domain and local parts of the recipient address.
33683
33684
33685
33686
33687 .subsection "Additional parameters for callouts" CALLaddparcall
33688 .cindex "callout" "additional parameters for"
33689 The &%callout%& option can be followed by an equals sign and a number of
33690 optional parameters, separated by commas. For example:
33691 .code
33692 verify = recipient/callout=10s,defer_ok
33693 .endd
33694 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33695 separate verify options, is retained for backwards compatibility, but is now
33696 deprecated. The additional parameters for &%callout%& are as follows:
33697
33698
33699 .vlist
33700 .vitem <&'a&~time&~interval'&>
33701 .cindex "callout" "timeout, specifying"
33702 This specifies the timeout that applies for the callout attempt to each host.
33703 For example:
33704 .code
33705 verify = sender/callout=5s
33706 .endd
33707 The default is 30 seconds. The timeout is used for each response from the
33708 remote host. It is also used for the initial connection, unless overridden by
33709 the &%connect%& parameter.
33710
33711
33712 .vitem &*connect&~=&~*&<&'time&~interval'&>
33713 .cindex "callout" "connection timeout, specifying"
33714 This parameter makes it possible to set a different (usually smaller) timeout
33715 for making the SMTP connection. For example:
33716 .code
33717 verify = sender/callout=5s,connect=1s
33718 .endd
33719 If not specified, this timeout defaults to the general timeout value.
33720
33721 .vitem &*defer_ok*&
33722 .cindex "callout" "defer, action on"
33723 When this parameter is present, failure to contact any host, or any other kind
33724 of temporary error, is treated as success by the ACL. However, the cache is not
33725 updated in this circumstance.
33726
33727 .vitem &*fullpostmaster*&
33728 .cindex "callout" "full postmaster check"
33729 This operates like the &%postmaster%& option (see below), but if the check for
33730 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33731 accordance with the specification in RFC 2821. The RFC states that the
33732 unqualified address &'postmaster'& should be accepted.
33733
33734
33735 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33736 .cindex "callout" "sender when verifying header"
33737 When verifying addresses in header lines using the &%header_sender%&
33738 verification option, Exim behaves by default as if the addresses are envelope
33739 sender addresses from a message. Callout verification therefore tests to see
33740 whether a bounce message could be delivered, by using an empty address in the
33741 MAIL command. However, it is arguable that these addresses might never be used
33742 as envelope senders, and could therefore justifiably reject bounce messages
33743 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33744 address to use in the MAIL command. For example:
33745 .code
33746 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33747 .endd
33748 This parameter is available only for the &%header_sender%& verification option.
33749
33750
33751 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33752 .cindex "callout" "overall timeout, specifying"
33753 This parameter sets an overall timeout for performing a callout verification.
33754 For example:
33755 .code
33756 verify = sender/callout=5s,maxwait=30s
33757 .endd
33758 This timeout defaults to four times the callout timeout for individual SMTP
33759 commands. The overall timeout applies when there is more than one host that can
33760 be tried. The timeout is checked before trying the next host. This prevents
33761 very long delays if there are a large number of hosts and all are timing out
33762 (for example, when network connections are timing out).
33763
33764
33765 .vitem &*no_cache*&
33766 .cindex "callout" "cache, suppressing"
33767 .cindex "caching callout, suppressing"
33768 When this parameter is given, the callout cache is neither read nor updated.
33769
33770 .vitem &*postmaster*&
33771 .cindex "callout" "postmaster; checking"
33772 When this parameter is set, a successful callout check is followed by a similar
33773 check for the local part &'postmaster'& at the same domain. If this address is
33774 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33775 the postmaster check is recorded in a cache record; if it is a failure, this is
33776 used to fail subsequent callouts for the domain without a connection being
33777 made, until the cache record expires.
33778
33779 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33780 The postmaster check uses an empty sender in the MAIL command by default.
33781 You can use this parameter to do a postmaster check using a different address.
33782 For example:
33783 .code
33784 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33785 .endd
33786 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33787 one overrides. The &%postmaster%& parameter is equivalent to this example:
33788 .code
33789 require  verify = sender/callout=postmaster_mailfrom=
33790 .endd
33791 &*Warning*&: The caching arrangements for postmaster checking do not take
33792 account of the sender address. It is assumed that either the empty address or
33793 a fixed non-empty address will be used. All that Exim remembers is that the
33794 postmaster check for the domain succeeded or failed.
33795
33796
33797 .vitem &*random*&
33798 .cindex "callout" "&""random""& check"
33799 When this parameter is set, before doing the normal callout check, Exim does a
33800 check for a &"random"& local part at the same domain. The local part is not
33801 really random &-- it is defined by the expansion of the option
33802 &%callout_random_local_part%&, which defaults to
33803 .code
33804 $primary_hostname-$tod_epoch-testing
33805 .endd
33806 The idea here is to try to determine whether the remote host accepts all local
33807 parts without checking. If it does, there is no point in doing callouts for
33808 specific local parts. If the &"random"& check succeeds, the result is saved in
33809 a cache record, and used to force the current and subsequent callout checks to
33810 succeed without a connection being made, until the cache record expires.
33811
33812 .vitem &*use_postmaster*&
33813 .cindex "callout" "sender for recipient check"
33814 This parameter applies to recipient callouts only. For example:
33815 .code
33816 deny  !verify = recipient/callout=use_postmaster
33817 .endd
33818 .vindex "&$qualify_domain$&"
33819 It causes a non-empty postmaster address to be used in the MAIL command when
33820 performing the callout for the recipient, and also for a &"random"& check if
33821 that is configured. The local part of the address is &`postmaster`& and the
33822 domain is the contents of &$qualify_domain$&.
33823
33824 .vitem &*use_sender*&
33825 This option applies to recipient callouts only. For example:
33826 .code
33827 require  verify = recipient/callout=use_sender
33828 .endd
33829 It causes the message's actual sender address to be used in the MAIL
33830 command when performing the callout, instead of an empty address. There is no
33831 need to use this option unless you know that the called hosts make use of the
33832 sender when checking recipients. If used indiscriminately, it reduces the
33833 usefulness of callout caching.
33834
33835 .vitem &*hold*&
33836 This option applies to recipient callouts only. For example:
33837 .code
33838 require  verify = recipient/callout=use_sender,hold
33839 .endd
33840 It causes the connection to be held open and used for any further recipients
33841 and for eventual delivery (should that be done quickly).
33842 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33843 when that is used for the connections.
33844 The advantage is only gained if there are no callout cache hits
33845 (which could be enforced by the no_cache option),
33846 if the use_sender option is used,
33847 if neither the random nor the use_postmaster option is used,
33848 and if no other callouts intervene.
33849 .endlist
33850
33851 If you use any of the parameters that set a non-empty sender for the MAIL
33852 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33853 &%use_sender%&), you should think about possible loops. Recipient checking is
33854 usually done between two hosts that are under the same management, and the host
33855 that receives the callouts is not normally configured to do callouts itself.
33856 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33857 these circumstances.
33858
33859 However, if you use a non-empty sender address for a callout to an arbitrary
33860 host, there is the likelihood that the remote host will itself initiate a
33861 callout check back to your host. As it is checking what appears to be a message
33862 sender, it is likely to use an empty address in MAIL, thus avoiding a
33863 callout loop. However, to be on the safe side it would be best to set up your
33864 own ACLs so that they do not do sender verification checks when the recipient
33865 is the address you use for header sender or postmaster callout checking.
33866
33867 Another issue to think about when using non-empty senders for callouts is
33868 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33869 by the sender/recipient combination; thus, for any given recipient, many more
33870 actual callouts are performed than when an empty sender or postmaster is used.
33871
33872
33873
33874
33875 .subsection "Callout caching" SECTcallvercache
33876 .cindex "hints database" "callout cache"
33877 .cindex "callout" "cache, description of"
33878 .cindex "caching" "callout"
33879 Exim caches the results of callouts in order to reduce the amount of resources
33880 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33881 option. A hints database called &"callout"& is used for the cache. Two
33882 different record types are used: one records the result of a callout check for
33883 a specific address, and the other records information that applies to the
33884 entire domain (for example, that it accepts the local part &'postmaster'&).
33885
33886 When an original callout fails, a detailed SMTP error message is given about
33887 the failure. However, for subsequent failures that use the cache data, this message
33888 is not available.
33889
33890 The expiry times for negative and positive address cache records are
33891 independent, and can be set by the global options &%callout_negative_expire%&
33892 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33893
33894 If a host gives a negative response to an SMTP connection, or rejects any
33895 commands up to and including
33896 .code
33897 MAIL FROM:<>
33898 .endd
33899 (but not including the MAIL command with a non-empty address),
33900 any callout attempt is bound to fail. Exim remembers such failures in a
33901 domain cache record, which it uses to fail callouts for the domain without
33902 making new connections, until the domain record times out. There are two
33903 separate expiry times for domain cache records:
33904 &%callout_domain_negative_expire%& (default 3h) and
33905 &%callout_domain_positive_expire%& (default 7d).
33906
33907 Domain records expire when the negative expiry time is reached if callouts
33908 cannot be made for the domain, or if the postmaster check failed.
33909 Otherwise, they expire when the positive expiry time is reached. This
33910 ensures that, for example, a host that stops accepting &"random"& local parts
33911 will eventually be noticed.
33912
33913 The callout caching mechanism is based on the domain of the address that is
33914 being tested. If the domain routes to several hosts, it is assumed that their
33915 behaviour will be the same.
33916
33917
33918
33919 .section "Quota caching" "SECTquotacache"
33920 .cindex "hints database" "quota cache"
33921 .cindex "quota" "cache, description of"
33922 .cindex "caching" "quota"
33923 Exim caches the results of quota verification
33924 in order to reduce the amount of resources used.
33925 The &"callout"& hints database is used.
33926
33927 The default cache periods are five minutes for a positive (good) result
33928 and one hour for a negative result.
33929 To change the periods the &%quota%& option can be followed by an equals sign
33930 and a number of optional paramemters, separated by commas.
33931 For example:
33932 .code
33933 verify = recipient/quota=cachepos=1h,cacheneg=1d
33934 .endd
33935 Possible parameters are:
33936 .vlist
33937 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33938 .cindex "quota cache" "positive entry expiry, specifying"
33939 Set the lifetime for a positive cache entry.
33940 A value of zero seconds is legitimate.
33941
33942 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33943 .cindex "quota cache" "negative entry expiry, specifying"
33944 As above, for a negative entry.
33945
33946 .vitem &*no_cache*&
33947 Set both positive and negative lifetimes to zero.
33948
33949 .section "Sender address verification reporting" "SECTsenaddver"
33950 .cindex "verifying" "suppressing error details"
33951 See section &<<SECTaddressverification>>& for a general discussion of
33952 verification. When sender verification fails in an ACL, the details of the
33953 failure are given as additional output lines before the 550 response to the
33954 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33955 you might see:
33956 .code
33957 MAIL FROM:<xyz@abc.example>
33958 250 OK
33959 RCPT TO:<pqr@def.example>
33960 550-Verification failed for <xyz@abc.example>
33961 550-Called:   192.168.34.43
33962 550-Sent:     RCPT TO:<xyz@abc.example>
33963 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33964 550 Sender verification failed
33965 .endd
33966 If more than one RCPT command fails in the same way, the details are given
33967 only for the first of them. However, some administrators do not want to send
33968 out this much information. You can suppress the details by adding
33969 &`/no_details`& to the ACL statement that requests sender verification. For
33970 example:
33971 .code
33972 verify = sender/no_details
33973 .endd
33974
33975 .section "Redirection while verifying" "SECTredirwhilveri"
33976 .cindex "verifying" "redirection while"
33977 .cindex "address redirection" "while verifying"
33978 A dilemma arises when a local address is redirected by aliasing or forwarding
33979 during verification: should the generated addresses themselves be verified,
33980 or should the successful expansion of the original address be enough to verify
33981 it? By default, Exim takes the following pragmatic approach:
33982
33983 .ilist
33984 When an incoming address is redirected to just one child address, verification
33985 continues with the child address, and if that fails to verify, the original
33986 verification also fails.
33987 .next
33988 When an incoming address is redirected to more than one child address,
33989 verification does not continue. A success result is returned.
33990 .endlist
33991
33992 This seems the most reasonable behaviour for the common use of aliasing as a
33993 way of redirecting different local parts to the same mailbox. It means, for
33994 example, that a pair of alias entries of the form
33995 .code
33996 A.Wol:   aw123
33997 aw123:   :fail: Gone away, no forwarding address
33998 .endd
33999 work as expected, with both local parts causing verification failure. When a
34000 redirection generates more than one address, the behaviour is more like a
34001 mailing list, where the existence of the alias itself is sufficient for
34002 verification to succeed.
34003
34004 It is possible, however, to change the default behaviour so that all successful
34005 redirections count as successful verifications, however many new addresses are
34006 generated. This is specified by the &%success_on_redirect%& verification
34007 option. For example:
34008 .code
34009 require verify = recipient/success_on_redirect/callout=10s
34010 .endd
34011 In this example, verification succeeds if a router generates a new address, and
34012 the callout does not occur, because no address was routed to a remote host.
34013
34014 When verification is being tested via the &%-bv%& option, the treatment of
34015 redirections is as just described, unless the &%-v%& or any debugging option is
34016 also specified. In that case, full verification is done for every generated
34017 address and a report is output for each of them.
34018
34019
34020
34021 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34022 .cindex "CSA" "verifying"
34023 Client SMTP Authorization is a system that allows a site to advertise
34024 which machines are and are not permitted to send email. This is done by placing
34025 special SRV records in the DNS; these are looked up using the client's HELO
34026 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34027 Authorization checks in Exim are performed by the ACL condition:
34028 .code
34029 verify = csa
34030 .endd
34031 This fails if the client is not authorized. If there is a DNS problem, or if no
34032 valid CSA SRV record is found, or if the client is authorized, the condition
34033 succeeds. These three cases can be distinguished using the expansion variable
34034 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34035 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34036 be likely to cause problems for legitimate email.
34037
34038 The error messages produced by the CSA code include slightly more
34039 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34040 looking up the CSA SRV record, or problems looking up the CSA target
34041 address record. There are four reasons for &$csa_status$& being &"fail"&:
34042
34043 .ilist
34044 The client's host name is explicitly not authorized.
34045 .next
34046 The client's IP address does not match any of the CSA target IP addresses.
34047 .next
34048 The client's host name is authorized but it has no valid target IP addresses
34049 (for example, the target's addresses are IPv6 and the client is using IPv4).
34050 .next
34051 The client's host name has no CSA SRV record but a parent domain has asserted
34052 that all subdomains must be explicitly authorized.
34053 .endlist
34054
34055 The &%csa%& verification condition can take an argument which is the domain to
34056 use for the DNS query. The default is:
34057 .code
34058 verify = csa/$sender_helo_name
34059 .endd
34060 This implementation includes an extension to CSA. If the query domain
34061 is an address literal such as [192.0.2.95], or if it is a bare IP
34062 address, Exim searches for CSA SRV records in the reverse DNS as if
34063 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34064 meaningful to say:
34065 .code
34066 verify = csa/$sender_host_address
34067 .endd
34068 In fact, this is the check that Exim performs if the client does not say HELO.
34069 This extension can be turned off by setting the main configuration option
34070 &%dns_csa_use_reverse%& to be false.
34071
34072 If a CSA SRV record is not found for the domain itself, a search
34073 is performed through its parent domains for a record which might be
34074 making assertions about subdomains. The maximum depth of this search is limited
34075 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34076 default. Exim does not look for CSA SRV records in a top level domain, so the
34077 default settings handle HELO domains as long as seven
34078 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34079 of legitimate HELO domains.
34080
34081 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34082 direct SRV lookups, this is not sufficient because of the extra parent domain
34083 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34084 addresses into lookups in the reverse DNS space. The result of a successful
34085 lookup such as:
34086 .code
34087 ${lookup dnsdb {csa=$sender_helo_name}}
34088 .endd
34089 has two space-separated fields: an authorization code and a target host name.
34090 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34091 authorization required but absent, or &"?"& for unknown.
34092
34093
34094
34095
34096 .section "Bounce address tag validation" "SECTverifyPRVS"
34097 .cindex "BATV, verifying"
34098 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34099 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34100 Genuine incoming bounce messages should therefore always be addressed to
34101 recipients that have a valid tag. This scheme is a way of detecting unwanted
34102 bounce messages caused by sender address forgeries (often called &"collateral
34103 spam"&), because the recipients of such messages do not include valid tags.
34104
34105 There are two expansion items to help with the implementation of the BATV
34106 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34107 the original envelope sender address by using a simple key to add a hash of the
34108 address and some time-based randomizing information. The &%prvs%& expansion
34109 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34110 The syntax of these expansion items is described in section
34111 &<<SECTexpansionitems>>&.
34112 The validity period on signed addresses is seven days.
34113
34114 As an example, suppose the secret per-address keys are stored in an MySQL
34115 database. A query to look up the key for an address could be defined as a macro
34116 like this:
34117 .code
34118 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34119                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34120                 }{$value}}
34121 .endd
34122 Suppose also that the senders who make use of BATV are defined by an address
34123 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34124 use this:
34125 .code
34126 # Bounces: drop unsigned addresses for BATV senders
34127 deny senders = :
34128      recipients = +batv_senders
34129      message = This address does not send an unsigned reverse path
34130
34131 # Bounces: In case of prvs-signed address, check signature.
34132 deny senders = :
34133      condition  = ${prvscheck {$local_part@$domain}\
34134                   {PRVSCHECK_SQL}{1}}
34135      !condition = $prvscheck_result
34136      message = Invalid reverse path signature.
34137 .endd
34138 The first statement rejects recipients for bounce messages that are addressed
34139 to plain BATV sender addresses, because it is known that BATV senders do not
34140 send out messages with plain sender addresses. The second statement rejects
34141 recipients that are prvs-signed, but with invalid signatures (either because
34142 the key is wrong, or the signature has timed out).
34143
34144 A non-prvs-signed address is not rejected by the second statement, because the
34145 &%prvscheck%& expansion yields an empty string if its first argument is not a
34146 prvs-signed address, thus causing the &%condition%& condition to be false. If
34147 the first argument is a syntactically valid prvs-signed address, the yield is
34148 the third string (in this case &"1"&), whether or not the cryptographic and
34149 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34150 of the checks (empty for failure, &"1"& for success).
34151
34152 There is one more issue you must consider when implementing prvs-signing:
34153 you have to ensure that the routers accept prvs-signed addresses and
34154 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34155 router to remove the signature with a configuration along these lines:
34156 .code
34157 batv_redirect:
34158   driver = redirect
34159   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34160 .endd
34161 This works because, if the third argument of &%prvscheck%& is empty, the result
34162 of the expansion of a prvs-signed address is the decoded value of the original
34163 address. This router should probably be the first of your routers that handles
34164 local addresses.
34165
34166 To create BATV-signed addresses in the first place, a transport of this form
34167 can be used:
34168 .code
34169 external_smtp_batv:
34170   driver = smtp
34171   return_path = ${prvs {$return_path} \
34172                        {${lookup mysql{SELECT \
34173                        secret FROM batv_prvs WHERE \
34174                        sender='${quote_mysql:$sender_address}'} \
34175                        {$value}fail}}}
34176 .endd
34177 If no key can be found for the existing return path, no signing takes place.
34178
34179
34180
34181 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34182 .cindex "&ACL;" "relay control"
34183 .cindex "relaying" "control by ACL"
34184 .cindex "policy control" "relay control"
34185 An MTA is said to &'relay'& a message if it receives it from some host and
34186 delivers it directly to another host as a result of a remote address contained
34187 within it. Redirecting a local address via an alias or forward file and then
34188 passing the message on to another host is not relaying,
34189 .cindex "&""percent hack""&"
34190 but a redirection as a result of the &"percent hack"& is.
34191
34192 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34193 A host which is acting as a gateway or an MX backup is concerned with incoming
34194 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34195 a host which is acting as a smart host for a number of clients is concerned
34196 with outgoing relaying from those clients to the Internet at large. Often the
34197 same host is fulfilling both functions,
34198 . ///
34199 . as illustrated in the diagram below,
34200 . ///
34201 but in principle these two kinds of relaying are entirely independent. What is
34202 not wanted is the transmission of mail from arbitrary remote hosts through your
34203 system to arbitrary domains.
34204
34205
34206 You can implement relay control by means of suitable statements in the ACL that
34207 runs for each RCPT command. For convenience, it is often easiest to use
34208 Exim's named list facility to define the domains and hosts involved. For
34209 example, suppose you want to do the following:
34210
34211 .ilist
34212 Deliver a number of domains to mailboxes on the local host (or process them
34213 locally in some other way). Let's say these are &'my.dom1.example'& and
34214 &'my.dom2.example'&.
34215 .next
34216 Relay mail for a number of other domains for which you are the secondary MX.
34217 These might be &'friend1.example'& and &'friend2.example'&.
34218 .next
34219 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34220 Suppose your LAN is 192.168.45.0/24.
34221 .endlist
34222
34223
34224 In the main part of the configuration, you put the following definitions:
34225 .code
34226 domainlist local_domains    = my.dom1.example : my.dom2.example
34227 domainlist relay_to_domains = friend1.example : friend2.example
34228 hostlist   relay_from_hosts = 192.168.45.0/24
34229 .endd
34230 Now you can use these definitions in the ACL that is run for every RCPT
34231 command:
34232 .code
34233 acl_check_rcpt:
34234   accept domains = +local_domains : +relay_to_domains
34235   accept hosts   = +relay_from_hosts
34236 .endd
34237 The first statement accepts any RCPT command that contains an address in
34238 the local or relay domains. For any other domain, control passes to the second
34239 statement, which accepts the command only if it comes from one of the relay
34240 hosts. In practice, you will probably want to make your ACL more sophisticated
34241 than this, for example, by including sender and recipient verification. The
34242 default configuration includes a more comprehensive example, which is described
34243 in chapter &<<CHAPdefconfil>>&.
34244
34245
34246
34247 .section "Checking a relay configuration" "SECTcheralcon"
34248 .cindex "relaying" "checking control of"
34249 You can check the relay characteristics of your configuration in the same way
34250 that you can test any ACL behaviour for an incoming SMTP connection, by using
34251 the &%-bh%& option to run a fake SMTP session with which you interact.
34252 .ecindex IIDacl
34253
34254
34255
34256 . ////////////////////////////////////////////////////////////////////////////
34257 . ////////////////////////////////////////////////////////////////////////////
34258
34259 .chapter "Content scanning at ACL time" "CHAPexiscan"
34260 .scindex IIDcosca "content scanning" "at ACL time"
34261 The extension of Exim to include content scanning at ACL time, formerly known
34262 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34263 was integrated into the main source for Exim release 4.50, and Tom continues to
34264 maintain it. Most of the wording of this chapter is taken from Tom's
34265 specification.
34266
34267 It is also possible to scan the content of messages at other times. The
34268 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34269 scanning after all the ACLs have run. A transport filter can be used to scan
34270 messages at delivery time (see the &%transport_filter%& option, described in
34271 chapter &<<CHAPtransportgeneric>>&).
34272
34273 If you want to include the ACL-time content-scanning features when you compile
34274 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34275 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34276
34277 .ilist
34278 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34279 for all MIME parts for SMTP and non-SMTP messages, respectively.
34280 .next
34281 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34282 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34283 run at the end of message reception (the &%acl_smtp_data%& ACL).
34284 .next
34285 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34286 of messages, or parts of messages, for debugging purposes.
34287 .next
34288 Additional expansion variables that are set in the new ACL and by the new
34289 conditions.
34290 .next
34291 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34292 .endlist
34293
34294 Content-scanning is continually evolving, and new features are still being
34295 added. While such features are still unstable and liable to incompatible
34296 changes, they are made available in Exim by setting options whose names begin
34297 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34298 this manual. You can find out about them by reading the file called
34299 &_doc/experimental.txt_&.
34300
34301 All the content-scanning facilities work on a MBOX copy of the message that is
34302 temporarily created in a file called:
34303 .display
34304 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34305 .endd
34306 The &_.eml_& extension is a friendly hint to virus scanners that they can
34307 expect an MBOX-like structure inside that file. The file is created when the
34308 first content scanning facility is called. Subsequent calls to content
34309 scanning conditions open the same file again. The directory is recursively
34310 removed when the &%acl_smtp_data%& ACL has finished running, unless
34311 .code
34312 control = no_mbox_unspool
34313 .endd
34314 has been encountered. When the MIME ACL decodes files, they are put into the
34315 same directory by default.
34316
34317
34318
34319 .section "Scanning for viruses" "SECTscanvirus"
34320 .cindex "virus scanning"
34321 .cindex "content scanning" "for viruses"
34322 .cindex "content scanning" "the &%malware%& condition"
34323 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34324 It supports a &"generic"& interface to scanners called via the shell, and
34325 specialized interfaces for &"daemon"& type virus scanners, which are resident
34326 in memory and thus are much faster.
34327
34328 Since message data needs to have arrived,
34329 the condition may be only called in ACL defined by
34330 &%acl_smtp_data%&,
34331 &%acl_smtp_data_prdr%&,
34332 &%acl_smtp_mime%& or
34333 &%acl_smtp_dkim%&
34334
34335 A timeout of 2 minutes is applied to a scanner call (by default);
34336 if it expires then a defer action is taken.
34337
34338 .oindex "&%av_scanner%&"
34339 You can set the &%av_scanner%& option in the main part of the configuration
34340 to specify which scanner to use, together with any additional options that
34341 are needed. The basic syntax is as follows:
34342 .display
34343 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34344 .endd
34345 If you do not set &%av_scanner%&, it defaults to
34346 .code
34347 av_scanner = sophie:/var/run/sophie
34348 .endd
34349 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34350 before use.
34351 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34352 The following scanner types are supported in this release,
34353 though individual ones can be included or not at build time:
34354
34355 .vlist
34356 .vitem &%avast%&
34357 .cindex "virus scanners" "avast"
34358 This is the scanner daemon of Avast. It has been tested with Avast Core
34359 Security (currently at version 2.2.0).
34360 You can get a trial version at &url(https://www.avast.com) or for Linux
34361 at &url(https://www.avast.com/linux-server-antivirus).
34362 This scanner type takes one option,
34363 which can be either a full path to a UNIX socket,
34364 or host and port specifiers separated by white space.
34365 The host may be a name or an IP address; the port is either a
34366 single number or a pair of numbers with a dash between.
34367 A list of options may follow. These options are interpreted on the
34368 Exim's side of the malware scanner, or are given on separate lines to
34369 the daemon as options before the main scan command.
34370
34371 .cindex &`pass_unscanned`& "avast"
34372 If &`pass_unscanned`&
34373 is set, any files the Avast scanner can't scan (e.g.
34374 decompression bombs, or invalid archives) are considered clean. Use with
34375 care.
34376
34377 For example:
34378 .code
34379 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34380 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34381 av_scanner = avast:192.168.2.22 5036
34382 .endd
34383 If you omit the argument, the default path
34384 &_/var/run/avast/scan.sock_&
34385 is used.
34386 If you use a remote host,
34387 you need to make Exim's spool directory available to it,
34388 as the scanner is passed a file path, not file contents.
34389 For information about available commands and their options you may use
34390 .code
34391 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34392     FLAGS
34393     SENSITIVITY
34394     PACK
34395 .endd
34396
34397 If the scanner returns a temporary failure (e.g. license issues, or
34398 permission problems), the message is deferred and a paniclog entry is
34399 written.  The usual &`defer_ok`& option is available.
34400
34401 .vitem &%aveserver%&
34402 .cindex "virus scanners" "Kaspersky"
34403 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34404 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34405 which is the path to the daemon's UNIX socket. The default is shown in this
34406 example:
34407 .code
34408 av_scanner = aveserver:/var/run/aveserver
34409 .endd
34410
34411
34412 .vitem &%clamd%&
34413 .cindex "virus scanners" "clamd"
34414 This daemon-type scanner is GPL and free. You can get it at
34415 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34416 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34417 in the MIME ACL. This is no longer believed to be necessary.
34418
34419 The options are a list of server specifiers, which may be
34420 a UNIX socket specification,
34421 a TCP socket specification,
34422 or a (global) option.
34423
34424 A socket specification consists of a space-separated list.
34425 For a Unix socket the first element is a full path for the socket,
34426 for a TCP socket the first element is the IP address
34427 and the second a port number,
34428 Any further elements are per-server (non-global) options.
34429 These per-server options are supported:
34430 .code
34431 retry=<timespec>        Retry on connect fail
34432 .endd
34433
34434 The &`retry`& option specifies a time after which a single retry for
34435 a failed connect is made.  The default is to not retry.
34436
34437 If a Unix socket file is specified, only one server is supported.
34438
34439 Examples:
34440 .code
34441 av_scanner = clamd:/opt/clamd/socket
34442 av_scanner = clamd:192.0.2.3 1234
34443 av_scanner = clamd:192.0.2.3 1234:local
34444 av_scanner = clamd:192.0.2.3 1234 retry=10s
34445 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34446 .endd
34447 If the value of av_scanner points to a UNIX socket file or contains the
34448 &`local`&
34449 option, then the ClamAV interface will pass a filename containing the data
34450 to be scanned, which should normally result in less I/O happening and be
34451 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34452 Exim does not assume that there is a common filesystem with the remote host.
34453
34454 The final example shows that multiple TCP targets can be specified.  Exim will
34455 randomly use one for each incoming email (i.e. it load balances them).  Note
34456 that only TCP targets may be used if specifying a list of scanners; a UNIX
34457 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34458 unavailable, Exim will try the remaining one(s) until it finds one that works.
34459 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34460 not keep track of scanner state between multiple messages, and the scanner
34461 selection is random, so the message will get logged in the mainlog for each
34462 email that the down scanner gets chosen first (message wrapped to be readable):
34463 .code
34464 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34465    clamd: connection to localhost, port 3310 failed
34466    (Connection refused)
34467 .endd
34468
34469 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34470 contributing the code for this scanner.
34471
34472 .vitem &%cmdline%&
34473 .cindex "virus scanners" "command line interface"
34474 This is the keyword for the generic command line scanner interface. It can be
34475 used to attach virus scanners that are invoked from the shell. This scanner
34476 type takes 3 mandatory options:
34477
34478 .olist
34479 The full path and name of the scanner binary, with all command line options,
34480 and a placeholder (&`%s`&) for the directory to scan.
34481
34482 .next
34483 A regular expression to match against the STDOUT and STDERR output of the
34484 virus scanner. If the expression matches, a virus was found. You must make
34485 absolutely sure that this expression matches on &"virus found"&. This is called
34486 the &"trigger"& expression.
34487
34488 .next
34489 Another regular expression, containing exactly one pair of parentheses, to
34490 match the name of the virus found in the scanners output. This is called the
34491 &"name"& expression.
34492 .endlist olist
34493
34494 For example, Sophos Sweep reports a virus on a line like this:
34495 .code
34496 Virus 'W32/Magistr-B' found in file ./those.bat
34497 .endd
34498 For the trigger expression, we can match the phrase &"found in file"&. For the
34499 name expression, we want to extract the W32/Magistr-B string, so we can match
34500 for the single quotes left and right of it. Altogether, this makes the
34501 configuration setting:
34502 .code
34503 av_scanner = cmdline:\
34504              /path/to/sweep -ss -all -rec -archive %s:\
34505              found in file:'(.+)'
34506 .endd
34507 .vitem &%drweb%&
34508 .cindex "virus scanners" "DrWeb"
34509 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34510 takes one option,
34511 either a full path to a UNIX socket,
34512 or host and port specifiers separated by white space.
34513 The host may be a name or an IP address; the port is either a
34514 single number or a pair of numbers with a dash between.
34515 For example:
34516 .code
34517 av_scanner = drweb:/var/run/drwebd.sock
34518 av_scanner = drweb:192.168.2.20 31337
34519 .endd
34520 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34521 is used. Thanks to Alex Miller for contributing the code for this scanner.
34522
34523 .vitem &%f-protd%&
34524 .cindex "virus scanners" "f-protd"
34525 The f-protd scanner is accessed via HTTP over TCP.
34526 One argument is taken, being a space-separated hostname and port number
34527 (or port-range).
34528 For example:
34529 .code
34530 av_scanner = f-protd:localhost 10200-10204
34531 .endd
34532 If you omit the argument, the default values shown above are used.
34533
34534 .vitem &%f-prot6d%&
34535 .cindex "virus scanners" "f-prot6d"
34536 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34537 One argument is taken, being a space-separated hostname and port number.
34538 For example:
34539 .code
34540 av_scanner = f-prot6d:localhost 10200
34541 .endd
34542 If you omit the argument, the default values show above are used.
34543
34544 .vitem &%fsecure%&
34545 .cindex "virus scanners" "F-Secure"
34546 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34547 argument which is the path to a UNIX socket. For example:
34548 .code
34549 av_scanner = fsecure:/path/to/.fsav
34550 .endd
34551 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34552 Thelmen for contributing the code for this scanner.
34553
34554 .vitem &%kavdaemon%&
34555 .cindex "virus scanners" "Kaspersky"
34556 This is the scanner daemon of Kaspersky Version 4. This version of the
34557 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34558 scanner type takes one option, which is the path to the daemon's UNIX socket.
34559 For example:
34560 .code
34561 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34562 .endd
34563 The default path is &_/var/run/AvpCtl_&.
34564
34565 .vitem &%mksd%&
34566 .cindex "virus scanners" "mksd"
34567 This was a daemon type scanner that is aimed mainly at Polish users,
34568 though some documentation was available in English.
34569 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34570 and this appears to be a candidate for removal from Exim, unless
34571 we are informed of other virus scanners which use the same protocol
34572 to integrate.
34573 The only option for this scanner type is
34574 the maximum number of processes used simultaneously to scan the attachments,
34575 provided that mksd has
34576 been run with at least the same number of child processes. For example:
34577 .code
34578 av_scanner = mksd:2
34579 .endd
34580 You can safely omit this option (the default value is 1).
34581
34582 .vitem &%sock%&
34583 .cindex "virus scanners" "simple socket-connected"
34584 This is a general-purpose way of talking to simple scanner daemons
34585 running on the local machine.
34586 There are four options:
34587 an address (which may be an IP address and port, or the path of a Unix socket),
34588 a commandline to send (may include a single %s which will be replaced with
34589 the path to the mail file to be scanned),
34590 an RE to trigger on from the returned data,
34591 and an RE to extract malware_name from the returned data.
34592 For example:
34593 .code
34594 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34595 .endd
34596 Note that surrounding whitespace is stripped from each option, meaning
34597 there is no way to specify a trailing newline.
34598 The socket specifier and both regular-expressions are required.
34599 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34600 specify an empty element to get this.
34601
34602 .vitem &%sophie%&
34603 .cindex "virus scanners" "Sophos and Sophie"
34604 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34605 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34606 for this scanner type is the path to the UNIX socket that Sophie uses for
34607 client communication. For example:
34608 .code
34609 av_scanner = sophie:/tmp/sophie
34610 .endd
34611 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34612 the option.
34613 .endlist
34614
34615 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34616 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34617 ACL.
34618
34619 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34620 makes it possible to use different scanners. See further below for an example.
34621 The &%malware%& condition caches its results, so when you use it multiple times
34622 for the same message, the actual scanning process is only carried out once.
34623 However, using expandable items in &%av_scanner%& disables this caching, in
34624 which case each use of the &%malware%& condition causes a new scan of the
34625 message.
34626
34627 The &%malware%& condition takes a right-hand argument that is expanded before
34628 use and taken as a list, slash-separated by default.
34629 The first element can then be one of
34630
34631 .ilist
34632 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34633 The condition succeeds if a virus was found, and fail otherwise. This is the
34634 recommended usage.
34635 .next
34636 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34637 the condition fails immediately.
34638 .next
34639 A regular expression, in which case the message is scanned for viruses. The
34640 condition succeeds if a virus is found and its name matches the regular
34641 expression. This allows you to take special actions on certain types of virus.
34642 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34643 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34644 .endlist
34645
34646 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34647 messages even if there is a problem with the virus scanner.
34648 Otherwise, such a problem causes the ACL to defer.
34649
34650 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34651 specify a non-default timeout.  The default is two minutes.
34652 For example:
34653 .code
34654 malware = * / defer_ok / tmo=10s
34655 .endd
34656 A timeout causes the ACL to defer.
34657
34658 .vindex "&$callout_address$&"
34659 When a connection is made to the scanner the expansion variable &$callout_address$&
34660 is set to record the actual address used.
34661
34662 .vindex "&$malware_name$&"
34663 When a virus is found, the condition sets up an expansion variable called
34664 &$malware_name$& that contains the name of the virus. You can use it in a
34665 &%message%& modifier that specifies the error returned to the sender, and/or in
34666 logging data.
34667
34668 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34669 imposed by your anti-virus scanner.
34670
34671 Here is a very simple scanning example:
34672 .code
34673 deny malware = *
34674      message = This message contains malware ($malware_name)
34675 .endd
34676 The next example accepts messages when there is a problem with the scanner:
34677 .code
34678 deny malware = */defer_ok
34679      message = This message contains malware ($malware_name)
34680 .endd
34681 The next example shows how to use an ACL variable to scan with both sophie and
34682 aveserver. It assumes you have set:
34683 .code
34684 av_scanner = $acl_m0
34685 .endd
34686 in the main Exim configuration.
34687 .code
34688 deny set acl_m0 = sophie
34689      malware = *
34690      message = This message contains malware ($malware_name)
34691
34692 deny set acl_m0 = aveserver
34693      malware = *
34694      message = This message contains malware ($malware_name)
34695 .endd
34696
34697
34698 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34699 .cindex "content scanning" "for spam"
34700 .cindex "spam scanning"
34701 .cindex "SpamAssassin"
34702 .cindex "Rspamd"
34703 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34704 score and a report for the message.
34705 Support is also provided for Rspamd.
34706
34707 For more information about installation and configuration of SpamAssassin or
34708 Rspamd refer to their respective websites at
34709 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34710
34711 SpamAssassin can be installed with CPAN by running:
34712 .code
34713 perl -MCPAN -e 'install Mail::SpamAssassin'
34714 .endd
34715 SpamAssassin has its own set of configuration files. Please review its
34716 documentation to see how you can tweak it. The default installation should work
34717 nicely, however.
34718
34719 .oindex "&%spamd_address%&"
34720 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34721 intend to use an instance running on the local host you do not need to set
34722 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34723 you must set the &%spamd_address%& option in the global part of the Exim
34724 configuration as follows (example):
34725 .code
34726 spamd_address = 192.168.99.45 783
34727 .endd
34728 The SpamAssassin protocol relies on a TCP half-close from the client.
34729 If your SpamAssassin client side is running a Linux system with an
34730 iptables firewall, consider setting
34731 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34732 timeout, Exim uses when waiting for a response from the SpamAssassin
34733 server (currently defaulting to 120s).  With a lower value the Linux
34734 connection tracking may consider your half-closed connection as dead too
34735 soon.
34736
34737
34738 To use Rspamd (which by default listens on all local addresses
34739 on TCP port 11333)
34740 you should add &%variant=rspamd%& after the address/port pair, for example:
34741 .code
34742 spamd_address = 127.0.0.1 11333 variant=rspamd
34743 .endd
34744
34745 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34746 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34747 filename instead of an address/port pair:
34748 .code
34749 spamd_address = /var/run/spamd_socket
34750 .endd
34751 You can have multiple &%spamd%& servers to improve scalability. These can
34752 reside on other hardware reachable over the network. To specify multiple
34753 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34754 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34755 .code
34756 spamd_address = 192.168.2.10 783 : \
34757                 192.168.2.11 783 : \
34758                 192.168.2.12 783
34759 .endd
34760 Up to 32 &%spamd%& servers are supported.
34761 When a server fails to respond to the connection attempt, all other
34762 servers are tried until one succeeds. If no server responds, the &%spam%&
34763 condition defers.
34764
34765 Unix and TCP socket specifications may be mixed in any order.
34766 Each element of the list is a list itself, space-separated by default
34767 and changeable in the usual way (&<<SECTlistsepchange>>&);
34768 take care to not double the separator.
34769
34770 For TCP socket specifications a host name or IP (v4 or v6, but
34771 subject to list-separator quoting rules) address can be used,
34772 and the port can be one or a dash-separated pair.
34773 In the latter case, the range is tried in strict order.
34774
34775 Elements after the first for Unix sockets, or second for TCP socket,
34776 are options.
34777 The supported options are:
34778 .code
34779 pri=<priority>      Selection priority
34780 weight=<value>      Selection bias
34781 time=<start>-<end>  Use only between these times of day
34782 retry=<timespec>    Retry on connect fail
34783 tmo=<timespec>      Connection time limit
34784 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34785 .endd
34786
34787 The &`pri`& option specifies a priority for the server within the list,
34788 higher values being tried first.
34789 The default priority is 1.
34790
34791 The &`weight`& option specifies a selection bias.
34792 Within a priority set
34793 servers are queried in a random fashion, weighted by this value.
34794 The default value for selection bias is 1.
34795
34796 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34797 in the local time zone; each element being one or more digits.
34798 Either the seconds or both minutes and seconds, plus the leading &`.`&
34799 characters, may be omitted and will be taken as zero.
34800
34801 Timeout specifications for the &`retry`& and &`tmo`& options
34802 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34803
34804 The &`tmo`& option specifies an overall timeout for communication.
34805 The default value is two minutes.
34806
34807 The &`retry`& option specifies a time after which a single retry for
34808 a failed connect is made.
34809 The default is to not retry.
34810
34811 The &%spamd_address%& variable is expanded before use if it starts with
34812 a dollar sign. In this case, the expansion may return a string that is
34813 used as the list so that multiple spamd servers can be the result of an
34814 expansion.
34815
34816 .vindex "&$callout_address$&"
34817 When a connection is made to the server the expansion variable &$callout_address$&
34818 is set to record the actual address used.
34819
34820 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34821 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34822 .code
34823 deny spam = joe
34824      message = This message was classified as SPAM
34825 .endd
34826 The right-hand side of the &%spam%& condition specifies a name. This is
34827 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34828 to scan using a specific profile, but rather use the SpamAssassin system-wide
34829 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34830 Rspamd does not use this setting. However, you must put something on the
34831 right-hand side.
34832
34833 The name allows you to use per-domain or per-user antispam profiles in
34834 principle, but this is not straightforward in practice, because a message may
34835 have multiple recipients, not necessarily all in the same domain. Because the
34836 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34837 read the contents of the message, the variables &$local_part$& and &$domain$&
34838 are not set.
34839 Careful enforcement of single-recipient messages
34840 (e.g. by responding with defer in the recipient ACL for all recipients
34841 after the first),
34842 or the use of PRDR,
34843 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34844 are needed to use this feature.
34845
34846 The right-hand side of the &%spam%& condition is expanded before being used, so
34847 you can put lookups or conditions there. When the right-hand side evaluates to
34848 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34849
34850
34851 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34852 large ones may cause significant performance degradation. As most spam messages
34853 are quite small, it is recommended that you do not scan the big ones. For
34854 example:
34855 .code
34856 deny condition = ${if < {$message_size}{10K}}
34857      spam = nobody
34858      message = This message was classified as SPAM
34859 .endd
34860
34861 The &%spam%& condition returns true if the threshold specified in the user's
34862 SpamAssassin profile has been matched or exceeded. If you want to use the
34863 &%spam%& condition for its side effects (see the variables below), you can make
34864 it always return &"true"& by appending &`:true`& to the username.
34865
34866 .cindex "spam scanning" "returned variables"
34867 When the &%spam%& condition is run, it sets up a number of expansion
34868 variables.
34869 Except for &$spam_report$&,
34870 these variables are saved with the received message so are
34871 available for use at delivery time.
34872
34873 .vlist
34874 .vitem &$spam_score$&
34875 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34876 for inclusion in log or reject messages.
34877
34878 .vitem &$spam_score_int$&
34879 The spam score of the message, multiplied by ten, as an integer value. For
34880 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34881 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34882 The integer value is useful for numeric comparisons in conditions.
34883
34884 .vitem &$spam_bar$&
34885 A string consisting of a number of &"+"& or &"-"& characters, representing the
34886 integer part of the spam score value. A spam score of 4.4 would have a
34887 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34888 headers, since MUAs can match on such strings. The maximum length of the
34889 spam bar is 50 characters.
34890
34891 .vitem &$spam_report$&
34892 A multiline text table, containing the full SpamAssassin report for the
34893 message. Useful for inclusion in headers or reject messages.
34894 This variable is only usable in a DATA-time ACL.
34895 Beware that SpamAssassin may return non-ASCII characters, especially
34896 when running in country-specific locales, which are not legal
34897 unencoded in headers.
34898
34899 .vitem &$spam_action$&
34900 For SpamAssassin either 'reject' or 'no action' depending on the
34901 spam score versus threshold.
34902 For Rspamd, the recommended action.
34903
34904 .endlist
34905
34906 The &%spam%& condition caches its results unless expansion in
34907 spamd_address was used. If you call it again with the same user name, it
34908 does not scan again, but rather returns the same values as before.
34909
34910 The &%spam%& condition returns DEFER if there is any error while running
34911 the message through SpamAssassin or if the expansion of spamd_address
34912 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34913 statement block), append &`/defer_ok`& to the right-hand side of the
34914 spam condition, like this:
34915 .code
34916 deny spam    = joe/defer_ok
34917      message = This message was classified as SPAM
34918 .endd
34919 This causes messages to be accepted even if there is a problem with &%spamd%&.
34920
34921 Here is a longer, commented example of the use of the &%spam%&
34922 condition:
34923 .code
34924 # put headers in all messages (no matter if spam or not)
34925 warn  spam = nobody:true
34926       add_header = X-Spam-Score: $spam_score ($spam_bar)
34927       add_header = X-Spam-Report: $spam_report
34928
34929 # add second subject line with *SPAM* marker when message
34930 # is over threshold
34931 warn  spam = nobody
34932       add_header = Subject: *SPAM* $h_Subject:
34933
34934 # reject spam at high scores (> 12)
34935 deny  spam = nobody:true
34936       condition = ${if >{$spam_score_int}{120}{1}{0}}
34937       message = This message scored $spam_score spam points.
34938 .endd
34939
34940
34941
34942 .section "Scanning MIME parts" "SECTscanmimepart"
34943 .cindex "content scanning" "MIME parts"
34944 .cindex "MIME content scanning"
34945 .oindex "&%acl_smtp_mime%&"
34946 .oindex "&%acl_not_smtp_mime%&"
34947 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34948 each MIME part of an SMTP message, including multipart types, in the sequence
34949 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34950 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34951 options may both refer to the same ACL if you want the same processing in both
34952 cases.
34953
34954 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34955 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34956 the case of a non-SMTP message. However, a MIME ACL is called only if the
34957 message contains a &'Content-Type:'& header line. When a call to a MIME
34958 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34959 result code is sent to the client. In the case of an SMTP message, the
34960 &%acl_smtp_data%& ACL is not called when this happens.
34961
34962 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34963 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34964 condition to match against the raw MIME part. You can also use the
34965 &%mime_regex%& condition to match against the decoded MIME part (see section
34966 &<<SECTscanregex>>&).
34967
34968 At the start of a MIME ACL, a number of variables are set from the header
34969 information for the relevant MIME part. These are described below. The contents
34970 of the MIME part are not by default decoded into a disk file except for MIME
34971 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34972 part into a disk file, you can use the &%decode%& condition. The general
34973 syntax is:
34974 .display
34975 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34976 .endd
34977 The right hand side is expanded before use. After expansion,
34978 the value can be:
34979
34980 .olist
34981 &"0"& or &"false"&, in which case no decoding is done.
34982 .next
34983 The string &"default"&. In that case, the file is put in the temporary
34984 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34985 a sequential filename consisting of the message id and a sequence number. The
34986 full path and name is available in &$mime_decoded_filename$& after decoding.
34987 .next
34988 A full path name starting with a slash. If the full name is an existing
34989 directory, it is used as a replacement for the default directory. The filename
34990 is then sequentially assigned. If the path does not exist, it is used as
34991 the full path and filename.
34992 .next
34993 If the string does not start with a slash, it is used as the
34994 filename, and the default path is then used.
34995 .endlist
34996 The &%decode%& condition normally succeeds. It is only false for syntax
34997 errors or unusual circumstances such as memory shortages. You can easily decode
34998 a file with its original, proposed filename using
34999 .code
35000 decode = $mime_filename
35001 .endd
35002 However, you should keep in mind that &$mime_filename$& might contain
35003 anything. If you place files outside of the default path, they are not
35004 automatically unlinked.
35005
35006 For RFC822 attachments (these are messages attached to messages, with a
35007 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35008 as for the primary message, only that the &$mime_is_rfc822$& expansion
35009 variable is set (see below). Attached messages are always decoded to disk
35010 before being checked, and the files are unlinked once the check is done.
35011
35012 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35013 used to match regular expressions against raw and decoded MIME parts,
35014 respectively. They are described in section &<<SECTscanregex>>&.
35015
35016 .cindex "MIME content scanning" "returned variables"
35017 The following list describes all expansion variables that are
35018 available in the MIME ACL:
35019
35020 .vlist
35021 .vitem &$mime_anomaly_level$& &&&
35022        &$mime_anomaly_text$&
35023 .vindex &$mime_anomaly_level$&
35024 .vindex &$mime_anomaly_text$&
35025 If there are problems decoding, these variables contain information on
35026 the detected issue.
35027
35028 .vitem &$mime_boundary$&
35029 .vindex &$mime_boundary$&
35030 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35031 have a boundary string, which is stored in this variable. If the current part
35032 has no boundary parameter in the &'Content-Type:'& header, this variable
35033 contains the empty string.
35034
35035 .vitem &$mime_charset$&
35036 .vindex &$mime_charset$&
35037 This variable contains the character set identifier, if one was found in the
35038 &'Content-Type:'& header. Examples for charset identifiers are:
35039 .code
35040 us-ascii
35041 gb2312 (Chinese)
35042 iso-8859-1
35043 .endd
35044 Please note that this value is not normalized, so you should do matches
35045 case-insensitively.
35046
35047 .vitem &$mime_content_description$&
35048 .vindex &$mime_content_description$&
35049 This variable contains the normalized content of the &'Content-Description:'&
35050 header. It can contain a human-readable description of the parts content. Some
35051 implementations repeat the filename for attachments here, but they are usually
35052 only used for display purposes.
35053
35054 .vitem &$mime_content_disposition$&
35055 .vindex &$mime_content_disposition$&
35056 This variable contains the normalized content of the &'Content-Disposition:'&
35057 header. You can expect strings like &"attachment"& or &"inline"& here.
35058
35059 .vitem &$mime_content_id$&
35060 .vindex &$mime_content_id$&
35061 This variable contains the normalized content of the &'Content-ID:'& header.
35062 This is a unique ID that can be used to reference a part from another part.
35063
35064 .vitem &$mime_content_size$&
35065 .vindex &$mime_content_size$&
35066 This variable is set only after the &%decode%& modifier (see above) has been
35067 successfully run. It contains the size of the decoded part in kilobytes. The
35068 size is always rounded up to full kilobytes, so only a completely empty part
35069 has a &$mime_content_size$& of zero.
35070
35071 .vitem &$mime_content_transfer_encoding$&
35072 .vindex &$mime_content_transfer_encoding$&
35073 This variable contains the normalized content of the
35074 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35075 type. Typical values are &"base64"& and &"quoted-printable"&.
35076
35077 .vitem &$mime_content_type$&
35078 .vindex &$mime_content_type$&
35079 If the MIME part has a &'Content-Type:'& header, this variable contains its
35080 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35081 are some examples of popular MIME types, as they may appear in this variable:
35082 .code
35083 text/plain
35084 text/html
35085 application/octet-stream
35086 image/jpeg
35087 audio/midi
35088 .endd
35089 If the MIME part has no &'Content-Type:'& header, this variable contains the
35090 empty string.
35091
35092 .vitem &$mime_decoded_filename$&
35093 .vindex &$mime_decoded_filename$&
35094 This variable is set only after the &%decode%& modifier (see above) has been
35095 successfully run. It contains the full path and filename of the file
35096 containing the decoded data.
35097 .endlist
35098
35099 .cindex "RFC 2047"
35100 .vlist
35101 .vitem &$mime_filename$&
35102 .vindex &$mime_filename$&
35103 This is perhaps the most important of the MIME variables. It contains a
35104 proposed filename for an attachment, if one was found in either the
35105 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35106 RFC2047
35107 or RFC2231
35108 decoded, but no additional sanity checks are done.
35109  If no filename was
35110 found, this variable contains the empty string.
35111
35112 .vitem &$mime_is_coverletter$&
35113 .vindex &$mime_is_coverletter$&
35114 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35115 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35116 content in the cover letter, while not restricting attachments at all.
35117
35118 The variable contains 1 (true) for a MIME part believed to be part of the
35119 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35120 follows:
35121
35122 .olist
35123 The outermost MIME part of a message is always a cover letter.
35124
35125 .next
35126 If a multipart/alternative or multipart/related MIME part is a cover letter,
35127 so are all MIME subparts within that multipart.
35128
35129 .next
35130 If any other multipart is a cover letter, the first subpart is a cover letter,
35131 and the rest are attachments.
35132
35133 .next
35134 All parts contained within an attachment multipart are attachments.
35135 .endlist olist
35136
35137 As an example, the following will ban &"HTML mail"& (including that sent with
35138 alternative plain text), while allowing HTML files to be attached. HTML
35139 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35140 .code
35141 deny !condition = $mime_is_rfc822
35142      condition = $mime_is_coverletter
35143      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35144      message = HTML mail is not accepted here
35145 .endd
35146
35147 .vitem &$mime_is_multipart$&
35148 .vindex &$mime_is_multipart$&
35149 This variable has the value 1 (true) when the current part has the main type
35150 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35151 Since multipart entities only serve as containers for other parts, you may not
35152 want to carry out specific actions on them.
35153
35154 .vitem &$mime_is_rfc822$&
35155 .vindex &$mime_is_rfc822$&
35156 This variable has the value 1 (true) if the current part is not a part of the
35157 checked message itself, but part of an attached message. Attached message
35158 decoding is fully recursive.
35159
35160 .vitem &$mime_part_count$&
35161 .vindex &$mime_part_count$&
35162 This variable is a counter that is raised for each processed MIME part. It
35163 starts at zero for the very first part (which is usually a multipart). The
35164 counter is per-message, so it is reset when processing RFC822 attachments (see
35165 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35166 complete, so you can use it in the DATA ACL to determine the number of MIME
35167 parts of a message. For non-MIME messages, this variable contains the value -1.
35168 .endlist
35169
35170
35171
35172 .section "Scanning with regular expressions" "SECTscanregex"
35173 .cindex "content scanning" "with regular expressions"
35174 .cindex "regular expressions" "content scanning with"
35175 You can specify your own custom regular expression matches on the full body of
35176 the message, or on individual MIME parts.
35177
35178 The &%regex%& condition takes one or more regular expressions as arguments and
35179 matches them against the full message (when called in the DATA ACL) or a raw
35180 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35181 linewise, with a maximum line length of 32K characters. That means you cannot
35182 have multiline matches with the &%regex%& condition.
35183
35184 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35185 to 32K of decoded content (the whole content at once, not linewise). If the
35186 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35187 is decoded automatically when &%mime_regex%& is executed (using default path
35188 and filename values). If the decoded data is larger than  32K, only the first
35189 32K characters are checked.
35190
35191 The regular expressions are passed as a colon-separated list. To include a
35192 literal colon, you must double it. Since the whole right-hand side string is
35193 expanded before being used, you must also escape dollar signs and backslashes
35194 with more backslashes, or use the &`\N`& facility to disable expansion.
35195 Here is a simple example that contains two regular expressions:
35196 .code
35197 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35198      message = contains blacklisted regex ($regex_match_string)
35199 .endd
35200 The conditions returns true if any one of the regular expressions matches. The
35201 &$regex_match_string$& expansion variable is then set up and contains the
35202 matching regular expression.
35203 The expansion variables &$regex1$& &$regex2$& etc
35204 are set to any substrings captured by the regular expression.
35205
35206 &*Warning*&: With large messages, these conditions can be fairly
35207 CPU-intensive.
35208
35209 .ecindex IIDcosca
35210
35211
35212
35213
35214 . ////////////////////////////////////////////////////////////////////////////
35215 . ////////////////////////////////////////////////////////////////////////////
35216
35217 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35218          "Local scan function"
35219 .scindex IIDlosca "&[local_scan()]& function" "description of"
35220 .cindex "customizing" "input scan using C function"
35221 .cindex "policy control" "by local scan function"
35222 In these days of email worms, viruses, and ever-increasing spam, some sites
35223 want to apply a lot of checking to messages before accepting them.
35224
35225 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35226 passing messages to external virus and spam scanning software. You can also do
35227 a certain amount in Exim itself through string expansions and the &%condition%&
35228 condition in the ACL that runs after the SMTP DATA command or the ACL for
35229 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35230
35231 To allow for further customization to a site's own requirements, there is the
35232 possibility of linking Exim with a private message scanning function, written
35233 in C. If you want to run code that is written in something other than C, you
35234 can of course use a little C stub to call it.
35235
35236 The local scan function is run once for every incoming message, at the point
35237 when Exim is just about to accept the message.
35238 It can therefore be used to control non-SMTP messages from local processes as
35239 well as messages arriving via SMTP.
35240
35241 Exim applies a timeout to calls of the local scan function, and there is an
35242 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35243 Zero means &"no timeout"&.
35244 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35245 before calling the local scan function, so that the most common types of crash
35246 are caught. If the timeout is exceeded or one of those signals is caught, the
35247 incoming message is rejected with a temporary error if it is an SMTP message.
35248 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35249 code. The incident is logged on the main and reject logs.
35250
35251
35252
35253 .section "Building Exim to use a local scan function" "SECID207"
35254 .cindex "&[local_scan()]& function" "building Exim to use"
35255 To make use of the local scan function feature, you must tell Exim where your
35256 function is before building Exim, by setting
35257 both HAVE_LOCAL_SCAN and
35258 LOCAL_SCAN_SOURCE in your
35259 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35260 directory, so you might set
35261 .code
35262 HAVE_LOCAL_SCAN=yes
35263 LOCAL_SCAN_SOURCE=Local/local_scan.c
35264 .endd
35265 for example. The function must be called &[local_scan()]&;
35266 the source file(s) for it should first #define LOCAL_SCAN
35267 and then #include "local_scan.h".
35268 It is called by
35269 Exim after it has received a message, when the success return code is about to
35270 be sent. This is after all the ACLs have been run. The return code from your
35271 function controls whether the message is actually accepted or not. There is a
35272 commented template function (that just accepts the message) in the file
35273 _src/local_scan.c_.
35274
35275 If you want to make use of Exim's runtime configuration file to set options
35276 for your &[local_scan()]& function, you must also set
35277 .code
35278 LOCAL_SCAN_HAS_OPTIONS=yes
35279 .endd
35280 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35281
35282
35283
35284
35285 .section "API for local_scan()" "SECTapiforloc"
35286 .cindex "&[local_scan()]& function" "API description"
35287 .cindex &%dlfunc%& "API description"
35288 You must include this line near the start of your code:
35289 .code
35290 #define LOCAL_SCAN
35291 #include "local_scan.h"
35292 .endd
35293 This header file defines a number of variables and other values, and the
35294 prototype for the function itself. Exim is coded to use unsigned char values
35295 almost exclusively, and one of the things this header defines is a shorthand
35296 for &`unsigned char`& called &`uschar`&.
35297 It also makes available the following macro definitions, to simplify casting character
35298 strings and pointers to character strings:
35299 .code
35300 #define CS   (char *)
35301 #define CCS  (const char *)
35302 #define CSS  (char **)
35303 #define US   (unsigned char *)
35304 #define CUS  (const unsigned char *)
35305 #define USS  (unsigned char **)
35306 .endd
35307 The function prototype for &[local_scan()]& is:
35308 .code
35309 extern int local_scan(int fd, uschar **return_text);
35310 .endd
35311 The arguments are as follows:
35312
35313 .ilist
35314 &%fd%& is a file descriptor for the file that contains the body of the message
35315 (the -D file). The file is open for reading and writing, but updating it is not
35316 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35317
35318 The descriptor is positioned at character 19 of the file, which is the first
35319 character of the body itself, because the first 19 characters are the message
35320 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35321 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35322 case this changes in some future version.
35323 .next
35324 &%return_text%& is an address which you can use to return a pointer to a text
35325 string at the end of the function. The value it points to on entry is NULL.
35326 .endlist
35327
35328 The function must return an &%int%& value which is one of the following macros:
35329
35330 .vlist
35331 .vitem &`LOCAL_SCAN_ACCEPT`&
35332 .vindex "&$local_scan_data$&"
35333 The message is accepted. If you pass back a string of text, it is saved with
35334 the message, and made available in the variable &$local_scan_data$&. No
35335 newlines are permitted (if there are any, they are turned into spaces) and the
35336 maximum length of text is 1000 characters.
35337
35338 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35339 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35340 queued without immediate delivery, and is frozen.
35341
35342 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35343 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35344 queued without immediate delivery.
35345
35346 .vitem &`LOCAL_SCAN_REJECT`&
35347 The message is rejected; the returned text is used as an error message which is
35348 passed back to the sender and which is also logged. Newlines are permitted &--
35349 they cause a multiline response for SMTP rejections, but are converted to
35350 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35351 used.
35352
35353 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35354 The message is temporarily rejected; the returned text is used as an error
35355 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35356 problem"& is used.
35357
35358 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35359 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35360 message is not written to the reject log. It has the effect of unsetting the
35361 &%rejected_header%& log selector for just this rejection. If
35362 &%rejected_header%& is already unset (see the discussion of the
35363 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35364 same as LOCAL_SCAN_REJECT.
35365
35366 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35367 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35368 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35369 .endlist
35370
35371 If the message is not being received by interactive SMTP, rejections are
35372 reported by writing to &%stderr%& or by sending an email, as configured by the
35373 &%-oe%& command line options.
35374
35375
35376
35377 .section "Configuration options for local_scan()" "SECTconoptloc"
35378 .cindex "&[local_scan()]& function" "configuration options"
35379 It is possible to have option settings in the main configuration file
35380 that set values in static variables in the &[local_scan()]& module. If you
35381 want to do this, you must have the line
35382 .code
35383 LOCAL_SCAN_HAS_OPTIONS=yes
35384 .endd
35385 in your &_Local/Makefile_& when you build Exim. (This line is in
35386 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35387 file, you must define static variables to hold the option values, and a table
35388 to define them.
35389
35390 The table must be a vector called &%local_scan_options%&, of type
35391 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35392 and a pointer to the variable that holds the value. The entries must appear in
35393 alphabetical order. Following &%local_scan_options%& you must also define a
35394 variable called &%local_scan_options_count%& that contains the number of
35395 entries in the table. Here is a short example, showing two kinds of option:
35396 .code
35397 static int my_integer_option = 42;
35398 static uschar *my_string_option = US"a default string";
35399
35400 optionlist local_scan_options[] = {
35401   { "my_integer", opt_int,       &my_integer_option },
35402   { "my_string",  opt_stringptr, &my_string_option }
35403 };
35404
35405 int local_scan_options_count =
35406   sizeof(local_scan_options)/sizeof(optionlist);
35407 .endd
35408 The values of the variables can now be changed from Exim's runtime
35409 configuration file by including a local scan section as in this example:
35410 .code
35411 begin local_scan
35412 my_integer = 99
35413 my_string = some string of text...
35414 .endd
35415 The available types of option data are as follows:
35416
35417 .vlist
35418 .vitem &*opt_bool*&
35419 This specifies a boolean (true/false) option. The address should point to a
35420 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35421 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35422 whether such a variable has been set at all, you can initialize it to
35423 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35424 values.)
35425
35426 .vitem &*opt_fixed*&
35427 This specifies a fixed point number, such as is used for load averages.
35428 The address should point to a variable of type &`int`&. The value is stored
35429 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35430
35431 .vitem &*opt_int*&
35432 This specifies an integer; the address should point to a variable of type
35433 &`int`&. The value may be specified in any of the integer formats accepted by
35434 Exim.
35435
35436 .vitem &*opt_mkint*&
35437 This is the same as &%opt_int%&, except that when such a value is output in a
35438 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35439 printed with the suffix K or M.
35440
35441 .vitem &*opt_octint*&
35442 This also specifies an integer, but the value is always interpreted as an
35443 octal integer, whether or not it starts with the digit zero, and it is
35444 always output in octal.
35445
35446 .vitem &*opt_stringptr*&
35447 This specifies a string value; the address must be a pointer to a
35448 variable that points to a string (for example, of type &`uschar *`&).
35449
35450 .vitem &*opt_time*&
35451 This specifies a time interval value. The address must point to a variable of
35452 type &`int`&. The value that is placed there is a number of seconds.
35453 .endlist
35454
35455 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35456 out the values of all the &[local_scan()]& options.
35457
35458
35459
35460 .section "Available Exim variables" "SECID208"
35461 .cindex "&[local_scan()]& function" "available Exim variables"
35462 The header &_local_scan.h_& gives you access to a number of C variables. These
35463 are the only ones that are guaranteed to be maintained from release to release.
35464 Note, however, that you can obtain the value of any Exim expansion variable,
35465 including &$recipients$&, by calling &'expand_string()'&. The exported
35466 C variables are as follows:
35467
35468 .vlist
35469 .vitem &*int&~body_linecount*&
35470 This variable contains the number of lines in the message's body.
35471 It is not valid if the &%spool_wireformat%& option is used.
35472
35473 .vitem &*int&~body_zerocount*&
35474 This variable contains the number of binary zero bytes in the message's body.
35475 It is not valid if the &%spool_wireformat%& option is used.
35476
35477 .vitem &*unsigned&~int&~debug_selector*&
35478 This variable is set to zero when no debugging is taking place. Otherwise, it
35479 is a bitmap of debugging selectors. Two bits are identified for use in
35480 &[local_scan()]&; they are defined as macros:
35481
35482 .ilist
35483 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35484 testing option that is not privileged &-- any caller may set it. All the
35485 other selector bits can be set only by admin users.
35486
35487 .next
35488 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35489 by the &`+local_scan`& debug selector. It is not included in the default set
35490 of debugging bits.
35491 .endlist ilist
35492
35493 Thus, to write to the debugging output only when &`+local_scan`& has been
35494 selected, you should use code like this:
35495 .code
35496 if ((debug_selector & D_local_scan) != 0)
35497   debug_printf("xxx", ...);
35498 .endd
35499 .vitem &*uschar&~*expand_string_message*&
35500 After a failing call to &'expand_string()'& (returned value NULL), the
35501 variable &%expand_string_message%& contains the error message, zero-terminated.
35502
35503 .vitem &*header_line&~*header_list*&
35504 A pointer to a chain of header lines. The &%header_line%& structure is
35505 discussed below.
35506
35507 .vitem &*header_line&~*header_last*&
35508 A pointer to the last of the header lines.
35509
35510 .vitem &*const&~uschar&~*headers_charset*&
35511 The value of the &%headers_charset%& configuration option.
35512
35513 .vitem &*BOOL&~host_checking*&
35514 This variable is TRUE during a host checking session that is initiated by the
35515 &%-bh%& command line option.
35516
35517 .vitem &*uschar&~*interface_address*&
35518 The IP address of the interface that received the message, as a string. This
35519 is NULL for locally submitted messages.
35520
35521 .vitem &*int&~interface_port*&
35522 The port on which this message was received. When testing with the &%-bh%&
35523 command line option, the value of this variable is -1 unless a port has been
35524 specified via the &%-oMi%& option.
35525
35526 .vitem &*uschar&~*message_id*&
35527 This variable contains Exim's message id for the incoming message (the value of
35528 &$message_exim_id$&) as a zero-terminated string.
35529
35530 .vitem &*uschar&~*received_protocol*&
35531 The name of the protocol by which the message was received.
35532
35533 .vitem &*int&~recipients_count*&
35534 The number of accepted recipients.
35535
35536 .vitem &*recipient_item&~*recipients_list*&
35537 .cindex "recipient" "adding in local scan"
35538 .cindex "recipient" "removing in local scan"
35539 The list of accepted recipients, held in a vector of length
35540 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35541 can add additional recipients by calling &'receive_add_recipient()'& (see
35542 below). You can delete recipients by removing them from the vector and
35543 adjusting the value in &%recipients_count%&. In particular, by setting
35544 &%recipients_count%& to zero you remove all recipients. If you then return the
35545 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35546 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35547 and then call &'receive_add_recipient()'& as often as needed.
35548
35549 .vitem &*uschar&~*sender_address*&
35550 The envelope sender address. For bounce messages this is the empty string.
35551
35552 .vitem &*uschar&~*sender_host_address*&
35553 The IP address of the sending host, as a string. This is NULL for
35554 locally-submitted messages.
35555
35556 .vitem &*uschar&~*sender_host_authenticated*&
35557 The name of the authentication mechanism that was used, or NULL if the message
35558 was not received over an authenticated SMTP connection.
35559
35560 .vitem &*uschar&~*sender_host_name*&
35561 The name of the sending host, if known.
35562
35563 .vitem &*int&~sender_host_port*&
35564 The port on the sending host.
35565
35566 .vitem &*BOOL&~smtp_input*&
35567 This variable is TRUE for all SMTP input, including BSMTP.
35568
35569 .vitem &*BOOL&~smtp_batched_input*&
35570 This variable is TRUE for BSMTP input.
35571
35572 .vitem &*int&~store_pool*&
35573 The contents of this variable control which pool of memory is used for new
35574 requests. See section &<<SECTmemhanloc>>& for details.
35575 .endlist
35576
35577
35578 .section "Structure of header lines" "SECID209"
35579 The &%header_line%& structure contains the members listed below.
35580 You can add additional header lines by calling the &'header_add()'& function
35581 (see below). You can cause header lines to be ignored (deleted) by setting
35582 their type to *.
35583
35584
35585 .vlist
35586 .vitem &*struct&~header_line&~*next*&
35587 A pointer to the next header line, or NULL for the last line.
35588
35589 .vitem &*int&~type*&
35590 A code identifying certain headers that Exim recognizes. The codes are printing
35591 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35592 Notice in particular that any header line whose type is * is not transmitted
35593 with the message. This flagging is used for header lines that have been
35594 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35595 lines.) Effectively, * means &"deleted"&.
35596
35597 .vitem &*int&~slen*&
35598 The number of characters in the header line, including the terminating and any
35599 internal newlines.
35600
35601 .vitem &*uschar&~*text*&
35602 A pointer to the text of the header. It always ends with a newline, followed by
35603 a zero byte. Internal newlines are preserved.
35604 .endlist
35605
35606
35607
35608 .section "Structure of recipient items" "SECID210"
35609 The &%recipient_item%& structure contains these members:
35610
35611 .vlist
35612 .vitem &*uschar&~*address*&
35613 This is a pointer to the recipient address as it was received.
35614
35615 .vitem &*int&~pno*&
35616 This is used in later Exim processing when top level addresses are created by
35617 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35618 and must always contain -1 at this stage.
35619
35620 .vitem &*uschar&~*errors_to*&
35621 If this value is not NULL, bounce messages caused by failing to deliver to the
35622 recipient are sent to the address it contains. In other words, it overrides the
35623 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35624 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35625 an unqualified address, Exim qualifies it using the domain from
35626 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35627 is NULL for all recipients.
35628 .endlist
35629
35630
35631
35632 .section "Available Exim functions" "SECID211"
35633 .cindex "&[local_scan()]& function" "available Exim functions"
35634 The header &_local_scan.h_& gives you access to a number of Exim functions.
35635 These are the only ones that are guaranteed to be maintained from release to
35636 release:
35637
35638 .vlist
35639 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35640        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35641
35642 This function creates a child process that runs the command specified by
35643 &%argv%&. The environment for the process is specified by &%envp%&, which can
35644 be NULL if no environment variables are to be passed. A new umask is supplied
35645 for the process in &%newumask%&.
35646
35647 Pipes to the standard input and output of the new process are set up
35648 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35649 standard error is cloned to the standard output. If there are any file
35650 descriptors &"in the way"& in the new process, they are closed. If the final
35651 argument is TRUE, the new process is made into a process group leader.
35652
35653 The function returns the pid of the new process, or -1 if things go wrong.
35654
35655 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35656 This function waits for a child process to terminate, or for a timeout (in
35657 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35658 return value is as follows:
35659
35660 .ilist
35661 >= 0
35662
35663 The process terminated by a normal exit and the value is the process
35664 ending status.
35665
35666 .next
35667 < 0 and > &--256
35668
35669 The process was terminated by a signal and the value is the negation of the
35670 signal number.
35671
35672 .next
35673 &--256
35674
35675 The process timed out.
35676 .next
35677 &--257
35678
35679 The was some other error in wait(); &%errno%& is still set.
35680 .endlist
35681
35682 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35683 This function provide you with a means of submitting a new message to
35684 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35685 want, but this packages it all up for you.) The function creates a pipe,
35686 forks a subprocess that is running
35687 .code
35688 exim -t -oem -oi -f <>
35689 .endd
35690 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35691 that is connected to the standard input. The yield of the function is the PID
35692 of the subprocess. You can then write a message to the file descriptor, with
35693 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35694
35695 When you have finished, call &'child_close()'& to wait for the process to
35696 finish and to collect its ending status. A timeout value of zero is usually
35697 fine in this circumstance. Unless you have made a mistake with the recipient
35698 addresses, you should get a return code of zero.
35699
35700
35701 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35702        *sender_authentication)*&
35703 This function is a more sophisticated version of &'child_open()'&. The command
35704 that it runs is:
35705 .display
35706 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35707 .endd
35708 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35709
35710
35711 .vitem &*void&~debug_printf(char&~*,&~...)*&
35712 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35713 output is written to the standard error stream. If no debugging is selected,
35714 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35715 conditional on the &`local_scan`& debug selector by coding like this:
35716 .code
35717 if ((debug_selector & D_local_scan) != 0)
35718   debug_printf("xxx", ...);
35719 .endd
35720
35721 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35722 This is an interface to Exim's string expansion code. The return value is the
35723 expanded string, or NULL if there was an expansion failure.
35724 The C variable &%expand_string_message%& contains an error message after an
35725 expansion failure. If expansion does not change the string, the return value is
35726 the pointer to the input string. Otherwise, the return value points to a new
35727 block of memory that was obtained by a call to &'store_get()'&. See section
35728 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35729
35730 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35731 This function allows you to an add additional header line at the end of the
35732 existing ones. The first argument is the type, and should normally be a space
35733 character. The second argument is a format string and any number of
35734 substitution arguments as for &[sprintf()]&. You may include internal newlines
35735 if you want, and you must ensure that the string ends with a newline.
35736
35737 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35738         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35739 This function adds a new header line at a specified point in the header
35740 chain. The header itself is specified as for &'header_add()'&.
35741
35742 If &%name%& is NULL, the new header is added at the end of the chain if
35743 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35744 NULL, the header lines are searched for the first non-deleted header that
35745 matches the name. If one is found, the new header is added before it if
35746 &%after%& is false. If &%after%& is true, the new header is added after the
35747 found header and any adjacent subsequent ones with the same name (even if
35748 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35749 option controls where the header is added. If it is true, addition is at the
35750 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35751 headers, or at the top if there are no &'Received:'& headers, you could use
35752 .code
35753 header_add_at_position(TRUE, US"Received", TRUE,
35754   ' ', "X-xxx: ...");
35755 .endd
35756 Normally, there is always at least one non-deleted &'Received:'& header, but
35757 there may not be if &%received_header_text%& expands to an empty string.
35758
35759
35760 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35761 This function removes header lines. If &%occurrence%& is zero or negative, all
35762 occurrences of the header are removed. If occurrence is greater than zero, that
35763 particular instance of the header is removed. If no header(s) can be found that
35764 match the specification, the function does nothing.
35765
35766
35767 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35768         int&~length,&~BOOL&~notdel)*&"
35769 This function tests whether the given header has the given name. It is not just
35770 a string comparison, because white space is permitted between the name and the
35771 colon. If the &%notdel%& argument is true, a false return is forced for all
35772 &"deleted"& headers; otherwise they are not treated specially. For example:
35773 .code
35774 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35775 .endd
35776 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35777 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35778 This function base64-encodes a string, which is passed by address and length.
35779 The text may contain bytes of any value, including zero. The result is passed
35780 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35781 zero-terminated.
35782
35783 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35784 This function decodes a base64-encoded string. Its arguments are a
35785 zero-terminated base64-encoded string and the address of a variable that is set
35786 to point to the result, which is in dynamic memory. The length of the decoded
35787 string is the yield of the function. If the input is invalid base64 data, the
35788 yield is -1. A zero byte is added to the end of the output string to make it
35789 easy to interpret as a C string (assuming it contains no zeros of its own). The
35790 added zero byte is not included in the returned count.
35791
35792 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35793 This function checks for a match in a domain list. Domains are always
35794 matched caselessly. The return value is one of the following:
35795 .itable none 0 0 2 15* left 85* left
35796 .irow &`OK`&    "match succeeded"
35797 .irow &`FAIL`&  "match failed"
35798 .irow &`DEFER`& "match deferred"
35799 .endtable
35800 DEFER is usually caused by some kind of lookup defer, such as the
35801 inability to contact a database.
35802
35803 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35804         BOOL&~caseless)*&"
35805 This function checks for a match in a local part list. The third argument
35806 controls case-sensitivity. The return values are as for
35807 &'lss_match_domain()'&.
35808
35809 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35810         BOOL&~caseless)*&"
35811 This function checks for a match in an address list. The third argument
35812 controls the case-sensitivity of the local part match. The domain is always
35813 matched caselessly. The return values are as for &'lss_match_domain()'&.
35814
35815 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35816         uschar&~*list)*&"
35817 This function checks for a match in a host list. The most common usage is
35818 expected to be
35819 .code
35820 lss_match_host(sender_host_name, sender_host_address, ...)
35821 .endd
35822 .vindex "&$sender_host_address$&"
35823 An empty address field matches an empty item in the host list. If the host name
35824 is NULL, the name corresponding to &$sender_host_address$& is automatically
35825 looked up if a host name is required to match an item in the list. The return
35826 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35827 returns ERROR in the case when it had to look up a host name, but the lookup
35828 failed.
35829
35830 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35831         *format,&~...)*&"
35832 This function writes to Exim's log files. The first argument should be zero (it
35833 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35834 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35835 them. It specifies to which log or logs the message is written. The remaining
35836 arguments are a format and relevant insertion arguments. The string should not
35837 contain any newlines, not even at the end.
35838
35839
35840 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35841 This function adds an additional recipient to the message. The first argument
35842 is the recipient address. If it is unqualified (has no domain), it is qualified
35843 with the &%qualify_recipient%& domain. The second argument must always be -1.
35844
35845 This function does not allow you to specify a private &%errors_to%& address (as
35846 described with the structure of &%recipient_item%& above), because it pre-dates
35847 the addition of that field to the structure. However, it is easy to add such a
35848 value afterwards. For example:
35849 .code
35850  receive_add_recipient(US"monitor@mydom.example", -1);
35851  recipients_list[recipients_count-1].errors_to =
35852    US"postmaster@mydom.example";
35853 .endd
35854
35855 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35856 This is a convenience function to remove a named recipient from the list of
35857 recipients. It returns true if a recipient was removed, and false if no
35858 matching recipient could be found. The argument must be a complete email
35859 address.
35860 .endlist
35861
35862
35863 .cindex "RFC 2047"
35864 .vlist
35865 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35866   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35867 This function decodes strings that are encoded according to RFC 2047. Typically
35868 these are the contents of header lines. First, each &"encoded word"& is decoded
35869 from the Q or B encoding into a byte-string. Then, if provided with the name of
35870 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35871 made  to translate the result to the named character set. If this fails, the
35872 binary string is returned with an error message.
35873
35874 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35875 maximum MIME word length is enforced. The third argument is the target
35876 encoding, or NULL if no translation is wanted.
35877
35878 .cindex "binary zero" "in RFC 2047 decoding"
35879 .cindex "RFC 2047" "binary zero in"
35880 If a binary zero is encountered in the decoded string, it is replaced by the
35881 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35882 not be 0 because header lines are handled as zero-terminated strings.
35883
35884 The function returns the result of processing the string, zero-terminated; if
35885 &%lenptr%& is not NULL, the length of the result is set in the variable to
35886 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35887
35888 If an error is encountered, the function returns NULL and uses the &%error%&
35889 argument to return an error message. The variable pointed to by &%error%& is
35890 set to NULL if there is no error; it may be set non-NULL even when the function
35891 returns a non-NULL value if decoding was successful, but there was a problem
35892 with translation.
35893
35894
35895 .vitem &*int&~smtp_fflush(void)*&
35896 This function is used in conjunction with &'smtp_printf()'&, as described
35897 below.
35898
35899 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35900 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35901 output stream. You should use this function only when there is an SMTP output
35902 stream, that is, when the incoming message is being received via interactive
35903 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35904 is FALSE. If you want to test for an incoming message from another host (as
35905 opposed to a local process that used the &%-bs%& command line option), you can
35906 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35907 is involved.
35908
35909 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35910 output function, so it can be used for all forms of SMTP connection.
35911
35912 The second argument is used to request that the data be buffered
35913 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35914 This is advisory only, but likely to save on system-calls and packets
35915 sent when a sequence of calls to the function are made.
35916
35917 The argument was added in Exim version 4.90 - changing the API/ABI.
35918 Nobody noticed until 4.93 was imminent, at which point the
35919 ABI version number was incremented.
35920
35921 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35922 must start with an appropriate response code: 550 if you are going to return
35923 LOCAL_SCAN_REJECT, 451 if you are going to return
35924 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35925 initial lines of a multi-line response, the code must be followed by a hyphen
35926 to indicate that the line is not the final response line. You must also ensure
35927 that the lines you write terminate with CRLF. For example:
35928 .code
35929 smtp_printf("550-this is some extra info\r\n");
35930 return LOCAL_SCAN_REJECT;
35931 .endd
35932 Note that you can also create multi-line responses by including newlines in
35933 the data returned via the &%return_text%& argument. The added value of using
35934 &'smtp_printf()'& is that, for instance, you could introduce delays between
35935 multiple output lines.
35936
35937 The &'smtp_printf()'& function does not return any error indication, because it
35938 does not
35939 guarantee a flush of
35940 pending output, and therefore does not test
35941 the state of the stream. (In the main code of Exim, flushing and error
35942 detection is done when Exim is ready for the next SMTP input command.) If
35943 you want to flush the output and check for an error (for example, the
35944 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35945 arguments. It flushes the output stream, and returns a non-zero value if there
35946 is an error.
35947
35948 .vitem &*void&~*store_get(int,BOOL)*&
35949 This function accesses Exim's internal store (memory) manager. It gets a new
35950 chunk of memory whose size is given by the first argument.
35951 The second argument should be given as TRUE if the memory will be used for
35952 data possibly coming from an attacker (eg. the message content),
35953 FALSE if it is locally-sourced.
35954 Exim bombs out if it ever
35955 runs out of memory. See the next section for a discussion of memory handling.
35956
35957 .vitem &*void&~*store_get_perm(int,BOOL)*&
35958 This function is like &'store_get()'&, but it always gets memory from the
35959 permanent pool. See the next section for a discussion of memory handling.
35960
35961 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35962 See below.
35963
35964 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35965 See below.
35966
35967 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35968 These three functions create strings using Exim's dynamic memory facilities.
35969 The first makes a copy of an entire string. The second copies up to a maximum
35970 number of characters, indicated by the second argument. The third uses a format
35971 and insertion arguments to create a new string. In each case, the result is a
35972 pointer to a new string in the current memory pool. See the next section for
35973 more discussion.
35974 .endlist
35975
35976
35977
35978 .section "More about Exim's memory handling" "SECTmemhanloc"
35979 .cindex "&[local_scan()]& function" "memory handling"
35980 No function is provided for freeing memory, because that is never needed.
35981 The dynamic memory that Exim uses when receiving a message is automatically
35982 recycled if another message is received by the same process (this applies only
35983 to incoming SMTP connections &-- other input methods can supply only one
35984 message at a time). After receiving the last message, a reception process
35985 terminates.
35986
35987 Because it is recycled, the normal dynamic memory cannot be used for holding
35988 data that must be preserved over a number of incoming messages on the same SMTP
35989 connection. However, Exim in fact uses two pools of dynamic memory; the second
35990 one is not recycled, and can be used for this purpose.
35991
35992 If you want to allocate memory that remains available for subsequent messages
35993 in the same SMTP connection, you should set
35994 .code
35995 store_pool = POOL_PERM
35996 .endd
35997 before calling the function that does the allocation. There is no need to
35998 restore the value if you do not need to; however, if you do want to revert to
35999 the normal pool, you can either restore the previous value of &%store_pool%& or
36000 set it explicitly to POOL_MAIN.
36001
36002 The pool setting applies to all functions that get dynamic memory, including
36003 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36004 There is also a convenience function called &'store_get_perm()'& that gets a
36005 block of memory from the permanent pool while preserving the value of
36006 &%store_pool%&.
36007 .ecindex IIDlosca
36008
36009
36010
36011
36012 . ////////////////////////////////////////////////////////////////////////////
36013 . ////////////////////////////////////////////////////////////////////////////
36014
36015 .chapter "System-wide message filtering" "CHAPsystemfilter"
36016 .scindex IIDsysfil1 "filter" "system filter"
36017 .scindex IIDsysfil2 "filtering all mail"
36018 .scindex IIDsysfil3 "system filter"
36019 The previous chapters (on ACLs and the local scan function) describe checks
36020 that can be applied to messages before they are accepted by a host. There is
36021 also a mechanism for checking messages once they have been received, but before
36022 they are delivered. This is called the &'system filter'&.
36023
36024 The system filter operates in a similar manner to users' filter files, but it
36025 is run just once per message (however many recipients the message has).
36026 It should not normally be used as a substitute for routing, because &%deliver%&
36027 commands in a system router provide new envelope recipient addresses.
36028 The system filter must be an Exim filter. It cannot be a Sieve filter.
36029
36030 The system filter is run at the start of a delivery attempt, before any routing
36031 is done. If a message fails to be completely delivered at the first attempt,
36032 the system filter is run again at the start of every retry.
36033 If you want your filter to do something only once per message, you can make use
36034 .cindex retry condition
36035 of the &%first_delivery%& condition in an &%if%& command in the filter to
36036 prevent it happening on retries.
36037
36038 .vindex "&$domain$&"
36039 .vindex "&$local_part$&"
36040 &*Warning*&: Because the system filter runs just once, variables that are
36041 specific to individual recipient addresses, such as &$local_part$& and
36042 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36043 you want to run a centrally-specified filter for each recipient address
36044 independently, you can do so by setting up a suitable &(redirect)& router, as
36045 described in section &<<SECTperaddfil>>& below.
36046
36047
36048 .section "Specifying a system filter" "SECID212"
36049 .cindex "uid (user id)" "system filter"
36050 .cindex "gid (group id)" "system filter"
36051 The name of the file that contains the system filter must be specified by
36052 setting &%system_filter%&. If you want the filter to run under a uid and gid
36053 other than root, you must also set &%system_filter_user%& and
36054 &%system_filter_group%& as appropriate. For example:
36055 .code
36056 system_filter = /etc/mail/exim.filter
36057 system_filter_user = exim
36058 .endd
36059 If a system filter generates any deliveries directly to files or pipes (via the
36060 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36061 specified by setting &%system_filter_file_transport%& and
36062 &%system_filter_pipe_transport%&, respectively. Similarly,
36063 &%system_filter_reply_transport%& must be set to handle any messages generated
36064 by the &%reply%& command.
36065
36066
36067 .section "Testing a system filter" "SECID213"
36068 You can run simple tests of a system filter in the same way as for a user
36069 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36070 are permitted only in system filters are recognized.
36071
36072 If you want to test the combined effect of a system filter and a user filter,
36073 you can use both &%-bF%& and &%-bf%& on the same command line.
36074
36075
36076
36077 .section "Contents of a system filter" "SECID214"
36078 The language used to specify system filters is the same as for users' filter
36079 files. It is described in the separate end-user document &'Exim's interface to
36080 mail filtering'&. However, there are some additional features that are
36081 available only in system filters; these are described in subsequent sections.
36082 If they are encountered in a user's filter file or when testing with &%-bf%&,
36083 they cause errors.
36084
36085 .cindex "frozen messages" "manual thaw; testing in filter"
36086 There are two special conditions which, though available in users' filter
36087 files, are designed for use in system filters. The condition &%first_delivery%&
36088 is true only for the first attempt at delivering a message, and
36089 &%manually_thawed%& is true only if the message has been frozen, and
36090 subsequently thawed by an admin user. An explicit forced delivery counts as a
36091 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36092
36093 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36094 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36095 succeed, it will not be tried again.
36096 If you want Exim to retry an unseen delivery until it succeeds, you should
36097 arrange to set it up every time the filter runs.
36098
36099 When a system filter finishes running, the values of the variables &$n0$& &--
36100 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36101 users' filter files. Thus a system filter can, for example, set up &"scores"&
36102 to which users' filter files can refer.
36103
36104
36105
36106 .section "Additional variable for system filters" "SECID215"
36107 .vindex "&$recipients$&"
36108 The expansion variable &$recipients$&, containing a list of all the recipients
36109 of the message (separated by commas and white space), is available in system
36110 filters. It is not available in users' filters for privacy reasons.
36111
36112
36113
36114 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36115 .cindex "freezing messages"
36116 .cindex "message" "freezing"
36117 .cindex "message" "forced failure"
36118 .cindex "&%fail%&" "in system filter"
36119 .cindex "&%freeze%& in system filter"
36120 .cindex "&%defer%& in system filter"
36121 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36122 always available in system filters, but are not normally enabled in users'
36123 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36124 for the &(redirect)& router.) These commands can optionally be followed by the
36125 word &%text%& and a string containing an error message, for example:
36126 .code
36127 fail text "this message looks like spam to me"
36128 .endd
36129 The keyword &%text%& is optional if the next character is a double quote.
36130
36131 The &%defer%& command defers delivery of the original recipients of the
36132 message. The &%fail%& command causes all the original recipients to be failed,
36133 and a bounce message to be created. The &%freeze%& command suspends all
36134 delivery attempts for the original recipients. In all cases, any new deliveries
36135 that are specified by the filter are attempted as normal after the filter has
36136 run.
36137
36138 The &%freeze%& command is ignored if the message has been manually unfrozen and
36139 not manually frozen since. This means that automatic freezing by a system
36140 filter can be used as a way of checking out suspicious messages. If a message
36141 is found to be all right, manually unfreezing it allows it to be delivered.
36142
36143 .cindex "log" "&%fail%& command log line"
36144 .cindex "&%fail%&" "log line; reducing"
36145 The text given with a fail command is used as part of the bounce message as
36146 well as being written to the log. If the message is quite long, this can fill
36147 up a lot of log space when such failures are common. To reduce the size of the
36148 log message, Exim interprets the text in a special way if it starts with the
36149 two characters &`<<`& and contains &`>>`& later. The text between these two
36150 strings is written to the log, and the rest of the text is used in the bounce
36151 message. For example:
36152 .code
36153 fail "<<filter test 1>>Your message is rejected \
36154      because it contains attachments that we are \
36155      not prepared to receive."
36156 .endd
36157
36158 .cindex "loop" "caused by &%fail%&"
36159 Take great care with the &%fail%& command when basing the decision to fail on
36160 the contents of the message, because the bounce message will of course include
36161 the contents of the original message and will therefore trigger the &%fail%&
36162 command again (causing a mail loop) unless steps are taken to prevent this.
36163 Testing the &%error_message%& condition is one way to prevent this. You could
36164 use, for example
36165 .code
36166 if $message_body contains "this is spam" and not error_message
36167 then fail text "spam is not wanted here" endif
36168 .endd
36169 though of course that might let through unwanted bounce messages. The
36170 alternative is clever checking of the body and/or headers to detect bounces
36171 generated by the filter.
36172
36173 The interpretation of a system filter file ceases after a
36174 &%defer%&,
36175 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36176 set up earlier in the filter file are honoured, so you can use a sequence such
36177 as
36178 .code
36179 mail ...
36180 freeze
36181 .endd
36182 to send a specified message when the system filter is freezing (or deferring or
36183 failing) a message. The normal deliveries for the message do not, of course,
36184 take place.
36185
36186
36187
36188 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36189 .cindex "header lines" "adding; in system filter"
36190 .cindex "header lines" "removing; in system filter"
36191 .cindex "filter" "header lines; adding/removing"
36192 Two filter commands that are available only in system filters are:
36193 .code
36194 headers add <string>
36195 headers remove <string>
36196 .endd
36197 The argument for the &%headers add%& is a string that is expanded and then
36198 added to the end of the message's headers. It is the responsibility of the
36199 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36200 space is ignored, and if the string is otherwise empty, or if the expansion is
36201 forced to fail, the command has no effect.
36202
36203 You can use &"\n"& within the string, followed by white space, to specify
36204 continued header lines. More than one header may be added in one command by
36205 including &"\n"& within the string without any following white space. For
36206 example:
36207 .code
36208 headers add "X-header-1: ....\n  \
36209              continuation of X-header-1 ...\n\
36210              X-header-2: ...."
36211 .endd
36212 Note that the header line continuation white space after the first newline must
36213 be placed before the backslash that continues the input string, because white
36214 space after input continuations is ignored.
36215
36216 The argument for &%headers remove%& is a colon-separated list of header names.
36217 This command applies only to those headers that are stored with the message;
36218 those that are added at delivery time (such as &'Envelope-To:'& and
36219 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36220 header with the same name, they are all removed.
36221
36222 The &%headers%& command in a system filter makes an immediate change to the set
36223 of header lines that was received with the message (with possible additions
36224 from ACL processing). Subsequent commands in the system filter operate on the
36225 modified set, which also forms the basis for subsequent message delivery.
36226 Unless further modified during routing or transporting, this set of headers is
36227 used for all recipients of the message.
36228
36229 During routing and transporting, the variables that refer to the contents of
36230 header lines refer only to those lines that are in this set. Thus, header lines
36231 that are added by a system filter are visible to users' filter files and to all
36232 routers and transports. This contrasts with the manipulation of header lines by
36233 routers and transports, which is not immediate, but which instead is saved up
36234 until the message is actually being written (see section
36235 &<<SECTheadersaddrem>>&).
36236
36237 If the message is not delivered at the first attempt, header lines that were
36238 added by the system filter are stored with the message, and so are still
36239 present at the next delivery attempt. Header lines that were removed are still
36240 present, but marked &"deleted"& so that they are not transported with the
36241 message. For this reason, it is usual to make the &%headers%& command
36242 conditional on &%first_delivery%& so that the set of header lines is not
36243 modified more than once.
36244
36245 Because header modification in a system filter acts immediately, you have to
36246 use an indirect approach if you want to modify the contents of a header line.
36247 For example:
36248 .code
36249 headers add "Old-Subject: $h_subject:"
36250 headers remove "Subject"
36251 headers add "Subject: new subject (was: $h_old-subject:)"
36252 headers remove "Old-Subject"
36253 .endd
36254
36255
36256
36257 .section "Setting an errors address in a system filter" "SECID217"
36258 .cindex "envelope from"
36259 .cindex "envelope sender"
36260 In a system filter, if a &%deliver%& command is followed by
36261 .code
36262 errors_to <some address>
36263 .endd
36264 in order to change the envelope sender (and hence the error reporting) for that
36265 delivery, any address may be specified. (In a user filter, only the current
36266 user's address can be set.) For example, if some mail is being monitored, you
36267 might use
36268 .code
36269 unseen deliver monitor@spying.example errors_to root@local.example
36270 .endd
36271 to take a copy which would not be sent back to the normal error reporting
36272 address if its delivery failed.
36273
36274
36275
36276 .section "Per-address filtering" "SECTperaddfil"
36277 .vindex "&$domain_data$&"
36278 .vindex "&$local_part_data$&"
36279 In contrast to the system filter, which is run just once per message for each
36280 delivery attempt, it is also possible to set up a system-wide filtering
36281 operation that runs once for each recipient address. In this case, variables
36282 such as &$local_part_data$& and &$domain_data$& can be used,
36283 and indeed, the choice of filter file could be made dependent on them.
36284 This is an example of a router which implements such a filter:
36285 .code
36286 central_filter:
36287   check_local_user
36288   driver = redirect
36289   domains = +local_domains
36290   file = /central/filters/$local_part_data
36291   no_verify
36292   allow_filter
36293   allow_freeze
36294 .endd
36295 The filter is run in a separate process under its own uid. Therefore, either
36296 &%check_local_user%& must be set (as above), in which case the filter is run as
36297 the local user, or the &%user%& option must be used to specify which user to
36298 use. If both are set, &%user%& overrides.
36299
36300 Care should be taken to ensure that none of the commands in the filter file
36301 specify a significant delivery if the message is to go on to be delivered to
36302 its intended recipient. The router will not then claim to have dealt with the
36303 address, so it will be passed on to subsequent routers to be delivered in the
36304 normal way.
36305 .ecindex IIDsysfil1
36306 .ecindex IIDsysfil2
36307 .ecindex IIDsysfil3
36308
36309
36310
36311
36312
36313
36314 . ////////////////////////////////////////////////////////////////////////////
36315 . ////////////////////////////////////////////////////////////////////////////
36316
36317 .chapter "Message processing" "CHAPmsgproc"
36318 .scindex IIDmesproc "message" "general processing"
36319 Exim performs various transformations on the sender and recipient addresses of
36320 all messages that it handles, and also on the messages' header lines. Some of
36321 these are optional and configurable, while others always take place. All of
36322 this processing, except rewriting as a result of routing, and the addition or
36323 removal of header lines while delivering, happens when a message is received,
36324 before it is placed on Exim's queue.
36325
36326 Some of the automatic processing takes place by default only for
36327 &"locally-originated"& messages. This adjective is used to describe messages
36328 that are not received over TCP/IP, but instead are passed to an Exim process on
36329 its standard input. This includes the interactive &"local SMTP"& case that is
36330 set up by the &%-bs%& command line option.
36331
36332 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36333 or ::1) are not considered to be locally-originated. Exim does not treat the
36334 loopback interface specially in any way.
36335
36336 If you want the loopback interface to be treated specially, you must ensure
36337 that there are appropriate entries in your ACLs.
36338
36339
36340
36341
36342 .section "Submission mode for non-local messages" "SECTsubmodnon"
36343 .cindex "message" "submission"
36344 .cindex "submission mode"
36345 Processing that happens automatically for locally-originated messages (unless
36346 &%suppress_local_fixups%& is set) can also be requested for messages that are
36347 received over TCP/IP. The term &"submission mode"& is used to describe this
36348 state. Submission mode is set by the modifier
36349 .code
36350 control = submission
36351 .endd
36352 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36353 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36354 a local submission, and is normally used when the source of the message is
36355 known to be an MUA running on a client host (as opposed to an MTA). For
36356 example, to set submission mode for messages originating on the IPv4 loopback
36357 interface, you could include the following in the MAIL ACL:
36358 .code
36359 warn  hosts = 127.0.0.1
36360       control = submission
36361 .endd
36362 .cindex "&%sender_retain%& submission option"
36363 There are some options that can be used when setting submission mode. A slash
36364 is used to separate options. For example:
36365 .code
36366 control = submission/sender_retain
36367 .endd
36368 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36369 true and &%local_from_check%& false for the current incoming message. The first
36370 of these allows an existing &'Sender:'& header in the message to remain, and
36371 the second suppresses the check to ensure that &'From:'& matches the
36372 authenticated sender. With this setting, Exim still fixes up messages by adding
36373 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36374 attempt to check sender authenticity in header lines.
36375
36376 When &%sender_retain%& is not set, a submission mode setting may specify a
36377 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36378 example:
36379 .code
36380 control = submission/domain=some.domain
36381 .endd
36382 The domain may be empty. How this value is used is described in sections
36383 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36384 that allows you to specify the user's full name for inclusion in a created
36385 &'Sender:'& or &'From:'& header line. For example:
36386 .code
36387 accept authenticated = *
36388        control = submission/domain=wonderland.example/\
36389                             name=${lookup {$authenticated_id} \
36390                                    lsearch {/etc/exim/namelist}}
36391 .endd
36392 Because the name may contain any characters, including slashes, the &%name%&
36393 option must be given last. The remainder of the string is used as the name. For
36394 the example above, if &_/etc/exim/namelist_& contains:
36395 .code
36396 bigegg:  Humpty Dumpty
36397 .endd
36398 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36399 line would be:
36400 .code
36401 Sender: Humpty Dumpty <bigegg@wonderland.example>
36402 .endd
36403 .cindex "return path" "in submission mode"
36404 By default, submission mode forces the return path to the same address as is
36405 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36406 specified, the return path is also left unchanged.
36407
36408 &*Note*&: The changes caused by submission mode take effect after the predata
36409 ACL. This means that any sender checks performed before the fix-ups use the
36410 untrusted sender address specified by the user, not the trusted sender address
36411 specified by submission mode. Although this might be slightly unexpected, it
36412 does mean that you can configure ACL checks to spot that a user is trying to
36413 spoof another's address.
36414
36415 .section "Line endings" "SECTlineendings"
36416 .cindex "line endings"
36417 .cindex "carriage return"
36418 .cindex "linefeed"
36419 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36420 linefeed) is the line ending for messages transmitted over the Internet using
36421 SMTP over TCP/IP. However, within individual operating systems, different
36422 conventions are used. For example, Unix-like systems use just LF, but others
36423 use CRLF or just CR.
36424
36425 Exim was designed for Unix-like systems, and internally, it stores messages
36426 using the system's convention of a single LF as a line terminator. When
36427 receiving a message, all line endings are translated to this standard format.
36428 Originally, it was thought that programs that passed messages directly to an
36429 MTA within an operating system would use that system's convention. Experience
36430 has shown that this is not the case; for example, there are Unix applications
36431 that use CRLF in this circumstance. For this reason, and for compatibility with
36432 other MTAs, the way Exim handles line endings for all messages is now as
36433 follows:
36434
36435 .ilist
36436 LF not preceded by CR is treated as a line ending.
36437 .next
36438 CR is treated as a line ending; if it is immediately followed by LF, the LF
36439 is ignored.
36440 .next
36441 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36442 nor a local message in the state where a line containing only a dot is a
36443 terminator.
36444 .next
36445 If a bare CR is encountered within a header line, an extra space is added after
36446 the line terminator so as not to end the header line. The reasoning behind this
36447 is that bare CRs in header lines are most likely either to be mistakes, or
36448 people trying to play silly games.
36449 .next
36450 If the first header line received in a message ends with CRLF, a subsequent
36451 bare LF in a header line is treated in the same way as a bare CR in a header
36452 line.
36453 .endlist
36454
36455
36456
36457
36458
36459 .section "Unqualified addresses" "SECID218"
36460 .cindex "unqualified addresses"
36461 .cindex "address" "qualification"
36462 By default, Exim expects every envelope address it receives from an external
36463 host to be fully qualified. Unqualified addresses cause negative responses to
36464 SMTP commands. However, because SMTP is used as a means of transporting
36465 messages from MUAs running on personal workstations, there is sometimes a
36466 requirement to accept unqualified addresses from specific hosts or IP networks.
36467
36468 Exim has two options that separately control which hosts may send unqualified
36469 sender or recipient addresses in SMTP commands, namely
36470 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36471 cases, if an unqualified address is accepted, it is qualified by adding the
36472 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36473
36474 .oindex "&%qualify_domain%&"
36475 .oindex "&%qualify_recipient%&"
36476 Unqualified addresses in header lines are automatically qualified for messages
36477 that are locally originated, unless the &%-bnq%& option is given on the command
36478 line. For messages received over SMTP, unqualified addresses in header lines
36479 are qualified only if unqualified addresses are permitted in SMTP commands. In
36480 other words, such qualification is also controlled by
36481 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36482
36483
36484
36485
36486 .section "The UUCP From line" "SECID219"
36487 .cindex "&""From""& line"
36488 .cindex "UUCP" "&""From""& line"
36489 .cindex "sender" "address"
36490 .oindex "&%uucp_from_pattern%&"
36491 .oindex "&%uucp_from_sender%&"
36492 .cindex "envelope from"
36493 .cindex "envelope sender"
36494 .cindex "Sendmail compatibility" "&""From""& line"
36495 Messages that have come from UUCP (and some other applications) often begin
36496 with a line containing the envelope sender and a timestamp, following the word
36497 &"From"&. Examples of two common formats are:
36498 .code
36499 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36500 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36501 .endd
36502 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36503 Exim recognizes such lines at the start of messages that are submitted to it
36504 via the command line (that is, on the standard input). It does not recognize
36505 such lines in incoming SMTP messages, unless the sending host matches
36506 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36507 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36508 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36509 default value matches the two common cases shown above and puts the address
36510 that follows &"From"& into &$1$&.
36511
36512 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36513 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36514 a trusted user, the message's sender address is constructed by expanding the
36515 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36516 then parsed as an RFC 2822 address. If there is no domain, the local part is
36517 qualified with &%qualify_domain%& unless it is the empty string. However, if
36518 the command line &%-f%& option is used, it overrides the &"From"& line.
36519
36520 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36521 sender address is not changed. This is also the case for incoming SMTP messages
36522 that are permitted to contain &"From"& lines.
36523
36524 Only one &"From"& line is recognized. If there is more than one, the second is
36525 treated as a data line that starts the body of the message, as it is not valid
36526 as a header line. This also happens if a &"From"& line is present in an
36527 incoming SMTP message from a source that is not permitted to send them.
36528
36529
36530
36531 .section "Header lines"
36532 .subsection "Resent- header lines" SECID220
36533 .chindex Resent-
36534 RFC 2822 makes provision for sets of header lines starting with the string
36535 &`Resent-`& to be added to a message when it is resent by the original
36536 recipient to somebody else. These headers are &'Resent-Date:'&,
36537 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36538 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36539
36540 .blockquote
36541 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36542 processing of replies or other such automatic actions on messages.'&
36543 .endblockquote
36544
36545 This leaves things a bit vague as far as other processing actions such as
36546 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36547 follows:
36548
36549 .ilist
36550 A &'Resent-From:'& line that just contains the login id of the submitting user
36551 is automatically rewritten in the same way as &'From:'& (see below).
36552 .next
36553 If there's a rewriting rule for a particular header line, it is also applied to
36554 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36555 &'From:'& also rewrites &'Resent-From:'&.
36556 .next
36557 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36558 also removed.
36559 .next
36560 For a locally-submitted message,
36561 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36562 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36563 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36564 included in log lines in this case.
36565 .next
36566 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36567 &%Resent-%& header lines are present.
36568 .endlist
36569
36570
36571
36572
36573 .subsection Auto-Submitted: SECID221
36574 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36575 includes the header line:
36576 .code
36577 Auto-Submitted: auto-replied
36578 .endd
36579
36580 .subsection Bcc: SECID222
36581 .cindex "&'Bcc:'& header line"
36582 If Exim is called with the &%-t%& option, to take recipient addresses from a
36583 message's header, it removes any &'Bcc:'& header line that may exist (after
36584 extracting its addresses). If &%-t%& is not present on the command line, any
36585 existing &'Bcc:'& is not removed.
36586
36587
36588 .subsection Date: SECID223
36589 .cindex Date:
36590 If a locally-generated or submission-mode message has no &'Date:'& header line,
36591 Exim adds one, using the current date and time, unless the
36592 &%suppress_local_fixups%& control has been specified.
36593
36594 .subsection Delivery-date: SECID224
36595 .cindex "&'Delivery-date:'& header line"
36596 .oindex "&%delivery_date_remove%&"
36597 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36598 set. Exim can be configured to add them to the final delivery of messages. (See
36599 the generic &%delivery_date_add%& transport option.) They should not be present
36600 in messages in transit. If the &%delivery_date_remove%& configuration option is
36601 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36602 messages.
36603
36604
36605 .subsection Envelope-to: SECID225
36606 .chindex Envelope-to:
36607 .oindex "&%envelope_to_remove%&"
36608 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36609 Exim can be configured to add them to the final delivery of messages. (See the
36610 generic &%envelope_to_add%& transport option.) They should not be present in
36611 messages in transit. If the &%envelope_to_remove%& configuration option is set
36612 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36613 messages.
36614
36615
36616 .subsection From: SECTthefrohea
36617 .chindex From:
36618 .cindex "Sendmail compatibility" "&""From""& line"
36619 .cindex "message" "submission"
36620 .cindex "submission mode"
36621 If a submission-mode message does not contain a &'From:'& header line, Exim
36622 adds one if either of the following conditions is true:
36623
36624 .ilist
36625 The envelope sender address is not empty (that is, this is not a bounce
36626 message). The added header line copies the envelope sender address.
36627 .next
36628 .vindex "&$authenticated_id$&"
36629 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36630 .olist
36631 .vindex "&$qualify_domain$&"
36632 If no domain is specified by the submission control, the local part is
36633 &$authenticated_id$& and the domain is &$qualify_domain$&.
36634 .next
36635 If a non-empty domain is specified by the submission control, the local
36636 part is &$authenticated_id$&, and the domain is the specified domain.
36637 .next
36638 If an empty domain is specified by the submission control,
36639 &$authenticated_id$& is assumed to be the complete address.
36640 .endlist
36641 .endlist
36642
36643 A non-empty envelope sender takes precedence.
36644
36645 If a locally-generated incoming message does not contain a &'From:'& header
36646 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36647 containing the sender's address. The calling user's login name and full name
36648 are used to construct the address, as described in section &<<SECTconstr>>&.
36649 They are obtained from the password data by calling &[getpwuid()]& (but see the
36650 &%unknown_login%& configuration option). The address is qualified with
36651 &%qualify_domain%&.
36652
36653 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36654 &'From:'& header line containing just the unqualified login name of the calling
36655 user, this is replaced by an address containing the user's login name and full
36656 name as described in section &<<SECTconstr>>&.
36657
36658
36659 .subsection Message-ID: SECID226
36660 .chindex Message-ID:
36661 .cindex "message" "submission"
36662 .oindex "&%message_id_header_text%&"
36663 If a locally-generated or submission-mode incoming message does not contain a
36664 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36665 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36666 to the message. If there are any &'Resent-:'& headers in the message, it
36667 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36668 message id, preceded by the letter E to ensure it starts with a letter, and
36669 followed by @ and the primary host name. Additional information can be included
36670 in this header line by setting the &%message_id_header_text%& and/or
36671 &%message_id_header_domain%& options.
36672
36673
36674 .subsection Received: SECID227
36675 .chindex Received:
36676 A &'Received:'& header line is added at the start of every message. The
36677 contents are defined by the &%received_header_text%& configuration option, and
36678 Exim automatically adds a semicolon and a timestamp to the configured string.
36679
36680 The &'Received:'& header is generated as soon as the message's header lines
36681 have been received. At this stage, the timestamp in the &'Received:'& header
36682 line is the time that the message started to be received. This is the value
36683 that is seen by the DATA ACL and by the &[local_scan()]& function.
36684
36685 Once a message is accepted, the timestamp in the &'Received:'& header line is
36686 changed to the time of acceptance, which is (apart from a small delay while the
36687 -H spool file is written) the earliest time at which delivery could start.
36688
36689
36690 .subsection References: SECID228
36691 .chindex References:
36692 Messages created by the &(autoreply)& transport include a &'References:'&
36693 header line. This is constructed according to the rules that are described in
36694 section 3.64 of RFC 2822 (which states that replies should contain such a
36695 header line), and section 3.14 of RFC 3834 (which states that automatic
36696 responses are not different in this respect). However, because some mail
36697 processing software does not cope well with very long header lines, no more
36698 than 12 message IDs are copied from the &'References:'& header line in the
36699 incoming message. If there are more than 12, the first one and then the final
36700 11 are copied, before adding the message ID of the incoming message.
36701
36702
36703
36704 .subsection Return-path: SECID229
36705 .chindex Return-path:
36706 .oindex "&%return_path_remove%&"
36707 &'Return-path:'& header lines are defined as something an MTA may insert when
36708 it does the final delivery of messages. (See the generic &%return_path_add%&
36709 transport option.) Therefore, they should not be present in messages in
36710 transit. If the &%return_path_remove%& configuration option is set (the
36711 default), Exim removes &'Return-path:'& header lines from incoming messages.
36712
36713
36714
36715 .subsection Sender: SECTthesenhea
36716 .cindex "&'Sender:'& header line"
36717 .cindex "message" "submission"
36718 .chindex Sender:
36719 For a locally-originated message from an untrusted user, Exim may remove an
36720 existing &'Sender:'& header line, and it may add a new one. You can modify
36721 these actions by setting the &%local_sender_retain%& option true, the
36722 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36723 control setting.
36724
36725 When a local message is received from an untrusted user and
36726 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36727 control has not been set, a check is made to see if the address given in the
36728 &'From:'& header line is the correct (local) sender of the message. The address
36729 that is expected has the login name as the local part and the value of
36730 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36731 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36732 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36733 line is added to the message.
36734
36735 If you set &%local_from_check%& false, this checking does not occur. However,
36736 the removal of an existing &'Sender:'& line still happens, unless you also set
36737 &%local_sender_retain%& to be true. It is not possible to set both of these
36738 options true at the same time.
36739
36740 .cindex "submission mode"
36741 By default, no processing of &'Sender:'& header lines is done for messages
36742 received over TCP/IP or for messages submitted by trusted users. However, when
36743 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36744 not specified on the submission control, the following processing takes place:
36745
36746 .vindex "&$authenticated_id$&"
36747 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36748 authenticated, and &$authenticated_id$& is not empty, a sender address is
36749 created as follows:
36750
36751 .ilist
36752 .vindex "&$qualify_domain$&"
36753 If no domain is specified by the submission control, the local part is
36754 &$authenticated_id$& and the domain is &$qualify_domain$&.
36755 .next
36756 If a non-empty domain is specified by the submission control, the local part
36757 is &$authenticated_id$&, and the domain is the specified domain.
36758 .next
36759 If an empty domain is specified by the submission control,
36760 &$authenticated_id$& is assumed to be the complete address.
36761 .endlist
36762
36763 This address is compared with the address in the &'From:'& header line. If they
36764 are different, a &'Sender:'& header line containing the created address is
36765 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36766 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36767
36768 .cindex "return path" "created from &'Sender:'&"
36769 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36770 the message (the envelope sender address) is changed to be the same address,
36771 except in the case of submission mode when &%sender_retain%& is specified.
36772
36773
36774
36775 .section "Adding and removing header lines in routers and transports" &&&
36776          "SECTheadersaddrem"
36777 .cindex "header lines" "adding; in router or transport"
36778 .cindex "header lines" "removing; in router or transport"
36779 When a message is delivered, the addition and removal of header lines can be
36780 specified in a system filter, or on any of the routers and transports that
36781 process the message. Section &<<SECTaddremheasys>>& contains details about
36782 modifying headers in a system filter. Header lines can also be added in an ACL
36783 as a message is received (see section &<<SECTaddheadacl>>&).
36784
36785 In contrast to what happens in a system filter, header modifications that are
36786 specified on routers and transports apply only to the particular recipient
36787 addresses that are being processed by those routers and transports. These
36788 changes do not actually take place until a copy of the message is being
36789 transported. Therefore, they do not affect the basic set of header lines, and
36790 they do not affect the values of the variables that refer to header lines.
36791
36792 &*Note*&: In particular, this means that any expansions in the configuration of
36793 the transport cannot refer to the modified header lines, because such
36794 expansions all occur before the message is actually transported.
36795
36796 For both routers and transports, the argument of a &%headers_add%&
36797 option must be in the form of one or more RFC 2822 header lines, separated by
36798 newlines (coded as &"\n"&). For example:
36799 .code
36800 headers_add = X-added-header: added by $primary_hostname\n\
36801               X-added-second: another added header line
36802 .endd
36803 Exim does not check the syntax of these added header lines.
36804
36805 Multiple &%headers_add%& options for a single router or transport can be
36806 specified; the values will append to a single list of header lines.
36807 Each header-line is separately expanded.
36808
36809 The argument of a &%headers_remove%& option must consist of a colon-separated
36810 list of header names. This is confusing, because header names themselves are
36811 often terminated by colons. In this case, the colons are the list separators,
36812 not part of the names. For example:
36813 .code
36814 headers_remove = return-receipt-to:acknowledge-to
36815 .endd
36816
36817 Multiple &%headers_remove%& options for a single router or transport can be
36818 specified; the arguments will append to a single header-names list.
36819 Each item is separately expanded.
36820 Note that colons in complex expansions which are used to
36821 form all or part of a &%headers_remove%& list
36822 will act as list separators.
36823
36824 When &%headers_add%& or &%headers_remove%& is specified on a router,
36825 items are expanded at routing time,
36826 and then associated with all addresses that are
36827 accepted by that router, and also with any new addresses that it generates. If
36828 an address passes through several routers as a result of aliasing or
36829 forwarding, the changes are cumulative.
36830
36831 .oindex "&%unseen%&"
36832 However, this does not apply to multiple routers that result from the use of
36833 the &%unseen%& option. Any header modifications that were specified by the
36834 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36835
36836 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36837 settings cannot be delivered together in a batch, so a transport is always
36838 dealing with a set of addresses that have the same header-processing
36839 requirements.
36840
36841 The transport starts by writing the original set of header lines that arrived
36842 with the message, possibly modified by the system filter. As it writes out
36843 these lines, it consults the list of header names that were attached to the
36844 recipient address(es) by &%headers_remove%& options in routers, and it also
36845 consults the transport's own &%headers_remove%& option. Header lines whose
36846 names are on either of these lists are not written out. If there are multiple
36847 instances of any listed header, they are all skipped.
36848
36849 After the remaining original header lines have been written, new header
36850 lines that were specified by routers' &%headers_add%& options are written, in
36851 the order in which they were attached to the address. These are followed by any
36852 header lines specified by the transport's &%headers_add%& option.
36853
36854 This way of handling header line modifications in routers and transports has
36855 the following consequences:
36856
36857 .ilist
36858 The original set of header lines, possibly modified by the system filter,
36859 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36860 to it, at all times.
36861 .next
36862 Header lines that are added by a router's
36863 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36864 expansion syntax in subsequent routers or the transport.
36865 .next
36866 Conversely, header lines that are specified for removal by &%headers_remove%&
36867 in a router remain visible to subsequent routers and the transport.
36868 .next
36869 Headers added to an address by &%headers_add%& in a router cannot be removed by
36870 a later router or by a transport.
36871 .next
36872 An added header can refer to the contents of an original header that is to be
36873 removed, even it has the same name as the added header. For example:
36874 .code
36875 headers_remove = subject
36876 headers_add = Subject: new subject (was: $h_subject:)
36877 .endd
36878 .endlist
36879
36880 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36881 for a &(redirect)& router that has the &%one_time%& option set.
36882
36883
36884
36885
36886
36887 .section "Constructed addresses" "SECTconstr"
36888 .cindex "address" "constructed"
36889 .cindex "constructed address"
36890 When Exim constructs a sender address for a locally-generated message, it uses
36891 the form
36892 .display
36893 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36894 .endd
36895 For example:
36896 .code
36897 Zaphod Beeblebrox <zaphod@end.univ.example>
36898 .endd
36899 The user name is obtained from the &%-F%& command line option if set, or
36900 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36901 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36902 ampersand character, this is replaced by the login name with the first letter
36903 upper cased, as is conventional in a number of operating systems. See the
36904 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36905 The &%unknown_username%& option can be used to specify user names in cases when
36906 there is no password file entry.
36907
36908 .cindex "RFC 2047"
36909 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36910 parts of it if necessary. In addition, if it contains any non-printing
36911 characters, it is encoded as described in RFC 2047, which defines a way of
36912 including non-ASCII characters in header lines. The value of the
36913 &%headers_charset%& option specifies the name of the encoding that is used (the
36914 characters are assumed to be in this encoding). The setting of
36915 &%print_topbitchars%& controls whether characters with the top bit set (that
36916 is, with codes greater than 127) count as printing characters or not.
36917
36918
36919
36920 .section "Case of local parts" "SECID230"
36921 .cindex "case of local parts"
36922 .cindex "local part" "case of"
36923 RFC 2822 states that the case of letters in the local parts of addresses cannot
36924 be assumed to be non-significant. Exim preserves the case of local parts of
36925 addresses, but by default it uses a lower-cased form when it is routing,
36926 because on most Unix systems, usernames are in lower case and case-insensitive
36927 routing is required. However, any particular router can be made to use the
36928 original case for local parts by setting the &%caseful_local_part%& generic
36929 router option.
36930
36931 .cindex "mixed-case login names"
36932 If you must have mixed-case user names on your system, the best way to proceed,
36933 assuming you want case-independent handling of incoming email, is to set up
36934 your first router to convert incoming local parts in your domains to the
36935 correct case by means of a file lookup. For example:
36936 .code
36937 correct_case:
36938   driver = redirect
36939   domains = +local_domains
36940   data = ${lookup{$local_part}cdb\
36941               {/etc/usercased.cdb}{$value}fail}\
36942               @$domain
36943 .endd
36944 For this router, the local part is forced to lower case by the default action
36945 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36946 up a new local part in the correct case. If you then set &%caseful_local_part%&
36947 on any subsequent routers which process your domains, they will operate on
36948 local parts with the correct case in a case-sensitive manner.
36949
36950
36951
36952 .section "Dots in local parts" "SECID231"
36953 .cindex "dot" "in local part"
36954 .cindex "local part" "dots in"
36955 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36956 part may not begin or end with a dot, nor have two consecutive dots in the
36957 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36958 empty components for compatibility.
36959
36960
36961
36962 .section "Rewriting addresses" "SECID232"
36963 .cindex "rewriting" "addresses"
36964 Rewriting of sender and recipient addresses, and addresses in headers, can
36965 happen automatically, or as the result of configuration options, as described
36966 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36967 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36968
36969 Automatic rewriting includes qualification, as mentioned above. The other case
36970 in which it can happen is when an incomplete non-local domain is given. The
36971 routing process may cause this to be expanded into the full domain name. For
36972 example, a header such as
36973 .code
36974 To: hare@teaparty
36975 .endd
36976 might get rewritten as
36977 .code
36978 To: hare@teaparty.wonderland.fict.example
36979 .endd
36980 Rewriting as a result of routing is the one kind of message processing that
36981 does not happen at input time, as it cannot be done until the address has
36982 been routed.
36983
36984 Strictly, one should not do &'any'& deliveries of a message until all its
36985 addresses have been routed, in case any of the headers get changed as a
36986 result of routing. However, doing this in practice would hold up many
36987 deliveries for unreasonable amounts of time, just because one address could not
36988 immediately be routed. Exim therefore does not delay other deliveries when
36989 routing of one or more addresses is deferred.
36990 .ecindex IIDmesproc
36991
36992
36993
36994 . ////////////////////////////////////////////////////////////////////////////
36995 . ////////////////////////////////////////////////////////////////////////////
36996
36997 .chapter "SMTP processing" "CHAPSMTP"
36998 .scindex IIDsmtpproc1 "SMTP" "processing details"
36999 .scindex IIDsmtpproc2 "LMTP" "processing details"
37000 Exim supports a number of different ways of using the SMTP protocol, and its
37001 LMTP variant, which is an interactive protocol for transferring messages into a
37002 closed mail store application. This chapter contains details of how SMTP is
37003 processed. For incoming mail, the following are available:
37004
37005 .ilist
37006 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37007 .next
37008 SMTP over the standard input and output (the &%-bs%& option);
37009 .next
37010 Batched SMTP on the standard input (the &%-bS%& option).
37011 .endlist
37012
37013 For mail delivery, the following are available:
37014
37015 .ilist
37016 SMTP over TCP/IP (the &(smtp)& transport);
37017 .next
37018 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37019 &"lmtp"&);
37020 .next
37021 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37022 transport);
37023 .next
37024 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37025 the &%use_bsmtp%& option set).
37026 .endlist
37027
37028 &'Batched SMTP'& is the name for a process in which batches of messages are
37029 stored in or read from files (or pipes), in a format in which SMTP commands are
37030 used to contain the envelope information.
37031
37032
37033
37034 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37035 .cindex "SMTP" "outgoing over TCP/IP"
37036 .cindex "outgoing SMTP over TCP/IP"
37037 .cindex "LMTP" "over TCP/IP"
37038 .cindex "outgoing LMTP over TCP/IP"
37039 .cindex "EHLO"
37040 .cindex "HELO"
37041 .cindex "SIZE" "option on MAIL command"
37042 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37043 The &%protocol%& option selects which protocol is to be used, but the actual
37044 processing is the same in both cases.
37045
37046 .cindex "ESMTP extensions" SIZE
37047 If, in response to its EHLO command, Exim is told that the SIZE
37048 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37049 command. The value of <&'n'&> is the message size plus the value of the
37050 &%size_addition%& option (default 1024) to allow for additions to the message
37051 such as per-transport header lines, or changes made in a
37052 .cindex "transport" "filter"
37053 .cindex "filter" "transport filter"
37054 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37055 suppressed.
37056
37057 If the remote server advertises support for PIPELINING, Exim uses the
37058 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37059 required for the transaction.
37060
37061 If the remote server advertises support for the STARTTLS command, and Exim
37062 was built to support TLS encryption, it tries to start a TLS session unless the
37063 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37064 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37065 is called for verification.
37066
37067 If the remote server advertises support for the AUTH command, Exim scans
37068 the authenticators configuration for any suitable client settings, as described
37069 in chapter &<<CHAPSMTPAUTH>>&.
37070
37071 .cindex "carriage return"
37072 .cindex "linefeed"
37073 Responses from the remote host are supposed to be terminated by CR followed by
37074 LF. However, there are known to be hosts that do not send CR characters, so in
37075 order to be able to interwork with such hosts, Exim treats LF on its own as a
37076 line terminator.
37077
37078 If a message contains a number of different addresses, all those with the same
37079 characteristics (for example, the same envelope sender) that resolve to the
37080 same set of hosts, in the same order, are sent in a single SMTP transaction,
37081 even if they are for different domains, unless there are more than the setting
37082 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37083 they are split into groups containing no more than &%max_rcpt%&s addresses
37084 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37085 in parallel sessions. The order of hosts with identical MX values is not
37086 significant when checking whether addresses can be batched in this way.
37087
37088 When the &(smtp)& transport suffers a temporary failure that is not
37089 message-related, Exim updates its transport-specific database, which contains
37090 records indexed by host name that remember which messages are waiting for each
37091 particular host. It also updates the retry database with new retry times.
37092
37093 .cindex "hints database" "retry keys"
37094 Exim's retry hints are based on host name plus IP address, so if one address of
37095 a multi-homed host is broken, it will soon be skipped most of the time.
37096 See the next section for more detail about error handling.
37097
37098 .cindex "SMTP" "passed connection"
37099 .cindex "SMTP" "batching over TCP/IP"
37100 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37101 looks in the hints database for the transport to see if there are any queued
37102 messages waiting for the host to which it is connected. If it finds one, it
37103 creates a new Exim process using the &%-MC%& option (which can only be used by
37104 a process running as root or the Exim user) and passes the TCP/IP socket to it
37105 so that it can deliver another message using the same socket. The new process
37106 does only those deliveries that are routed to the connected host, and may in
37107 turn pass the socket on to a third process, and so on.
37108
37109 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37110 limit the number of messages sent down a single TCP/IP connection.
37111
37112 .cindex "asterisk" "after IP address"
37113 The second and subsequent messages delivered down an existing connection are
37114 identified in the main log by the addition of an asterisk after the closing
37115 square bracket of the IP address.
37116
37117
37118
37119
37120 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37121 .cindex "error" "in outgoing SMTP"
37122 .cindex "SMTP" "errors in outgoing"
37123 .cindex "host" "error"
37124 Three different kinds of error are recognized for outgoing SMTP: host errors,
37125 message errors, and recipient errors.
37126
37127 .vlist
37128 .vitem "&*Host errors*&"
37129 A host error is not associated with a particular message or with a
37130 particular recipient of a message. The host errors are:
37131
37132 .ilist
37133 Connection refused or timed out,
37134 .next
37135 Any error response code on connection,
37136 .next
37137 Any error response code to EHLO or HELO,
37138 .next
37139 Loss of connection at any time, except after &"."&,
37140 .next
37141 I/O errors at any time,
37142 .next
37143 Timeouts during the session, other than in response to MAIL, RCPT or
37144 the &"."& at the end of the data.
37145 .endlist ilist
37146
37147 For a host error, a permanent error response on connection, or in response to
37148 EHLO, causes all addresses routed to the host to be failed. Any other host
37149 error causes all addresses to be deferred, and retry data to be created for the
37150 host. It is not tried again, for any message, until its retry time arrives. If
37151 the current set of addresses are not all delivered in this run (to some
37152 alternative host), the message is added to the list of those waiting for this
37153 host, so if it is still undelivered when a subsequent successful delivery is
37154 made to the host, it will be sent down the same SMTP connection.
37155
37156 .vitem "&*Message errors*&"
37157 .cindex "message" "error"
37158 A message error is associated with a particular message when sent to a
37159 particular host, but not with a particular recipient of the message. The
37160 message errors are:
37161
37162 .ilist
37163 Any error response code to MAIL, DATA, or the &"."& that terminates
37164 the data,
37165 .next
37166 Timeout after MAIL,
37167 .next
37168 Timeout or loss of connection after the &"."& that terminates the data. A
37169 timeout after the DATA command itself is treated as a host error, as is loss of
37170 connection at any other time.
37171 .endlist ilist
37172
37173 For a message error, a permanent error response (5&'xx'&) causes all addresses
37174 to be failed, and a delivery error report to be returned to the sender. A
37175 temporary error response (4&'xx'&), or one of the timeouts, causes all
37176 addresses to be deferred. Retry data is not created for the host, but instead,
37177 a retry record for the combination of host plus message id is created. The
37178 message is not added to the list of those waiting for this host. This ensures
37179 that the failing message will not be sent to this host again until the retry
37180 time arrives. However, other messages that are routed to the host are not
37181 affected, so if it is some property of the message that is causing the error,
37182 it will not stop the delivery of other mail.
37183
37184 If the remote host specified support for the SIZE parameter in its response
37185 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37186 over-large message will cause a message error because the error arrives as a
37187 response to MAIL.
37188
37189 .vitem "&*Recipient errors*&"
37190 .cindex "recipient" "error"
37191 A recipient error is associated with a particular recipient of a message. The
37192 recipient errors are:
37193
37194 .ilist
37195 Any error response to RCPT,
37196 .next
37197 Timeout after RCPT.
37198 .endlist
37199
37200 For a recipient error, a permanent error response (5&'xx'&) causes the
37201 recipient address to be failed, and a bounce message to be returned to the
37202 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37203 address to be deferred, and routing retry data to be created for it. This is
37204 used to delay processing of the address in subsequent queue runs, until its
37205 routing retry time arrives. This applies to all messages, but because it
37206 operates only in queue runs, one attempt will be made to deliver a new message
37207 to the failing address before the delay starts to operate. This ensures that,
37208 if the failure is really related to the message rather than the recipient
37209 (&"message too big for this recipient"& is a possible example), other messages
37210 have a chance of getting delivered. If a delivery to the address does succeed,
37211 the retry information gets cleared, so all stuck messages get tried again, and
37212 the retry clock is reset.
37213
37214 The message is not added to the list of those waiting for this host. Use of the
37215 host for other messages is unaffected, and except in the case of a timeout,
37216 other recipients are processed independently, and may be successfully delivered
37217 in the current SMTP session. After a timeout it is of course impossible to
37218 proceed with the session, so all addresses get deferred. However, those other
37219 than the one that failed do not suffer any subsequent retry delays. Therefore,
37220 if one recipient is causing trouble, the others have a chance of getting
37221 through when a subsequent delivery attempt occurs before the failing
37222 recipient's retry time.
37223 .endlist
37224
37225 In all cases, if there are other hosts (or IP addresses) available for the
37226 current set of addresses (for example, from multiple MX records), they are
37227 tried in this run for any undelivered addresses, subject of course to their
37228 own retry data. In other words, recipient error retry data does not take effect
37229 until the next delivery attempt.
37230
37231 Some hosts have been observed to give temporary error responses to every
37232 MAIL command at certain times (&"insufficient space"& has been seen). It
37233 would be nice if such circumstances could be recognized, and defer data for the
37234 host itself created, but this is not possible within the current Exim design.
37235 What actually happens is that retry data for every (host, message) combination
37236 is created.
37237
37238 The reason that timeouts after MAIL and RCPT are treated specially is that
37239 these can sometimes arise as a result of the remote host's verification
37240 procedures. Exim makes this assumption, and treats them as if a temporary error
37241 response had been received. A timeout after &"."& is treated specially because
37242 it is known that some broken implementations fail to recognize the end of the
37243 message if the last character of the last line is a binary zero. Thus, it is
37244 helpful to treat this case as a message error.
37245
37246 Timeouts at other times are treated as host errors, assuming a problem with the
37247 host, or the connection to it. If a timeout after MAIL, RCPT,
37248 or &"."& is really a connection problem, the assumption is that at the next try
37249 the timeout is likely to occur at some other point in the dialogue, causing it
37250 then to be treated as a host error.
37251
37252 There is experimental evidence that some MTAs drop the connection after the
37253 terminating &"."& if they do not like the contents of the message for some
37254 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37255 should be given. That is why Exim treats this case as a message rather than a
37256 host error, in order not to delay other messages to the same host.
37257
37258
37259
37260
37261 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37262 .cindex "SMTP" "incoming over TCP/IP"
37263 .cindex "incoming SMTP over TCP/IP"
37264 .cindex "inetd"
37265 .cindex "daemon"
37266 Incoming SMTP messages can be accepted in one of two ways: by running a
37267 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37268 &_/etc/inetd.conf_& should be like this:
37269 .code
37270 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37271 .endd
37272 Exim distinguishes between this case and the case of a locally running user
37273 agent using the &%-bs%& option by checking whether or not the standard input is
37274 a socket. When it is, either the port must be privileged (less than 1024), or
37275 the caller must be root or the Exim user. If any other user passes a socket
37276 with an unprivileged port number, Exim prints a message on the standard error
37277 stream and exits with an error code.
37278
37279 By default, Exim does not make a log entry when a remote host connects or
37280 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37281 unexpected. It can be made to write such log entries by setting the
37282 &%smtp_connection%& log selector.
37283
37284 .cindex "carriage return"
37285 .cindex "linefeed"
37286 Commands from the remote host are supposed to be terminated by CR followed by
37287 LF. However, there are known to be hosts that do not send CR characters. In
37288 order to be able to interwork with such hosts, Exim treats LF on its own as a
37289 line terminator.
37290 Furthermore, because common code is used for receiving messages from all
37291 sources, a CR on its own is also interpreted as a line terminator. However, the
37292 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37293
37294 .cindex "EHLO" "invalid data"
37295 .cindex "HELO" "invalid data"
37296 One area that sometimes gives rise to problems concerns the EHLO or
37297 HELO commands. Some clients send syntactically invalid versions of these
37298 commands, which Exim rejects by default. (This is nothing to do with verifying
37299 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37300 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37301 match the broken hosts that send invalid commands.
37302
37303 .cindex "SIZE option on MAIL command"
37304 .cindex "MAIL" "SIZE option"
37305 The amount of disk space available is checked whenever SIZE is received on
37306 a MAIL command, independently of whether &%message_size_limit%& or
37307 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37308 false. A temporary error is given if there is not enough space. If
37309 &%check_spool_space%& is set, the check is for that amount of space plus the
37310 value given with SIZE, that is, it checks that the addition of the incoming
37311 message will not reduce the space below the threshold.
37312
37313 When a message is successfully received, Exim includes the local message id in
37314 its response to the final &"."& that terminates the data. If the remote host
37315 logs this text it can help with tracing what has happened to a message.
37316
37317 The Exim daemon can limit the number of simultaneous incoming connections it is
37318 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37319 number of simultaneous incoming connections from a single remote host (see the
37320 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37321 rejected using the SMTP temporary error code 421.
37322
37323 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37324 subprocess has finished, as this can get lost at busy times. Instead, it looks
37325 for completed subprocesses every time it wakes up. Provided there are other
37326 things happening (new incoming calls, starts of queue runs), completed
37327 processes will be noticed and tidied away. On very quiet systems you may
37328 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37329 it will be noticed when the daemon next wakes up.
37330
37331 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37332 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37333 high system load &-- for details see the &%smtp_accept_reserve%&,
37334 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37335 applies in both the daemon and &'inetd'& cases.
37336
37337 Exim normally starts a delivery process for each message received, though this
37338 can be varied by means of the &%-odq%& command line option and the
37339 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37340 number of simultaneously running delivery processes started in this way from
37341 SMTP input can be limited by the &%smtp_accept_queue%& and
37342 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37343 subsequently received messages are just put on the input queue without starting
37344 a delivery process.
37345
37346 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37347 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37348 started up from the &'inetd'& daemon, because in that case each connection is
37349 handled by an entirely independent Exim process. Control by load average is,
37350 however, available with &'inetd'&.
37351
37352 Exim can be configured to verify addresses in incoming SMTP commands as they
37353 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37354 to rewrite addresses at this time &-- before any syntax checking is done. See
37355 section &<<SSECTrewriteS>>&.
37356
37357 Exim can also be configured to limit the rate at which a client host submits
37358 MAIL and RCPT commands in a single SMTP session. See the
37359 &%smtp_ratelimit_hosts%& option.
37360
37361
37362
37363 .subsection "Unrecognized SMTP commands" SECID234
37364 .cindex "SMTP" "unrecognized commands"
37365 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37366 commands during a single SMTP connection, it drops the connection after sending
37367 the error response to the last command. The default value for
37368 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37369 abuse that subvert web servers into making connections to SMTP ports; in these
37370 circumstances, a number of non-SMTP lines are sent first.
37371
37372
37373 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37374 .cindex "SMTP" "syntax errors"
37375 .cindex "SMTP" "protocol errors"
37376 A syntax error is detected if an SMTP command is recognized, but there is
37377 something syntactically wrong with its data, for example, a malformed email
37378 address in a RCPT command. Protocol errors include invalid command
37379 sequencing such as RCPT before MAIL. If Exim receives more than
37380 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37381 drops the connection after sending the error response to the last command. The
37382 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37383 broken clients that loop sending bad commands (yes, it has been seen).
37384
37385
37386
37387 .subsection "Use of non-mail SMTP commands" SECID236
37388 .cindex "SMTP" "non-mail commands"
37389 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37390 DATA. Exim counts such commands, and drops the connection if there are too
37391 many of them in a single SMTP session. This action catches some
37392 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37393 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37394 defines what &"too many"& means. Its default value is 10.
37395
37396 When a new message is expected, one occurrence of RSET is not counted. This
37397 allows a client to send one RSET between messages (this is not necessary,
37398 but some clients do it). Exim also allows one uncounted occurrence of HELO
37399 or EHLO, and one occurrence of STARTTLS between messages. After
37400 starting up a TLS session, another EHLO is expected, and so it too is not
37401 counted.
37402
37403 The first occurrence of AUTH in a connection, or immediately following
37404 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37405 RCPT, DATA, and QUIT are counted.
37406
37407 You can control which hosts are subject to the limit set by
37408 &%smtp_accept_max_nonmail%& by setting
37409 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37410 the limit apply to all hosts. This option means that you can exclude any
37411 specific badly-behaved hosts that you have to live with.
37412
37413
37414
37415
37416 .subsection "The VRFY and EXPN commands" SECID237
37417 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37418 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37419 appropriate) in order to decide whether the command should be accepted or not.
37420
37421 .cindex "VRFY" "processing"
37422 When no ACL is defined for VRFY, or if it rejects without
37423 setting an explicit response code, the command is accepted
37424 (with a 252 SMTP response code)
37425 in order to support awkward clients that do a VRFY before every RCPT.
37426 When VRFY is accepted, it runs exactly the same code as when Exim is
37427 called with the &%-bv%& option, and returns 250/451/550
37428 SMTP response codes.
37429
37430 .cindex "EXPN" "processing"
37431 If no ACL for EXPN is defined, the command is rejected.
37432 When EXPN is accepted, a single-level expansion of the address is done.
37433 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37434 than a verification (the &%-bv%& option). If an unqualified local part is given
37435 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37436 of VRFY and EXPN commands are logged on the main and reject logs, and
37437 VRFY verification failures are logged in the main log for consistency with
37438 RCPT failures.
37439
37440
37441
37442 .subsection "The ETRN command" SECTETRN
37443 .cindex "ETRN" "processing"
37444 .cindex "ESMTP extensions" ETRN
37445 RFC 1985 describes an ESMTP command called ETRN that is designed to
37446 overcome the security problems of the TURN command (which has fallen into
37447 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37448 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37449 should be accepted or not. If no ACL is defined, the command is rejected.
37450
37451 The ETRN command is concerned with &"releasing"& messages that are awaiting
37452 delivery to certain hosts. As Exim does not organize its message queue by host,
37453 the only form of ETRN that is supported by default is the one where the
37454 text starts with the &"#"& prefix, in which case the remainder of the text is
37455 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37456 the &%-R%& option to happen, with the remainder of the ETRN text as its
37457 argument. For example,
37458 .code
37459 ETRN #brigadoon
37460 .endd
37461 runs the command
37462 .code
37463 exim -R brigadoon
37464 .endd
37465 which causes a delivery attempt on all messages with undelivered addresses
37466 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37467 default), Exim prevents the simultaneous execution of more than one queue run
37468 for the same argument string as a result of an ETRN command. This stops
37469 a misbehaving client from starting more than one queue runner at once.
37470
37471 .cindex "hints database" "ETRN serialization"
37472 Exim implements the serialization by means of a hints database in which a
37473 record is written whenever a process is started by ETRN, and deleted when
37474 the process completes. However, Exim does not keep the SMTP session waiting for
37475 the ETRN process to complete. Once ETRN is accepted, the client is sent
37476 a &"success"& return code. Obviously there is scope for hints records to get
37477 left lying around if there is a system or program crash. To guard against this,
37478 Exim ignores any records that are more than six hours old.
37479
37480 .oindex "&%smtp_etrn_command%&"
37481 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37482 used. This specifies a command that is run whenever ETRN is received,
37483 whatever the form of its argument. For
37484 example:
37485 .code
37486 smtp_etrn_command = /etc/etrn_command $domain \
37487                     $sender_host_address
37488 .endd
37489 .vindex "&$domain$&"
37490 The string is split up into arguments which are independently expanded. The
37491 expansion variable &$domain$& is set to the argument of the ETRN command,
37492 and no syntax checking is done on the contents of this argument. Exim does not
37493 wait for the command to complete, so its status code is not checked. Exim runs
37494 under its own uid and gid when receiving incoming SMTP, so it is not possible
37495 for it to change them before running the command.
37496
37497
37498
37499 .section "Incoming local SMTP" "SECID238"
37500 .cindex "SMTP" "local incoming"
37501 Some user agents use SMTP to pass messages to their local MTA using the
37502 standard input and output, as opposed to passing the envelope on the command
37503 line and writing the message to the standard input. This is supported by the
37504 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37505 messages over TCP/IP (including the use of ACLs), except that the envelope
37506 sender given in a MAIL command is ignored unless the caller is trusted. In
37507 an ACL you can detect this form of SMTP input by testing for an empty host
37508 identification. It is common to have this as the first line in the ACL that
37509 runs for RCPT commands:
37510 .code
37511 accept hosts = :
37512 .endd
37513 This accepts SMTP messages from local processes without doing any other tests.
37514
37515
37516
37517 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37518 .cindex "SMTP" "batched outgoing"
37519 .cindex "batched SMTP output"
37520 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37521 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37522 be output in BSMTP format. No SMTP responses are possible for this form of
37523 delivery. All it is doing is using SMTP commands as a way of transmitting the
37524 envelope along with the message.
37525
37526 The message is written to the file or pipe preceded by the SMTP commands
37527 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37528 the message that start with a dot have an extra dot added. The SMTP command
37529 HELO is not normally used. If it is required, the &%message_prefix%& option
37530 can be used to specify it.
37531
37532 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37533 one recipient address at a time by default. However, you can arrange for them
37534 to handle several addresses at once by setting the &%batch_max%& option. When
37535 this is done for BSMTP, messages may contain multiple RCPT commands. See
37536 chapter &<<CHAPbatching>>& for more details.
37537
37538 .vindex "&$host$&"
37539 When one or more addresses are routed to a BSMTP transport by a router that
37540 sets up a host list, the name of the first host on the list is available to the
37541 transport in the variable &$host$&. Here is an example of such a transport and
37542 router:
37543 .code
37544 begin routers
37545 route_append:
37546   driver = manualroute
37547   transport = smtp_appendfile
37548   route_list = domain.example  batch.host.example
37549
37550 begin transports
37551 smtp_appendfile:
37552   driver = appendfile
37553   directory = /var/bsmtp/$host
37554   batch_max = 1000
37555   use_bsmtp
37556   user = exim
37557 .endd
37558 This causes messages addressed to &'domain.example'& to be written in BSMTP
37559 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37560 message (unless there are more than 1000 recipients).
37561
37562
37563
37564 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37565 .cindex "SMTP" "batched incoming"
37566 .cindex "batched SMTP input"
37567 The &%-bS%& command line option causes Exim to accept one or more messages by
37568 reading SMTP on the standard input, but to generate no responses. If the caller
37569 is trusted, the senders in the MAIL commands are believed; otherwise the
37570 sender is always the caller of Exim. Unqualified senders and receivers are not
37571 rejected (there seems little point) but instead just get qualified. HELO
37572 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37573 as NOOP; QUIT quits.
37574
37575 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37576 ACL is run in the same way as for non-SMTP local input.
37577
37578 If an error is detected while reading a message, including a missing &"."& at
37579 the end, Exim gives up immediately. It writes details of the error to the
37580 standard output in a stylized way that the calling program should be able to
37581 make some use of automatically, for example:
37582 .code
37583 554 Unexpected end of file
37584 Transaction started in line 10
37585 Error detected in line 14
37586 .endd
37587 It writes a more verbose version, for human consumption, to the standard error
37588 file, for example:
37589 .code
37590 An error was detected while processing a file of BSMTP input.
37591 The error message was:
37592
37593 501 '>' missing at end of address
37594
37595 The SMTP transaction started in line 10.
37596 The error was detected in line 12.
37597 The SMTP command at fault was:
37598
37599 rcpt to:<malformed@in.com.plete
37600
37601 1 previous message was successfully processed.
37602 The rest of the batch was abandoned.
37603 .endd
37604 The return code from Exim is zero only if there were no errors. It is 1 if some
37605 messages were accepted before an error was detected, and 2 if no messages were
37606 accepted.
37607 .ecindex IIDsmtpproc1
37608 .ecindex IIDsmtpproc2
37609
37610
37611
37612 . ////////////////////////////////////////////////////////////////////////////
37613 . ////////////////////////////////////////////////////////////////////////////
37614
37615 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37616          "Customizing messages"
37617 When a message fails to be delivered, or remains in the queue for more than a
37618 configured amount of time, Exim sends a message to the original sender, or
37619 to an alternative configured address. The text of these messages is built into
37620 the code of Exim, but it is possible to change it, either by adding a single
37621 string, or by replacing each of the paragraphs by text supplied in a file.
37622
37623 The &'From:'& and &'To:'& header lines are automatically generated; you can
37624 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37625 option. Exim also adds the line
37626 .code
37627 Auto-Submitted: auto-generated
37628 .endd
37629 to all warning and bounce messages,
37630
37631
37632 .section "Customizing bounce messages" "SECID239"
37633 .cindex "customizing" "bounce message"
37634 .cindex "bounce message" "customizing"
37635 If &%bounce_message_text%& is set, its contents are included in the default
37636 message immediately after &"This message was created automatically by mail
37637 delivery software."& The string is not expanded. It is not used if
37638 &%bounce_message_file%& is set.
37639
37640 When &%bounce_message_file%& is set, it must point to a template file for
37641 constructing error messages. The file consists of a series of text items,
37642 separated by lines consisting of exactly four asterisks. If the file cannot be
37643 opened, default text is used and a message is written to the main and panic
37644 logs. If any text item in the file is empty, default text is used for that
37645 item.
37646
37647 .vindex "&$bounce_recipient$&"
37648 .vindex "&$bounce_return_size_limit$&"
37649 Each item of text that is read from the file is expanded, and there are two
37650 expansion variables which can be of use here: &$bounce_recipient$& is set to
37651 the recipient of an error message while it is being created, and
37652 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37653 option, rounded to a whole number.
37654
37655 The items must appear in the file in the following order:
37656
37657 .ilist
37658 The first item is included in the headers, and should include at least a
37659 &'Subject:'& header. Exim does not check the syntax of these headers.
37660 .next
37661 The second item forms the start of the error message. After it, Exim lists the
37662 failing addresses with their error messages.
37663 .next
37664 The third item is used to introduce any text from pipe transports that is to be
37665 returned to the sender. It is omitted if there is no such text.
37666 .next
37667 The fourth, fifth and sixth items will be ignored and may be empty.
37668 The fields exist for back-compatibility
37669 .endlist
37670
37671 The default state (&%bounce_message_file%& unset) is equivalent to the
37672 following file, in which the sixth item is empty. The &'Subject:'& and some
37673 other lines have been split in order to fit them on the page:
37674 .code
37675 Subject: Mail delivery failed
37676   ${if eq{$sender_address}{$bounce_recipient}
37677   {: returning message to sender}}
37678 ****
37679 This message was created automatically by mail delivery software.
37680
37681 A message ${if eq{$sender_address}{$bounce_recipient}
37682   {that you sent }{sent by
37683
37684 <$sender_address>
37685
37686 }}could not be delivered to all of its recipients.
37687 This is a permanent error. The following address(es) failed:
37688 ****
37689 The following text was generated during the delivery attempt(s):
37690 ****
37691 ------ This is a copy of the message, including all the headers.
37692   ------
37693 ****
37694 ------ The body of the message is $message_size characters long;
37695   only the first
37696 ------ $bounce_return_size_limit or so are included here.
37697 ****
37698 .endd
37699 .section "Customizing warning messages" "SECTcustwarn"
37700 .cindex "customizing" "warning message"
37701 .cindex "warning of delay" "customizing the message"
37702 The option &%warn_message_file%& can be pointed at a template file for use when
37703 warnings about message delays are created. In this case there are only three
37704 text sections:
37705
37706 .ilist
37707 The first item is included in the headers, and should include at least a
37708 &'Subject:'& header. Exim does not check the syntax of these headers.
37709 .next
37710 The second item forms the start of the warning message. After it, Exim lists
37711 the delayed addresses.
37712 .next
37713 The third item then ends the message.
37714 .endlist
37715
37716 The default state is equivalent to the following file, except that some lines
37717 have been split here, in order to fit them on the page:
37718 .code
37719 Subject: Warning: message $message_exim_id delayed
37720   $warn_message_delay
37721 ****
37722 This message was created automatically by mail delivery software.
37723
37724 A message ${if eq{$sender_address}{$warn_message_recipients}
37725 {that you sent }{sent by
37726
37727 <$sender_address>
37728
37729 }}has not been delivered to all of its recipients after
37730 more than $warn_message_delay in the queue on $primary_hostname.
37731
37732 The message identifier is:     $message_exim_id
37733 The subject of the message is: $h_subject
37734 The date of the message is:    $h_date
37735
37736 The following address(es) have not yet been delivered:
37737 ****
37738 No action is required on your part. Delivery attempts will
37739 continue for some time, and this warning may be repeated at
37740 intervals if the message remains undelivered. Eventually the
37741 mail delivery software will give up, and when that happens,
37742 the message will be returned to you.
37743 .endd
37744 .vindex "&$warn_message_delay$&"
37745 .vindex "&$warn_message_recipients$&"
37746 However, in the default state the subject and date lines are omitted if no
37747 appropriate headers exist. During the expansion of this file,
37748 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37749 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37750 of recipients for the warning message. There may be more than one if there are
37751 multiple addresses with different &%errors_to%& settings on the routers that
37752 handled them.
37753
37754
37755
37756
37757 . ////////////////////////////////////////////////////////////////////////////
37758 . ////////////////////////////////////////////////////////////////////////////
37759
37760 .chapter "Some common configuration settings" "CHAPcomconreq"
37761 This chapter discusses some configuration settings that seem to be fairly
37762 common. More examples and discussion can be found in the Exim book.
37763
37764
37765
37766 .section "Sending mail to a smart host" "SECID240"
37767 .cindex "smart host" "example router"
37768 If you want to send all mail for non-local domains to a &"smart host"&, you
37769 should replace the default &(dnslookup)& router with a router which does the
37770 routing explicitly:
37771 .code
37772 send_to_smart_host:
37773   driver = manualroute
37774   route_list = !+local_domains smart.host.name
37775   transport = remote_smtp
37776 .endd
37777 You can use the smart host's IP address instead of the name if you wish.
37778 If you are using Exim only to submit messages to a smart host, and not for
37779 receiving incoming messages, you can arrange for it to do the submission
37780 synchronously by setting the &%mua_wrapper%& option (see chapter
37781 &<<CHAPnonqueueing>>&).
37782
37783
37784
37785
37786 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37787 .cindex "mailing lists"
37788 Exim can be used to run simple mailing lists, but for large and/or complicated
37789 requirements, the use of additional specialized mailing list software such as
37790 Majordomo or Mailman is recommended.
37791
37792 The &(redirect)& router can be used to handle mailing lists where each list
37793 is maintained in a separate file, which can therefore be managed by an
37794 independent manager. The &%domains%& router option can be used to run these
37795 lists in a separate domain from normal mail. For example:
37796 .code
37797 lists:
37798   driver = redirect
37799   domains = lists.example
37800   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37801   forbid_pipe
37802   forbid_file
37803   errors_to = ${quote_local_part:$local_part-request}@lists.example
37804   no_more
37805 .endd
37806 This router is skipped for domains other than &'lists.example'&. For addresses
37807 in that domain, it looks for a file that matches the local part. If there is no
37808 such file, the router declines, but because &%no_more%& is set, no subsequent
37809 routers are tried, and so the whole delivery fails.
37810
37811 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37812 expanded into a filename or a pipe delivery, which is usually inappropriate in
37813 a mailing list.
37814
37815 .oindex "&%errors_to%&"
37816 The &%errors_to%& option specifies that any delivery errors caused by addresses
37817 taken from a mailing list are to be sent to the given address rather than the
37818 original sender of the message. However, before acting on this, Exim verifies
37819 the error address, and ignores it if verification fails.
37820
37821 For example, using the configuration above, mail sent to
37822 &'dicts@lists.example'& is passed on to those addresses contained in
37823 &_/usr/lists/dicts_&, with error reports directed to
37824 &'dicts-request@lists.example'&, provided that this address can be verified.
37825 There could be a file called &_/usr/lists/dicts-request_& containing
37826 the address(es) of this particular list's manager(s), but other approaches,
37827 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37828 or &%local_part_suffix%& options) to handle addresses of the form
37829 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37830
37831
37832
37833 .section "Syntax errors in mailing lists" "SECID241"
37834 .cindex "mailing lists" "syntax errors in"
37835 If an entry in redirection data contains a syntax error, Exim normally defers
37836 delivery of the original address. That means that a syntax error in a mailing
37837 list holds up all deliveries to the list. This may not be appropriate when a
37838 list is being maintained automatically from data supplied by users, and the
37839 addresses are not rigorously checked.
37840
37841 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37842 entries that fail to parse, noting the incident in the log. If in addition
37843 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37844 whenever a broken address is skipped. It is usually appropriate to set
37845 &%syntax_errors_to%& to the same address as &%errors_to%&.
37846
37847
37848
37849 .section "Re-expansion of mailing lists" "SECID242"
37850 .cindex "mailing lists" "re-expansion of"
37851 Exim remembers every individual address to which a message has been delivered,
37852 in order to avoid duplication, but it normally stores only the original
37853 recipient addresses with a message. If all the deliveries to a mailing list
37854 cannot be done at the first attempt, the mailing list is re-expanded when the
37855 delivery is next tried. This means that alterations to the list are taken into
37856 account at each delivery attempt, so addresses that have been added to
37857 the list since the message arrived will therefore receive a copy of the
37858 message, even though it pre-dates their subscription.
37859
37860 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37861 on the &(redirect)& router. If this is done, any addresses generated by the
37862 router that fail to deliver at the first attempt are added to the message as
37863 &"top level"& addresses, and the parent address that generated them is marked
37864 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37865 subsequent delivery attempts. The disadvantage of this is that if any of the
37866 failing addresses are incorrect, correcting them in the file has no effect on
37867 pre-existing messages.
37868
37869 The original top-level address is remembered with each of the generated
37870 addresses, and is output in any log messages. However, any intermediate parent
37871 addresses are not recorded. This makes a difference to the log only if the
37872 &%all_parents%& selector is set, but for mailing lists there is normally only
37873 one level of expansion anyway.
37874
37875
37876
37877 .section "Closed mailing lists" "SECID243"
37878 .cindex "mailing lists" "closed"
37879 The examples so far have assumed open mailing lists, to which anybody may
37880 send mail. It is also possible to set up closed lists, where mail is accepted
37881 from specified senders only. This is done by making use of the generic
37882 &%senders%& option to restrict the router that handles the list.
37883
37884 The following example uses the same file as a list of recipients and as a list
37885 of permitted senders. It requires three routers:
37886 .code
37887 lists_request:
37888   driver = redirect
37889   domains = lists.example
37890   local_part_suffix = -request
37891   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37892   file = /usr/lists/${local_part_data}-request
37893   no_more
37894
37895 lists_post:
37896   driver = redirect
37897   domains = lists.example
37898   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37899   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37900   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37901   forbid_pipe
37902   forbid_file
37903   errors_to = ${quote_local_part:$local_part-request}@lists.example
37904   no_more
37905
37906 lists_closed:
37907   driver = redirect
37908   domains = lists.example
37909   allow_fail
37910   data = :fail: $local_part@lists.example is a closed mailing list
37911 .endd
37912 All three routers have the same &%domains%& setting, so for any other domains,
37913 they are all skipped. The first router runs only if the local part ends in
37914 &%-request%&. It handles messages to the list manager(s) by means of an open
37915 mailing list.
37916
37917 The second router runs only if the &%senders%& precondition is satisfied. It
37918 checks for the existence of a list that corresponds to the local part, and then
37919 checks that the sender is on the list by means of a linear search. It is
37920 necessary to check for the existence of the file before trying to search it,
37921 because otherwise Exim thinks there is a configuration error. If the file does
37922 not exist, the expansion of &%senders%& is *, which matches all senders. This
37923 means that the router runs, but because there is no list, declines, and
37924 &%no_more%& ensures that no further routers are run. The address fails with an
37925 &"unrouteable address"& error.
37926
37927 The third router runs only if the second router is skipped, which happens when
37928 a mailing list exists, but the sender is not on it. This router forcibly fails
37929 the address, giving a suitable error message.
37930
37931
37932
37933
37934 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37935 .cindex "VERP"
37936 .cindex "Variable Envelope Return Paths"
37937 .cindex "envelope from"
37938 .cindex "envelope sender"
37939 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37940 are a way of helping mailing list administrators discover which subscription
37941 address is the cause of a particular delivery failure. The idea is to encode
37942 the original recipient address in the outgoing envelope sender address, so that
37943 if the message is forwarded by another host and then subsequently bounces, the
37944 original recipient can be extracted from the recipient address of the bounce.
37945
37946 .oindex &%errors_to%&
37947 .oindex &%return_path%&
37948 Envelope sender addresses can be modified by Exim using two different
37949 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37950 list examples), or the &%return_path%& option on a transport. The second of
37951 these is effective only if the message is successfully delivered to another
37952 host; it is not used for errors detected on the local host (see the description
37953 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37954 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37955 .code
37956 verp_smtp:
37957   driver = smtp
37958   max_rcpt = 1
37959   return_path = \
37960     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37961       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37962 .endd
37963 This has the effect of rewriting the return path (envelope sender) on outgoing
37964 SMTP messages, if the local part of the original return path ends in
37965 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37966 local part and domain of the recipient into the return path. Suppose, for
37967 example, that a message whose return path has been set to
37968 &'somelist-request@your.dom.example'& is sent to
37969 &'subscriber@other.dom.example'&. In the transport, the return path is
37970 rewritten as
37971 .code
37972 somelist-request+subscriber=other.dom.example@your.dom.example
37973 .endd
37974 .vindex "&$local_part$&"
37975 For this to work, you must tell Exim to send multiple copies of messages that
37976 have more than one recipient, so that each copy has just one recipient. This is
37977 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37978 might be sent to several different recipients in the same domain, in which case
37979 &$local_part$& is not available in the transport, because it is not unique.
37980
37981 Unless your host is doing nothing but mailing list deliveries, you should
37982 probably use a separate transport for the VERP deliveries, so as not to use
37983 extra resources in making one-per-recipient copies for other deliveries. This
37984 can easily be done by expanding the &%transport%& option in the router:
37985 .code
37986 dnslookup:
37987   driver = dnslookup
37988   domains = ! +local_domains
37989   transport = \
37990     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37991       {verp_smtp}{remote_smtp}}
37992   no_more
37993 .endd
37994 If you want to change the return path using &%errors_to%& in a router instead
37995 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37996 routers that handle mailing list addresses. This will ensure that all delivery
37997 errors, including those detected on the local host, are sent to the VERP
37998 address.
37999
38000 On a host that does no local deliveries and has no manual routing, only the
38001 &(dnslookup)& router needs to be changed. A special transport is not needed for
38002 SMTP deliveries. Every mailing list recipient has its own return path value,
38003 and so Exim must hand them to the transport one at a time. Here is an example
38004 of a &(dnslookup)& router that implements VERP:
38005 .code
38006 verp_dnslookup:
38007   driver = dnslookup
38008   domains = ! +local_domains
38009   transport = remote_smtp
38010   errors_to = \
38011     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38012      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38013   no_more
38014 .endd
38015 Before you start sending out messages with VERPed return paths, you must also
38016 configure Exim to accept the bounce messages that come back to those paths.
38017 Typically this is done by setting a &%local_part_suffix%& option for a
38018 router, and using this to route the messages to wherever you want to handle
38019 them.
38020
38021 The overhead incurred in using VERP depends very much on the size of the
38022 message, the number of recipient addresses that resolve to the same remote
38023 host, and the speed of the connection over which the message is being sent. If
38024 a lot of addresses resolve to the same host and the connection is slow, sending
38025 a separate copy of the message for each address may take substantially longer
38026 than sending a single copy with many recipients (for which VERP cannot be
38027 used).
38028
38029
38030
38031
38032
38033
38034 .section "Virtual domains" "SECTvirtualdomains"
38035 .cindex "virtual domains"
38036 .cindex "domain" "virtual"
38037 The phrase &'virtual domain'& is unfortunately used with two rather different
38038 meanings:
38039
38040 .ilist
38041 A domain for which there are no real mailboxes; all valid local parts are
38042 aliases for other email addresses. Common examples are organizational
38043 top-level domains and &"vanity"& domains.
38044 .next
38045 One of a number of independent domains that are all handled by the same host,
38046 with mailboxes on that host, but where the mailbox owners do not necessarily
38047 have login accounts on that host.
38048 .endlist
38049
38050 The first usage is probably more common, and does seem more &"virtual"& than
38051 the second. This kind of domain can be handled in Exim with a straightforward
38052 aliasing router. One approach is to create a separate alias file for each
38053 virtual domain. Exim can test for the existence of the alias file to determine
38054 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38055 to a router of this form:
38056 .code
38057 virtual:
38058   driver = redirect
38059   domains = dsearch;/etc/mail/virtual
38060   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38061   no_more
38062 .endd
38063 The &%domains%& option specifies that the router is to be skipped, unless there
38064 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38065 domain that is being processed.
38066 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38067 being placed into the &$domain_data$& variable.
38068
38069 When the router runs, it looks up the local
38070 part in the file to find a new address (or list of addresses). The &%no_more%&
38071 setting ensures that if the lookup fails (leading to &%data%& being an empty
38072 string), Exim gives up on the address without trying any subsequent routers.
38073
38074 This one router can handle all the virtual domains because the alias filenames
38075 follow a fixed pattern. Permissions can be arranged so that appropriate people
38076 can edit the different alias files. A successful aliasing operation results in
38077 a new envelope recipient address, which is then routed from scratch.
38078
38079 The other kind of &"virtual"& domain can also be handled in a straightforward
38080 way. One approach is to create a file for each domain containing a list of
38081 valid local parts, and use it in a router like this:
38082 .code
38083 my_domains:
38084   driver = accept
38085   domains = dsearch;/etc/mail/domains
38086   local_parts = lsearch;/etc/mail/domains/$domain
38087   transport = my_mailboxes
38088 .endd
38089 The address is accepted if there is a file for the domain, and the local part
38090 can be found in the file. The &%domains%& option is used to check for the
38091 file's existence because &%domains%& is tested before the &%local_parts%&
38092 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38093 because that option is tested after &%local_parts%&. The transport is as
38094 follows:
38095 .code
38096 my_mailboxes:
38097   driver = appendfile
38098   file = /var/mail/$domain_data/$local_part_data
38099   user = mail
38100 .endd
38101 This uses a directory of mailboxes for each domain. The &%user%& setting is
38102 required, to specify which uid is to be used for writing to the mailboxes.
38103
38104 The configuration shown here is just one example of how you might support this
38105 requirement. There are many other ways this kind of configuration can be set
38106 up, for example, by using a database instead of separate files to hold all the
38107 information about the domains.
38108
38109
38110
38111 .section "Multiple user mailboxes" "SECTmulbox"
38112 .cindex "multiple mailboxes"
38113 .cindex "mailbox" "multiple"
38114 .cindex "local part" "prefix"
38115 .cindex "local part" "suffix"
38116 Heavy email users often want to operate with multiple mailboxes, into which
38117 incoming mail is automatically sorted. A popular way of handling this is to
38118 allow users to use multiple sender addresses, so that replies can easily be
38119 identified. Users are permitted to add prefixes or suffixes to their local
38120 parts for this purpose. The wildcard facility of the generic router options
38121 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38122 example, consider this router:
38123 .code
38124 userforward:
38125   driver = redirect
38126   check_local_user
38127   file = $home/.forward
38128   local_part_suffix = -*
38129   local_part_suffix_optional
38130   allow_filter
38131 .endd
38132 .vindex "&$local_part_suffix$&"
38133 It runs a user's &_.forward_& file for all local parts of the form
38134 &'username-*'&. Within the filter file the user can distinguish different
38135 cases by testing the variable &$local_part_suffix$&. For example:
38136 .code
38137 if $local_part_suffix contains -special then
38138 save /home/$local_part_data/Mail/special
38139 endif
38140 .endd
38141 If the filter file does not exist, or does not deal with such addresses, they
38142 fall through to subsequent routers, and, assuming no subsequent use of the
38143 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38144 control over which suffixes are valid.
38145
38146 Alternatively, a suffix can be used to trigger the use of a different
38147 &_.forward_& file &-- which is the way a similar facility is implemented in
38148 another MTA:
38149 .code
38150 userforward:
38151   driver = redirect
38152   check_local_user
38153   local_part_suffix = -*
38154   local_part_suffix_optional
38155   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38156   allow_filter
38157 .endd
38158 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38159 example, &_.forward-special_& is used. Once again, if the appropriate file
38160 does not exist, or does not deal with the address, it is passed on to
38161 subsequent routers, which could, if required, look for an unqualified
38162 &_.forward_& file to use as a default.
38163
38164
38165
38166 .section "Simplified vacation processing" "SECID244"
38167 .cindex "vacation processing"
38168 The traditional way of running the &'vacation'& program is for a user to set up
38169 a pipe command in a &_.forward_& file
38170 (see section &<<SECTspecitredli>>& for syntax details).
38171 This is prone to error by inexperienced users. There are two features of Exim
38172 that can be used to make this process simpler for users:
38173
38174 .ilist
38175 A local part prefix such as &"vacation-"& can be specified on a router which
38176 can cause the message to be delivered directly to the &'vacation'& program, or
38177 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38178 &_.forward_& file are then much simpler. For example:
38179 .code
38180 spqr, vacation-spqr
38181 .endd
38182 .next
38183 The &%require_files%& generic router option can be used to trigger a
38184 vacation delivery by checking for the existence of a certain file in the
38185 user's home directory. The &%unseen%& generic option should also be used, to
38186 ensure that the original delivery also proceeds. In this case, all the user has
38187 to do is to create a file called, say, &_.vacation_&, containing a vacation
38188 message.
38189 .endlist
38190
38191 Another advantage of both these methods is that they both work even when the
38192 use of arbitrary pipes by users is locked out.
38193
38194
38195
38196 .section "Taking copies of mail" "SECID245"
38197 .cindex "message" "copying every"
38198 Some installations have policies that require archive copies of all messages to
38199 be made. A single copy of each message can easily be taken by an appropriate
38200 command in a system filter, which could, for example, use a different file for
38201 each day's messages.
38202
38203 There is also a shadow transport mechanism that can be used to take copies of
38204 messages that are successfully delivered by local transports, one copy per
38205 delivery. This could be used, &'inter alia'&, to implement automatic
38206 notification of delivery by sites that insist on doing such things.
38207
38208
38209
38210 .section "Intermittently connected hosts" "SECID246"
38211 .cindex "intermittently connected hosts"
38212 It has become quite common (because it is cheaper) for hosts to connect to the
38213 Internet periodically rather than remain connected all the time. The normal
38214 arrangement is that mail for such hosts accumulates on a system that is
38215 permanently connected.
38216
38217 Exim was designed for use on permanently connected hosts, and so it is not
38218 particularly well-suited to use in an intermittently connected environment.
38219 Nevertheless there are some features that can be used.
38220
38221
38222 .section "Exim on the upstream server host" "SECID247"
38223 It is tempting to arrange for incoming mail for the intermittently connected
38224 host to remain in Exim's queue until the client connects. However, this
38225 approach does not scale very well. Two different kinds of waiting message are
38226 being mixed up in the same queue &-- those that cannot be delivered because of
38227 some temporary problem, and those that are waiting for their destination host
38228 to connect. This makes it hard to manage the queue, as well as wasting
38229 resources, because each queue runner scans the entire queue.
38230
38231 A better approach is to separate off those messages that are waiting for an
38232 intermittently connected host. This can be done by delivering these messages
38233 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38234 format, from where they are transmitted by other software when their
38235 destination connects. This makes it easy to collect all the mail for one host
38236 in a single directory, and to apply local timeout rules on a per-message basis
38237 if required.
38238
38239 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38240 you are doing this, you should configure Exim with a long retry period for the
38241 intermittent host. For example:
38242 .code
38243 cheshire.wonderland.fict.example    *   F,5d,24h
38244 .endd
38245 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38246 which messages it has queued up for that host. Once the intermittent host comes
38247 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38248 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38249 causes all the queued up messages to be delivered, often down a single SMTP
38250 connection. While the host remains connected, any new messages get delivered
38251 immediately.
38252
38253 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38254 issued with a different IP address each time it connects, Exim's retry
38255 mechanisms on the holding host get confused, because the IP address is normally
38256 used as part of the key string for holding retry information. This can be
38257 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38258 Since this has disadvantages for permanently connected hosts, it is best to
38259 arrange a separate transport for the intermittently connected ones.
38260
38261
38262
38263 .section "Exim on the intermittently connected client host" "SECID248"
38264 The value of &%smtp_accept_queue_per_connection%& should probably be
38265 increased, or even set to zero (that is, disabled) on the intermittently
38266 connected host, so that all incoming messages down a single connection get
38267 delivered immediately.
38268
38269 .cindex "SMTP" "passed connection"
38270 .cindex "SMTP" "multiple deliveries"
38271 .cindex "multiple SMTP deliveries"
38272 .cindex "first pass routing"
38273 Mail waiting to be sent from an intermittently connected host will probably
38274 not have been routed, because without a connection DNS lookups are not
38275 possible. This means that if a normal queue run is done at connection time,
38276 each message is likely to be sent in a separate SMTP session. This can be
38277 avoided by starting the queue run with a command line option beginning with
38278 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38279 first pass, routing is done but no deliveries take place. The second pass is a
38280 normal queue run; since all the messages have been previously routed, those
38281 destined for the same host are likely to get sent as multiple deliveries in a
38282 single SMTP connection.
38283
38284
38285
38286 . ////////////////////////////////////////////////////////////////////////////
38287 . ////////////////////////////////////////////////////////////////////////////
38288
38289 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38290          "Exim as a non-queueing client"
38291 .cindex "client, non-queueing"
38292 .cindex "smart host" "suppressing queueing"
38293 On a personal computer, it is a common requirement for all
38294 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38295 configured to operate that way, for all the popular operating systems.
38296 However, there are some MUAs for Unix-like systems that cannot be so
38297 configured: they submit messages using the command line interface of
38298 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38299 messages this way.
38300
38301 If the personal computer runs continuously, there is no problem, because it can
38302 run a conventional MTA that handles delivery to the smart host, and deal with
38303 any delays via its queueing mechanism. However, if the computer does not run
38304 continuously or runs different operating systems at different times, queueing
38305 email is not desirable.
38306
38307 There is therefore a requirement for something that can provide the
38308 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38309 any queueing or retrying facilities. Furthermore, the delivery to the smart
38310 host should be synchronous, so that if it fails, the sending MUA is immediately
38311 informed. In other words, we want something that extends an MUA that submits
38312 to a local MTA via the command line so that it behaves like one that submits
38313 to a remote smart host using TCP/SMTP.
38314
38315 There are a number of applications (for example, there is one called &'ssmtp'&)
38316 that do this job. However, people have found them to be lacking in various
38317 ways. For instance, you might want to allow aliasing and forwarding to be done
38318 before sending a message to the smart host.
38319
38320 Exim already had the necessary infrastructure for doing this job. Just a few
38321 tweaks were needed to make it behave as required, though it is somewhat of an
38322 overkill to use a fully-featured MTA for this purpose.
38323
38324 .oindex "&%mua_wrapper%&"
38325 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38326 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38327 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38328 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38329 compatible router and transport configuration. Typically there will be just one
38330 router and one transport, sending everything to a smart host.
38331
38332 When run in MUA wrapping mode, the behaviour of Exim changes in the
38333 following ways:
38334
38335 .ilist
38336 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38337 In other words, the only way to submit messages is via the command line.
38338 .next
38339 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38340 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38341 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38342 does not finish until the delivery attempt is complete. If the delivery is
38343 successful, a zero return code is given.
38344 .next
38345 Address redirection is permitted, but the final routing for all addresses must
38346 be to the same remote transport, and to the same list of hosts. Furthermore,
38347 the return address (envelope sender) must be the same for all recipients, as
38348 must any added or deleted header lines. In other words, it must be possible to
38349 deliver the message in a single SMTP transaction, however many recipients there
38350 are.
38351 .next
38352 If these conditions are not met, or if routing any address results in a
38353 failure or defer status, or if Exim is unable to deliver all the recipients
38354 successfully to one of the smart hosts, delivery of the entire message fails.
38355 .next
38356 Because no queueing is allowed, all failures are treated as permanent; there
38357 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38358 smart host. Furthermore, because only a single yes/no response can be given to
38359 the caller, it is not possible to deliver to some recipients and not others. If
38360 there is an error (temporary or permanent) for any recipient, all are failed.
38361 .next
38362 If more than one smart host is listed, Exim will try another host after a
38363 connection failure or a timeout, in the normal way. However, if this kind of
38364 failure happens for all the hosts, the delivery fails.
38365 .next
38366 When delivery fails, an error message is written to the standard error stream
38367 (as well as to Exim's log), and Exim exits to the caller with a return code
38368 value 1. The message is expunged from Exim's spool files. No bounce messages
38369 are ever generated.
38370 .next
38371 No retry data is maintained, and any retry rules are ignored.
38372 .next
38373 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38374 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38375 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38376 .endlist
38377
38378 The overall effect is that Exim makes a single synchronous attempt to deliver
38379 the message, failing if there is any kind of problem. Because no local
38380 deliveries are done and no daemon can be run, Exim does not need root
38381 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38382 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38383 the advantages and disadvantages of running without root privilege.
38384
38385
38386
38387
38388 . ////////////////////////////////////////////////////////////////////////////
38389 . ////////////////////////////////////////////////////////////////////////////
38390
38391 .chapter "Log files" "CHAPlog"
38392 .scindex IIDloggen "log" "general description"
38393 .cindex "log" "types of"
38394 Exim writes three different logs, referred to as the main log, the reject log,
38395 and the panic log:
38396
38397 .ilist
38398 .cindex "main log"
38399 The main log records the arrival of each message and each delivery in a single
38400 line in each case. The format is as compact as possible, in an attempt to keep
38401 down the size of log files. Two-character flag sequences make it easy to pick
38402 out these lines. A number of other events are recorded in the main log. Some of
38403 them are optional, in which case the &%log_selector%& option controls whether
38404 they are included or not. A Perl script called &'eximstats'&, which does simple
38405 analysis of main log files, is provided in the Exim distribution (see section
38406 &<<SECTmailstat>>&).
38407 .next
38408 .cindex "reject log"
38409 The reject log records information from messages that are rejected as a result
38410 of a configuration option (that is, for policy reasons).
38411 The first line of each rejection is a copy of the line that is also written to
38412 the main log. Then, if the message's header has been read at the time the log
38413 is written, its contents are written to this log. Only the original header
38414 lines are available; header lines added by ACLs are not logged. You can use the
38415 reject log to check that your policy controls are working correctly; on a busy
38416 host this may be easier than scanning the main log for rejection messages. You
38417 can suppress the writing of the reject log by setting &%write_rejectlog%&
38418 false.
38419 .next
38420 .cindex "panic log"
38421 .cindex "system log"
38422 When certain serious errors occur, Exim writes entries to its panic log. If the
38423 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38424 are usually written to the main log as well, but can get lost amid the mass of
38425 other entries. The panic log should be empty under normal circumstances. It is
38426 therefore a good idea to check it (or to have a &'cron'& script check it)
38427 regularly, in order to become aware of any problems. When Exim cannot open its
38428 panic log, it tries as a last resort to write to the system log (syslog). This
38429 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38430 message itself is written at priority LOG_CRIT.
38431 .endlist
38432
38433 Every log line starts with a timestamp, in the format shown in the following
38434 example. Note that many of the examples shown in this chapter are line-wrapped.
38435 In the log file, this would be all on one line:
38436 .code
38437 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38438   by QUIT
38439 .endd
38440 By default, the timestamps are in the local timezone. There are two
38441 ways of changing this:
38442
38443 .ilist
38444 You can set the &%timezone%& option to a different time zone; in particular, if
38445 you set
38446 .code
38447 timezone = UTC
38448 .endd
38449 the timestamps will be in UTC (aka GMT).
38450 .next
38451 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38452 example:
38453 .code
38454 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38455 .endd
38456 .endlist
38457
38458 .cindex "log" "process ids in"
38459 .cindex "pid (process id)" "in log lines"
38460 Exim does not include its process id in log lines by default, but you can
38461 request that it does so by specifying the &`pid`& log selector (see section
38462 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38463 brackets, immediately after the time and date.
38464
38465
38466
38467
38468 .section "Where the logs are written" "SECTwhelogwri"
38469 .cindex "log" "destination"
38470 .cindex "log" "to file"
38471 .cindex "log" "to syslog"
38472 .cindex "syslog"
38473 The logs may be written to local files, or to syslog, or both. However, it
38474 should be noted that many syslog implementations use UDP as a transport, and
38475 are therefore unreliable in the sense that messages are not guaranteed to
38476 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38477 It has also been reported that on large log files (tens of megabytes) you may
38478 need to tweak syslog to prevent it syncing the file with each write &-- on
38479 Linux this has been seen to make syslog take 90% plus of CPU time.
38480
38481 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38482 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38483 configuration. This latter string is expanded, so it can contain, for example,
38484 references to the host name:
38485 .code
38486 log_file_path = /var/log/$primary_hostname/exim_%slog
38487 .endd
38488 It is generally advisable, however, to set the string in &_Local/Makefile_&
38489 rather than at runtime, because then the setting is available right from the
38490 start of Exim's execution. Otherwise, if there's something it wants to log
38491 before it has read the configuration file (for example, an error in the
38492 configuration file) it will not use the path you want, and may not be able to
38493 log at all.
38494
38495 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38496 list, currently limited to at most two items. This is one option where the
38497 facility for changing a list separator may not be used. The list must always be
38498 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38499 otherwise the item must either be an absolute path, containing &`%s`& at the
38500 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38501 implying the use of a default path.
38502
38503 When Exim encounters an empty item in the list, it searches the list defined by
38504 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38505 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38506 mean &"use the path specified at build time"&. If no such item exists, log
38507 files are written in the &_log_& subdirectory of the spool directory. This is
38508 equivalent to the configuration file setting:
38509 .code
38510 log_file_path = $spool_directory/log/%slog
38511 .endd
38512 If you do not specify anything at build time or runtime,
38513 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38514 that is where the logs are written.
38515
38516 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38517 are in use &-- see section &<<SECTdatlogfil>>& below.
38518
38519 Here are some examples of possible Makefile settings:
38520 .display
38521 &`LOG_FILE_PATH=syslog                    `& syslog only
38522 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38523 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38524 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38525 .endd
38526 If there are more than two paths in the list, the first is used and a panic
38527 error is logged.
38528
38529
38530
38531 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38532 .cindex "log" "cycling local files"
38533 .cindex "cycling logs"
38534 .cindex "&'exicyclog'&"
38535 .cindex "log" "local files; writing to"
38536 Some operating systems provide centralized and standardized methods for cycling
38537 log files. For those that do not, a utility script called &'exicyclog'& is
38538 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38539 main and reject logs each time it is called. The maximum number of old logs to
38540 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38541
38542 An Exim delivery process opens the main log when it first needs to write to it,
38543 and it keeps the file open in case subsequent entries are required &-- for
38544 example, if a number of different deliveries are being done for the same
38545 message. However, remote SMTP deliveries can take a long time, and this means
38546 that the file may be kept open long after it is renamed if &'exicyclog'& or
38547 something similar is being used to rename log files on a regular basis. To
38548 ensure that a switch of log files is noticed as soon as possible, Exim calls
38549 &[stat()]& on the main log's name before reusing an open file, and if the file
38550 does not exist, or its inode has changed, the old file is closed and Exim
38551 tries to open the main log from scratch. Thus, an old log file may remain open
38552 for quite some time, but no Exim processes should write to it once it has been
38553 renamed.
38554
38555
38556
38557 .section "Datestamped log files" "SECTdatlogfil"
38558 .cindex "log" "datestamped files"
38559 Instead of cycling the main and reject log files by renaming them
38560 periodically, some sites like to use files whose names contain a datestamp,
38561 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38562 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38563 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38564 point where the datestamp is required. For example:
38565 .code
38566 log_file_path = /var/spool/exim/log/%slog-%D
38567 log_file_path = /var/log/exim-%s-%D.log
38568 log_file_path = /var/spool/exim/log/%D-%slog
38569 log_file_path = /var/log/exim/%s.%M
38570 .endd
38571 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38572 examples of names generated by the above examples:
38573 .code
38574 /var/spool/exim/log/mainlog-20021225
38575 /var/log/exim-reject-20021225.log
38576 /var/spool/exim/log/20021225-mainlog
38577 /var/log/exim/main.200212
38578 .endd
38579 When this form of log file is specified, Exim automatically switches to new
38580 files at midnight. It does not make any attempt to compress old logs; you
38581 will need to write your own script if you require this. You should not
38582 run &'exicyclog'& with this form of logging.
38583
38584 The location of the panic log is also determined by &%log_file_path%&, but it
38585 is not datestamped, because rotation of the panic log does not make sense.
38586 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38587 the string. In addition, if it immediately follows a slash, a following
38588 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38589 character is removed. Thus, the four examples above would give these panic
38590 log names:
38591 .code
38592 /var/spool/exim/log/paniclog
38593 /var/log/exim-panic.log
38594 /var/spool/exim/log/paniclog
38595 /var/log/exim/panic
38596 .endd
38597
38598
38599 .section "Logging to syslog" "SECID249"
38600 .cindex "log" "syslog; writing to"
38601 The use of syslog does not change what Exim logs or the format of its messages,
38602 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38603 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38604 that, the same strings are written to syslog as to log files. The syslog
38605 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38606 by default, but you can change these by setting the &%syslog_facility%& and
38607 &%syslog_processname%& options, respectively. If Exim was compiled with
38608 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38609 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38610 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38611 the time and host name to each line.
38612 The three log streams are mapped onto syslog priorities as follows:
38613
38614 .ilist
38615 &'mainlog'& is mapped to LOG_INFO
38616 .next
38617 &'rejectlog'& is mapped to LOG_NOTICE
38618 .next
38619 &'paniclog'& is mapped to LOG_ALERT
38620 .endlist
38621
38622 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38623 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38624 these are routed by syslog to the same place. You can suppress this duplication
38625 by setting &%syslog_duplication%& false.
38626
38627 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38628 entries contain multiple lines when headers are included. To cope with both
38629 these cases, entries written to syslog are split into separate &[syslog()]&
38630 calls at each internal newline, and also after a maximum of
38631 870 data characters. (This allows for a total syslog line length of 1024, when
38632 additions such as timestamps are added.) If you are running a syslog
38633 replacement that can handle lines longer than the 1024 characters allowed by
38634 RFC 3164, you should set
38635 .code
38636 SYSLOG_LONG_LINES=yes
38637 .endd
38638 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38639 lines, but it still splits at internal newlines in &'reject'& log entries.
38640
38641 To make it easy to re-assemble split lines later, each component of a split
38642 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38643 where <&'n'&> is the component number and <&'m'&> is the total number of
38644 components in the entry. The / delimiter is used when the line was split
38645 because it was too long; if it was split because of an internal newline, the \
38646 delimiter is used. For example, supposing the length limit to be 50 instead of
38647 870, the following would be the result of a typical rejection message to
38648 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38649 name, and pid as added by syslog:
38650 .code
38651 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38652 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38653 [3/5]  when scanning for sender: missing or malformed lo
38654 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38655 [5/5] mple>)
38656 .endd
38657 The same error might cause the following lines to be written to &"rejectlog"&
38658 (LOG_NOTICE):
38659 .code
38660 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38661 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38662 [3/18] er when scanning for sender: missing or malformed
38663 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38664 [5\18] .example>)
38665 [6\18] Recipients: ph10@some.domain.cam.example
38666 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38667 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38668 [9\18]        id 16RdAL-0006pc-00
38669 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38670 [11\18] 09:43 +0100
38671 [12\18] F From: <>
38672 [13\18]   Subject: this is a test header
38673 [18\18]   X-something: this is another header
38674 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38675 [16\18] le>
38676 [17\18] B Bcc:
38677 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38678 .endd
38679 Log lines that are neither too long nor contain newlines are written to syslog
38680 without modification.
38681
38682 If only syslog is being used, the Exim monitor is unable to provide a log tail
38683 display, unless syslog is routing &'mainlog'& to a file on the local host and
38684 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38685 where it is.
38686
38687
38688
38689 .section "Log line flags" "SECID250"
38690 One line is written to the main log for each message received, and for each
38691 successful, unsuccessful, and delayed delivery. These lines can readily be
38692 picked out by the distinctive two-character flags that immediately follow the
38693 timestamp. The flags are:
38694 .itable none 0 0 2 10* left 90* left
38695 .irow &%<=%&     "message arrival"
38696 .irow &%(=%&     "message fakereject"
38697 .irow &%=>%&     "normal message delivery"
38698 .irow &%->%&     "additional address in same delivery"
38699 .irow &%>>%&     "cutthrough message delivery"
38700 .irow &%*>%&     "delivery suppressed by &%-N%&"
38701 .irow &%**%&     "delivery failed; address bounced"
38702 .irow &%==%&     "delivery deferred; temporary problem"
38703 .endtable
38704
38705
38706 .section "Logging message reception" "SECID251"
38707 .cindex "log" "reception line"
38708 The format of the single-line entry in the main log that is written for every
38709 message received is shown in the basic example below, which is split over
38710 several lines in order to fit it on the page:
38711 .code
38712 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38713   H=mailer.fict.example [192.168.123.123] U=exim
38714   P=smtp S=5678 id=<incoming message id>
38715 .endd
38716 The address immediately following &"<="& is the envelope sender address. A
38717 bounce message is shown with the sender address &"<>"&, and if it is locally
38718 generated, this is followed by an item of the form
38719 .code
38720 R=<message id>
38721 .endd
38722 which is a reference to the message that caused the bounce to be sent.
38723
38724 .cindex "HELO"
38725 .cindex "EHLO"
38726 For messages from other hosts, the H and U fields identify the remote host and
38727 record the RFC 1413 identity of the user that sent the message, if one was
38728 received. The number given in square brackets is the IP address of the sending
38729 host. If there is a single, unparenthesized  host name in the H field, as
38730 above, it has been verified to correspond to the IP address (see the
38731 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38732 by the remote host in the SMTP HELO or EHLO command, and has not been
38733 verified. If verification yields a different name to that given for HELO or
38734 EHLO, the verified name appears first, followed by the HELO or EHLO
38735 name in parentheses.
38736
38737 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38738 without brackets, in the HELO or EHLO command, leading to entries in
38739 the log containing text like these examples:
38740 .code
38741 H=(10.21.32.43) [192.168.8.34]
38742 H=([10.21.32.43]) [192.168.8.34]
38743 .endd
38744 This can be confusing. Only the final address in square brackets can be relied
38745 on.
38746
38747 For locally generated messages (that is, messages not received over TCP/IP),
38748 the H field is omitted, and the U field contains the login name of the caller
38749 of Exim.
38750
38751 .cindex "authentication" "logging"
38752 .cindex "AUTH" "logging"
38753 For all messages, the P field specifies the protocol used to receive the
38754 message. This is the value that is stored in &$received_protocol$&. In the case
38755 of incoming SMTP messages, the value indicates whether or not any SMTP
38756 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38757 session was encrypted, there is an additional X field that records the cipher
38758 suite that was used.
38759
38760 .cindex log protocol
38761 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38762 hosts that have authenticated themselves using the SMTP AUTH command. The first
38763 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38764 there is an additional item A= followed by the name of the authenticator that
38765 was used. If an authenticated identification was set up by the authenticator's
38766 &%server_set_id%& option, this is logged too, separated by a colon from the
38767 authenticator name.
38768
38769 .cindex "size" "of message"
38770 The id field records the existing message id, if present. The size of the
38771 received message is given by the S field. When the message is delivered,
38772 headers may be removed or added, so that the size of delivered copies of the
38773 message may not correspond with this value (and indeed may be different to each
38774 other).
38775
38776 The &%log_selector%& option can be used to request the logging of additional
38777 data when a message is received. See section &<<SECTlogselector>>& below.
38778
38779
38780
38781 .section "Logging deliveries" "SECID252"
38782 .cindex "log" "delivery line"
38783 The format of the single-line entry in the main log that is written for every
38784 delivery is shown in one of the examples below, for local and remote
38785 deliveries, respectively. Each example has been split into multiple lines in order
38786 to fit it on the page:
38787 .code
38788 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38789   <marv@hitch.fict.example> R=localuser T=local_delivery
38790 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38791   monk@holistic.fict.example R=dnslookup T=remote_smtp
38792   H=holistic.fict.example [192.168.234.234]
38793 .endd
38794 For ordinary local deliveries, the original address is given in angle brackets
38795 after the final delivery address, which might be a pipe or a file. If
38796 intermediate address(es) exist between the original and the final address, the
38797 last of these is given in parentheses after the final address. The R and T
38798 fields record the router and transport that were used to process the address.
38799
38800 If SMTP AUTH was used for the delivery there is an additional item A=
38801 followed by the name of the authenticator that was used.
38802 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38803 option, this is logged too, as a second colon-separated list item.
38804 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38805
38806 If a shadow transport was run after a successful local delivery, the log line
38807 for the successful delivery has an item added on the end, of the form
38808 .display
38809 &`ST=<`&&'shadow transport name'&&`>`&
38810 .endd
38811 If the shadow transport did not succeed, the error message is put in
38812 parentheses afterwards.
38813
38814 .cindex "asterisk" "after IP address"
38815 When more than one address is included in a single delivery (for example, two
38816 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38817 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38818 down a single SMTP connection, an asterisk follows the
38819 remote IP address (and port if enabled)
38820 in the log lines for the second and subsequent messages.
38821 When two or more messages are delivered down a single TLS connection, the
38822 DNS and some TLS-related information logged for the first message delivered
38823 will not be present in the log lines for the second and subsequent messages.
38824 TLS cipher information is still available.
38825
38826 .cindex "delivery" "cutthrough; logging"
38827 .cindex "cutthrough" "logging"
38828 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38829 line precedes the reception line, since cutthrough waits for a possible
38830 rejection from the destination in case it can reject the sourced item.
38831
38832 The generation of a reply message by a filter file gets logged as a
38833 &"delivery"& to the addressee, preceded by &">"&.
38834
38835 The &%log_selector%& option can be used to request the logging of additional
38836 data when a message is delivered. See section &<<SECTlogselector>>& below.
38837
38838
38839 .section "Discarded deliveries" "SECID253"
38840 .cindex "discarded messages"
38841 .cindex "message" "discarded"
38842 .cindex "delivery" "discarded; logging"
38843 When a message is discarded as a result of the command &"seen finish"& being
38844 obeyed in a filter file which generates no deliveries, a log entry of the form
38845 .code
38846 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38847   <low.club@bridge.example> R=userforward
38848 .endd
38849 is written, to record why no deliveries are logged. When a message is discarded
38850 because it is aliased to &":blackhole:"& the log line is like this:
38851 .code
38852 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38853   <hole@nowhere.example> R=blackhole_router
38854 .endd
38855
38856
38857 .section "Deferred deliveries" "SECID254"
38858 When a delivery is deferred, a line of the following form is logged:
38859 .code
38860 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38861   R=dnslookup T=smtp defer (146): Connection refused
38862 .endd
38863 In the case of remote deliveries, the error is the one that was given for the
38864 last IP address that was tried. Details of individual SMTP failures are also
38865 written to the log, so the above line would be preceded by something like
38866 .code
38867 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38868   mail1.endrest.example [192.168.239.239]: Connection refused
38869 .endd
38870 When a deferred address is skipped because its retry time has not been reached,
38871 a message is written to the log, but this can be suppressed by setting an
38872 appropriate value in &%log_selector%&.
38873
38874
38875
38876 .section "Delivery failures" "SECID255"
38877 .cindex "delivery" "failure; logging"
38878 If a delivery fails because an address cannot be routed, a line of the
38879 following form is logged:
38880 .code
38881 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38882   <jim@trek99.example>: unknown mail domain
38883 .endd
38884 If a delivery fails at transport time, the router and transport are shown, and
38885 the response from the remote host is included, as in this example:
38886 .code
38887 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38888   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38889   after pipelined RCPT TO:<ace400@pb.example>: host
38890   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38891   <ace400@pb.example>...Addressee unknown
38892 .endd
38893 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38894 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38895 disabling PIPELINING. The log lines for all forms of delivery failure are
38896 flagged with &`**`&.
38897
38898
38899
38900 .section "Fake deliveries" "SECID256"
38901 .cindex "delivery" "fake; logging"
38902 If a delivery does not actually take place because the &%-N%& option has been
38903 used to suppress it, a normal delivery line is written to the log, except that
38904 &"=>"& is replaced by &"*>"&.
38905
38906
38907
38908 .section "Completion" "SECID257"
38909 A line of the form
38910 .code
38911 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38912 .endd
38913 is written to the main log when a message is about to be removed from the spool
38914 at the end of its processing.
38915
38916
38917
38918
38919 .section "Summary of Fields in Log Lines" "SECID258"
38920 .cindex "log" "summary of fields"
38921 A summary of the field identifiers that are used in log lines is shown in
38922 the following table:
38923 .display
38924 &`A   `&        authenticator name (and optional id and sender)
38925 &`C   `&        SMTP confirmation on delivery
38926 &`    `&        command list for &"no mail in SMTP session"&
38927 &`CV  `&        certificate verification status
38928 &`D   `&        duration of &"no mail in SMTP session"&
38929 &`DKIM`&        domain verified in incoming message
38930 &`DN  `&        distinguished name from peer certificate
38931 &`DS  `&        DNSSEC secured lookups
38932 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38933 &`F   `&        sender address (on delivery lines)
38934 &`H   `&        host name and IP address
38935 &`I   `&        local interface used
38936 &`id  `&        message id (from header) for incoming message
38937 &`K   `&        CHUNKING extension used
38938 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38939 &`M8S `&        8BITMIME status for incoming message
38940 &`P   `&        on &`<=`& lines: protocol used
38941 &`    `&        on &`=>`& and &`**`& lines: return path
38942 &`PRDR`&        PRDR extension used
38943 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38944 &`Q   `&        alternate queue name
38945 &`QT  `&        on &`=>`& lines: time spent on queue so far
38946 &`    `&        on &"Completed"& lines: time spent on queue
38947 &`R   `&        on &`<=`& lines: reference for local bounce
38948 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38949 &`RT  `&        on &`<=`& lines: time taken for reception
38950 &`S   `&        size of message in bytes
38951 &`SNI `&        server name indication from TLS client hello
38952 &`ST  `&        shadow transport name
38953 &`T   `&        on &`<=`& lines: message subject (topic)
38954 &`TFO `&        connection took advantage of TCP Fast Open
38955 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38956 &`U   `&        local user or RFC 1413 identity
38957 &`X   `&        TLS cipher suite
38958 .endd
38959
38960
38961 .section "Other log entries" "SECID259"
38962 Various other types of log entry are written from time to time. Most should be
38963 self-explanatory. Among the more common are:
38964
38965 .ilist
38966 .cindex "retry" "time not reached"
38967 &'retry time not reached'&&~&~An address previously suffered a temporary error
38968 during routing or local delivery, and the time to retry has not yet arrived.
38969 This message is not written to an individual message log file unless it happens
38970 during the first delivery attempt.
38971 .next
38972 &'retry time not reached for any host'&&~&~An address previously suffered
38973 temporary errors during remote delivery, and the retry time has not yet arrived
38974 for any of the hosts to which it is routed.
38975 .next
38976 .cindex "spool directory" "file locked"
38977 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38978 some other Exim process is already working on the message. This can be quite
38979 common if queue running processes are started at frequent intervals. The
38980 &'exiwhat'& utility script can be used to find out what Exim processes are
38981 doing.
38982 .next
38983 .cindex "error" "ignored"
38984 &'error ignored'&&~&~There are several circumstances that give rise to this
38985 message:
38986 .olist
38987 Exim failed to deliver a bounce message whose age was greater than
38988 &%ignore_bounce_errors_after%&. The bounce was discarded.
38989 .next
38990 A filter file set up a delivery using the &"noerror"& option, and the delivery
38991 failed. The delivery was discarded.
38992 .next
38993 A delivery set up by a router configured with
38994 . ==== As this is a nested list, any displays it contains must be indented
38995 . ==== as otherwise they are too far to the left.
38996 .code
38997     errors_to = <>
38998 .endd
38999 failed. The delivery was discarded.
39000 .endlist olist
39001 .next
39002 .cindex DKIM "log line"
39003 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39004 logging and the message has a DKIM signature header.
39005 .endlist ilist
39006
39007
39008
39009
39010
39011 .section "Reducing or increasing what is logged" "SECTlogselector"
39012 .cindex "log" "selectors"
39013 By setting the &%log_selector%& global option, you can disable some of Exim's
39014 default logging to the main log, or you can request additional logging. The value of
39015 &%log_selector%& is made up of names preceded by plus or minus characters. For
39016 example:
39017 .code
39018 log_selector = +arguments -retry_defer
39019 .endd
39020 The list of optional log items is in the following table, with the default
39021 selection marked by asterisks:
39022 .itable none 0 0 3 2.8in left 10pt center 3in left
39023 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39024 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39025 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39026 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39027 .irow &`arguments`&                     &nbsp; "command line arguments"
39028 .irow &`connection_reject`&             *       "connection rejections"
39029 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39030 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39031 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39032 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39033 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature"
39034 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39035 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39036 .irow &`etrn`&                          *       "ETRN commands"
39037 .irow &`host_lookup_failed`&            *       "as it says"
39038 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39039 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39040 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39041 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39042 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39043 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39044 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39045 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39046 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39047 .irow &`queue_run`&                     *       "start and end queue runs"
39048 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39049 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39050 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39051 .irow &`pid`&                           &nbsp; "Exim process id"
39052 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39053 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39054 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39055 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39056 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39057 .irow &`rejected_header`&               *       "header contents on reject log"
39058 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39059 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39060 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39061 .irow &`sender_verify_fail`&            *       "sender verification failures"
39062 .irow &`size_reject`&                   *       "rejection because too big"
39063 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39064 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39065 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39066 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39067 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39068 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39069 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39070 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39071 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39072 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39073 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39074 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39075 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39076 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39077 .irow &`unknown_in_list`&               &nbsp; "DNS lookup failed in list match"
39078 .irow &`all`&                           &nbsp; "&*all of the above*&"
39079 .endtable
39080 See also the &%slow_lookup_log%& main configuration option,
39081 section &<<SECID99>>&
39082
39083 More details on each of these items follows:
39084
39085 .ilist
39086 .cindex "8BITMIME"
39087 .cindex "log" "8BITMIME"
39088 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39089 which may help in tracking down interoperability issues with ancient MTAs
39090 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39091 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39092 &`7BIT`& and &`8BITMIME`& respectively.
39093 .next
39094 .cindex "&%warn%& ACL verb" "log when skipping"
39095 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39096 its conditions cannot be evaluated, a log line to this effect is written if
39097 this log selector is set.
39098 .next
39099 .cindex "log" "rewriting"
39100 .cindex "rewriting" "logging"
39101 &%address_rewrite%&: This applies both to global rewrites and per-transport
39102 rewrites, but not to rewrites in filters run as an unprivileged user (because
39103 such users cannot access the log).
39104 .next
39105 .cindex "log" "full parentage"
39106 &%all_parents%&: Normally only the original and final addresses are logged on
39107 delivery lines; with this selector, intermediate parents are given in
39108 parentheses between them.
39109 .next
39110 .cindex "log" "Exim arguments"
39111 .cindex "Exim arguments, logging"
39112 &%arguments%&: This causes Exim to write the arguments with which it was called
39113 to the main log, preceded by the current working directory. This is a debugging
39114 feature, added to make it easier to find out how certain MUAs call
39115 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39116 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39117 that are empty or that contain white space are quoted. Non-printing characters
39118 are shown as escape sequences. This facility cannot log unrecognized arguments,
39119 because the arguments are checked before the configuration file is read. The
39120 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39121 between the caller and Exim.
39122 .next
39123 .cindex "log" "connection rejections"
39124 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39125 connection is rejected, for whatever reason.
39126 .next
39127 .cindex "log" "delayed delivery"
39128 .cindex "delayed delivery, logging"
39129 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39130 started for an incoming message because the load is too high or too many
39131 messages were received on one connection. Logging does not occur if no delivery
39132 process is started because &%queue_only%& is set or &%-odq%& was used.
39133 .next
39134 .cindex "log" "delivery duration"
39135 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39136 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39137 If millisecond logging is enabled, short times will be shown with greater
39138 precision, eg. &`DT=0.304s`&.
39139 .next
39140 .cindex "log" "message size on delivery"
39141 .cindex "size" "of message"
39142 &%delivery_size%&: For each delivery, the size of message delivered is added to
39143 the &"=>"& line, tagged with S=.
39144 .next
39145 .cindex log "DKIM verification"
39146 .cindex DKIM "verification logging"
39147 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39148 verifies successfully a tag of DKIM is added, with one of the verified domains.
39149 .next
39150 .cindex log "DKIM verification"
39151 .cindex DKIM "verification logging"
39152 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39153 .next
39154 .cindex "log" "dnslist defer"
39155 .cindex "DNS list" "logging defer"
39156 .cindex "black list (DNS)"
39157 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39158 DNS black list suffers a temporary error.
39159 .next
39160 .cindex log dnssec
39161 .cindex dnssec logging
39162 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39163 dns lookups gave secure results a tag of DS is added.
39164 For acceptance this covers the reverse and forward lookups for host name verification.
39165 It does not cover helo-name verification.
39166 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39167 .next
39168 .cindex "log" "ETRN commands"
39169 .cindex "ETRN" "logging"
39170 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39171 is run to determine whether or not it is actually accepted. An invalid ETRN
39172 command, or one received within a message transaction is not logged by this
39173 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39174 .next
39175 .cindex "log" "host lookup failure"
39176 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39177 any addresses, or when a lookup of an IP address fails to find a host name, a
39178 log line is written. This logging does not apply to direct DNS lookups when
39179 routing email addresses, but it does apply to &"byname"& lookups.
39180 .next
39181 .cindex "log" "ident timeout"
39182 .cindex "RFC 1413" "logging timeout"
39183 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39184 client's ident port times out.
39185 .next
39186 .cindex "log" "incoming interface"
39187 .cindex "log" "outgoing interface"
39188 .cindex "log" "local interface"
39189 .cindex "log" "local address and port"
39190 .cindex "TCP/IP" "logging local address and port"
39191 .cindex "interface" "logging"
39192 &%incoming_interface%&: The interface on which a message was received is added
39193 to the &"<="& line as an IP address in square brackets, tagged by I= and
39194 followed by a colon and the port number. The local interface and port are also
39195 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39196 rejection lines, and (despite the name) to outgoing
39197 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39198 The latter can be disabled by turning off the &%outgoing_interface%& option.
39199 .next
39200 .cindex log "incoming proxy address"
39201 .cindex proxy "logging proxy address"
39202 .cindex "TCP/IP" "logging proxy address"
39203 &%proxy%&: The internal (closest to the system running Exim) IP address
39204 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39205 on a proxied connection
39206 or the &"=>"& line for a message delivered on a proxied connection.
39207 See &<<SECTproxyInbound>>& for more information.
39208 .next
39209 .cindex "log" "incoming remote port"
39210 .cindex "port" "logging remote"
39211 .cindex "TCP/IP" "logging incoming remote port"
39212 .vindex "&$sender_fullhost$&"
39213 .vindex "&$sender_rcvhost$&"
39214 &%incoming_port%&: The remote port number from which a message was received is
39215 added to log entries and &'Received:'& header lines, following the IP address
39216 in square brackets, and separated from it by a colon. This is implemented by
39217 changing the value that is put in the &$sender_fullhost$& and
39218 &$sender_rcvhost$& variables. Recording the remote port number has become more
39219 important with the widening use of NAT (see RFC 2505).
39220 .next
39221 .cindex "log" "dropped connection"
39222 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39223 connection is unexpectedly dropped.
39224 .next
39225 .cindex "log" "millisecond timestamps"
39226 .cindex millisecond logging
39227 .cindex timestamps "millisecond, in logs"
39228 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39229 appended to the seconds value.
39230 .next
39231 .cindex "log" "message id"
39232 &%msg_id%&: The value of the Message-ID: header.
39233 .next
39234 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39235 This will be either because the message is a bounce, or was submitted locally
39236 (submission mode) without one.
39237 The field identifier will have an asterix appended: &"id*="&.
39238 .next
39239 .cindex "log" "outgoing interface"
39240 .cindex "log" "local interface"
39241 .cindex "log" "local address and port"
39242 .cindex "TCP/IP" "logging local address and port"
39243 .cindex "interface" "logging"
39244 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39245 interface on which a message was sent is added to delivery lines as an I= tag
39246 followed by IP address in square brackets. You can disable this by turning
39247 off the &%outgoing_interface%& option.
39248 .next
39249 .cindex "log" "outgoing remote port"
39250 .cindex "port" "logging outgoing remote"
39251 .cindex "TCP/IP" "logging outgoing remote port"
39252 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39253 containing => tags) following the IP address.
39254 The local port is also added if &%incoming_interface%& and
39255 &%outgoing_interface%& are both enabled.
39256 This option is not included in the default setting, because for most ordinary
39257 configurations, the remote port number is always 25 (the SMTP port), and the
39258 local port is a random ephemeral port.
39259 .next
39260 .cindex "log" "process ids in"
39261 .cindex "pid (process id)" "in log lines"
39262 &%pid%&: The current process id is added to every log line, in square brackets,
39263 immediately after the time and date.
39264 .next
39265 .cindex log pipelining
39266 .cindex pipelining "logging outgoing"
39267 &%pipelining%&: A field is added to delivery and accept
39268 log lines when the ESMTP PIPELINING extension was used.
39269 The field is a single "L".
39270
39271 On accept lines, where PIPELINING was offered but not used by the client,
39272 the field has a minus appended.
39273
39274 .cindex "pipelining" "early connection"
39275 If Exim is built without the DISABLE_PIPE_CONNECT build option
39276 accept "L" fields have a period appended if the feature was
39277 offered but not used, or an asterisk appended if used.
39278 Delivery "L" fields have an asterisk appended if used.
39279
39280 .next
39281 .cindex "log" "queue run"
39282 .cindex "queue runner" "logging"
39283 &%queue_run%&: The start and end of every queue run are logged.
39284 .next
39285 .cindex "log" "queue time"
39286 &%queue_time%&: The amount of time the message has been in the queue on the
39287 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39288 &`QT=3m45s`&.
39289 If millisecond logging is enabled, short times will be shown with greater
39290 precision, eg. &`QT=1.578s`&.
39291 .next
39292 &%queue_time_overall%&: The amount of time the message has been in the queue on
39293 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39294 example, &`QT=3m45s`&.
39295 .next
39296 .cindex "log" "receive duration"
39297 &%receive_time%&: For each message, the amount of real time it has taken to
39298 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39299 If millisecond logging is enabled, short times will be shown with greater
39300 precision, eg. &`RT=0.204s`&.
39301 .next
39302 .cindex "log" "recipients"
39303 &%received_recipients%&: The recipients of a message are listed in the main log
39304 as soon as the message is received. The list appears at the end of the log line
39305 that is written when a message is received, preceded by the word &"for"&. The
39306 addresses are listed after they have been qualified, but before any rewriting
39307 has taken place.
39308 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39309 in the list.
39310 .next
39311 .cindex "log" "sender reception"
39312 &%received_sender%&: The unrewritten original sender of a message is added to
39313 the end of the log line that records the message's arrival, after the word
39314 &"from"& (before the recipients if &%received_recipients%& is also set).
39315 .next
39316 .cindex "log" "header lines for rejection"
39317 &%rejected_header%&: If a message's header has been received at the time a
39318 rejection is written to the reject log, the complete header is added to the
39319 log. Header logging can be turned off individually for messages that are
39320 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39321 .next
39322 .cindex "log" "retry defer"
39323 &%retry_defer%&: A log line is written if a delivery is deferred because a
39324 retry time has not yet been reached. However, this &"retry time not reached"&
39325 message is always omitted from individual message logs after the first delivery
39326 attempt.
39327 .next
39328 .cindex "log" "return path"
39329 &%return_path_on_delivery%&: The return path that is being transmitted with
39330 the message is included in delivery and bounce lines, using the tag P=.
39331 This is omitted if no delivery actually happens, for example, if routing fails,
39332 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39333 .next
39334 .cindex "log" "sender on delivery"
39335 &%sender_on_delivery%&: The message's sender address is added to every delivery
39336 and bounce line, tagged by F= (for &"from"&).
39337 This is the original sender that was received with the message; it is not
39338 necessarily the same as the outgoing return path.
39339 .next
39340 .cindex "log" "sender verify failure"
39341 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39342 gives details of a sender verification failure is not written. Log lines for
39343 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39344 detail is lost.
39345 .next
39346 .cindex "log" "size rejection"
39347 &%size_reject%&: A log line is written whenever a message is rejected because
39348 it is too big.
39349 .next
39350 .cindex "log" "frozen messages; skipped"
39351 .cindex "frozen messages" "logging skipping"
39352 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39353 queue run because it another process is already delivering it or because
39354 it is frozen.
39355 .cindex "&""spool file is locked""&"
39356 .cindex "&""message is frozen""&"
39357 The message that is written is either &"spool file is locked"& or
39358 &"message is frozen"&.
39359 .next
39360 .cindex "log" "smtp confirmation"
39361 .cindex "SMTP" "logging confirmation"
39362 .cindex "LMTP" "logging confirmation"
39363 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39364 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39365 A number of MTAs (including Exim) return an identifying string in this
39366 response.
39367 .next
39368 .cindex "log" "SMTP connections"
39369 .cindex "SMTP" "logging connections"
39370 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39371 established or closed, unless the connection is from a host that matches
39372 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39373 only when the closure is unexpected.) This applies to connections from local
39374 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39375 dropped in the middle of a message, a log line is always written, whether or
39376 not this selector is set, but otherwise nothing is written at the start and end
39377 of connections unless this selector is enabled.
39378
39379 For TCP/IP connections to an Exim daemon, the current number of connections is
39380 included in the log message for each new connection, but note that the count is
39381 reset if the daemon is restarted.
39382 Also, because connections are closed (and the closure is logged) in
39383 subprocesses, the count may not include connections that have been closed but
39384 whose termination the daemon has not yet noticed. Thus, while it is possible to
39385 match up the opening and closing of connections in the log, the value of the
39386 logged counts may not be entirely accurate.
39387 .next
39388 .cindex "log" "SMTP transaction; incomplete"
39389 .cindex "SMTP" "logging incomplete transactions"
39390 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39391 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39392 and the message sender plus any accepted recipients are included in the log
39393 line. This can provide evidence of dictionary attacks.
39394 .next
39395 .cindex "log" "non-MAIL SMTP sessions"
39396 .cindex "MAIL" "logging session without"
39397 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39398 connection terminates without having issued a MAIL command. This includes both
39399 the case when the connection is dropped, and the case when QUIT is used. It
39400 does not include cases where the connection is rejected right at the start (by
39401 an ACL, or because there are too many connections, or whatever). These cases
39402 already have their own log lines.
39403
39404 The log line that is written contains the identity of the client in the usual
39405 way, followed by D= and a time, which records the duration of the connection.
39406 If the connection was authenticated, this fact is logged exactly as it is for
39407 an incoming message, with an A= item. If the connection was encrypted, CV=,
39408 DN=, and X= items may appear as they do for an incoming message, controlled by
39409 the same logging options.
39410
39411 Finally, if any SMTP commands were issued during the connection, a C= item
39412 is added to the line, listing the commands that were used. For example,
39413 .code
39414 C=EHLO,QUIT
39415 .endd
39416 shows that the client issued QUIT straight after EHLO. If there were fewer
39417 than 20 commands, they are all listed. If there were more than 20 commands,
39418 the last 20 are listed, preceded by &"..."&. However, with the default
39419 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39420 have been aborted before 20 non-mail commands are processed.
39421 .next
39422 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39423 colon-separated, is appended to the A= item for a message arrival or delivery
39424 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39425 was accepted or used.
39426 .next
39427 .cindex "log" "SMTP protocol error"
39428 .cindex "SMTP" "logging protocol error"
39429 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39430 encountered. Exim does not have perfect detection of all protocol errors
39431 because of transmission delays and the use of pipelining. If PIPELINING has
39432 been advertised to a client, an Exim server assumes that the client will use
39433 it, and therefore it does not count &"expected"& errors (for example, RCPT
39434 received after rejecting MAIL) as protocol errors.
39435 .next
39436 .cindex "SMTP" "logging syntax errors"
39437 .cindex "SMTP" "syntax errors; logging"
39438 .cindex "SMTP" "unknown command; logging"
39439 .cindex "log" "unknown SMTP command"
39440 .cindex "log" "SMTP syntax error"
39441 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39442 encountered. An unrecognized command is treated as a syntax error. For an
39443 external connection, the host identity is given; for an internal connection
39444 using &%-bs%& the sender identification (normally the calling user) is given.
39445 .next
39446 .cindex "log" "subject"
39447 .cindex "subject, logging"
39448 &%subject%&: The subject of the message is added to the arrival log line,
39449 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39450 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39451 specifies whether characters with values greater than 127 should be logged
39452 unchanged, or whether they should be rendered as escape sequences.
39453 .next
39454 .cindex "log" "certificate verification"
39455 .cindex log DANE
39456 .cindex DANE logging
39457 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39458 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39459 verified
39460 using a CA trust anchor,
39461 &`CV=dane`& if using a DNS trust anchor,
39462 and &`CV=no`& if not.
39463 .next
39464 .cindex "log" "TLS cipher"
39465 .cindex "TLS" "logging cipher"
39466 &%tls_cipher%&: When a message is sent or received over an encrypted
39467 connection, the cipher suite used is added to the log line, preceded by X=.
39468 .next
39469 .cindex "log" "TLS peer DN"
39470 .cindex "TLS" "logging peer DN"
39471 &%tls_peerdn%&: When a message is sent or received over an encrypted
39472 connection, and a certificate is supplied by the remote host, the peer DN is
39473 added to the log line, preceded by DN=.
39474 .next
39475 .cindex "log" "TLS resumption"
39476 .cindex "TLS" "logging session resumption"
39477 &%tls_resumption%&: When a message is sent or received over an encrypted
39478 connection and the TLS session resumed one used on a previous TCP connection,
39479 an asterisk is appended to the X= cipher field in the log line.
39480 .next
39481 .cindex "log" "TLS SNI"
39482 .cindex "TLS" "logging SNI"
39483 .cindex SNI logging
39484 &%tls_sni%&: When a message is received over an encrypted connection, and
39485 the remote host provided the Server Name Indication extension, the SNI is
39486 added to the log line, preceded by SNI=.
39487 .next
39488 .cindex "log" "DNS failure in list"
39489 &%unknown_in_list%&: This setting causes a log entry to be written when the
39490 result of a list match is failure because a DNS lookup failed.
39491 .endlist
39492
39493
39494 .section "Message log" "SECID260"
39495 .cindex "message" "log file for"
39496 .cindex "log" "message log; description of"
39497 .cindex "&_msglog_& directory"
39498 .oindex "&%preserve_message_logs%&"
39499 In addition to the general log files, Exim writes a log file for each message
39500 that it handles. The names of these per-message logs are the message ids, and
39501 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39502 message log contains copies of the log lines that apply to the message. This
39503 makes it easier to inspect the status of an individual message without having
39504 to search the main log. A message log is deleted when processing of the message
39505 is complete, unless &%preserve_message_logs%& is set, but this should be used
39506 only with great care because they can fill up your disk very quickly.
39507
39508 On a heavily loaded system, it may be desirable to disable the use of
39509 per-message logs, in order to reduce disk I/O. This can be done by setting the
39510 &%message_logs%& option false.
39511 .ecindex IIDloggen
39512
39513
39514
39515
39516 . ////////////////////////////////////////////////////////////////////////////
39517 . ////////////////////////////////////////////////////////////////////////////
39518
39519 .chapter "Exim utilities" "CHAPutils"
39520 .scindex IIDutils "utilities"
39521 A number of utility scripts and programs are supplied with Exim and are
39522 described in this chapter. There is also the Exim Monitor, which is covered in
39523 the next chapter. The utilities described here are:
39524
39525 .itable none 0 0 3  7* left  15* left  40* left
39526 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39527   "list what Exim processes are doing"
39528 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39529 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39530 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39531 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39532                                                 various criteria"
39533 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39534 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39535   "extract statistics from the log"
39536 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39537   "check address acceptance from given IP"
39538 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39539 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39540 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39541 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39542 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39543 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39544 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39545 .endtable
39546
39547 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39548 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39549 &url(https://duncanthrax.net/exilog/) for details.
39550
39551
39552
39553
39554 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39555 .cindex "&'exiwhat'&"
39556 .cindex "process, querying"
39557 .cindex "SIGUSR1"
39558 On operating systems that can restart a system call after receiving a signal
39559 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39560 a line describing what it is doing to the file &_exim-process.info_& in the
39561 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39562 processes it can find, having first emptied the file. It then waits for one
39563 second to allow the Exim processes to react before displaying the results. In
39564 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39565 send the signal to the Exim processes, so it is normally run as root.
39566
39567 &*Warning*&: This is not an efficient process. It is intended for occasional
39568 use by system administrators. It is not sensible, for example, to set up a
39569 script that sends SIGUSR1 signals to Exim processes at short intervals.
39570
39571
39572 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39573 varies in different operating systems. Not only are different options used,
39574 but the format of the output is different. For this reason, there are some
39575 system configuration options that configure exactly how &'exiwhat'& works. If
39576 it doesn't seem to be working for you, check the following compile-time
39577 options:
39578 .itable none 0 0 2 30* left 70* left
39579 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39580 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39581 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39582 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39583 .endtable
39584 An example of typical output from &'exiwhat'& is
39585 .code
39586 164 daemon: -q1h, listening on port 25
39587 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39588 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39589   [10.19.42.42] (editor@ref.example)
39590 10592 handling incoming call from [192.168.243.242]
39591 10628 accepting a local non-SMTP message
39592 .endd
39593 The first number in the output line is the process number. The third line has
39594 been split here, in order to fit it on the page.
39595
39596
39597
39598 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39599 .cindex "&'exiqgrep'&"
39600 .cindex "queue" "grepping"
39601 This utility is a Perl script contributed by Matt Hubbard. It runs
39602 .code
39603 exim -bpu
39604 .endd
39605 or (in case &*-a*& switch is specified)
39606 .code
39607 exim -bp
39608 .endd
39609 to obtain a queue listing, and then greps the output to select messages
39610 that match given criteria. The following selection options are available:
39611
39612 .vlist
39613 .vitem &*-f*&&~<&'regex'&>
39614 Match the sender address using a case-insensitive search. The field that is
39615 tested is enclosed in angle brackets, so you can test for bounce messages with
39616 .code
39617 exiqgrep -f '^<>$'
39618 .endd
39619 .vitem &*-r*&&~<&'regex'&>
39620 Match a recipient address using a case-insensitive search. The field that is
39621 tested is not enclosed in angle brackets.
39622
39623 .vitem &*-s*&&~<&'regex'&>
39624 Match against the size field.
39625
39626 .vitem &*-y*&&~<&'seconds'&>
39627 Match messages that are younger than the given time.
39628
39629 .vitem &*-o*&&~<&'seconds'&>
39630 Match messages that are older than the given time.
39631
39632 .vitem &*-z*&
39633 Match only frozen messages.
39634
39635 .vitem &*-x*&
39636 Match only non-frozen messages.
39637
39638 .vitem &*-G*&&~<&'queuename'&>
39639 Match only messages in the given queue.  Without this, the default queue is searched.
39640 .endlist
39641
39642 The following options control the format of the output:
39643
39644 .vlist
39645 .vitem &*-c*&
39646 Display only the count of matching messages.
39647
39648 .vitem &*-l*&
39649 Long format &-- display the full message information as output by Exim. This is
39650 the default.
39651
39652 .vitem &*-i*&
39653 Display message ids only.
39654
39655 .vitem &*-b*&
39656 Brief format &-- one line per message.
39657
39658 .vitem &*-R*&
39659 Display messages in reverse order.
39660
39661 .vitem &*-a*&
39662 Include delivered recipients in queue listing.
39663 .endlist
39664
39665 The following options give alternates for configuration:
39666
39667 .vlist
39668 .vitem &*-C*&&~<&'config&~file'&>
39669 is used to specify an alternate &_exim.conf_& which might
39670 contain alternate exim configuration the queue management might be using.
39671
39672 .vitem &*-E*&&~<&'path'&>
39673 can be used to specify a path for the exim binary,
39674 overriding the built-in one.
39675 .endlist
39676
39677 There is one more option, &%-h%&, which outputs a list of options.
39678 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39679
39680
39681
39682 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39683 .cindex "&'exiqsumm'&"
39684 .cindex "queue" "summary"
39685 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39686 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39687 running a command such as
39688 .code
39689 exim -bp | exiqsumm
39690 .endd
39691 The output consists of one line for each domain that has messages waiting for
39692 it, as in the following example:
39693 .code
39694 3   2322   74m   66m  msn.com.example
39695 .endd
39696 Each line lists the number of pending deliveries for a domain, their total
39697 volume, and the length of time that the oldest and the newest messages have
39698 been waiting. Note that the number of pending deliveries is greater than the
39699 number of messages when messages have more than one recipient.
39700
39701 A summary line is output at the end. By default the output is sorted on the
39702 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39703 the output to be sorted by oldest message and by count of messages,
39704 respectively. There are also three options that split the messages for each
39705 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39706 separates frozen messages, and &%-s%& separates messages according to their
39707 sender.
39708
39709 The output of &'exim -bp'& contains the original addresses in the message, so
39710 this also applies to the output from &'exiqsumm'&. No domains from addresses
39711 generated by aliasing or forwarding are included (unless the &%one_time%&
39712 option of the &(redirect)& router has been used to convert them into &"top
39713 level"& addresses).
39714
39715
39716
39717
39718 .section "Extracting specific information from the log (exigrep)" &&&
39719          "SECTextspeinf"
39720 .cindex "&'exigrep'&"
39721 .cindex "log" "extracts; grepping for"
39722 The &'exigrep'& utility is a Perl script that searches one or more main log
39723 files for entries that match a given pattern. When it finds a match, it
39724 extracts all the log entries for the relevant message, not just those that
39725 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39726 given message, or all mail for a given user, or for a given host, for example.
39727 The input files can be in Exim log format or syslog format.
39728 If a matching log line is not associated with a specific message, it is
39729 included in &'exigrep'&'s output without any additional lines. The usage is:
39730 .display
39731 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39732 .endd
39733 If no log filenames are given on the command line, the standard input is read.
39734
39735 The &%-t%& argument specifies a number of seconds. It adds an additional
39736 condition for message selection. Messages that are complete are shown only if
39737 they spent more than <&'n'&> seconds in the queue.
39738
39739 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39740 makes it case-sensitive. This may give a performance improvement when searching
39741 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39742 option; with &%-I%& they do not. In both cases it is possible to change the
39743 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39744
39745 The &%-l%& option means &"literal"&, that is, treat all characters in the
39746 pattern as standing for themselves. Otherwise the pattern must be a Perl
39747 regular expression.
39748
39749 The &%-v%& option inverts the matching condition. That is, a line is selected
39750 if it does &'not'& match the pattern.
39751
39752 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39753 that are generated as a result/response to a message that &'exigrep'& matched
39754 normally.
39755
39756 Example of &%-M%&:
39757 user_a sends a message to user_b, which generates a bounce back to user_b. If
39758 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39759 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39760 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39761 when searching for &"user_a"& will show both messages since the bounce is
39762 &"related"& to or a &"result"& of the first message that was found by the
39763 search term.
39764
39765 If the location of a &'zcat'& command is known from the definition of
39766 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39767 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39768 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39769 autodetection of some well known compression extensions.
39770
39771
39772 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39773 .cindex "&'exipick'&"
39774 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39775 lists messages from the queue according to a variety of criteria. For details
39776 of &'exipick'&'s facilities, run &'exipick'& with
39777 the &%--help%& option.
39778
39779
39780 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39781 .cindex "log" "cycling local files"
39782 .cindex "cycling logs"
39783 .cindex "&'exicyclog'&"
39784 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39785 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39786 you are using log files with datestamps in their names (see section
39787 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39788 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39789 There are two command line options for &'exicyclog'&:
39790 .ilist
39791 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39792 default that is set when Exim is built. The default default is 10.
39793 .next
39794 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39795 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39796 overriding the script's default, which is to find the setting from Exim's
39797 configuration.
39798 .endlist
39799
39800 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39801 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39802 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39803 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39804 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39805 logs are handled similarly.
39806
39807 If the limit is greater than 99, the script uses 3-digit numbers such as
39808 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39809 to one that is greater, or &'vice versa'&, you will have to fix the names of
39810 any existing log files.
39811
39812 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39813 the end are deleted. All files with numbers greater than 01 are compressed,
39814 using a compression command which is configured by the COMPRESS_COMMAND
39815 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39816 root &%crontab%& entry of the form
39817 .code
39818 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39819 .endd
39820 assuming you have used the name &"exim"& for the Exim user. You can run
39821 &'exicyclog'& as root if you wish, but there is no need.
39822
39823
39824
39825 .section "Mail statistics (eximstats)" "SECTmailstat"
39826 .cindex "statistics"
39827 .cindex "&'eximstats'&"
39828 A Perl script called &'eximstats'& is provided for extracting statistical
39829 information from log files. The output is either plain text, or HTML.
39830 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39831 . --- 404 error and everything else points to that.
39832
39833 The &'eximstats'& script has been hacked about quite a bit over time. The
39834 latest version is the result of some extensive revision by Steve Campbell. A
39835 lot of information is given by default, but there are options for suppressing
39836 various parts of it. Following any options, the arguments to the script are a
39837 list of files, which should be main log files. For example:
39838 .code
39839 eximstats -nr /var/spool/exim/log/mainlog.01
39840 .endd
39841 By default, &'eximstats'& extracts information about the number and volume of
39842 messages received from or delivered to various hosts. The information is sorted
39843 both by message count and by volume, and the top fifty hosts in each category
39844 are listed on the standard output. Similar information, based on email
39845 addresses or domains instead of hosts can be requested by means of various
39846 options. For messages delivered and received locally, similar statistics are
39847 also produced per user.
39848
39849 The output also includes total counts and statistics about delivery errors, and
39850 histograms showing the number of messages received and deliveries made in each
39851 hour of the day. A delivery with more than one address in its envelope (for
39852 example, an SMTP transaction with more than one RCPT command) is counted
39853 as a single delivery by &'eximstats'&.
39854
39855 Though normally more deliveries than receipts are reported (as messages may
39856 have multiple recipients), it is possible for &'eximstats'& to report more
39857 messages received than delivered, even though the queue is empty at the start
39858 and end of the period in question. If an incoming message contains no valid
39859 recipients, no deliveries are recorded for it. A bounce message is handled as
39860 an entirely separate message.
39861
39862 &'eximstats'& always outputs a grand total summary giving the volume and number
39863 of messages received and deliveries made, and the number of hosts involved in
39864 each case. It also outputs the number of messages that were delayed (that is,
39865 not completely delivered at the first attempt), and the number that had at
39866 least one address that failed.
39867
39868 The remainder of the output is in sections that can be independently disabled
39869 or modified by various options. It consists of a summary of deliveries by
39870 transport, histograms of messages received and delivered per time interval
39871 (default per hour), information about the time messages spent in the queue,
39872 a list of relayed messages, lists of the top fifty sending hosts, local
39873 senders, destination hosts, and destination local users by count and by volume,
39874 and a list of delivery errors that occurred.
39875
39876 The relay information lists messages that were actually relayed, that is, they
39877 came from a remote host and were directly delivered to some other remote host,
39878 without being processed (for example, for aliasing or forwarding) locally.
39879
39880 There are quite a few options for &'eximstats'& to control exactly what it
39881 outputs. These are documented in the Perl script itself, and can be extracted
39882 by running the command &(perldoc)& on the script. For example:
39883 .code
39884 perldoc /usr/exim/bin/eximstats
39885 .endd
39886
39887 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39888 .cindex "&'exim_checkaccess'&"
39889 .cindex "policy control" "checking access"
39890 .cindex "checking access"
39891 The &%-bh%& command line argument allows you to run a fake SMTP session with
39892 debugging output, in order to check what Exim is doing when it is applying
39893 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39894 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39895 sometimes you just want to answer the question &"Does this address have
39896 access?"& without bothering with any further details.
39897
39898 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39899 two arguments, an IP address and an email address:
39900 .code
39901 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39902 .endd
39903 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39904 given email address would be accepted in a RCPT command in a TCP/IP
39905 connection from the host with the given IP address. The output of the utility
39906 is either the word &"accepted"&, or the SMTP error response, for example:
39907 .code
39908 Rejected:
39909 550 Relay not permitted
39910 .endd
39911 When running this test, the utility uses &`<>`& as the envelope sender address
39912 for the MAIL command, but you can change this by providing additional
39913 options. These are passed directly to the Exim command. For example, to specify
39914 that the test is to be run with the sender address &'himself@there.example'&
39915 you can use:
39916 .code
39917 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39918                  -f himself@there.example
39919 .endd
39920 Note that these additional Exim command line items must be given after the two
39921 mandatory arguments.
39922
39923 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39924 while running its checks. You can run checks that include callouts by using
39925 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39926
39927
39928
39929 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39930 .cindex "DBM" "building dbm files"
39931 .cindex "building DBM files"
39932 .cindex "&'exim_dbmbuild'&"
39933 .cindex "lower casing"
39934 .cindex "binary zero" "in lookup key"
39935 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39936 the format used by the &(lsearch)& lookup (see section
39937 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39938 names as keys and the remainder of the information as data. The lower-casing
39939 can be prevented by calling the program with the &%-nolc%& option.
39940
39941 A terminating zero is included as part of the key string. This is expected by
39942 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39943 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39944 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39945 files.
39946
39947 The program requires two arguments: the name of the input file (which can be a
39948 single hyphen to indicate the standard input), and the name of the output file.
39949 It creates the output under a temporary name, and then renames it if all went
39950 well.
39951
39952 .cindex "USE_DB"
39953 If the native DB interface is in use (USE_DB is set in a compile-time
39954 configuration file &-- this is common in free versions of Unix) the two
39955 filenames must be different, because in this mode the Berkeley DB functions
39956 create a single output file using exactly the name given. For example,
39957 .code
39958 exim_dbmbuild /etc/aliases /etc/aliases.db
39959 .endd
39960 reads the system alias file and creates a DBM version of it in
39961 &_/etc/aliases.db_&.
39962
39963 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39964 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39965 environment, the suffixes are added to the second argument of
39966 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39967 when the Berkeley functions are used in compatibility mode (though this is not
39968 recommended), because in that case it adds a &_.db_& suffix to the filename.
39969
39970 If a duplicate key is encountered, the program outputs a warning, and when it
39971 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39972 option is used. By default, only the first of a set of duplicates is used &--
39973 this makes it compatible with &(lsearch)& lookups. There is an option
39974 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39975 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39976 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39977 return code is 2.
39978
39979
39980
39981
39982 .section "Finding individual retry times (exinext)" "SECTfinindret"
39983 .cindex "retry" "times"
39984 .cindex "&'exinext'&"
39985 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39986 fish specific information out of the retry database. Given a mail domain (or a
39987 complete address), it looks up the hosts for that domain, and outputs any retry
39988 information for the hosts or for the domain. At present, the retry information
39989 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39990 output. For example:
39991 .code
39992 $ exinext piglet@milne.fict.example
39993 kanga.milne.example:192.168.8.1 error 146: Connection refused
39994   first failed: 21-Feb-1996 14:57:34
39995   last tried:   21-Feb-1996 14:57:34
39996   next try at:  21-Feb-1996 15:02:34
39997 roo.milne.example:192.168.8.3 error 146: Connection refused
39998   first failed: 20-Jan-1996 13:12:08
39999   last tried:   21-Feb-1996 11:42:03
40000   next try at:  21-Feb-1996 19:42:03
40001   past final cutoff time
40002 .endd
40003 You can also give &'exinext'& a local part, without a domain, and it
40004 will give any retry information for that local part in your default domain.
40005 A message id can be used to obtain retry information pertaining to a specific
40006 message. This exists only when an attempt to deliver a message to a remote host
40007 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40008 &'exinext'& is not particularly efficient, but then it is not expected to be
40009 run very often.
40010
40011 The &'exinext'& utility calls Exim to find out information such as the location
40012 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40013 passed on to the &'exim'& commands. The first specifies an alternate Exim
40014 configuration file, and the second sets macros for use within the configuration
40015 file. These features are mainly to help in testing, but might also be useful in
40016 environments where more than one configuration file is in use.
40017
40018
40019
40020 .section "Hints database maintenance" "SECThindatmai"
40021 .cindex "hints database" "maintenance"
40022 .cindex "maintaining Exim's hints database"
40023 Three utility programs are provided for maintaining the DBM files that Exim
40024 uses to contain its delivery hint information. Each program requires two
40025 arguments. The first specifies the name of Exim's spool directory, and the
40026 second is the name of the database it is to operate on. These are as follows:
40027
40028 .ilist
40029 &'retry'&: the database of retry information
40030 .next
40031 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40032 for remote hosts
40033 .next
40034 &'callout'&: the callout cache
40035 .next
40036 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40037 .next
40038 &'tls'&: TLS session resumption data
40039 .next
40040 &'misc'&: other hints data
40041 .endlist
40042
40043 The &'misc'& database is used for
40044
40045 .ilist
40046 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40047 .next
40048 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40049 &(smtp)& transport)
40050 .next
40051 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40052 in a transport)
40053 .endlist
40054
40055
40056
40057 .section "exim_dumpdb" "SECTdumpdb"
40058 .cindex "&'exim_dumpdb'&"
40059 The entire contents of a database are written to the standard output by the
40060 &'exim_dumpdb'& program,
40061 taking as arguments the spool and database names.
40062 An option &'-z'& may be given to request times in UTC;
40063 otherwise times are in the local timezone.
40064 An option &'-k'& may be given to dump only the record keys.
40065 For example, to dump the retry database:
40066 .code
40067 exim_dumpdb /var/spool/exim retry
40068 .endd
40069 For the retry database
40070 two lines of output are produced for each entry:
40071 .code
40072 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40073 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40074 .endd
40075 The first item on the first line is the key of the record. It starts with one
40076 of the letters R, or T, depending on whether it refers to a routing or
40077 transport retry. For a local delivery, the next part is the local address; for
40078 a remote delivery it is the name of the remote host, followed by its failing IP
40079 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40080 transport). If the remote port is not the standard one (port 25), it is added
40081 to the IP address. Then there follows an error code, an additional error code,
40082 and a textual description of the error.
40083
40084 The three times on the second line are the time of first failure, the time of
40085 the last delivery attempt, and the computed time for the next attempt. The line
40086 ends with an asterisk if the cutoff time for the last retry rule has been
40087 exceeded.
40088
40089 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40090 consists of a host name followed by a list of ids for messages that are or were
40091 waiting to be delivered to that host. If there are a very large number for any
40092 one host, continuation records, with a sequence number added to the host name,
40093 may be seen. The data in these records is often out of date, because a message
40094 may be routed to several alternative hosts, and Exim makes no effort to keep
40095 cross-references.
40096
40097
40098
40099 .section "exim_tidydb" "SECTtidydb"
40100 .cindex "&'exim_tidydb'&"
40101 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40102 database. If run with no options, it removes all records that are more than 30
40103 days old. The age is calculated from the date and time that the record was last
40104 updated. Note that, in the case of the retry database, it is &'not'& the time
40105 since the first delivery failure. Information about a host that has been down
40106 for more than 30 days will remain in the database, provided that the record is
40107 updated sufficiently often.
40108
40109 The cutoff date can be altered by means of the &%-t%& option, which must be
40110 followed by a time. For example, to remove all records older than a week from
40111 the retry database:
40112 .code
40113 exim_tidydb -t 7d /var/spool/exim retry
40114 .endd
40115 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40116 message ids. In the former these appear as data in records keyed by host &--
40117 they were messages that were waiting for that host &-- and in the latter they
40118 are the keys for retry information for messages that have suffered certain
40119 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40120 message ids in database records are those of messages that are still on the
40121 queue. Message ids for messages that no longer exist are removed from
40122 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40123 For the &'retry'& database, records whose keys are non-existent message ids are
40124 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40125 whenever it removes information from the database.
40126
40127 Certain records are automatically removed by Exim when they are no longer
40128 needed, but others are not. For example, if all the MX hosts for a domain are
40129 down, a retry record is created for each one. If the primary MX host comes back
40130 first, its record is removed when Exim successfully delivers to it, but the
40131 records for the others remain because Exim has not tried to use those hosts.
40132
40133 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40134 hints databases. You should do this at a quiet time of day, because it requires
40135 a database to be locked (and therefore inaccessible to Exim) while it does its
40136 work. Removing records from a DBM file does not normally make the file smaller,
40137 but all the common DBM libraries are able to re-use the space that is released.
40138 After an initial phase of increasing in size, the databases normally reach a
40139 point at which they no longer get any bigger, as long as they are regularly
40140 tidied.
40141
40142 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40143 databases is likely to keep on increasing.
40144
40145
40146
40147
40148 .section "exim_fixdb" "SECTfixdb"
40149 .cindex "&'exim_fixdb'&"
40150 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40151 Its main use is for testing Exim, but it might also be occasionally useful for
40152 getting round problems in a live system. Its interface
40153 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40154 key of a database record can then be entered, and the data for that record is
40155 displayed.
40156
40157 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40158 except the &'retry'& database, that is the only operation that can be carried
40159 out. For the &'retry'& database, each field is output preceded by a number, and
40160 data for individual fields can be changed by typing the field number followed
40161 by new data, for example:
40162 .code
40163 > 4 951102:1000
40164 .endd
40165 resets the time of the next delivery attempt. Time values are given as a
40166 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40167 used as optional separators.
40168
40169 Both displayed and input times are in the local timezone by default.
40170 If an option &'-z'& is used on the command line, displayed times
40171 are in UTC.
40172
40173
40174
40175
40176 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40177 .cindex "mailbox" "maintenance"
40178 .cindex "&'exim_lock'&"
40179 .cindex "locking mailboxes"
40180 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40181 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40182 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40183 a user agent while investigating a problem. The utility requires the name of
40184 the file as its first argument. If the locking is successful, the second
40185 argument is run as a command (using C's &[system()]& function); if there is no
40186 second argument, the value of the SHELL environment variable is used; if this
40187 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40188 is unlocked and the utility ends. The following options are available:
40189
40190 .vlist
40191 .vitem &%-fcntl%&
40192 Use &[fcntl()]& locking on the open mailbox.
40193
40194 .vitem &%-flock%&
40195 Use &[flock()]& locking on the open mailbox, provided the operating system
40196 supports it.
40197
40198 .vitem &%-interval%&
40199 This must be followed by a number, which is a number of seconds; it sets the
40200 interval to sleep between retries (default 3).
40201
40202 .vitem &%-lockfile%&
40203 Create a lock file before opening the mailbox.
40204
40205 .vitem &%-mbx%&
40206 Lock the mailbox using MBX rules.
40207
40208 .vitem &%-q%&
40209 Suppress verification output.
40210
40211 .vitem &%-retries%&
40212 This must be followed by a number; it sets the number of times to try to get
40213 the lock (default 10).
40214
40215 .vitem &%-restore_time%&
40216 This option causes &%exim_lock%& to restore the modified and read times to the
40217 locked file before exiting. This allows you to access a locked mailbox (for
40218 example, to take a backup copy) without disturbing the times that the user
40219 subsequently sees.
40220
40221 .vitem &%-timeout%&
40222 This must be followed by a number, which is a number of seconds; it sets a
40223 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40224 default), a non-blocking call is used.
40225
40226 .vitem &%-v%&
40227 Generate verbose output.
40228 .endlist
40229
40230 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40231 default is to create a lock file and also to use &[fcntl()]& locking on the
40232 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40233 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40234 requires that the directory containing the file be writeable. Locking by lock
40235 file does not last forever; Exim assumes that a lock file is expired if it is
40236 more than 30 minutes old.
40237
40238 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40239 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40240 to be taken out on the open mailbox, and an exclusive lock on the file
40241 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40242 number of the mailbox file. When the locking is released, if an exclusive lock
40243 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40244
40245 The default output contains verification of the locking that takes place. The
40246 &%-v%& option causes some additional information to be given. The &%-q%& option
40247 suppresses all output except error messages.
40248
40249 A command such as
40250 .code
40251 exim_lock /var/spool/mail/spqr
40252 .endd
40253 runs an interactive shell while the file is locked, whereas
40254 .display
40255 &`exim_lock -q /var/spool/mail/spqr <<End`&
40256 <&'some commands'&>
40257 &`End`&
40258 .endd
40259 runs a specific non-interactive sequence of commands while the file is locked,
40260 suppressing all verification output. A single command can be run by a command
40261 such as
40262 .code
40263 exim_lock -q /var/spool/mail/spqr \
40264   "cp /var/spool/mail/spqr /some/where"
40265 .endd
40266 Note that if a command is supplied, it must be entirely contained within the
40267 second argument &-- hence the quotes.
40268
40269
40270 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40271 .cindex "exim_msgdate"
40272 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40273 This Perl script converts an Exim Mesage ID back into a human readable form.
40274 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40275
40276 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40277 .ecindex IIDutils
40278 . ////////////////////////////////////////////////////////////////////////////
40279 . ////////////////////////////////////////////////////////////////////////////
40280
40281 .chapter "The Exim monitor" "CHAPeximon"
40282 .scindex IIDeximon "Exim monitor" "description"
40283 .cindex "X-windows"
40284 .cindex "&'eximon'&"
40285 .cindex "Local/eximon.conf"
40286 .cindex "&_exim_monitor/EDITME_&"
40287 The Exim monitor is an application which displays in an X window information
40288 about the state of Exim's queue and what Exim is doing. An admin user can
40289 perform certain operations on messages from this GUI interface; however all
40290 such facilities are also available from the command line, and indeed, the
40291 monitor itself makes use of the command line to perform any actions requested.
40292
40293
40294
40295 .section "Running the monitor" "SECID264"
40296 The monitor is started by running the script called &'eximon'&. This is a shell
40297 script that sets up a number of environment variables, and then runs the
40298 binary called &_eximon.bin_&. The default appearance of the monitor window can
40299 be changed by editing the &_Local/eximon.conf_& file created by editing
40300 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40301 parameters are for.
40302
40303 The parameters that get built into the &'eximon'& script can be overridden for
40304 a particular invocation by setting up environment variables of the same names,
40305 preceded by &`EXIMON_`&. For example, a shell command such as
40306 .code
40307 EXIMON_LOG_DEPTH=400 eximon
40308 .endd
40309 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40310 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40311 overrides the Exim log file configuration. This makes it possible to have
40312 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40313 syslog messages are routed to a file on the local host.
40314
40315 X resources can be used to change the appearance of the window in the normal
40316 way. For example, a resource setting of the form
40317 .code
40318 Eximon*background: gray94
40319 .endd
40320 changes the colour of the background to light grey rather than white. The
40321 stripcharts are drawn with both the data lines and the reference lines in
40322 black. This means that the reference lines are not visible when on top of the
40323 data. However, their colour can be changed by setting a resource called
40324 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40325 For example, if your X server is running Unix, you could set up lighter
40326 reference lines in the stripcharts by obeying
40327 .code
40328 xrdb -merge <<End
40329 Eximon*highlight: gray
40330 End
40331 .endd
40332 .cindex "admin user"
40333 In order to see the contents of messages in the queue, and to operate on them,
40334 &'eximon'& must either be run as root or by an admin user.
40335
40336 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40337 contain X11 resource parameters interpreted by the X11 library.  In addition,
40338 if the first parameter starts with the string "gdb" then it is removed and the
40339 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40340 versioned variants of gdb can be invoked).
40341
40342 The monitor's window is divided into three parts. The first contains one or
40343 more stripcharts and two action buttons, the second contains a &"tail"& of the
40344 main log file, and the third is a display of the queue of messages awaiting
40345 delivery, with two more action buttons. The following sections describe these
40346 different parts of the display.
40347
40348
40349
40350
40351 .section "The stripcharts" "SECID265"
40352 .cindex "stripchart"
40353 The first stripchart is always a count of messages in the queue. Its name can
40354 be configured by setting QUEUE_STRIPCHART_NAME in the
40355 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40356 configuration script by regular expression matches on log file entries, making
40357 it possible to display, for example, counts of messages delivered to certain
40358 hosts or using certain transports. The supplied defaults display counts of
40359 received and delivered messages, and of local and SMTP deliveries. The default
40360 period between stripchart updates is one minute; this can be adjusted by a
40361 parameter in the &_Local/eximon.conf_& file.
40362
40363 The stripchart displays rescale themselves automatically as the value they are
40364 displaying changes. There are always 10 horizontal lines in each chart; the
40365 title string indicates the value of each division when it is greater than one.
40366 For example, &"x2"& means that each division represents a value of 2.
40367
40368 It is also possible to have a stripchart which shows the percentage fullness of
40369 a particular disk partition, which is useful when local deliveries are confined
40370 to a single partition.
40371
40372 .cindex "&%statvfs%& function"
40373 This relies on the availability of the &[statvfs()]& function or equivalent in
40374 the operating system. Most, but not all versions of Unix that support Exim have
40375 this. For this particular stripchart, the top of the chart always represents
40376 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40377 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40378 &_Local/eximon.conf_& file.
40379
40380
40381
40382
40383 .section "Main action buttons" "SECID266"
40384 .cindex "size" "of monitor window"
40385 .cindex "Exim monitor" "window size"
40386 .cindex "window size"
40387 Below the stripcharts there is an action button for quitting the monitor. Next
40388 to this is another button marked &"Size"&. They are placed here so that
40389 shrinking the window to its default minimum size leaves just the queue count
40390 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40391 the window to expand to its maximum size, unless it is already at the maximum,
40392 in which case it is reduced to its minimum.
40393
40394 When expanding to the maximum, if the window cannot be fully seen where it
40395 currently is, it is moved back to where it was the last time it was at full
40396 size. When it is expanding from its minimum size, the old position is
40397 remembered, and next time it is reduced to the minimum it is moved back there.
40398
40399 The idea is that you can keep a reduced window just showing one or two
40400 stripcharts at a convenient place on your screen, easily expand it to show
40401 the full window when required, and just as easily put it back to what it was.
40402 The idea is copied from what the &'twm'& window manager does for its
40403 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40404 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40405
40406 Normally, the monitor starts up with the window at its full size, but it can be
40407 built so that it starts up with the window at its smallest size, by setting
40408 START_SMALL=yes in &_Local/eximon.conf_&.
40409
40410
40411
40412 .section "The log display" "SECID267"
40413 .cindex "log" "tail of; in monitor"
40414 The second section of the window is an area in which a display of the tail of
40415 the main log is maintained.
40416 To save space on the screen, the timestamp on each log line is shortened by
40417 removing the date and, if &%log_timezone%& is set, the timezone.
40418 The log tail is not available when the only destination for logging data is
40419 syslog, unless the syslog lines are routed to a local file whose name is passed
40420 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40421
40422 The log sub-window has a scroll bar at its lefthand side which can be used to
40423 move back to look at earlier text, and the up and down arrow keys also have a
40424 scrolling effect. The amount of log that is kept depends on the setting of
40425 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40426 to use. When this is full, the earlier 50% of data is discarded &-- this is
40427 much more efficient than throwing it away line by line. The sub-window also has
40428 a horizontal scroll bar for accessing the ends of long log lines. This is the
40429 only means of horizontal scrolling; the right and left arrow keys are not
40430 available. Text can be cut from this part of the window using the mouse in the
40431 normal way. The size of this subwindow is controlled by parameters in the
40432 configuration file &_Local/eximon.conf_&.
40433
40434 Searches of the text in the log window can be carried out by means of the ^R
40435 and ^S keystrokes, which default to a reverse and a forward search,
40436 respectively. The search covers only the text that is displayed in the window.
40437 It cannot go further back up the log.
40438
40439 The point from which the search starts is indicated by a caret marker. This is
40440 normally at the end of the text in the window, but can be positioned explicitly
40441 by pointing and clicking with the left mouse button, and is moved automatically
40442 by a successful search. If new text arrives in the window when it is scrolled
40443 back, the caret remains where it is, but if the window is not scrolled back,
40444 the caret is moved to the end of the new text.
40445
40446 Pressing ^R or ^S pops up a window into which the search text can be typed.
40447 There are buttons for selecting forward or reverse searching, for carrying out
40448 the search, and for cancelling. If the &"Search"& button is pressed, the search
40449 happens and the window remains so that further searches can be done. If the
40450 &"Return"& key is pressed, a single search is done and the window is closed. If
40451 ^C is typed the search is cancelled.
40452
40453 The searching facility is implemented using the facilities of the Athena text
40454 widget. By default this pops up a window containing both &"search"& and
40455 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40456 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40457 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40458 provided version of &%TextPop%& when the remaining parts of the text widget
40459 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40460 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40461 on these systems, at the expense of having unwanted items in the search popup
40462 window.
40463
40464
40465
40466 .section "The queue display" "SECID268"
40467 .cindex "queue" "display in monitor"
40468 The bottom section of the monitor window contains a list of all messages that
40469 are in the queue, which includes those currently being received or delivered,
40470 as well as those awaiting delivery. The size of this subwindow is controlled by
40471 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40472 at which it is updated is controlled by another parameter in the same file &--
40473 the default is 5 minutes, since queue scans can be quite expensive. However,
40474 there is an &"Update"& action button just above the display which can be used
40475 to force an update of the queue display at any time.
40476
40477 When a host is down for some time, a lot of pending mail can build up for it,
40478 and this can make it hard to deal with other messages in the queue. To help
40479 with this situation there is a button next to &"Update"& called &"Hide"&. If
40480 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40481 type anything in here and press &"Return"&, the text is added to a chain of
40482 such texts, and if every undelivered address in a message matches at least one
40483 of the texts, the message is not displayed.
40484
40485 If there is an address that does not match any of the texts, all the addresses
40486 are displayed as normal. The matching happens on the ends of addresses so, for
40487 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40488 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40489 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40490 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40491 a hide request is automatically cancelled after one hour.
40492
40493 While the dialogue box is displayed, you can't press any buttons or do anything
40494 else to the monitor window. For this reason, if you want to cut text from the
40495 queue display to use in the dialogue box, you have to do the cutting before
40496 pressing the &"Hide"& button.
40497
40498 The queue display contains, for each unhidden queued message, the length of
40499 time it has been in the queue, the size of the message, the message id, the
40500 message sender, and the first undelivered recipient, all on one line. If it is
40501 a bounce message, the sender is shown as &"<>"&. If there is more than one
40502 recipient to which the message has not yet been delivered, subsequent ones are
40503 listed on additional lines, up to a maximum configured number, following which
40504 an ellipsis is displayed. Recipients that have already received the message are
40505 not shown.
40506
40507 .cindex "frozen messages" "display"
40508 If a message is frozen, an asterisk is displayed at the left-hand side.
40509
40510 The queue display has a vertical scroll bar, and can also be scrolled by means
40511 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40512 The text searching facilities, as described above for the log window, are also
40513 available, but the caret is always moved to the end of the text when the queue
40514 display is updated.
40515
40516
40517
40518 .section "The queue menu" "SECID269"
40519 .cindex "queue" "menu in monitor"
40520 If the &%shift%& key is held down and the left button is clicked when the mouse
40521 pointer is over the text for any message, an action menu pops up, and the first
40522 line of the queue display for the message is highlighted. This does not affect
40523 any selected text.
40524
40525 If you want to use some other event for popping up the menu, you can set the
40526 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40527 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40528 value set in this parameter is a standard X event description. For example, to
40529 run eximon using &%ctrl%& rather than &%shift%& you could use
40530 .code
40531 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40532 .endd
40533 The title of the menu is the message id, and it contains entries which act as
40534 follows:
40535
40536 .ilist
40537 &'message log'&: The contents of the message log for the message are displayed
40538 in a new text window.
40539 .next
40540 &'headers'&: Information from the spool file that contains the envelope
40541 information and headers is displayed in a new text window. See chapter
40542 &<<CHAPspool>>& for a description of the format of spool files.
40543 .next
40544 &'body'&: The contents of the spool file containing the body of the message are
40545 displayed in a new text window. There is a default limit of 20,000 bytes to the
40546 amount of data displayed. This can be changed by setting the BODY_MAX
40547 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40548 .next
40549 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40550 delivery of the message. This causes an automatic thaw if the message is
40551 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40552 a new text window. The delivery is run in a separate process, to avoid holding
40553 up the monitor while the delivery proceeds.
40554 .next
40555 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40556 that the message be frozen.
40557 .next
40558 .cindex "thawing messages"
40559 .cindex "unfreezing messages"
40560 .cindex "frozen messages" "thawing"
40561 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40562 that the message be thawed.
40563 .next
40564 .cindex "delivery" "forcing failure"
40565 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40566 that Exim gives up trying to deliver the message. A bounce message is generated
40567 for any remaining undelivered addresses.
40568 .next
40569 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40570 that the message be deleted from the system without generating a bounce
40571 message.
40572 .next
40573 &'add recipient'&: A dialog box is displayed into which a recipient address can
40574 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40575 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40576 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40577 causes a call to Exim to be made using the &%-Mar%& option to request that an
40578 additional recipient be added to the message, unless the entry box is empty, in
40579 which case no action is taken.
40580 .next
40581 &'mark delivered'&: A dialog box is displayed into which a recipient address
40582 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40583 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40584 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40585 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40586 recipient address as already delivered, unless the entry box is empty, in which
40587 case no action is taken.
40588 .next
40589 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40590 mark all recipient addresses as already delivered.
40591 .next
40592 &'edit sender'&: A dialog box is displayed initialized with the current
40593 sender's address. Pressing RETURN causes a call to Exim to be made using the
40594 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40595 in which case no action is taken. If you want to set an empty sender (as in
40596 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40597 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40598 the address is qualified with that domain.
40599 .endlist
40600
40601 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40602 other cases when a call to Exim is made, if there is any output from Exim (in
40603 particular, if the command fails) a window containing the command and the
40604 output is displayed. Otherwise, the results of the action are normally apparent
40605 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40606 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40607 if no output is generated.
40608
40609 The queue display is automatically updated for actions such as freezing and
40610 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40611 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40612 force an update of the display after one of these actions.
40613
40614 In any text window that is displayed as result of a menu action, the normal
40615 cut-and-paste facility is available, and searching can be carried out using ^R
40616 and ^S, as described above for the log tail window.
40617 .ecindex IIDeximon
40618
40619
40620
40621
40622
40623 . ////////////////////////////////////////////////////////////////////////////
40624 . ////////////////////////////////////////////////////////////////////////////
40625
40626 .chapter "Security considerations" "CHAPsecurity"
40627 .scindex IIDsecurcon "security" "discussion of"
40628 This chapter discusses a number of issues concerned with security, some of
40629 which are also covered in other parts of this manual.
40630
40631 For reasons that this author does not understand, some people have promoted
40632 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40633 existence of this chapter in the documentation. However, the intent of the
40634 chapter is simply to describe the way Exim works in relation to certain
40635 security concerns, not to make any specific claims about the effectiveness of
40636 its security as compared with other MTAs.
40637
40638 What follows is a description of the way Exim is supposed to be. Best efforts
40639 have been made to try to ensure that the code agrees with the theory, but an
40640 absence of bugs can never be guaranteed. Any that are reported will get fixed
40641 as soon as possible.
40642
40643
40644 .section "Building a more &""hardened""& Exim" "SECID286"
40645 .cindex "security" "build-time features"
40646 There are a number of build-time options that can be set in &_Local/Makefile_&
40647 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40648 Exim administrator who does not have the root password, or by someone who has
40649 penetrated the Exim (but not the root) account. These options are as follows:
40650
40651 .ilist
40652 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40653 start of any filenames used with the &%-C%& option. When it is set, these
40654 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40655 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40656 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40657 default setting for &%ALT_CONFIG_PREFIX%&.
40658
40659 If the permitted configuration files are confined to a directory to
40660 which only root has access, this guards against someone who has broken
40661 into the Exim account from running a privileged Exim with an arbitrary
40662 configuration file, and using it to break into other accounts.
40663 .next
40664
40665 If a non-trusted configuration file (i.e. not the default configuration file
40666 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40667 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40668 the next item), then root privilege is retained only if the caller of Exim is
40669 root. This locks out the possibility of testing a configuration using &%-C%&
40670 right through message reception and delivery, even if the caller is root. The
40671 reception works, but by that time, Exim is running as the Exim user, so when
40672 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40673 privilege to be lost. However, root can test reception and delivery using two
40674 separate commands.
40675
40676 .next
40677 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40678 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40679 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40680 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40681 the restrictive side.  Requiring build-time selection of safe macros is onerous
40682 but this option is intended solely as a transition mechanism to permit
40683 previously-working configurations to continue to work after release 4.73.
40684 .next
40685 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40686 is disabled.
40687 .next
40688 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40689 never to be used for any deliveries. This is like the &%never_users%& runtime
40690 option, but it cannot be overridden; the runtime option adds additional users
40691 to the list. The default setting is &"root"&; this prevents a non-root user who
40692 is permitted to modify the runtime file from using Exim as a way to get root.
40693 .endlist
40694
40695
40696
40697 .section "Root privilege" "SECID270"
40698 .cindex "setuid"
40699 .cindex "root privilege"
40700 The Exim binary is normally setuid to root, which means that it gains root
40701 privilege (runs as root) when it starts execution. In some special cases (for
40702 example, when the daemon is not in use and there are no local deliveries), it
40703 may be possible to run Exim setuid to some user other than root. This is
40704 discussed in the next section. However, in most installations, root privilege
40705 is required for two things:
40706
40707 .ilist
40708 To set up a socket connected to the standard SMTP port (25) when initialising
40709 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40710 not required.
40711 .next
40712 To be able to change uid and gid in order to read users' &_.forward_& files and
40713 perform local deliveries as the receiving user or as specified in the
40714 configuration.
40715 .endlist
40716
40717 It is not necessary to be root to do any of the other things Exim does, such as
40718 receiving messages and delivering them externally over SMTP, and it is
40719 obviously more secure if Exim does not run as root except when necessary.
40720 For this reason, a user and group for Exim to use must be defined in
40721 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40722 group"&. Their values can be changed by the runtime configuration, though this
40723 is not recommended. Often a user called &'exim'& is used, but some sites use
40724 &'mail'& or another user name altogether.
40725
40726 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40727 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40728 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40729
40730 After a new Exim process has interpreted its command line options, it changes
40731 uid and gid in the following cases:
40732
40733 .ilist
40734 .oindex "&%-C%&"
40735 .oindex "&%-D%&"
40736 If the &%-C%& option is used to specify an alternate configuration file, or if
40737 the &%-D%& option is used to define macro values for the configuration, and the
40738 calling process is not running as root, the uid and gid are changed to those of
40739 the calling process.
40740 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40741 option may not be used at all.
40742 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40743 can be supplied if the calling process is running as root, the Exim run-time
40744 user or CONFIGURE_OWNER, if defined.
40745 .next
40746 .oindex "&%-be%&"
40747 .oindex "&%-bf%&"
40748 .oindex "&%-bF%&"
40749 If the expansion test option (&%-be%&) or one of the filter testing options
40750 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40751 calling process.
40752 .next
40753 If the process is not a daemon process or a queue runner process or a delivery
40754 process or a process for testing address routing (started with &%-bt%&), the
40755 uid and gid are changed to the Exim user and group. This means that Exim always
40756 runs under its own uid and gid when receiving messages. This also applies when
40757 testing address verification
40758 .oindex "&%-bv%&"
40759 .oindex "&%-bh%&"
40760 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40761 option).
40762 .next
40763 For a daemon, queue runner, delivery, or address testing process, the uid
40764 remains as root at this stage, but the gid is changed to the Exim group.
40765 .endlist
40766
40767 The processes that initially retain root privilege behave as follows:
40768
40769 .ilist
40770 A daemon process changes the gid to the Exim group and the uid to the Exim
40771 user after setting up one or more listening sockets. The &[initgroups()]&
40772 function is called, so that if the Exim user is in any additional groups, they
40773 will be used during message reception.
40774 .next
40775 A queue runner process retains root privilege throughout its execution. Its
40776 job is to fork a controlled sequence of delivery processes.
40777 .next
40778 A delivery process retains root privilege throughout most of its execution,
40779 but any actual deliveries (that is, the transports themselves) are run in
40780 subprocesses which always change to a non-root uid and gid. For local
40781 deliveries this is typically the uid and gid of the owner of the mailbox; for
40782 remote deliveries, the Exim uid and gid are used. Once all the delivery
40783 subprocesses have been run, a delivery process changes to the Exim uid and gid
40784 while doing post-delivery tidying up such as updating the retry database and
40785 generating bounce and warning messages.
40786
40787 While the recipient addresses in a message are being routed, the delivery
40788 process runs as root. However, if a user's filter file has to be processed,
40789 this is done in a subprocess that runs under the individual user's uid and
40790 gid. A system filter is run as root unless &%system_filter_user%& is set.
40791 .next
40792 A process that is testing addresses (the &%-bt%& option) runs as root so that
40793 the routing is done in the same environment as a message delivery.
40794 .endlist
40795
40796
40797
40798
40799 .section "Running Exim without privilege" "SECTrunexiwitpri"
40800 .cindex "privilege, running without"
40801 .cindex "unprivileged running"
40802 .cindex "root privilege" "running without"
40803 Some installations like to run Exim in an unprivileged state for more of its
40804 operation, for added security. Support for this mode of operation is provided
40805 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40806 gid are changed to the Exim user and group at the start of a delivery process
40807 (and also queue runner and address testing processes). This means that address
40808 routing is no longer run as root, and the deliveries themselves cannot change
40809 to any other uid.
40810
40811 .cindex SIGHUP
40812 .cindex "daemon" "restarting"
40813 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40814 that the daemon can still be started in the usual way, and it can respond
40815 correctly to SIGHUP because the re-invocation regains root privilege.
40816
40817 An alternative approach is to make Exim setuid to the Exim user and also setgid
40818 to the Exim group. If you do this, the daemon must be started from a root
40819 process. (Calling Exim from a root process makes it behave in the way it does
40820 when it is setuid root.) However, the daemon cannot restart itself after a
40821 SIGHUP signal because it cannot regain privilege.
40822
40823 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40824 stops Exim from trying to re-invoke itself to do a delivery after a message has
40825 been received. Such a re-invocation is a waste of resources because it has no
40826 effect.
40827
40828 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40829 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40830 to the Exim user seems a clean approach, but there is one complication:
40831
40832 In this style of operation, Exim is running with the real uid and gid set to
40833 those of the calling process, and the effective uid/gid set to Exim's values.
40834 Ideally, any association with the calling process' uid/gid should be dropped,
40835 that is, the real uid/gid should be reset to the effective values so as to
40836 discard any privileges that the caller may have. While some operating systems
40837 have a function that permits this action for a non-root effective uid, quite a
40838 number of them do not. Because of this lack of standardization, Exim does not
40839 address this problem at this time.
40840
40841 For this reason, the recommended approach for &"mostly unprivileged"& running
40842 is to keep the Exim binary setuid to root, and to set
40843 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40844 be used in the most straightforward way.
40845
40846 If you configure Exim not to run delivery processes as root, there are a
40847 number of restrictions on what you can do:
40848
40849 .ilist
40850 You can deliver only as the Exim user/group. You should  explicitly use the
40851 &%user%& and &%group%& options to override routers or local transports that
40852 normally deliver as the recipient. This makes sure that configurations that
40853 work in this mode function the same way in normal mode. Any implicit or
40854 explicit specification of another user causes an error.
40855 .next
40856 Use of &_.forward_& files is severely restricted, such that it is usually
40857 not worthwhile to include them in the configuration.
40858 .next
40859 Users who wish to use &_.forward_& would have to make their home directory and
40860 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40861 and their equivalents in Exim filters, cannot be used. While they could be
40862 enabled in the Exim user's name, that would be insecure and not very useful.
40863 .next
40864 Unless the local user mailboxes are all owned by the Exim user (possible in
40865 some POP3 or IMAP-only environments):
40866
40867 .olist
40868 They must be owned by the Exim group and be writeable by that group. This
40869 implies you must set &%mode%& in the appendfile configuration, as well as the
40870 mode of the mailbox files themselves.
40871 .next
40872 You must set &%no_check_owner%&, since most or all of the files will not be
40873 owned by the Exim user.
40874 .next
40875 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40876 on a newly created mailbox when unprivileged. This also implies that new
40877 mailboxes need to be created manually.
40878 .endlist olist
40879 .endlist ilist
40880
40881
40882 These restrictions severely restrict what can be done in local deliveries.
40883 However, there are no restrictions on remote deliveries. If you are running a
40884 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40885 gives more security at essentially no cost.
40886
40887 If you are using the &%mua_wrapper%& facility (see chapter
40888 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40889
40890
40891
40892
40893 .section "Delivering to local files" "SECID271"
40894 Full details of the checks applied by &(appendfile)& before it writes to a file
40895 are given in chapter &<<CHAPappendfile>>&.
40896
40897
40898
40899 .section "Running local commands" "SECTsecconslocalcmds"
40900 .cindex "security" "local commands"
40901 .cindex "security" "command injection attacks"
40902 There are a number of ways in which an administrator can configure Exim to run
40903 commands based upon received, untrustworthy, data. Further, in some
40904 configurations a user who can control a &_.forward_& file can also arrange to
40905 run commands. Configuration to check includes, but is not limited to:
40906
40907 .ilist
40908 Use of &%use_shell%& in the pipe transport: various forms of shell command
40909 injection may be possible with this option present. It is dangerous and should
40910 be used only with considerable caution. Consider constraints which whitelist
40911 allowed characters in a variable which is to be used in a pipe transport that
40912 has &%use_shell%& enabled.
40913 .next
40914 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40915 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40916 &_.forward_& files in a redirect router. If Exim is running on a central mail
40917 hub to which ordinary users do not have shell access, but home directories are
40918 NFS mounted (for instance) then administrators should review the list of these
40919 forbid options available, and should bear in mind that the options that may
40920 need forbidding can change as new features are added between releases.
40921 .next
40922 The &%${run...}%& expansion item does not use a shell by default, but
40923 administrators can configure use of &_/bin/sh_& as part of the command.
40924 Such invocations should be viewed with prejudicial suspicion.
40925 .next
40926 Administrators who use embedded Perl are advised to explore how Perl's
40927 taint checking might apply to their usage.
40928 .next
40929 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40930 administrators are well advised to view its use with suspicion, in case (for
40931 instance) it allows a local-part to contain embedded Exim directives.
40932 .next
40933 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40934 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40935 each can reference arbitrary lists and files, rather than just being a list
40936 of opaque strings.
40937 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40938 real-world security vulnerabilities caused by its use with untrustworthy data
40939 injected in, for SQL injection attacks.
40940 Consider the use of the &%inlisti%& expansion condition instead.
40941 .endlist
40942
40943
40944
40945
40946 .section "Trust in configuration data" "SECTsecconfdata"
40947 .cindex "security" "data sources"
40948 .cindex "security" "regular expressions"
40949 .cindex "regular expressions" "security"
40950 .cindex "PCRE2" "security"
40951 If configuration data for Exim can come from untrustworthy sources, there
40952 are some issues to be aware of:
40953
40954 .ilist
40955 Use of &%${expand...}%& may provide a path for shell injection attacks.
40956 .next
40957 Letting untrusted data provide a regular expression is unwise.
40958 .next
40959 Using &%${match...}%& to apply a fixed regular expression against untrusted
40960 data may result in pathological behaviour within PCRE2.  Be aware of what
40961 "backtracking" means and consider options for being more strict with a regular
40962 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40963 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40964 possessive quantifiers or just not using regular expressions against untrusted
40965 data.
40966 .next
40967 It can be important to correctly use &%${quote:...}%&,
40968 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40969 items to ensure that data is correctly constructed.
40970 .next
40971 Some lookups might return multiple results, even though normal usage is only
40972 expected to yield one result.
40973 .endlist
40974
40975
40976
40977
40978 .section "IPv4 source routing" "SECID272"
40979 .cindex "source routing" "in IP packets"
40980 .cindex "IP source routing"
40981 Many operating systems suppress IP source-routed packets in the kernel, but
40982 some cannot be made to do this, so Exim does its own check. It logs incoming
40983 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40984 IPv6. No special checking is currently done.
40985
40986
40987
40988 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40989 Support for these SMTP commands is disabled by default. If required, they can
40990 be enabled by defining suitable ACLs.
40991
40992
40993
40994
40995 .section "Privileged users" "SECID274"
40996 .cindex "trusted users"
40997 .cindex "admin user"
40998 .cindex "privileged user"
40999 .cindex "user" "trusted"
41000 .cindex "user" "admin"
41001 Exim recognizes two sets of users with special privileges. Trusted users are
41002 able to submit new messages to Exim locally, but supply their own sender
41003 addresses and information about a sending host. For other users submitting
41004 local messages, Exim sets up the sender address from the uid, and doesn't
41005 permit a remote host to be specified.
41006
41007 .oindex "&%-f%&"
41008 However, an untrusted user is permitted to use the &%-f%& command line option
41009 in the special form &%-f <>%& to indicate that a delivery failure for the
41010 message should not cause an error report. This affects the message's envelope,
41011 but it does not affect the &'Sender:'& header. Untrusted users may also be
41012 permitted to use specific forms of address with the &%-f%& option by setting
41013 the &%untrusted_set_sender%& option.
41014
41015 Trusted users are used to run processes that receive mail messages from some
41016 other mail domain and pass them on to Exim for delivery either locally, or over
41017 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41018 as any user listed in the &%trusted_users%& configuration option, or under any
41019 group listed in the &%trusted_groups%& option.
41020
41021 Admin users are permitted to do things to the messages on Exim's queue. They
41022 can freeze or thaw messages, cause them to be returned to their senders, remove
41023 them entirely, or modify them in various ways. In addition, admin users can run
41024 the Exim monitor and see all the information it is capable of providing, which
41025 includes the contents of files on the spool.
41026
41027 .oindex "&%-M%&"
41028 .oindex "&%-q%&"
41029 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41030 delivery of messages on its queue is restricted to admin users. This
41031 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41032 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41033 queue is also restricted to admin users. This restriction can be relaxed by
41034 setting &%no_queue_list_requires_admin%&.
41035
41036 Exim recognizes an admin user if the calling process is running as root or as
41037 the Exim user or if any of the groups associated with the calling process is
41038 the Exim group. It is not necessary actually to be running under the Exim
41039 group. However, if admin users who are not root or the Exim user are to access
41040 the contents of files on the spool via the Exim monitor (which runs
41041 unprivileged), Exim must be built to allow group read access to its spool
41042 files.
41043
41044 By default, regular users are trusted to perform basic testing and
41045 introspection commands, as themselves.  This setting can be tightened by
41046 setting the &%commandline_checks_require_admin%& option.
41047 This affects most of the checking options,
41048 such as &%-be%& and anything else &%-b*%&.
41049
41050
41051 .section "Spool files" "SECID275"
41052 .cindex "spool directory" "files"
41053 Exim's spool directory and everything it contains is owned by the Exim user and
41054 set to the Exim group. The mode for spool files is defined in the
41055 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41056 any user who is a member of the Exim group can access these files.
41057
41058
41059
41060 .section "Use of argv[0]" "SECID276"
41061 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41062 of specific strings, Exim assumes certain options. For example, calling Exim
41063 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41064 to calling it with the option &%-bS%&. There are no security implications in
41065 this.
41066
41067
41068
41069 .section "Use of %f formatting" "SECID277"
41070 The only use made of &"%f"& by Exim is in formatting load average values. These
41071 are actually stored in integer variables as 1000 times the load average.
41072 Consequently, their range is limited and so therefore is the length of the
41073 converted output.
41074
41075
41076
41077 .section "Embedded Exim path" "SECID278"
41078 Exim uses its own path name, which is embedded in the code, only when it needs
41079 to re-exec in order to regain root privilege. Therefore, it is not root when it
41080 does so. If some bug allowed the path to get overwritten, it would lead to an
41081 arbitrary program's being run as exim, not as root.
41082
41083
41084
41085 .section "Dynamic module directory" "SECTdynmoddir"
41086 Any dynamically loadable modules must be installed into the directory
41087 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41088 loading it.
41089
41090
41091 .section "Use of sprintf()" "SECID279"
41092 .cindex "&[sprintf()]&"
41093 A large number of occurrences of &"sprintf"& in the code are actually calls to
41094 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41095 The intermediate formatting is done into a large fixed buffer by a function
41096 that runs through the format string itself, and checks the length of each
41097 conversion before performing it, thus preventing buffer overruns.
41098
41099 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41100 the output buffer is known to be sufficiently long to contain the converted
41101 string.
41102
41103
41104
41105 .section "Use of debug_printf() and log_write()" "SECID280"
41106 Arbitrary strings are passed to both these functions, but they do their
41107 formatting by calling the function &'string_vformat()'&, which runs through
41108 the format string itself, and checks the length of each conversion.
41109
41110
41111
41112 .section "Use of strcat() and strcpy()" "SECID281"
41113 These are used only in cases where the output buffer is known to be large
41114 enough to hold the result.
41115 .ecindex IIDsecurcon
41116
41117
41118
41119
41120 . ////////////////////////////////////////////////////////////////////////////
41121 . ////////////////////////////////////////////////////////////////////////////
41122
41123 .chapter "Format of spool files" "CHAPspool"
41124 .scindex IIDforspo1 "format" "spool files"
41125 .scindex IIDforspo2 "spool directory" "format of files"
41126 .scindex IIDforspo3 "spool files" "format of"
41127 .cindex "spool files" "editing"
41128 A message on Exim's queue consists of two files, whose names are the message id
41129 followed by -D and -H, respectively. The data portion of the message is kept in
41130 the -D file on its own. The message's envelope, status, and headers are all
41131 kept in the -H file, whose format is described in this chapter. Each of these
41132 two files contains the final component of its own name as its first line. This
41133 is insurance against disk crashes where the directory is lost but the files
41134 themselves are recoverable.
41135
41136 The file formats may be changed, or new formats added, at any release.
41137 Spool files are not intended as an interface to other programs
41138 and should not be used as such.
41139
41140 Some people are tempted into editing -D files in order to modify messages. You
41141 need to be extremely careful if you do this; it is not recommended and you are
41142 on your own if you do it. Here are some of the pitfalls:
41143
41144 .ilist
41145 You must ensure that Exim does not try to deliver the message while you are
41146 fiddling with it. The safest way is to take out a write lock on the -D file,
41147 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41148 place, the lock will be retained. If you write a new file and rename it, the
41149 lock will be lost at the instant of rename.
41150 .next
41151 .vindex "&$body_linecount$&"
41152 If you change the number of lines in the file, the value of
41153 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41154 cause incomplete transmission of messages or undeliverable messages.
41155 .next
41156 If the message is in MIME format, you must take care not to break it.
41157 .next
41158 If the message is cryptographically signed, any change will invalidate the
41159 signature.
41160 .endlist
41161 All in all, modifying -D files is fraught with danger.
41162
41163 Files whose names end with -J may also be seen in the &_input_& directory (or
41164 its subdirectories when &%split_spool_directory%& is set). These are journal
41165 files, used to record addresses to which the message has been delivered during
41166 the course of a delivery attempt. If there are still undelivered recipients at
41167 the end, the -H file is updated, and the -J file is deleted. If, however, there
41168 is some kind of crash (for example, a power outage) before this happens, the -J
41169 file remains in existence. When Exim next processes the message, it notices the
41170 -J file and uses it to update the -H file before starting the next delivery
41171 attempt.
41172
41173 Files whose names end with -K or .eml may also be seen in the spool.
41174 These are temporaries used for DKIM or malware processing, when that is used.
41175 They should be tidied up by normal operations; any old ones are probably
41176 relics of crashes and can be removed.
41177
41178 .section "Format of the -H file" "SECID282"
41179 .cindex "uid (user id)" "in spool file"
41180 .cindex "gid (group id)" "in spool file"
41181 The second line of the -H file contains the login name for the uid of the
41182 process that called Exim to read the message, followed by the numerical uid and
41183 gid. For a locally generated message, this is normally the user who sent the
41184 message. For a message received over TCP/IP via the daemon, it is
41185 normally the Exim user.
41186
41187 The third line of the file contains the address of the message's sender as
41188 transmitted in the envelope, contained in angle brackets. The sender address is
41189 empty for bounce messages. For incoming SMTP mail, the sender address is given
41190 in the MAIL command. For locally generated mail, the sender address is
41191 created by Exim from the login name of the current user and the configured
41192 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41193 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41194 &"<>"& or an address that matches &%untrusted_set_senders%&.
41195
41196 The fourth line contains two numbers. The first is the time that the message
41197 was received, in the conventional Unix form &-- the number of seconds since the
41198 start of the epoch. The second number is a count of the number of messages
41199 warning of delayed delivery that have been sent to the sender.
41200
41201 There follow a number of lines starting with a hyphen.
41202 These contain variables, can appear in any
41203 order, and are omitted when not relevant.
41204
41205 If there is a second hyphen after the first,
41206 the corresponding data is tainted.
41207 If there is a value in parentheses, the data is quoted for a lookup.
41208
41209 The following word specifies a variable,
41210 and the remainder of the item depends on the variable.
41211
41212 .vlist
41213 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41214 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41215 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41216 recognized, to provide backward compatibility. In the old format, a line of
41217 this form is present for every ACL variable that is not empty. The number
41218 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41219 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41220 the data string for the variable. The string itself starts at the beginning of
41221 the next line, and is followed by a newline character. It may contain internal
41222 newlines.
41223
41224 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41225 A line of this form is present for every ACL connection variable that is
41226 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41227 The length is the length of the data string for the variable. The string itself
41228 starts at the beginning of the next line, and is followed by a newline
41229 character. It may contain internal newlines.
41230
41231 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41232 A line of this form is present for every ACL message variable that is defined.
41233 Note that there is a space between &%-aclm%& and the rest of the name. The
41234 length is the length of the data string for the variable. The string itself
41235 starts at the beginning of the next line, and is followed by a newline
41236 character. It may contain internal newlines.
41237
41238 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41239 This is present if, when the message was received over SMTP, the value of
41240 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41241
41242 .vitem &%-allow_unqualified_recipient%&
41243 This is present if unqualified recipient addresses are permitted in header
41244 lines (to stop such addresses from being qualified if rewriting occurs at
41245 transport time). Local messages that were input using &%-bnq%& and remote
41246 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41247
41248 .vitem &%-allow_unqualified_sender%&
41249 This is present if unqualified sender addresses are permitted in header lines
41250 (to stop such addresses from being qualified if rewriting occurs at transport
41251 time). Local messages that were input using &%-bnq%& and remote messages from
41252 hosts that match &%sender_unqualified_hosts%& set this flag.
41253
41254 .vitem "&%-auth_id%&&~<&'text'&>"
41255 The id information for a message received on an authenticated SMTP connection
41256 &-- the value of the &$authenticated_id$& variable.
41257
41258 .vitem "&%-auth_sender%&&~<&'address'&>"
41259 The address of an authenticated sender &-- the value of the
41260 &$authenticated_sender$& variable.
41261
41262 .vitem "&%-body_linecount%&&~<&'number'&>"
41263 This records the number of lines in the body of the message, and is
41264 present unless &%-spool_file_wireformat%& is.
41265
41266 .vitem "&%-body_zerocount%&&~<&'number'&>"
41267 This records the number of binary zero bytes in the body of the message, and is
41268 present if the number is greater than zero.
41269
41270 .vitem &%-deliver_firsttime%&
41271 This is written when a new message is first added to the spool. When the spool
41272 file is updated after a deferral, it is omitted.
41273
41274 .vitem "&%-frozen%&&~<&'time'&>"
41275 .cindex "frozen messages" "spool data"
41276 The message is frozen, and the freezing happened at <&'time'&>.
41277
41278 .vitem "&%-helo_name%&&~<&'text'&>"
41279 This records the host name as specified by a remote host in a HELO or EHLO
41280 command.
41281
41282 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41283 This records the IP address of the host from which the message was received and
41284 the remote port number that was used. It is omitted for locally generated
41285 messages.
41286
41287 .vitem "&%-host_auth%&&~<&'text'&>"
41288 If the message was received on an authenticated SMTP connection, this records
41289 the name of the authenticator &-- the value of the
41290 &$sender_host_authenticated$& variable.
41291
41292 .vitem &%-host_lookup_failed%&
41293 This is present if an attempt to look up the sending host's name from its IP
41294 address failed. It corresponds to the &$host_lookup_failed$& variable.
41295
41296 .vitem "&%-host_name%&&~<&'text'&>"
41297 .cindex "reverse DNS lookup"
41298 .cindex "DNS" "reverse lookup"
41299 This records the name of the remote host from which the message was received,
41300 if the host name was looked up from the IP address when the message was being
41301 received. It is not present if no reverse lookup was done.
41302
41303 .vitem "&%-ident%&&~<&'text'&>"
41304 For locally submitted messages, this records the login of the originating user,
41305 unless it was a trusted user and the &%-oMt%& option was used to specify an
41306 ident value. For messages received over TCP/IP, this records the ident string
41307 supplied by the remote host, if any.
41308
41309 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41310 This records the IP address of the local interface and the port number through
41311 which a message was received from a remote host. It is omitted for locally
41312 generated messages.
41313
41314 .vitem &%-local%&
41315 The message is from a local sender.
41316
41317 .vitem &%-localerror%&
41318 The message is a locally-generated bounce message.
41319
41320 .vitem "&%-local_scan%&&~<&'string'&>"
41321 This records the data string that was returned by the &[local_scan()]& function
41322 when the message was received &-- the value of the &$local_scan_data$&
41323 variable. It is omitted if no data was returned.
41324
41325 .vitem &%-manual_thaw%&
41326 The message was frozen but has been thawed manually, that is, by an explicit
41327 Exim command rather than via the auto-thaw process.
41328
41329 .vitem &%-N%&
41330 A testing delivery process was started using the &%-N%& option to suppress any
41331 actual deliveries, but delivery was deferred. At any further delivery attempts,
41332 &%-N%& is assumed.
41333
41334 .vitem &%-received_protocol%&
41335 This records the value of the &$received_protocol$& variable, which contains
41336 the name of the protocol by which the message was received.
41337
41338 .vitem &%-sender_set_untrusted%&
41339 The envelope sender of this message was set by an untrusted local caller (used
41340 to ensure that the caller is displayed in queue listings).
41341
41342 .vitem "&%-spam_score_int%&&~<&'number'&>"
41343 If a message was scanned by SpamAssassin, this is present. It records the value
41344 of &$spam_score_int$&.
41345
41346 .vitem &%-spool_file_wireformat%&
41347 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41348 rather than Unix-format.
41349 The line-ending is CRLF rather than newline.
41350 There is still, however, no leading-dot-stuffing.
41351
41352 .vitem &%-tls_certificate_verified%&
41353 A TLS certificate was received from the client that sent this message, and the
41354 certificate was verified by the server.
41355
41356 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41357 When the message was received over an encrypted connection, this records the
41358 name of the cipher suite that was used.
41359
41360 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41361 When the message was received over an encrypted connection, and a certificate
41362 was received from the client, this records the Distinguished Name from that
41363 certificate.
41364 .endlist
41365
41366 Following the options there is a list of those addresses to which the message
41367 is not to be delivered. This set of addresses is initialized from the command
41368 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41369 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41370 the address is added to this set. The addresses are kept internally as a
41371 balanced binary tree, and it is a representation of that tree which is written
41372 to the spool file. If an address is expanded via an alias or forward file, the
41373 original address is added to the tree when deliveries to all its child
41374 addresses are complete.
41375
41376 If the tree is empty, there is a single line in the spool file containing just
41377 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41378 Y or N, followed by an address. The address is the value for the node of the
41379 tree, and the letters indicate whether the node has a left branch and/or a
41380 right branch attached to it, respectively. If branches exist, they immediately
41381 follow. Here is an example of a three-node tree:
41382 .code
41383 YY darcy@austen.fict.example
41384 NN alice@wonderland.fict.example
41385 NN editor@thesaurus.ref.example
41386 .endd
41387 After the non-recipients tree, there is a list of the message's recipients.
41388 This is a simple list, preceded by a count. It includes all the original
41389 recipients of the message, including those to whom the message has already been
41390 delivered. In the simplest case, the list contains one address per line. For
41391 example:
41392 .code
41393 4
41394 editor@thesaurus.ref.example
41395 darcy@austen.fict.example
41396 rdo@foundation
41397 alice@wonderland.fict.example
41398 .endd
41399 However, when a child address has been added to the top-level addresses as a
41400 result of the use of the &%one_time%& option on a &(redirect)& router, each
41401 line is of the following form:
41402 .display
41403 <&'top-level address'&> <&'errors_to address'&> &&&
41404   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41405 .endd
41406 The 01 flag bit indicates the presence of the three other fields that follow
41407 the top-level address. Other bits may be used in future to support additional
41408 fields. The <&'parent number'&> is the offset in the recipients list of the
41409 original parent of the &"one time"& address. The first two fields are the
41410 envelope sender that is associated with this address and its length. If the
41411 length is zero, there is no special envelope sender (there are then two space
41412 characters in the line). A non-empty field can arise from a &(redirect)& router
41413 that has an &%errors_to%& setting.
41414
41415
41416 A blank line separates the envelope and status information from the headers
41417 which follow. A header may occupy several lines of the file, and to save effort
41418 when reading it in, each header is preceded by a number and an identifying
41419 character. The number is the number of characters in the header, including any
41420 embedded newlines and the terminating newline. The character is one of the
41421 following:
41422
41423 .table2 50pt
41424 .row <&'blank'&>         "header in which Exim has no special interest"
41425 .row &`B`&               "&'Bcc:'& header"
41426 .row &`C`&               "&'Cc:'& header"
41427 .row &`F`&               "&'From:'& header"
41428 .row &`I`&               "&'Message-id:'& header"
41429 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41430 .row &`R`&               "&'Reply-To:'& header"
41431 .row &`S`&               "&'Sender:'& header"
41432 .row &`T`&               "&'To:'& header"
41433 .row &`*`&               "replaced or deleted header"
41434 .endtable
41435
41436 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41437 purposes. They are not transmitted when the message is delivered. Here is a
41438 typical set of headers:
41439 .code
41440 111P Received: by hobbit.fict.example with local (Exim 4.00)
41441 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41442 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41443 038* X-rewrote-sender: bb@hobbit.fict.example
41444 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41445 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41446 099* To: alice@wonderland.fict.example, rdo@foundation,
41447 darcy@austen.fict.example, editor@thesaurus.ref.example
41448 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41449 darcy@austen.fict.example, editor@thesaurus.ref.example
41450 038  Date: Fri, 11 May 2001 10:28:59 +0100
41451 .endd
41452 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41453 &'To:'& header have been rewritten, the last one because routing expanded the
41454 unqualified domain &'foundation'&.
41455 .ecindex IIDforspo1
41456 .ecindex IIDforspo2
41457 .ecindex IIDforspo3
41458
41459 .section "Format of the -D file" "SECID282a"
41460 The data file is traditionally in Unix-standard format: lines are ended with
41461 an ASCII newline character.
41462 However, when the &%spool_wireformat%& main option is used some -D files
41463 can have an alternate format.
41464 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41465 The -D file lines (not including the first name-component line) are
41466 suitable for direct copying to the wire when transmitting using the
41467 ESMTP CHUNKING option, meaning lower processing overhead.
41468 Lines are terminated with an ASCII CRLF pair.
41469 There is no dot-stuffing (and no dot-termination).
41470
41471 . ////////////////////////////////////////////////////////////////////////////
41472 . ////////////////////////////////////////////////////////////////////////////
41473
41474 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41475          "DKIM, SPF, SRS and DMARC Support"
41476
41477 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41478 .cindex "DKIM"
41479
41480 DKIM is a mechanism by which messages sent by some entity can be provably
41481 linked to a domain which that entity controls.  It permits reputation to
41482 be tracked on a per-domain basis, rather than merely upon source IP address.
41483 DKIM is documented in RFC 6376.
41484
41485 As DKIM relies on the message being unchanged in transit, messages handled
41486 by a mailing-list (which traditionally adds to the message) will not match
41487 any original DKIM signature.
41488
41489 DKIM support is compiled into Exim by default if TLS support is present.
41490 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41491
41492 Exim's DKIM implementation allows for
41493 .olist
41494 Signing outgoing messages: This function is implemented in the SMTP transport.
41495 It can co-exist with all other Exim features
41496 (including transport filters)
41497 except cutthrough delivery.
41498 .next
41499 Verifying signatures in incoming messages: This is implemented by an additional
41500 ACL (acl_smtp_dkim), which can be called several times per message, with
41501 different signature contexts.
41502 .endlist
41503
41504 In typical Exim style, the verification implementation does not include any
41505 default "policy". Instead it enables you to build your own policy using
41506 Exim's standard controls.
41507
41508 Please note that verification of DKIM signatures in incoming mail is turned
41509 on by default for logging (in the <= line) purposes.
41510
41511 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41512 When set, for each signature in incoming email,
41513 exim will log a line displaying the most important signature details, and the
41514 signature status. Here is an example (with line-breaks added for clarity):
41515 .code
41516 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41517     d=facebookmail.com s=q1-2009b
41518     c=relaxed/relaxed a=rsa-sha1
41519     i=@facebookmail.com t=1252484542 [verification succeeded]
41520 .endd
41521
41522 You might want to turn off DKIM verification processing entirely for internal
41523 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41524 control modifier. This should typically be done in the RCPT ACL, at points
41525 where you accept mail from relay sources (internal hosts or authenticated
41526 senders).
41527
41528
41529 .subsection "Signing outgoing messages" SECDKIMSIGN
41530 .cindex DKIM signing
41531
41532 For signing to be usable you must have published a DKIM record in DNS.
41533 Note that RFC 8301 (which does not cover EC keys) says:
41534 .code
41535 rsa-sha1 MUST NOT be used for signing or verifying.
41536
41537 Signers MUST use RSA keys of at least 1024 bits for all keys.
41538 Signers SHOULD use RSA keys of at least 2048 bits.
41539 .endd
41540
41541 Note also that the key content (the 'p=' field)
41542 in the DNS record is different between RSA and EC keys;
41543 for the former it is the base64 of the ASN.1 for the RSA public key
41544 (equivalent to the private-key .pem with the header/trailer stripped)
41545 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41546
41547 Signing is enabled by setting private options on the SMTP transport.
41548 These options take (expandable) strings as arguments.
41549
41550 .option dkim_domain smtp "string list&!!" unset
41551 The domain(s) you want to sign with.
41552 After expansion, this can be a list.
41553 Each element in turn,
41554 lowercased,
41555 .vindex "&$dkim_domain$&"
41556 is put into the &%$dkim_domain%& expansion variable
41557 while expanding the remaining signing options.
41558 If it is empty after expansion, DKIM signing is not done,
41559 and no error will result even if &%dkim_strict%& is set.
41560
41561 .option dkim_selector smtp "string list&!!" unset
41562 This sets the key selector string.
41563 After expansion, which can use &$dkim_domain$&, this can be a list.
41564 Each element in turn is put in the expansion
41565 .vindex "&$dkim_selector$&"
41566 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41567 option along with &%$dkim_domain%&.
41568 If the option is empty after expansion, DKIM signing is not done for this domain,
41569 and no error will result even if &%dkim_strict%& is set.
41570
41571 To do, for example, dual-signing with RSA and EC keys
41572 this could be be used:
41573 .code
41574 dkim_selector = ec_sel : rsa_sel
41575 dkim_private_key = KEYS_DIR/$dkim_selector
41576 .endd
41577
41578 .option dkim_private_key smtp string&!! unset
41579 This sets the private key to use.
41580 You can use the &%$dkim_domain%& and
41581 &%$dkim_selector%& expansion variables to determine the private key to use.
41582 The result can either
41583 .ilist
41584 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41585 .next
41586 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41587 be a valid Ed25519 private key (same format as above)
41588 .next
41589 start with a slash, in which case it is treated as a file that contains
41590 the private key
41591 .next
41592 be "0", "false" or the empty string, in which case the message will not
41593 be signed. This case will not result in an error, even if &%dkim_strict%&
41594 is set.
41595 .endlist
41596
41597 To generate keys under OpenSSL:
41598 .code
41599 openssl genrsa -out dkim_rsa.private 2048
41600 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41601 .endd
41602 The result file from the first command should be retained, and
41603 this option set to use it.
41604 Take the base-64 lines from the output of the second command, concatenated,
41605 for the DNS TXT record.
41606 See section 3.6 of RFC6376 for the record specification.
41607
41608 Under GnuTLS:
41609 .code
41610 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41611 certtool --load-privkey=dkim_rsa.private --pubkey-info
41612 .endd
41613
41614 Note that RFC 8301 says:
41615 .code
41616 Signers MUST use RSA keys of at least 1024 bits for all keys.
41617 Signers SHOULD use RSA keys of at least 2048 bits.
41618 .endd
41619
41620 EC keys for DKIM are defined by RFC 8463.
41621 They are considerably smaller than RSA keys for equivalent protection.
41622 As they are a recent development, users should consider dual-signing
41623 (by setting a list of selectors, and an expansion for this option)
41624 for some transition period.
41625 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41626 for EC keys.
41627
41628 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41629 .code
41630 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41631 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41632 .endd
41633
41634 To produce the required public key value for a DNS record:
41635 .code
41636 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41637 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41638 .endd
41639
41640 Exim also supports an alternate format
41641 of Ed25519 keys in DNS which was a candidate during development
41642 of the standard, but not adopted.
41643 A future release will probably drop that support.
41644
41645 .option dkim_hash smtp string&!! sha256
41646 Can be set to any one of the supported hash methods, which are:
41647 .ilist
41648 &`sha1`& &-- should not be used, is old and insecure
41649 .next
41650 &`sha256`& &-- the default
41651 .next
41652 &`sha512`& &-- possibly more secure but less well supported
41653 .endlist
41654
41655 Note that RFC 8301 says:
41656 .code
41657 rsa-sha1 MUST NOT be used for signing or verifying.
41658 .endd
41659
41660 .option dkim_identity smtp string&!! unset
41661 If set after expansion, the value is used to set an "i=" tag in
41662 the signing header.  The DKIM standards restrict the permissible
41663 syntax of this optional tag to a mail address, with possibly-empty
41664 local part, an @, and a domain identical to or subdomain of the "d="
41665 tag value.  Note that Exim does not check the value.
41666
41667 .option dkim_canon smtp string&!! unset
41668 This option sets the canonicalization method used when signing a message.
41669 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41670 The option defaults to "relaxed" when unset. Note: the current implementation
41671 only supports signing with the same canonicalization method for both headers and body.
41672
41673 .option dkim_strict smtp string&!! unset
41674 This  option  defines  how  Exim  behaves  when  signing a message that
41675 should be signed fails for some reason.  When the expansion evaluates to
41676 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41677 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41678 variables here.
41679
41680 .option dkim_sign_headers smtp string&!! "see below"
41681 If set, this option must expand to a colon-separated
41682 list of header names.
41683 Headers with these names, or the absence or such a header, will be included
41684 in the message signature.
41685 When unspecified, the header names listed in RFC4871 will be used,
41686 whether or not each header is present in the message.
41687 The default list is available for the expansion in the macro
41688 &"_DKIM_SIGN_HEADERS"&
41689 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41690
41691 If a name is repeated, multiple headers by that name (or the absence thereof)
41692 will be signed.  The textually later headers in the headers part of the
41693 message are signed first, if there are multiples.
41694
41695 A name can be prefixed with either an &"="& or a &"+"& character.
41696 If an &"="& prefix is used, all headers that are present with this name
41697 will be signed.
41698 If a &"+"& prefix if used, all headers that are present with this name
41699 will be signed, and one signature added for a missing header with the
41700 name will be appended.
41701
41702 .option dkim_timestamps smtp integer&!! unset
41703 This option controls the inclusion of timestamp information in the signature.
41704 If not set, no such information will be included.
41705 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41706 for the expiry tag
41707 (eg. 1209600 for two weeks);
41708 both creation (t=) and expiry (x=) tags will be included.
41709
41710 RFC 6376 lists these tags as RECOMMENDED.
41711
41712
41713 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41714 .cindex DKIM verification
41715
41716 Verification of DKIM signatures in SMTP incoming email is done for all
41717 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41718 .cindex DKIM "selecting signature algorithms"
41719 Individual classes of signature algorithm can be ignored by changing
41720 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41721 The &%dkim_verify_minimal%& option can be set to cease verification
41722 processing for a message once the first passing signature is found.
41723
41724 .cindex authentication "expansion item"
41725 Performing verification sets up information used by the
41726 &%authresults%& expansion item.
41727
41728 For most purposes the default option settings suffice and the remainder
41729 of this section can be ignored.
41730
41731 The results of verification are made available to the
41732 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41733 A missing ACL definition defaults to accept.
41734 By default, the ACL is called once for each
41735 syntactically(!) correct signature in the incoming message.
41736 If any ACL call does not accept, the message is not accepted.
41737 If a cutthrough delivery was in progress for the message, that is
41738 summarily dropped (having wasted the transmission effort).
41739
41740 To evaluate the verification result in the ACL
41741 a large number of expansion variables
41742 containing the signature status and its details are set up during the
41743 runtime of the ACL.
41744
41745 Calling the ACL only for existing signatures is not sufficient to build
41746 more advanced policies. For that reason, the main option
41747 &%dkim_verify_signers%&, and an expansion variable
41748 &%$dkim_signers%& exist.
41749
41750 The main option &%dkim_verify_signers%& can be set to a colon-separated
41751 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41752 called. It is expanded when the message has been received. At this point,
41753 the expansion variable &%$dkim_signers%& already contains a colon-separated
41754 list of signer domains and identities for the message. When
41755 &%dkim_verify_signers%& is not specified in the main configuration,
41756 it defaults as:
41757 .code
41758 dkim_verify_signers = $dkim_signers
41759 .endd
41760 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41761 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41762 call the ACL for known domains or identities. This would be achieved as follows:
41763 .code
41764 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41765 .endd
41766 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41767 and "ebay.com", plus all domains and identities that have signatures in the message.
41768 You can also be more creative in constructing your policy. For example:
41769 .code
41770 dkim_verify_signers = $sender_address_domain:$dkim_signers
41771 .endd
41772
41773 If a domain or identity is listed several times in the (expanded) value of
41774 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41775
41776 Note that if the option is set using untrustworthy data
41777 (such as the From: header)
41778 care should be taken to force lowercase for domains
41779 and for the domain part if identities.
41780 The default setting can be regarded as trustworthy in this respect.
41781
41782 If multiple signatures match a domain (or identity), the ACL is called once
41783 for each matching signature.
41784
41785
41786 Inside the DKIM ACL, the following expansion variables are
41787 available (from most to least important):
41788
41789
41790 .vlist
41791 .vitem &%$dkim_cur_signer%&
41792 The signer that is being evaluated in this ACL run. This can be a domain or
41793 an identity. This is one of the list items from the expanded main option
41794 &%dkim_verify_signers%& (see above).
41795
41796 .vitem &%$dkim_verify_status%&
41797 Within the DKIM ACL,
41798 a string describing the general status of the signature. One of
41799 .ilist
41800 &%none%&: There is no signature in the message for the current domain or
41801 identity (as reflected by &%$dkim_cur_signer%&).
41802 .next
41803 &%invalid%&: The signature could not be verified due to a processing error.
41804 More detail is available in &%$dkim_verify_reason%&.
41805 .next
41806 &%fail%&: Verification of the signature failed.  More detail is
41807 available in &%$dkim_verify_reason%&.
41808 .next
41809 &%pass%&: The signature passed verification. It is valid.
41810 .endlist
41811
41812 This variable can be overwritten using an ACL 'set' modifier.
41813 This might, for instance, be done to enforce a policy restriction on
41814 hash-method or key-size:
41815 .code
41816   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41817        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41818        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41819                                   {< {$dkim_key_length}{1024}}}}
41820        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41821        set dkim_verify_status = fail
41822        set dkim_verify_reason = hash too weak or key too short
41823 .endd
41824
41825 So long as a DKIM ACL is defined (it need do no more than accept),
41826 after all the DKIM ACL runs have completed, the value becomes a
41827 colon-separated list of the values after each run.
41828 This is maintained for the mime, prdr and data ACLs.
41829
41830 .vitem &%$dkim_verify_reason%&
41831 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41832 "fail" or "invalid". One of
41833 .ilist
41834 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41835 key for the domain could not be retrieved. This may be a temporary problem.
41836 .next
41837 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41838 record for the domain is syntactically invalid.
41839 .next
41840 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41841 body hash does not match the one specified in the signature header. This
41842 means that the message body was modified in transit.
41843 .next
41844 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41845 could not be verified. This may mean that headers were modified,
41846 re-written or otherwise changed in a way which is incompatible with
41847 DKIM verification. It may of course also mean that the signature is forged.
41848 .endlist
41849
41850 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41851
41852 .vitem &%$dkim_domain%&
41853 The signing domain. IMPORTANT: This variable is only populated if there is
41854 an actual signature in the message for the current domain or identity (as
41855 reflected by &%$dkim_cur_signer%&).
41856
41857 .vitem &%$dkim_identity%&
41858 The signing identity, if present. IMPORTANT: This variable is only populated
41859 if there is an actual signature in the message for the current domain or
41860 identity (as reflected by &%$dkim_cur_signer%&).
41861
41862 .vitem &%$dkim_selector%&
41863 The key record selector string.
41864
41865 .vitem &%$dkim_algo%&
41866 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41867 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41868 may also be 'ed25519-sha256'.
41869 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41870 for EC keys.
41871
41872 Note that RFC 8301 says:
41873 .code
41874 rsa-sha1 MUST NOT be used for signing or verifying.
41875
41876 DKIM signatures identified as having been signed with historic
41877 algorithms (currently, rsa-sha1) have permanently failed evaluation
41878 .endd
41879
41880 To enforce this you must either have a DKIM ACL which checks this variable
41881 and overwrites the &$dkim_verify_status$& variable as discussed above,
41882 or have set the main option &%dkim_verify_hashes%& to exclude
41883 processing of such signatures.
41884
41885 .vitem &%$dkim_canon_body%&
41886 The body canonicalization method. One of 'relaxed' or 'simple'.
41887
41888 .vitem &%$dkim_canon_headers%&
41889 The header canonicalization method. One of 'relaxed' or 'simple'.
41890
41891 .vitem &%$dkim_copiedheaders%&
41892 A transcript of headers and their values which are included in the signature
41893 (copied from the 'z=' tag of the signature).
41894 Note that RFC6376 requires that verification fail if the From: header is
41895 not included in the signature.  Exim does not enforce this; sites wishing
41896 strict enforcement should code the check explicitly.
41897
41898 .vitem &%$dkim_bodylength%&
41899 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41900 limit was set by the signer, "9999999999999" is returned. This makes sure
41901 that this variable always expands to an integer value.
41902 &*Note:*& The presence of the signature tag specifying a signing body length
41903 is one possible route to spoofing of valid DKIM signatures.
41904 A paranoid implementation might wish to regard signature where this variable
41905 shows less than the "no limit" return as being invalid.
41906
41907 .vitem &%$dkim_created%&
41908 UNIX timestamp reflecting the date and time when the signature was created.
41909 When this was not specified by the signer, "0" is returned.
41910
41911 .vitem &%$dkim_expires%&
41912 UNIX timestamp reflecting the date and time when the signer wants the
41913 signature to be treated as "expired". When this was not specified by the
41914 signer, "9999999999999" is returned. This makes it possible to do useful
41915 integer size comparisons against this value.
41916 Note that Exim does not check this value.
41917
41918 .vitem &%$dkim_headernames%&
41919 A colon-separated list of names of headers included in the signature.
41920
41921 .vitem &%$dkim_key_testing%&
41922 "1" if the key record has the "testing" flag set, "0" if not.
41923
41924 .vitem &%$dkim_key_nosubdomains%&
41925 "1" if the key record forbids subdomaining, "0" otherwise.
41926
41927 .vitem &%$dkim_key_srvtype%&
41928 Service type (tag s=) from the key record. Defaults to "*" if not specified
41929 in the key record.
41930
41931 .vitem &%$dkim_key_granularity%&
41932 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41933 in the key record.
41934
41935 .vitem &%$dkim_key_notes%&
41936 Notes from the key record (tag n=).
41937
41938 .vitem &%$dkim_key_length%&
41939 Number of bits in the key.
41940 Valid only once the key is loaded, which is at the time the header signature
41941 is verified, which is after the body hash is.
41942
41943 Note that RFC 8301 says:
41944 .code
41945 Verifiers MUST NOT consider signatures using RSA keys of
41946 less than 1024 bits as valid signatures.
41947 .endd
41948
41949 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41950 option.
41951
41952 .endlist
41953
41954 In addition, two ACL conditions are provided:
41955
41956 .vlist
41957 .vitem &%dkim_signers%&
41958 ACL condition that checks a colon-separated list of domains or identities
41959 for a match against the domain or identity that the ACL is currently verifying
41960 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41961 verb to a group of domains or identities. For example:
41962
41963 .code
41964 # Warn when Mail purportedly from GMail has no gmail signature
41965 warn sender_domains = gmail.com
41966      dkim_signers = gmail.com
41967      dkim_status = none
41968      log_message = GMail sender without gmail.com DKIM signature
41969 .endd
41970
41971 Note that the above does not check for a total lack of DKIM signing;
41972 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41973
41974 .vitem &%dkim_status%&
41975 ACL condition that checks a colon-separated list of possible DKIM verification
41976 results against the actual result of verification. This is typically used
41977 to restrict an ACL verb to a list of verification outcomes, for example:
41978
41979 .code
41980 deny sender_domains = paypal.com:paypal.de
41981      dkim_signers = paypal.com:paypal.de
41982      dkim_status = none:invalid:fail
41983      message = Mail from Paypal with invalid/missing signature
41984 .endd
41985
41986 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41987 see the documentation of the &%$dkim_verify_status%& expansion variable above
41988 for more information of what they mean.
41989 .endlist
41990
41991
41992
41993
41994 .section "SPF (Sender Policy Framework)" SECSPF
41995 .cindex SPF verification
41996
41997 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41998 messages with its domain in the envelope from, documented by RFC 7208.
41999 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42000 the &url(http://openspf.org).
42001 . --- 2019-10-28: still not https, open-spf.org is told to be a
42002 . --- web-archive copy of the now dead openspf.org site
42003 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42004 . --- discussion.
42005
42006 Messages sent by a system not authorised will fail checking of such assertions.
42007 This includes retransmissions done by traditional forwarders.
42008
42009 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42010 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42011 &url(https://www.libspf2.org/).
42012 There is no Exim involvement in the transmission of messages;
42013 publishing certain DNS records is all that is required.
42014
42015 For verification, an ACL condition and an expansion lookup are provided.
42016 .cindex authentication "expansion item"
42017 Performing verification sets up information used by the
42018 &%authresults%& expansion item.
42019
42020
42021 .cindex SPF "ACL condition"
42022 .cindex ACL "spf condition"
42023 The ACL condition "spf" can be used at or after the MAIL ACL.
42024 It takes as an argument a list of strings giving the outcome of the SPF check,
42025 and will succeed for any matching outcome.
42026 Valid strings are:
42027 .vlist
42028 .vitem &%pass%&
42029 The SPF check passed, the sending host is positively verified by SPF.
42030
42031 .vitem &%fail%&
42032 The SPF check failed, the sending host is NOT allowed to send mail for the
42033 domain in the envelope-from address.
42034
42035 .vitem &%softfail%&
42036 The SPF check failed, but the queried domain can't absolutely confirm that this
42037 is a forgery.
42038
42039 .vitem &%none%&
42040 The queried domain does not publish SPF records.
42041
42042 .vitem &%neutral%&
42043 The SPF check returned a "neutral" state.  This means the queried domain has
42044 published a SPF record, but wants to allow outside servers to send mail under
42045 its domain as well.  This should be treated like "none".
42046
42047 .vitem &%permerror%&
42048 This indicates a syntax error in the SPF record of the queried domain.
42049 You may deny messages when this occurs.
42050
42051 .vitem &%temperror%&
42052 This indicates a temporary error during all processing, including Exim's
42053 SPF processing.  You may defer messages when this occurs.
42054
42055 .vitem &%invalid%&
42056 There was an error during processing of the SPF lookup
42057 .endlist
42058
42059 You can prefix each string with an exclamation mark to  invert
42060 its meaning,  for example  "!fail" will  match all  results but
42061 "fail".  The  string  list is  evaluated  left-to-right,  in a
42062 short-circuit fashion.
42063
42064 Example:
42065 .code
42066 deny spf = fail
42067      message = $sender_host_address is not allowed to send mail from \
42068                ${if def:sender_address_domain \
42069                     {$sender_address_domain}{$sender_helo_name}}.  \
42070                Please see http://www.open-spf.org/Why;\
42071                identity=${if def:sender_address_domain \
42072                              {$sender_address}{$sender_helo_name}};\
42073                ip=$sender_host_address
42074 .endd
42075
42076 Note: The above mentioned URL may not be as helpful as expected. You are
42077 encouraged to replace the link with a link to a site with more
42078 explanations.
42079
42080 When the spf condition has run, it sets up several expansion
42081 variables:
42082
42083 .cindex SPF "verification variables"
42084 .vlist
42085 .vitem &$spf_header_comment$&
42086 .vindex &$spf_header_comment$&
42087   This contains a human-readable string describing the outcome
42088   of the SPF check. You can add it to a custom header or use
42089   it for logging purposes.
42090
42091 .vitem &$spf_received$&
42092 .vindex &$spf_received$&
42093   This contains a complete Received-SPF: header (name and
42094   content) that can be added to the message. Please note that
42095   according to the SPF draft, this header must be added at the
42096   top of the header list, i.e. with
42097 .code
42098 add_header = :at_start:$spf_received
42099 .endd
42100   See section &<<SECTaddheadacl>>& for further details.
42101
42102   Note: in case of "Best-guess" (see below), the convention is
42103   to put this string in a header called X-SPF-Guess: instead.
42104
42105 .vitem &$spf_result$&
42106 .vindex &$spf_result$&
42107   This contains the outcome of the SPF check in string form,
42108   currently one of pass, fail, softfail, none, neutral, permerror,
42109   temperror, or &"(invalid)"&.
42110
42111 .vitem &$spf_result_guessed$&
42112 .vindex &$spf_result_guessed$&
42113   This boolean is true only if a best-guess operation was used
42114   and required in order to obtain a result.
42115
42116 .vitem &$spf_smtp_comment$&
42117 .vindex &$spf_smtp_comment$&
42118 .vindex &%spf_smtp_comment_template%&
42119   This contains a string that can be used in a SMTP response
42120   to the calling party. Useful for "fail".
42121   The string is generated by the SPF library from the template configured in the main config
42122   option &%spf_smtp_comment_template%&.
42123 .endlist
42124
42125
42126 .cindex SPF "ACL condition"
42127 .cindex ACL "spf_guess condition"
42128 .cindex SPF "best guess"
42129 In addition to SPF, you can also perform checks for so-called
42130 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42131 SPF, but it is supported by the same framework that enables SPF
42132 capability.
42133 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42134 for a description of what it means.
42135 . --- 2019-10-28: still not https:
42136
42137 To access this feature, simply use the spf_guess condition in place
42138 of the spf one.  For example:
42139
42140 .code
42141 deny spf_guess = fail
42142      message = $sender_host_address doesn't look trustworthy to me
42143 .endd
42144
42145 In case you decide to reject messages based on this check, you
42146 should note that although it uses the same framework, "Best-guess"
42147 is not SPF, and therefore you should not mention SPF at all in your
42148 reject message.
42149
42150 When the spf_guess condition has run, it sets up the same expansion
42151 variables as when spf condition is run, described above.
42152
42153 Additionally, since Best-guess is not standardized, you may redefine
42154 what "Best-guess" means to you by redefining the main configuration
42155 &%spf_guess%& option.
42156 For example, the following:
42157
42158 .code
42159 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42160 .endd
42161
42162 would relax host matching rules to a broader network range.
42163
42164
42165 .cindex SPF "lookup expansion"
42166 .cindex lookup spf
42167 A lookup expansion is also available. It takes an email
42168 address as the key and an IP address
42169 (v4 or v6)
42170 as the database:
42171
42172 .code
42173   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42174 .endd
42175
42176 The lookup will return the same result strings as can appear in
42177 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42178
42179
42180
42181
42182
42183 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42184 .cindex SRS "sender rewriting scheme"
42185
42186 SRS can be used to modify sender addresses when forwarding so that
42187 SPF verification does not object to them.
42188 It operates by encoding the original envelope sender in a new
42189 sender local part and using a domain run by the forwarding site
42190 as the new domain for the sender.  Any DSN message should be returned
42191 to this new sender at the forwarding site, which can extract the
42192 original sender from the coded local part and forward the DSN to
42193 the originator.
42194
42195 This is a way of avoiding the breakage that SPF does to forwarding.
42196 The constructed local-part will be longer than the original,
42197 leading to possible problems with very long addresses.
42198 The changing of the sender address also hinders the tracing of mail
42199 problems.
42200
42201 Exim can be built to include native SRS support.  To do this
42202 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42203 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42204 will be defined.
42205 The support is limited to SRS0-encoding; SRS1 is not supported.
42206
42207 .cindex SRS excoding
42208 To encode an address use this expansion item:
42209 .vlist
42210 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42211 .cindex "&%srs_encode%& expansion item"
42212 .cindex SRS "expansion item"
42213 The first argument should be a secret known and used by all systems
42214 handling the recipient domain for the original message.
42215 There is no need to periodically change this key; a timestamp is also
42216 encoded.
42217 The second argument should be given as the envelope sender address before this
42218 encoding operation.
42219 If this value is empty the the expansion result will be empty.
42220 The third argument should be the recipient domain of the message when
42221 it arrived at this system.
42222 .endlist
42223
42224 .cindex SRS decoding
42225 To decode an address use this expansion condition:
42226 .vlist
42227 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42228 The first argument should be the recipient local prt as is was received.
42229 The second argument is the site secret.
42230
42231 If the messages is not for an SRS-encoded recipient the condition will
42232 return false.  If it is, the condition will return true and the variable
42233 &$srs_recipient$& will be set to the decoded (original) value.
42234 .endlist
42235
42236 Example usage:
42237 .code
42238   #macro
42239   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42240
42241   #routers
42242
42243   outbound:
42244     driver =    dnslookup
42245     # if outbound, and forwarding has been done, use an alternate transport
42246     domains =   ! +my_domains
42247     transport = ${if eq {$local_part@$domain} \
42248                         {$original_local_part@$original_domain} \
42249                      {remote_smtp} {remote_forwarded_smtp}}
42250
42251   inbound_srs:
42252     driver =    redirect
42253     senders =   :
42254     domains =   +my_domains
42255     # detect inbound bounces which are SRS'd, and decode them
42256     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42257     data =      $srs_recipient
42258
42259   inbound_srs_failure:
42260     driver =    redirect
42261     senders =   :
42262     domains =   +my_domains
42263     # detect inbound bounces which look SRS'd but are invalid
42264     condition = ${if inbound_srs {$local_part} {}}
42265     allow_fail
42266     data =      :fail: Invalid SRS recipient address
42267
42268   #... further routers here
42269
42270
42271   # transport; should look like the non-forward outbound
42272   # one, plus the max_rcpt and return_path options
42273   remote_forwarded_smtp:
42274     driver =              smtp
42275     # single-recipient so that $original_domain is valid
42276     max_rcpt =            1
42277     # modify the envelope from, for mails that we forward
42278     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42279 .endd
42280
42281
42282
42283
42284
42285 .section DMARC SECDMARC
42286 .cindex DMARC verification
42287
42288 DMARC combines feedback from SPF, DKIM, and header From: in order
42289 to attempt to provide better indicators of the authenticity of an
42290 email.  This document does not explain the fundamentals; you
42291 should read and understand how it works by visiting the website at
42292 &url(http://www.dmarc.org/).
42293
42294 If Exim is built with DMARC support,
42295 the libopendmarc library is used.
42296
42297 For building Exim yourself, obtain the library from
42298 &url(http://sourceforge.net/projects/opendmarc/)
42299 to obtain a copy, or find it in your favorite package
42300 repository.  You will need to attend to the local/Makefile feature
42301 SUPPORT_DMARC and the associated LDFLAGS addition.
42302 This description assumes
42303 that headers will be in /usr/local/include, and that the libraries
42304 are in /usr/local/lib.
42305
42306 .subsection Configuration SSECDMARCCONFIG
42307 .cindex DMARC configuration
42308
42309 There are three main-configuration options:
42310 .cindex DMARC "configuration options"
42311
42312 The &%dmarc_tld_file%& option
42313 .oindex &%dmarc_tld_file%&
42314 defines the location of a text file of valid
42315 top level domains the opendmarc library uses
42316 during domain parsing. Maintained by Mozilla,
42317 the most current version can be downloaded
42318 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42319 See also the util/renew-opendmarc-tlds.sh script.
42320 The default for the option is unset.
42321 If not set, DMARC processing is disabled.
42322
42323
42324 The &%dmarc_history_file%& option, if set
42325 .oindex &%dmarc_history_file%&
42326 defines the location of a file to log results
42327 of dmarc verification on inbound emails. The
42328 contents are importable by the opendmarc tools
42329 which will manage the data, send out DMARC
42330 reports, and expire the data. Make sure the
42331 directory of this file is writable by the user
42332 exim runs as.
42333 The default is unset.
42334
42335 The &%dmarc_forensic_sender%& option
42336 .oindex &%dmarc_forensic_sender%&
42337 defines an alternate email address to use when sending a
42338 forensic report detailing alignment failures
42339 if a sender domain's dmarc record specifies it
42340 and you have configured Exim to send them.
42341 If set, this is expanded and used for the
42342 From: header line; the address is extracted
42343 from it and used for the envelope from.
42344 If not set (the default), the From: header is expanded from
42345 the dsn_from option, and <> is used for the
42346 envelope from.
42347
42348 .subsection Controls SSECDMARCCONTROLS
42349 .cindex DMARC controls
42350
42351 By default, the DMARC processing will run for any remote,
42352 non-authenticated user.  It makes sense to only verify DMARC
42353 status of messages coming from remote, untrusted sources.  You can
42354 use standard conditions such as hosts, senders, etc, to decide that
42355 DMARC verification should *not* be performed for them and disable
42356 DMARC with an ACL control modifier:
42357 .code
42358   control = dmarc_disable_verify
42359 .endd
42360 A DMARC record can also specify a "forensic address", which gives
42361 exim an email address to submit reports about failed alignment.
42362 Exim does not do this by default because in certain conditions it
42363 results in unintended information leakage (what lists a user might
42364 be subscribed to, etc).  You must configure exim to submit forensic
42365 reports to the owner of the domain.  If the DMARC record contains a
42366 forensic address and you specify the control statement below, then
42367 exim will send these forensic emails.  It is also advised that you
42368 configure a &%dmarc_forensic_sender%& because the default sender address
42369 construction might be inadequate.
42370 .code
42371   control = dmarc_enable_forensic
42372 .endd
42373 (AGAIN: You can choose not to send these forensic reports by simply
42374 not putting the dmarc_enable_forensic control line at any point in
42375 your exim config.  If you don't tell exim to send them, it will not
42376 send them.)
42377
42378 There are no options to either control.  Both must appear before
42379 the DATA acl.
42380
42381 .subsection ACL SSECDMARCACL
42382 .cindex DMARC "ACL condition"
42383
42384 DMARC checks can be run on incoming SMTP  messages by using the
42385 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42386 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42387 condition.  Putting this condition in the ACLs is required in order
42388 for a DMARC check to actually occur.  All of the variables are set
42389 up before the DATA ACL, but there is no actual DMARC check that
42390 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42391
42392 The &"dmarc_status"& condition takes a list of strings on its
42393 right-hand side.  These strings describe recommended action based
42394 on the DMARC check.  To understand what the policy recommendations
42395 mean, refer to the DMARC website above.  Valid strings are:
42396 .itable none 0 0 2 20* left 80* left
42397 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42398 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42399 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42400 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42401 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42402 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42403 .irow &'temperror'&     "Library error or dns error"
42404 .irow &'off'&           "The DMARC check was disabled for this email"
42405 .endtable
42406 You can prefix each string with an exclamation mark to invert its
42407 meaning, for example "!accept" will match all results but
42408 "accept".  The string list is evaluated left-to-right in a
42409 short-circuit fashion.  When a string matches the outcome of the
42410 DMARC check, the condition succeeds.  If none of the listed
42411 strings matches the outcome of the DMARC check, the condition
42412 fails.
42413
42414 Of course, you can also use any other lookup method that Exim
42415 supports, including LDAP, Postgres, MySQL, etc, as long as the
42416 result is a list of colon-separated strings.
42417
42418 Performing the check sets up information used by the
42419 &%authresults%& expansion item.
42420
42421 Several expansion variables are set before the DATA ACL is
42422 processed, and you can use them in this ACL.  The following
42423 expansion variables are available:
42424
42425 .vlist
42426 .vitem &$dmarc_status$&
42427 .vindex &$dmarc_status$&
42428 .cindex DMARC result
42429 A one word status indicating what the DMARC library
42430 thinks of the email.  It is a combination of the results of
42431 DMARC record lookup and the SPF/DKIM/DMARC processing results
42432 (if a DMARC record was found).  The actual policy declared
42433 in the DMARC record is in a separate expansion variable.
42434
42435 .vitem &$dmarc_status_text$&
42436 .vindex &$dmarc_status_text$&
42437 Slightly longer, human readable status.
42438
42439 .vitem &$dmarc_used_domain$&
42440 .vindex &$dmarc_used_domain$&
42441 The domain which DMARC used to look up the DMARC policy record.
42442
42443 .vitem &$dmarc_domain_policy$&
42444 .vindex &$dmarc_domain_policy$&
42445 The policy declared in the DMARC record.  Valid values
42446 are "none", "reject" and "quarantine".  It is blank when there
42447 is any error, including no DMARC record.
42448 .endlist
42449
42450 .subsection Logging SSECDMARCLOGGING
42451 .cindex DMARC logging
42452
42453 By default, Exim's DMARC configuration is intended to be
42454 non-intrusive and conservative.  To facilitate this, Exim will not
42455 create any type of logging files without explicit configuration by
42456 you, the admin.  Nor will Exim send out any emails/reports about
42457 DMARC issues without explicit configuration by you, the admin (other
42458 than typical bounce messages that may come about due to ACL
42459 processing or failure delivery issues).
42460
42461 In order to log statistics suitable to be imported by the opendmarc
42462 tools, you need to:
42463 .ilist
42464 Configure the global option &%dmarc_history_file%&
42465 .next
42466 Configure cron jobs to call the appropriate opendmarc history
42467 import scripts and truncating the dmarc_history_file
42468 .endlist
42469
42470 In order to send forensic reports, you need to:
42471 .ilist
42472 Configure the global option &%dmarc_forensic_sender%&
42473 .next
42474 Configure, somewhere before the DATA ACL, the control option to
42475 enable sending DMARC forensic reports
42476 .endlist
42477
42478 .subsection Example SSECDMARCEXAMPLE
42479 .cindex DMARC example
42480
42481 Example usage:
42482 .code
42483 (RCPT ACL)
42484   warn    domains        = +local_domains
42485           hosts          = +local_hosts
42486           control        = dmarc_disable_verify
42487
42488   warn    !domains       = +screwed_up_dmarc_records
42489           control        = dmarc_enable_forensic
42490
42491   warn    condition      = (lookup if destined to mailing list)
42492           set acl_m_mailing_list = 1
42493
42494 (DATA ACL)
42495   warn    dmarc_status   = accept : none : off
42496           !authenticated = *
42497           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42498
42499   warn    dmarc_status   = !accept
42500           !authenticated = *
42501           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42502
42503   warn    dmarc_status   = quarantine
42504           !authenticated = *
42505           set $acl_m_quarantine = 1
42506           # Do something in a transport with this flag variable
42507
42508   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42509           condition      = ${if eq{$acl_m_mailing_list}{1}}
42510           message        = Messages from $dmarc_used_domain break mailing lists
42511
42512   deny    dmarc_status   = reject
42513           !authenticated = *
42514           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42515
42516   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42517 .endd
42518
42519
42520
42521
42522
42523 . ////////////////////////////////////////////////////////////////////////////
42524 . ////////////////////////////////////////////////////////////////////////////
42525
42526 .chapter "Proxies" "CHAPproxies" &&&
42527          "Proxy support"
42528 .cindex "proxy support"
42529 .cindex "proxy" "access via"
42530
42531 A proxy is an intermediate system through which communication is passed.
42532 Proxies may provide a security, availability or load-distribution function.
42533
42534
42535 .section "Inbound proxies" SECTproxyInbound
42536 .cindex proxy inbound
42537 .cindex proxy "server side"
42538 .cindex proxy "Proxy protocol"
42539 .cindex "Proxy protocol" proxy
42540
42541 Exim has support for receiving inbound SMTP connections via a proxy
42542 that uses &"Proxy Protocol"& to speak to it.
42543 To include this support, include &"SUPPORT_PROXY=yes"&
42544 in Local/Makefile.
42545
42546 It was built on the HAProxy specification, found at
42547 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42548
42549 The purpose of this facility is so that an application load balancer,
42550 such as HAProxy, can sit in front of several Exim servers
42551 to distribute load.
42552 Exim uses the local protocol communication with the proxy to obtain
42553 the remote SMTP system IP address and port information.
42554 There is no logging if a host passes or
42555 fails Proxy Protocol negotiation, but it can easily be determined and
42556 recorded in an ACL (example is below).
42557
42558 Use of a proxy is enabled by setting the &%hosts_proxy%&
42559 main configuration option to a hostlist; connections from these
42560 hosts will use Proxy Protocol.
42561 Exim supports both version 1 and version 2 of the Proxy Protocol and
42562 automatically determines which version is in use.
42563
42564 The Proxy Protocol header is the first data received on a TCP connection
42565 and is inserted before any TLS-on-connect handshake from the client; Exim
42566 negotiates TLS between Exim-as-server and the remote client, not between
42567 Exim and the proxy server. The Proxy Protocol header must be received
42568 within &%proxy_protocol_timeout%&, which defaults to 3s.
42569
42570 The following expansion variables are usable
42571 (&"internal"& and &"external"& here refer to the interfaces
42572 of the proxy):
42573 .itable none 0 0 2 30* left 70* left
42574 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42575 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42576 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42577 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42578 .irow $proxy_session            "boolean: SMTP connection via proxy"
42579 .endtable
42580 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42581 there was a protocol error.
42582 The variables &$sender_host_address$& and &$sender_host_port$&
42583 will have values for the actual client system, not the proxy.
42584
42585 Since the real connections are all coming from the proxy, and the
42586 per host connection tracking is done before Proxy Protocol is
42587 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42588 handle all of the parallel volume you expect per inbound proxy.
42589 With the option set so high, you lose the ability
42590 to protect your server from many connections from one IP.
42591 In order to prevent your server from overload, you
42592 need to add a per connection ratelimit to your connect ACL.
42593 A possible solution is:
42594 .display
42595   # Set max number of connections per host
42596   LIMIT   = 5
42597   # Or do some kind of IP lookup in a flat file or database
42598   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42599
42600   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42601           message        = Too many connections from this IP right now
42602 .endd
42603
42604
42605
42606 .section "Outbound proxies" SECTproxySOCKS
42607 .cindex proxy outbound
42608 .cindex proxy "client side"
42609 .cindex proxy SOCKS
42610 .cindex SOCKS proxy
42611 Exim has support for sending outbound SMTP via a proxy
42612 using a protocol called SOCKS5 (defined by RFC1928).
42613 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42614 Local/Makefile.
42615
42616 Use of a proxy is enabled by setting the &%socks_proxy%& option
42617 on an smtp transport.
42618 The option value is expanded and should then be a list
42619 (colon-separated by default) of proxy specifiers.
42620 Each proxy specifier is a list
42621 (space-separated by default) where the initial element
42622 is an IP address and any subsequent elements are options.
42623
42624 Options are a string <name>=<value>.
42625 The list of options is in the following table:
42626 .itable none 0 0 2 10* left 90* left
42627 .irow &'auth'&  "authentication method"
42628 .irow &'name'&  "authentication username"
42629 .irow &'pass'&  "authentication password"
42630 .irow &'port'&  "tcp port"
42631 .irow &'tmo'&   "connection timeout"
42632 .irow &'pri'&   "priority"
42633 .irow &'weight'& "selection bias"
42634 .endtable
42635
42636 More details on each of these options follows:
42637
42638 .ilist
42639 .cindex authentication "to proxy"
42640 .cindex proxy authentication
42641 &%auth%&: Either &"none"& (default) or &"name"&.
42642 Using &"name"& selects username/password authentication per RFC 1929
42643 for access to the proxy.
42644 Default is &"none"&.
42645 .next
42646 &%name%&: sets the username for the &"name"& authentication method.
42647 Default is empty.
42648 .next
42649 &%pass%&: sets the password for the &"name"& authentication method.
42650 Default is empty.
42651 .next
42652 &%port%&: the TCP port number to use for the connection to the proxy.
42653 Default is 1080.
42654 .next
42655 &%tmo%&: sets a connection timeout in seconds for this proxy.
42656 Default is 5.
42657 .next
42658 &%pri%&: specifies a priority for the proxy within the list,
42659 higher values being tried first.
42660 The default priority is 1.
42661 .next
42662 &%weight%&: specifies a selection bias.
42663 Within a priority set servers are queried in a random fashion,
42664 weighted by this value.
42665 The default value for selection bias is 1.
42666 .endlist
42667
42668 Proxies from the list are tried according to their priority
42669 and weight settings until one responds.  The timeout for the
42670 overall connection applies to the set of proxied attempts.
42671
42672 .section Logging SECTproxyLog
42673 To log the (local) IP of a proxy in the incoming or delivery logline,
42674 add &"+proxy"& to the &%log_selector%& option.
42675 This will add a component tagged with &"PRX="& to the line.
42676
42677 . ////////////////////////////////////////////////////////////////////////////
42678 . ////////////////////////////////////////////////////////////////////////////
42679
42680 .chapter "Internationalisation" "CHAPi18n" &&&
42681          "Internationalisation""
42682 .cindex internationalisation "email address"
42683 .cindex EAI
42684 .cindex i18n
42685 .cindex utf8 "mail name handling"
42686
42687 Exim has support for Internationalised mail names.
42688 To include this it must be built with SUPPORT_I18N and the libidn library.
42689 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42690
42691 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42692 instead of it) then IDNA2008 is supported; this adds an extra library
42693 requirement, upon libidn2.
42694
42695 .section "MTA operations" SECTi18nMTA
42696 .cindex SMTPUTF8 "ESMTP option"
42697 .cindex "ESMTP extensions" SMTPUTF8
42698 The main configuration option &%smtputf8_advertise_hosts%& specifies
42699 a host list.  If this matches the sending host and
42700 accept_8bitmime is true (the default) then the ESMTP option
42701 SMTPUTF8 will be advertised.
42702
42703 If the sender specifies the SMTPUTF8 option on a MAIL command
42704 international handling for the message is enabled and
42705 the expansion variable &$message_smtputf8$& will have value TRUE.
42706
42707 The option &%allow_utf8_domains%& is set to true for this
42708 message. All DNS lookups are converted to a-label form
42709 whatever the setting of &%allow_utf8_domains%&
42710 when Exim is built with SUPPORT_I18N.
42711
42712 Both localparts and domain are maintained as the original
42713 UTF-8 form internally; any comparison or regular-expression use will
42714 require appropriate care.  Filenames created, eg. by
42715 the appendfile transport, will have UTF-8 names.
42716
42717 HELO names sent by the smtp transport will have any UTF-8
42718 components expanded to a-label form,
42719 and any certificate name checks will be done using the a-label
42720 form of the name.
42721
42722 .cindex log protocol
42723 .cindex SMTPUTF8 logging
42724 .cindex i18n logging
42725 Log lines and Received-by: header lines will acquire a "utf8"
42726 prefix on the protocol element, eg. utf8esmtp.
42727
42728 The following expansion operators can be used:
42729 .code
42730 ${utf8_domain_to_alabel:str}
42731 ${utf8_domain_from_alabel:str}
42732 ${utf8_localpart_to_alabel:str}
42733 ${utf8_localpart_from_alabel:str}
42734 .endd
42735
42736 .cindex utf8 "address downconversion"
42737 .cindex i18n "utf8 address downconversion"
42738 The RCPT ACL
42739 may use the following modifier:
42740 .display
42741 control = utf8_downconvert
42742 control = utf8_downconvert/<value>
42743 .endd
42744 This sets a flag requiring that envelope addresses are converted to
42745 a-label form before smtp delivery.
42746 This is usually for use in a Message Submission Agent context,
42747 but could be used for any message.
42748
42749 If a value is appended it may be:
42750 .itable none 0 0 2 5* right 95* left
42751 .irow &`1`&     "mandatory downconversion"
42752 .irow &`0`&     "no downconversion"
42753 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42754 .endtable
42755 If no value is given, 1 is used.
42756
42757 If mua_wrapper is set, the utf8_downconvert control
42758 is initially set to -1.
42759
42760 The smtp transport has an option &%utf8_downconvert%&.
42761 If set it must expand to one of the three values described above,
42762 or an empty string.
42763 If non-empty it overrides value previously set
42764 (due to mua_wrapper or by an ACL control).
42765
42766
42767 There is no explicit support for VRFY and EXPN.
42768 Configurations supporting these should inspect
42769 &$smtp_command_argument$& for an SMTPUTF8 argument.
42770
42771 There is no support for LMTP on Unix sockets.
42772 Using the "lmtp" protocol option on an smtp transport,
42773 for LMTP over TCP, should work as expected.
42774
42775 There is no support for DSN unitext handling,
42776 and no provision for converting logging from or to UTF-8.
42777
42778
42779
42780 .section "MDA operations" SECTi18nMDA
42781 To aid in constructing names suitable for IMAP folders
42782 the following expansion operator can be used:
42783 .code
42784 ${imapfolder {<string>} {<sep>} {<specials>}}
42785 .endd
42786
42787 The string is converted from the charset specified by
42788 the "headers charset" command (in a filter file)
42789 or &%headers_charset%& main configuration option (otherwise),
42790 to the
42791 modified UTF-7 encoding specified by RFC 2060,
42792 with the following exception: All occurrences of <sep>
42793 (which has to be a single character)
42794 are replaced with periods ("."), and all periods and slashes that are not
42795 <sep> and are not in the <specials> string are BASE64 encoded.
42796
42797 The third argument can be omitted, defaulting to an empty string.
42798 The second argument can be omitted, defaulting to "/".
42799
42800 This is the encoding used by Courier for Maildir names on disk, and followed
42801 by many other IMAP servers.
42802
42803 Examples:
42804 .display
42805 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42806 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42807 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42808 .endd
42809
42810 Note that the source charset setting is vital, and also that characters
42811 must be representable in UTF-16.
42812
42813
42814 . ////////////////////////////////////////////////////////////////////////////
42815 . ////////////////////////////////////////////////////////////////////////////
42816
42817 .chapter "Events" "CHAPevents" &&&
42818          "Events"
42819 .cindex events
42820
42821 The events mechanism in Exim can be used to intercept processing at a number
42822 of points.  It was originally invented to give a way to do customised logging
42823 actions (for example, to a database) but can also be used to modify some
42824 processing actions.
42825
42826 Most installations will never need to use Events.
42827 The support can be left out of a build by defining DISABLE_EVENT=yes
42828 in &_Local/Makefile_&.
42829
42830 There are two major classes of events: main and transport.
42831 The main configuration option &%event_action%& controls reception events;
42832 a transport option &%event_action%& controls delivery events.
42833
42834 Both options are a string which is expanded when the event fires.
42835 An example might look like:
42836 .cindex logging custom
42837 .code
42838 event_action = ${if eq {msg:delivery}{$event_name} \
42839 {${lookup pgsql {SELECT * FROM record_Delivery( \
42840     '${quote_pgsql:$sender_address_domain}',\
42841     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42842     '${quote_pgsql:$domain}', \
42843     '${quote_pgsql:${lc:$local_part}}', \
42844     '${quote_pgsql:$host_address}', \
42845     '${quote_pgsql:${lc:$host}}', \
42846     '${quote_pgsql:$message_exim_id}')}} \
42847 } {}}
42848 .endd
42849
42850 Events have names which correspond to the point in process at which they fire.
42851 The name is placed in the variable &$event_name$& and the event action
42852 expansion must check this, as it will be called for every possible event type.
42853
42854 The current list of events is:
42855 .itable all 0 0 4 25* left 10* center 15* center 50* left
42856 .row auth:fail              after    both       "per driver per authentication attempt"
42857 .row dane:fail              after    transport  "per connection"
42858 .row msg:complete           after    main       "per message"
42859 .row msg:defer              after    transport  "per message per delivery try"
42860 .row msg:delivery           after    transport  "per recipient"
42861 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42862 .row msg:rcpt:defer         after    transport  "per recipient"
42863 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42864 .row msg:fail:delivery      after    transport  "per recipient"
42865 .row msg:fail:internal      after    main       "per recipient"
42866 .row tcp:connect            before   transport  "per connection"
42867 .row tcp:close              after    transport  "per connection"
42868 .row tls:cert               before   both       "per certificate in verification chain"
42869 .row tls:fail:connect       after    main       "per connection"
42870 .row smtp:connect           after    transport  "per connection"
42871 .row smtp:ehlo              after    transport  "per connection"
42872 .endtable
42873 New event types may be added in future.
42874
42875 The event name is a colon-separated list, defining the type of
42876 event in a tree of possibilities.  It may be used as a list
42877 or just matched on as a whole.  There will be no spaces in the name.
42878
42879 The second column in the table above describes whether the event fires
42880 before or after the action is associates with.  Those which fire before
42881 can be used to affect that action (more on this below).
42882
42883 The third column in the table above says what section of the configuration
42884 should define the event action.
42885
42886 An additional variable, &$event_data$&, is filled with information varying
42887 with the event type:
42888 .itable all 0 0 2 20* left 80* left
42889 .row auth:fail            "smtp response"
42890 .row dane:fail            "failure reason"
42891 .row msg:defer            "error string"
42892 .row msg:delivery         "smtp confirmation message"
42893 .row msg:fail:internal    "failure reason"
42894 .row msg:fail:delivery    "smtp error message"
42895 .row msg:host:defer       "error string"
42896 .row msg:rcpt:host:defer  "error string"
42897 .row msg:rcpt:defer       "error string"
42898 .row tls:cert             "verification chain depth"
42899 .row tls:fail:connect     "error string"
42900 .row smtp:connect         "smtp banner"
42901 .row smtp:ehlo            "smtp ehlo response"
42902 .endtable
42903
42904 The :defer events populate one extra variable: &$event_defer_errno$&.
42905
42906 For complex operations an ACL expansion can be used in &%event_action%&,
42907 however due to the multiple contexts that Exim operates in during
42908 the course of its processing:
42909 .ilist
42910 variables set in transport events will not be visible outside that
42911 transport call
42912 .next
42913 acl_m variables in a server context are lost on a new connection,
42914 and after smtp helo/ehlo/mail/starttls/rset commands
42915 .endlist
42916 Using an ACL expansion with the logwrite modifier can be
42917 a useful way of writing to the main log.
42918
42919 The expansion of the event_action option should normally
42920 return an empty string.  Should it return anything else the
42921 following will be forced:
42922 .itable all 0 0 2 20* left 80* left
42923 .row auth:fail        "log information to write"
42924 .row tcp:connect      "do not connect"
42925 .row tls:cert         "refuse verification"
42926 .row smtp:connect     "close connection"
42927 .endtable
42928 All other message types ignore the result string, and
42929 no other use is made of it.
42930
42931 For a tcp:connect event, if the connection is being made to a proxy
42932 then the address and port variables will be that of the proxy and not
42933 the target system.
42934
42935 For tls:cert events, if GnuTLS is in use this will trigger only per
42936 chain element received on the connection.
42937 For OpenSSL it will trigger for every chain element including those
42938 loaded locally.
42939
42940 . ////////////////////////////////////////////////////////////////////////////
42941 . ////////////////////////////////////////////////////////////////////////////
42942
42943 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42944          "Adding drivers or lookups"
42945 .cindex "adding drivers"
42946 .cindex "new drivers, adding"
42947 .cindex "drivers" "adding new"
42948 The following actions have to be taken in order to add a new router, transport,
42949 authenticator, or lookup type to Exim:
42950
42951 .olist
42952 Choose a name for the driver or lookup type that does not conflict with any
42953 existing name; I will use &"newdriver"& in what follows.
42954 .next
42955 Add to &_src/EDITME_& the line:
42956 .display
42957 <&'type'&>&`_NEWDRIVER=yes`&
42958 .endd
42959 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42960 code is not to be included in the binary by default, comment this line out. You
42961 should also add any relevant comments about the driver or lookup type.
42962 .next
42963 Add to &_src/config.h.defaults_& the line:
42964 .code
42965 #define <type>_NEWDRIVER
42966 .endd
42967 .next
42968 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42969 and create a table entry as is done for all the other drivers and lookup types.
42970 .next
42971 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42972 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42973 Add your &`NEWDRIVER`& to that list.
42974 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42975 simple form that most lookups have.
42976 .next
42977 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42978 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42979 driver or lookup type and add it to the definition of OBJ.
42980 .next
42981 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42982 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42983 .next
42984 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42985 &_src_&.
42986 .next
42987 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42988 as for other drivers and lookups.
42989 .endlist
42990
42991 Then all you need to do is write the code! A good way to start is to make a
42992 proforma by copying an existing module of the same type, globally changing all
42993 occurrences of the name, and cutting out most of the code. Note that any
42994 options you create must be listed in alphabetical order, because the tables are
42995 searched using a binary chop procedure.
42996
42997 There is a &_README_& file in each of the sub-directories of &_src_& describing
42998 the interface that is expected.
42999
43000
43001
43002
43003 . ////////////////////////////////////////////////////////////////////////////
43004 . ////////////////////////////////////////////////////////////////////////////
43005
43006 . /////////////////////////////////////////////////////////////////////////////
43007 . These lines are processing instructions for the Simple DocBook Processor that
43008 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43009 . PDFs than using xmlto and fop. They will be ignored by all other XML
43010 . processors.
43011 . /////////////////////////////////////////////////////////////////////////////
43012
43013 .literal xml
43014 <?sdop
43015   format="newpage"
43016   foot_right_recto="&chaptertitle;"
43017   foot_right_verso="&chaptertitle;"
43018 ?>
43019 .literal off
43020
43021 .makeindex "Options index"   "option"
43022 .makeindex "Variables index" "variable"
43023 .makeindex "Concept index"   "concept"
43024
43025
43026 . /////////////////////////////////////////////////////////////////////////////
43027 . /////////////////////////////////////////////////////////////////////////////