Docs: build notes for dynamic modules
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.98"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .set drivernamemax "64"
55
56 .macro copyyear
57 2024
58 .endmacro
59
60 . /////////////////////////////////////////////////////////////////////////////
61 . Additional xfpt markup used by this document, over and above the default
62 . provided in the xfpt library.
63 . /////////////////////////////////////////////////////////////////////////////
64
65 . --- Override the &$ flag to automatically insert a $ with the variable name.
66
67 .flag &$  $&   "<varname>$"  "</varname>"
68
69 . --- Short flags for daggers in option headings. They will always be inside
70 . --- an italic string, but we want the daggers to be in Roman.
71
72 .flag &!!      "</emphasis>&dagger;<emphasis>"
73 .flag &!?      "</emphasis>&Dagger;<emphasis>"
74
75 . --- A macro for an Exim option definition heading, generating a one-line
76 . --- table with four columns. For cases when the option name is given with
77 . --- a space, so that it can be split, a fifth argument is used for the
78 . --- index entry.
79 . --- Also one for multiple option def headings be grouped in a single
80 . --- table (but without the split capability).
81
82 .macro otable
83 .itable all 0 0 4 8* left 6* center 6* center 6* right
84 .endmacro
85
86 .macro orow
87 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
88 .endmacro
89
90 .macro option
91 .arg 5
92 .oindex "&%$5%&"
93 .endarg
94 .arg -5
95 .oindex "&%$1%&"
96 .endarg
97 .otable
98 .orow "$1" "$2" "$3" "$4"
99 .endtable
100 .endmacro
101
102 .macro options
103 .eacharg
104 .oindex "&%$+1%&"
105 .endeach 4
106 .otable
107 .eacharg
108 .orow "$+1" "$+2" "$+3" "$+4"
109 .endeach 4
110 .endtable
111 .endmacro
112
113 . --- A macro for the common 2-column tables. The width of the first column
114 . --- is suitable for the many tables at the start of the main options chapter;
115 . --- a small number of other 2-column tables override it.
116
117 .macro table2 196pt 254pt
118 .itable none 0 0 2 $1 left $2 left
119 .endmacro
120
121
122 . --- A macro for a plain variable, including the .vitem and .vindex
123 .macro var
124 .vitem $1
125 .vindex $1
126 .endmacro
127
128 . --- A macro for a "tainted" marker, done as a one-element table
129 .macro tmark
130 .itable none 0 0 1 10pt left
131 .row &'Tainted'&
132 .endtable
133 .endmacro
134
135 . --- A macro for a tainted variable, adding a taint-marker
136 .macro tvar
137 .var $1
138 .tmark
139 .endmacro
140
141 . --- A macro for a cmdline option, including a .oindex
142 . --- 1st arg is the option name, undecorated (we do that here).
143 . --- 2nd arg, optional, text (decorated as needed) to be appended to the name
144 .macro cmdopt
145 .vitem  &%$1%&$=2+&~$2+
146 .oindex &%$1%&
147 .endmacro
148
149 . --- A macro that generates .row, but puts &I; at the start of the first
150 . --- argument, thus indenting it. Assume a minimum of two arguments, and
151 . --- allow up to four arguments, which is as many as we'll ever need.
152
153 .macro irow
154 .arg 4
155 .row "&I;$1" "$2" "$3" "$4"
156 .endarg
157 .arg -4
158 .arg 3
159 .row "&I;$1" "$2" "$3"
160 .endarg
161 .arg -3
162 .row "&I;$1" "$2"
163 .endarg
164 .endarg
165 .endmacro
166
167 . --- Macros for option, variable, and concept index entries. For a "range"
168 . --- style of entry, use .scindex for the start and .ecindex for the end. The
169 . --- first argument of .scindex and the only argument of .ecindex must be the
170 . --- ID that ties them together.
171 . --- The index entry points to the most-recent chapter head, section or subsection
172 . --- head, or list-item.
173
174 .macro cindex
175 &<indexterm role="concept">&
176 &<primary>&$1&</primary>&
177 .arg 2
178 &<secondary>&$2&</secondary>&
179 .endarg
180 &</indexterm>&
181 .endmacro
182
183 .macro scindex
184 &<indexterm role="concept" id="$1" class="startofrange">&
185 &<primary>&$2&</primary>&
186 .arg 3
187 &<secondary>&$3&</secondary>&
188 .endarg
189 &</indexterm>&
190 .endmacro
191
192 .macro ecindex
193 &<indexterm role="concept" startref="$1" class="endofrange"/>&
194 .endmacro
195
196 .macro oindex
197 &<indexterm role="option">&
198 &<primary>&$1&</primary>&
199 .arg 2
200 &<secondary>&$2&</secondary>&
201 .endarg
202 &</indexterm>&
203 .endmacro
204
205 . --- The index entry points to the most-recent chapter head, section or subsection
206 . --- head, or varlist item.
207
208 .macro vindex
209 &<indexterm role="variable">&
210 &<primary>&$1&</primary>&
211 .arg 2
212 &<secondary>&$2&</secondary>&
213 .endarg
214 &</indexterm>&
215 .endmacro
216
217 .macro index
218 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
219 .endmacro
220
221
222 . use this for a concept-index entry for a header line
223 .macro chindex
224 .cindex "&'$1'& header line"
225 .cindex "header lines" $1
226 .endmacro
227 . ////////////////////////////////////////////////////////////////////////////
228
229
230 . ////////////////////////////////////////////////////////////////////////////
231 . The <bookinfo> element is removed from the XML before processing for ASCII
232 . output formats.
233 . ////////////////////////////////////////////////////////////////////////////
234
235 .literal xml
236 <bookinfo>
237 <title>Specification of the Exim Mail Transfer Agent</title>
238 <titleabbrev>The Exim MTA</titleabbrev>
239 <date>
240 .fulldate
241 </date>
242 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
243 <authorinitials>EM</authorinitials>
244 <revhistory><revision>
245 .versiondatexml
246   <authorinitials>EM</authorinitials>
247 </revision></revhistory>
248 <copyright><year>
249 .copyyear
250            </year><holder>The Exim Maintainers</holder></copyright>
251 </bookinfo>
252 .literal off
253
254
255 . /////////////////////////////////////////////////////////////////////////////
256 . These implement index entries of the form "x, see y" and "x, see also y".
257 . However, the DocBook DTD doesn't allow <indexterm> entries
258 . at the top level, so we have to put the .chapter directive first.
259 . /////////////////////////////////////////////////////////////////////////////
260
261 .chapter "Introduction" "CHID1"
262
263 .macro seeother
264 .literal xml
265 <indexterm role="$2">
266   <primary>$3</primary>
267 .arg 5
268   <secondary>$5</secondary>
269 .endarg
270   <$1><emphasis>$4</emphasis></$1>
271 </indexterm>
272 .literal off
273 .endmacro
274
275 . NB: for the 4-arg variant the ordering is awkward
276 .macro see
277 .seeother see "$1" "$2" "$3" "$4"
278 .endmacro
279 .macro seealso
280 .seeother seealso "$1" "$2" "$3" "$4"
281 .endmacro
282
283 .see     variable "<emphasis>$1</emphasis>, <emphasis>$2</emphasis>, etc." "numerical variables"
284 .see     concept address        rewriting                       rewriting
285 .see     concept "Bounce Address Tag Validation"        BATV
286 .see     concept "Client SMTP Authorization"            CSA
287 .see     concept "CR character" "carriage return"
288 .see     concept CRL            "certificate revocation list"
289 .seealso concept de-tainting    "tainted data"
290 .see     concept delivery       "bounce message"                "failure report"
291 .see     concept dialup         "intermittently connected hosts"
292 .see     concept exiscan        "content scanning"
293 .see     concept fallover       fallback
294 .see     concept filter         "Sieve filter"                  Sieve
295 .see     concept headers        "header lines"
296 .see     concept ident          "RFC 1413"
297 .see     concept "LF character" "linefeed"
298 .seealso concept maximum        limit
299 .see     concept monitor        "Exim monitor"
300 .see     concept "no_<emphasis>xxx</emphasis>"          "entry for xxx"
301 .see     concept NUL            "binary zero"
302 .see     concept "passwd file"  "/etc/passwd"
303 .see     concept "process id"   pid
304 .see     concept RBL            "DNS list"
305 .see     concept redirection    "address redirection"
306 .see     concept "return path"  "envelope sender"
307 .see     concept scanning       "content scanning"
308 .see     concept SSL            TLS
309 .see     concept string         expansion expansion
310 .see     concept "top bit"      "8-bit characters"
311 .see     concept variables      "expansion, variables"
312 .see     concept "zero, binary" "binary zero"
313
314
315 . /////////////////////////////////////////////////////////////////////////////
316 . This is the real start of the first chapter. See the comment above as to why
317 . we can't have the .chapter line here.
318 . chapter "Introduction"
319 . /////////////////////////////////////////////////////////////////////////////
320
321 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
322 Unix-like operating systems. It was designed on the assumption that it would be
323 run on hosts that are permanently connected to the Internet. However, it can be
324 used on intermittently connected hosts with suitable configuration adjustments.
325
326 Configuration files currently exist for the following operating systems: AIX,
327 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
328 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
329 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
330 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
331 Some of these operating systems are no longer current and cannot easily be
332 tested, so the configuration files may no longer work in practice.
333
334 There are also configuration files for compiling Exim in the Cygwin environment
335 that can be installed on systems running Windows. However, this document does
336 not contain any information about running Exim in the Cygwin environment.
337
338 The terms and conditions for the use and distribution of Exim are contained in
339 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
340 Public Licence, a copy of which may be found in the file &_LICENCE_&.
341
342 The use, supply, or promotion of Exim for the purpose of sending bulk,
343 unsolicited electronic mail is incompatible with the basic aims of Exim,
344 which revolve around the free provision of a service that enhances the quality
345 of personal communications. The author of Exim regards indiscriminate
346 mass-mailing as an antisocial, irresponsible abuse of the Internet.
347
348 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
349 experience of running and working on the Smail 3 code, I could never have
350 contemplated starting to write a new MTA. Many of the ideas and user interfaces
351 were originally taken from Smail 3, though the actual code of Exim is entirely
352 new, and has developed far beyond the initial concept.
353
354 Many people, both in Cambridge and around the world, have contributed to the
355 development and the testing of Exim, and to porting it to various operating
356 systems. I am grateful to them all. The distribution now contains a file called
357 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
358 contributors.
359
360
361 .section "Exim documentation" "SECID1"
362 . Keep this example change bar when updating the documentation!
363
364 .new
365 .cindex "documentation"
366 This edition of the Exim specification applies to version &version() of Exim.
367 Substantive changes from the &previousversion; edition are marked in some
368 renditions of this document; this paragraph is so marked if the rendition is
369 capable of showing a change indicator.
370 .wen
371
372 This document is very much a reference manual; it is not a tutorial. The reader
373 is expected to have some familiarity with the SMTP mail transfer protocol and
374 with general Unix system administration. Although there are some discussions
375 and examples in places, the information is mostly organized in a way that makes
376 it easy to look up, rather than in a natural order for sequential reading.
377 Furthermore, this manual aims to cover every aspect of Exim in detail, including
378 a number of rarely-used, special-purpose features that are unlikely to be of
379 very wide interest.
380
381 .cindex "books about Exim"
382 An &"easier"& discussion of Exim which provides more in-depth explanatory,
383 introductory, and tutorial material can be found in a book entitled &'The Exim
384 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
385 (&url(https://www.uit.co.uk/exim-book/)).
386
387 The book also contains a chapter that gives a general introduction to SMTP and
388 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
389 with the latest release of Exim. (Note that the earlier book about Exim,
390 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
391
392 .cindex "Debian" "information sources"
393 If you are using a Debian distribution of Exim, you will find information about
394 Debian-specific features in the file
395 &_/usr/share/doc/exim4-base/README.Debian_&.
396 The command &(man update-exim.conf)& is another source of Debian-specific
397 information.
398
399 .cindex "&_doc/NewStuff_&"
400 .cindex "&_doc/ChangeLog_&"
401 .cindex "change log"
402 As Exim develops, there may be features in newer versions that have not
403 yet made it into this document, which is updated only when the most significant
404 digit of the fractional part of the version number changes. Specifications of
405 new features that are not yet in this manual are placed in the file
406 &_doc/NewStuff_& in the Exim distribution.
407
408 Some features may be classified as &"experimental"&. These may change
409 incompatibly while they are developing, or even be withdrawn. For this reason,
410 they are not documented in this manual. Information about experimental features
411 can be found in the file &_doc/experimental.txt_&.
412
413 All changes to Exim (whether new features, bug fixes, or other kinds of
414 change) are noted briefly in the file called &_doc/ChangeLog_&.
415
416 .cindex "&_doc/spec.txt_&"
417 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
418 that it can easily be searched with a text editor. Other files in the &_doc_&
419 directory are:
420
421 .table2 100pt
422 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
423 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
424 .row &_exim.8_&              "a man page of Exim's command line options"
425 .row &_experimental.txt_&    "documentation of experimental features"
426 .row &_filter.txt_&          "specification of the filter language"
427 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
428 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
429 .row &_openssl.txt_&         "installing a current OpenSSL release"
430 .endtable
431
432 The main specification and the specification of the filtering language are also
433 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
434 &<<SECTavail>>& below tells you how to get hold of these.
435
436
437
438 .section "FTP site and websites" "SECID2"
439 .cindex "website"
440 .cindex "FTP site"
441 The primary site for Exim source distributions is the &%exim.org%& FTP site,
442 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
443 website, are hosted at the University of Cambridge.
444
445 .cindex "wiki"
446 .cindex "FAQ"
447 As well as Exim distribution tar files, the Exim website contains a number of
448 differently formatted versions of the documentation. A recent addition to the
449 online information is the Exim wiki (&url(https://wiki.exim.org)),
450 which contains what used to be a separate FAQ, as well as various other
451 examples, tips, and know-how that have been contributed by Exim users.
452 The wiki site should always redirect to the correct place, which is currently
453 provided by GitHub, and is open to editing by anyone with a GitHub account.
454
455 .cindex Bugzilla
456 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
457 this to report bugs, and also to add items to the wish list. Please search
458 first to check that you are not duplicating a previous entry.
459 Please do not ask for configuration help in the bug-tracker.
460
461
462 .section "Mailing lists" "SECID3"
463 .cindex "mailing lists" "for Exim users"
464 The following Exim mailing lists exist:
465
466 .table2 140pt
467 .row &'exim-announce@lists.exim.org'&   "Moderated, low volume announcements list"
468 .row &'exim-users@lists.exim.org'&      "General discussion list"
469 .row &'exim-users-de@lists.exim.org'&   "General discussion list in German language"
470 .row &'exim-dev@lists.exim.org'&        "Discussion of bugs, enhancements, etc."
471 .row &'exim-cvs@lists.exim.org'&        "Automated commit messages from the VCS"
472 .endtable
473
474 You can subscribe to these lists, change your existing subscriptions, and view
475 or search the archives via the mailing lists link on the Exim home page.
476 .cindex "Debian" "mailing list for"
477 If you are using a Debian distribution of Exim, you may wish to subscribe to
478 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
479 via this web page:
480 .display
481 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
482 .endd
483 Please ask Debian-specific questions on that list and not on the general Exim
484 lists.
485
486 .section "Bug reports" "SECID5"
487 .cindex "bug reports"
488 .cindex "reporting bugs"
489 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
490 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
491 whether some behaviour is a bug or not, the best thing to do is to post a
492 message to the &'exim-dev'& mailing list and have it discussed.
493
494
495
496 .section "Where to find the Exim distribution" "SECTavail"
497 .cindex "FTP site"
498 .cindex "HTTPS download site"
499 .cindex "distribution" "FTP site"
500 .cindex "distribution" "https site"
501 The master distribution site for the Exim distribution is
502 .display
503 &url(https://downloads.exim.org/)
504 .endd
505 The service is available over HTTPS, HTTP and FTP.
506 We encourage people to migrate to HTTPS.
507
508 The content served at &url(https://downloads.exim.org/) is identical to the
509 content served at &url(https://ftp.exim.org/pub/exim) and
510 &url(ftp://ftp.exim.org/pub/exim).
511
512 If accessing via a hostname containing &'ftp'&, then the file references that
513 follow are relative to the &_exim_& directories at these sites.
514 If accessing via the hostname &'downloads'& then the subdirectories described
515 here are top-level directories.
516
517 There are now quite a number of independent mirror sites around
518 the world. Those that I know about are listed in the file called &_Mirrors_&.
519
520 Within the top exim directory there are subdirectories called &_exim3_& (for
521 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
522 distributions), and &_Testing_& for testing versions. In the &_exim4_&
523 subdirectory, the current release can always be found in files called
524 .display
525 &_exim-n.nn.tar.xz_&
526 &_exim-n.nn.tar.gz_&
527 &_exim-n.nn.tar.bz2_&
528 .endd
529 where &'n.nn'& is the highest such version number in the directory. The three
530 files contain identical data; the only difference is the type of compression.
531 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
532 most portable to old systems.
533
534 .cindex "distribution" "signing details"
535 .cindex "distribution" "public key"
536 .cindex "public key for signed distribution"
537 The distributions will be PGP signed by an individual key of the Release
538 Coordinator.  This key will have a uid containing an email address in the
539 &'exim.org'& domain and will have signatures from other people, including
540 other Exim maintainers.  We expect that the key will be in the "strong set" of
541 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
542 PGP keys, a version of which can be found in the release directory in the file
543 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
544 such as &'pool.sks-keyservers.net'&.
545
546 At the time of the last update, releases were being made by Jeremy Harris and signed
547 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
548 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
549 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
550
551 The signatures for the tar bundles are in:
552 .display
553 &_exim-n.nn.tar.xz.asc_&
554 &_exim-n.nn.tar.gz.asc_&
555 &_exim-n.nn.tar.bz2.asc_&
556 .endd
557 For each released version, the log of changes is made available in a
558 separate file in the directory &_ChangeLogs_& so that it is possible to
559 find out what has changed without having to download the entire distribution.
560
561 .cindex "documentation" "available formats"
562 The main distribution contains ASCII versions of this specification and other
563 documentation; other formats of the documents are available in separate files
564 inside the &_exim4_& directory of the FTP site:
565 .display
566 &_exim-html-n.nn.tar.gz_&
567 &_exim-pdf-n.nn.tar.gz_&
568 &_exim-postscript-n.nn.tar.gz_&
569 &_exim-texinfo-n.nn.tar.gz_&
570 .endd
571 These tar files contain only the &_doc_& directory, not the complete
572 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
573
574
575 .section "Limitations" "SECID6"
576 .ilist
577 .cindex "limitations of Exim"
578 .cindex "bang paths" "not handled by Exim"
579 Exim is designed for use as an Internet MTA, and therefore handles addresses in
580 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
581 simple two-component bang paths can be converted by a straightforward rewriting
582 configuration. This restriction does not prevent Exim from being interfaced to
583 UUCP as a transport mechanism, provided that domain addresses are used.
584 .next
585 .cindex "domainless addresses"
586 .cindex "address" "without domain"
587 Exim insists that every address it handles has a domain attached. For incoming
588 local messages, domainless addresses are automatically qualified with a
589 configured domain value. Configuration options specify from which remote
590 systems unqualified addresses are acceptable. These are then qualified on
591 arrival.
592 .next
593 .cindex "transport" "external"
594 .cindex "external transports"
595 The only external transport mechanisms that are currently implemented are SMTP
596 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
597 transport is available, and there are facilities for writing messages to files
598 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
599 to send messages to other transport mechanisms such as UUCP, provided they can
600 handle domain-style addresses. Batched SMTP input is also catered for.
601 .next
602 Exim is not designed for storing mail for dial-in hosts. When the volumes of
603 such mail are large, it is better to get the messages &"delivered"& into files
604 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
605 other means.
606 .next
607 Although Exim does have basic facilities for scanning incoming messages, these
608 are not comprehensive enough to do full virus or spam scanning. Such operations
609 are best carried out using additional specialized software packages. If you
610 compile Exim with the content-scanning extension, straightforward interfaces to
611 a number of common scanners are provided.
612 .endlist
613
614
615 .section "Runtime configuration" "SECID7"
616 Exim's runtime configuration is held in a single text file that is divided
617 into a number of sections. The entries in this file consist of keywords and
618 values, in the style of Smail 3 configuration files. A default configuration
619 file which is suitable for simple online installations is provided in the
620 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
621
622
623 .section "Calling interface" "SECID8"
624 .cindex "Sendmail compatibility" "command line interface"
625 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
626 can be a straight replacement for &_/usr/lib/sendmail_& or
627 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
628 about Sendmail in order to run Exim. For actions other than sending messages,
629 Sendmail-compatible options also exist, but those that produce output (for
630 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
631 format. There are also some additional options that are compatible with Smail
632 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
633 documents all Exim's command line options. This information is automatically
634 made into the man page that forms part of the Exim distribution.
635
636 Control of messages in the queue can be done via certain privileged command
637 line options. There is also an optional monitor program called &'eximon'&,
638 which displays current information in an X window, and which contains a menu
639 interface to Exim's command line administration options.
640
641
642
643 .section "Terminology" "SECID9"
644 .cindex "terminology definitions"
645 .cindex "body of message" "definition of"
646 The &'body'& of a message is the actual data that the sender wants to transmit.
647 It is the last part of a message and is separated from the &'header'& (see
648 below) by a blank line.
649
650 .cindex "bounce message" "definition of"
651 When a message cannot be delivered, it is normally returned to the sender in a
652 delivery failure message or a &"non-delivery report"& (NDR). The term
653 &'bounce'& is commonly used for this action, and the error reports are often
654 called &'bounce messages'&. This is a convenient shorthand for &"delivery
655 failure error report"&. Such messages have an empty sender address in the
656 message's &'envelope'& (see below) to ensure that they cannot themselves give
657 rise to further bounce messages.
658
659 The term &'default'& appears frequently in this manual. It is used to qualify a
660 value which is used in the absence of any setting in the configuration. It may
661 also qualify an action which is taken unless a configuration setting specifies
662 otherwise.
663
664 The term &'defer'& is used when the delivery of a message to a specific
665 destination cannot immediately take place for some reason (a remote host may be
666 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
667 until a later time.
668
669 The word &'domain'& is sometimes used to mean all but the first component of a
670 host's name. It is &'not'& used in that sense here, where it normally refers to
671 the part of an email address following the @ sign.
672
673 .cindex "envelope, definition of"
674 .cindex "sender" "definition of"
675 A message in transit has an associated &'envelope'&, as well as a header and a
676 body. The envelope contains a sender address (to which bounce messages should
677 be delivered), and any number of recipient addresses. References to the
678 sender or the recipients of a message usually mean the addresses in the
679 envelope. An MTA uses these addresses for delivery, and for returning bounce
680 messages, not the addresses that appear in the header lines.
681
682 .cindex "message" "header, definition of"
683 .cindex "header section" "definition of"
684 The &'header'& of a message is the first part of a message's text, consisting
685 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
686 &'Subject:'&, etc. Long header lines can be split over several text lines by
687 indenting the continuations. The header is separated from the body by a blank
688 line.
689
690 .cindex "local part" "definition of"
691 .cindex "domain" "definition of"
692 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
693 part of an email address that precedes the @ sign. The part that follows the
694 @ sign is called the &'domain'& or &'mail domain'&.
695
696 .cindex "local delivery" "definition of"
697 .cindex "remote delivery, definition of"
698 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
699 delivery to a file or a pipe on the local host from delivery by SMTP over
700 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
701 host it is running on are &'remote'&.
702
703 .cindex "return path" "definition of"
704 &'Return path'& is another name that is used for the sender address in a
705 message's envelope.
706
707 .cindex "queue" "definition of"
708 The term &'queue'& is used to refer to the set of messages awaiting delivery
709 because this term is in widespread use in the context of MTAs. However, in
710 Exim's case, the reality is more like a pool than a queue, because there is
711 normally no ordering of waiting messages.
712
713 .cindex "queue runner" "definition of"
714 The term &'queue runner'& is used to describe a process that scans the queue
715 and attempts to deliver those messages whose retry times have come. This term
716 is used by other MTAs and also relates to the command &%runq%&, but in Exim
717 the waiting messages are normally processed in an unpredictable order.
718
719 .cindex "spool directory" "definition of"
720 The term &'spool directory'& is used for a directory in which Exim keeps the
721 messages in its queue &-- that is, those that it is in the process of
722 delivering. This should not be confused with the directory in which local
723 mailboxes are stored, which is called a &"spool directory"& by some people. In
724 the Exim documentation, &"spool"& is always used in the first sense.
725
726
727
728
729
730
731 . ////////////////////////////////////////////////////////////////////////////
732 . ////////////////////////////////////////////////////////////////////////////
733
734 .chapter "Incorporated code" "CHID2"
735 .cindex "incorporated code"
736 .cindex "regular expressions" "library"
737 .cindex "PCRE2"
738 .cindex "OpenDMARC"
739 A number of pieces of external code are included in the Exim distribution.
740
741 .ilist
742 Regular expressions are supported in the main Exim program and in the
743 Exim monitor using the freely-distributable PCRE2 library, copyright
744 &copy; University of Cambridge. The source to PCRE2 is not longer shipped with
745 Exim, so you will need to use the version of PCRE2 shipped with your system,
746 or obtain and install the full version of the library from
747 &url(https://github.com/PhilipHazel/pcre2/releases).
748 .next
749 .cindex "cdb" "acknowledgment"
750 Support for the cdb (Constant DataBase) lookup method is provided by code
751 contributed by Nigel Metheringham of (at the time he contributed it) Planet
752 Online Ltd. The implementation is completely contained within the code of Exim.
753 It does not link against an external cdb library. The code contains the
754 following statements:
755
756 .blockquote
757 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
758
759 This program is free software; you can redistribute it and/or modify it under
760 the terms of the GNU General Public License as published by the Free Software
761 Foundation; either version 2 of the License, or (at your option) any later
762 version.
763 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
764 the spec and sample code for cdb can be obtained from
765 &url(https://cr.yp.to/cdb.html). This implementation borrows
766 some code from Dan Bernstein's implementation (which has no license
767 restrictions applied to it).
768 .endblockquote
769 .next
770 .cindex "SPA authentication"
771 .cindex "Samba project"
772 .cindex "Microsoft Secure Password Authentication"
773 Client support for Microsoft's &'Secure Password Authentication'& is provided
774 by code contributed by Marc Prud'hommeaux. Server support was contributed by
775 Tom Kistner. This includes code taken from the Samba project, which is released
776 under the Gnu GPL.
777 .next
778 .cindex "Cyrus"
779 .cindex "&'pwcheck'& daemon"
780 .cindex "&'pwauthd'& daemon"
781 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
782 by code taken from the Cyrus-SASL library and adapted by Alexander S.
783 Sabourenkov. The permission notice appears below, in accordance with the
784 conditions expressed therein.
785
786 .blockquote
787 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
788
789 Redistribution and use in source and binary forms, with or without
790 modification, are permitted provided that the following conditions
791 are met:
792
793 .olist
794 Redistributions of source code must retain the above copyright
795 notice, this list of conditions and the following disclaimer.
796 .next
797 Redistributions in binary form must reproduce the above copyright
798 notice, this list of conditions and the following disclaimer in
799 the documentation and/or other materials provided with the
800 distribution.
801 .next
802 The name &"Carnegie Mellon University"& must not be used to
803 endorse or promote products derived from this software without
804 prior written permission. For permission or any other legal
805 details, please contact
806 .display
807               Office of Technology Transfer
808               Carnegie Mellon University
809               5000 Forbes Avenue
810               Pittsburgh, PA  15213-3890
811               (412) 268-4387, fax: (412) 268-7395
812               tech-transfer@andrew.cmu.edu
813 .endd
814 .next
815 Redistributions of any form whatsoever must retain the following
816 acknowledgment:
817
818 &"This product includes software developed by Computing Services
819 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
820
821 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
822 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
823 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
824 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
825 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
826 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
827 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
828 .endlist
829 .endblockquote
830
831 .next
832 .cindex "Exim monitor" "acknowledgment"
833 .cindex "X-windows"
834 .cindex "Athena"
835 The Exim Monitor program, which is an X-Window application, includes
836 modified versions of the Athena StripChart and TextPop widgets.
837 This code is copyright by DEC and MIT, and their permission notice appears
838 below, in accordance with the conditions expressed therein.
839
840 .blockquote
841 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
842 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
843
844 All Rights Reserved
845
846 Permission to use, copy, modify, and distribute this software and its
847 documentation for any purpose and without fee is hereby granted,
848 provided that the above copyright notice appear in all copies and that
849 both that copyright notice and this permission notice appear in
850 supporting documentation, and that the names of Digital or MIT not be
851 used in advertising or publicity pertaining to distribution of the
852 software without specific, written prior permission.
853
854 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
855 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
856 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
857 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
858 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
859 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
860 SOFTWARE.
861 .endblockquote
862
863 .next
864 .cindex "opendmarc" "acknowledgment"
865 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
866 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
867 derived code are indicated in the respective source files. The full OpenDMARC
868 license is provided in the LICENSE.opendmarc file contained in the distributed
869 source code.
870
871 .next
872 Many people have contributed code fragments, some large, some small, that were
873 not covered by any specific license requirements. It is assumed that the
874 contributors are happy to see their code incorporated into Exim under the GPL.
875 .endlist
876
877
878
879
880
881 . ////////////////////////////////////////////////////////////////////////////
882 . ////////////////////////////////////////////////////////////////////////////
883
884 .chapter "How Exim receives and delivers mail" "CHID11" &&&
885          "Receiving and delivering mail"
886
887
888 .section "Overall philosophy" "SECID10"
889 .cindex "design philosophy"
890 Exim is designed to work efficiently on systems that are permanently connected
891 to the Internet and are handling a general mix of mail. In such circumstances,
892 most messages can be delivered immediately. Consequently, Exim does not
893 maintain independent queues of messages for specific domains or hosts, though
894 it does try to send several messages in a single SMTP connection after a host
895 has been down, and it also maintains per-host retry information.
896
897
898 .section "Policy control" "SECID11"
899 .cindex "policy control" "overview"
900 Policy controls are now an important feature of MTAs that are connected to the
901 Internet. Perhaps their most important job is to stop MTAs from being abused as
902 &"open relays"& by misguided individuals who send out vast amounts of
903 unsolicited junk and want to disguise its source. Exim provides flexible
904 facilities for specifying policy controls on incoming mail:
905
906 .ilist
907 .cindex "&ACL;" "introduction"
908 Exim 4 (unlike previous versions of Exim) implements policy controls on
909 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
910 series of statements that may either grant or deny access. ACLs can be used at
911 several places in the SMTP dialogue while receiving a message from a remote
912 host. However, the most common places are after each RCPT command, and at the
913 very end of the message. The sysadmin can specify conditions for accepting or
914 rejecting individual recipients or the entire message, respectively, at these
915 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
916 error code.
917 .next
918 An ACL is also available for locally generated, non-SMTP messages. In this
919 case, the only available actions are to accept or deny the entire message.
920 .next
921 When Exim is compiled with the content-scanning extension, facilities are
922 provided in the ACL mechanism for passing the message to external virus and/or
923 spam scanning software. The result of such a scan is passed back to the ACL,
924 which can then use it to decide what to do with the message.
925 .next
926 When a message has been received, either from a remote host or from the local
927 host, but before the final acknowledgment has been sent, a locally supplied C
928 function called &[local_scan()]& can be run to inspect the message and decide
929 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
930 is accepted, the list of recipients can be modified by the function.
931 .next
932 Using the &[local_scan()]& mechanism is another way of calling external scanner
933 software. The &%SA-Exim%& add-on package works this way. It does not require
934 Exim to be compiled with the content-scanning extension.
935 .next
936 After a message has been accepted, a further checking mechanism is available in
937 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
938 runs at the start of every delivery process.
939 .endlist
940
941
942
943 .section "User filters" "SECID12"
944 .cindex "filter" "introduction"
945 .cindex "Sieve filter"
946 In a conventional Exim configuration, users are able to run private filters by
947 setting up appropriate &_.forward_& files in their home directories. See
948 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
949 configuration needed to support this, and the separate document entitled
950 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
951 of filtering are available:
952
953 .ilist
954 Sieve filters are written in the standard filtering language that is defined
955 by RFC 3028.
956 .next
957 Exim filters are written in a syntax that is unique to Exim, but which is more
958 powerful than Sieve, which it pre-dates.
959 .endlist
960
961 User filters are run as part of the routing process, described below.
962
963
964
965 .section "Message identification" "SECTmessiden"
966 .cindex "message ids" "details of format"
967 .cindex "format" "of message id"
968 .cindex "id of message"
969 .cindex "base62"
970 .cindex "base36"
971 .cindex "Darwin"
972 .cindex "Cygwin"
973 .cindex "exim_msgdate"
974 Every message handled by Exim is given a &'message id'& which is 23
975 characters long. It is divided into three parts, separated by hyphens, for
976 example &`16VDhn-000000001bo-D342`&. Each part is a sequence of letters and digits,
977 normally encoding numbers in base 62. However, in the Darwin operating
978 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
979 (avoiding the use of lower case letters) is used instead, because the message
980 id is used to construct filenames, and the names of files in those systems are
981 not always case-sensitive.
982
983 .cindex "pid (process id)" "re-use of"
984 The detail of the contents of the message id have changed as Exim has evolved.
985 Earlier versions relied on the operating system not re-using a process id (pid)
986 within one second. On modern operating systems, this assumption can no longer
987 be made, so the algorithm had to be changed. To retain backward compatibility,
988 the format of the message id was retained, which is why the following rules are
989 somewhat eccentric:
990
991 .ilist
992 The first six characters of the message id are the time at which the message
993 started to be received, to a granularity of one second. That is, this field
994 contains the number of seconds since the start of the epoch (the normal Unix
995 way of representing the date and time of day).
996 .next
997 After the first hyphen, the next
998 eleven
999 characters are the id of the process that received the message.
1000 .next
1001 There are two different possibilities for the final four characters:
1002 .olist
1003 .oindex "&%localhost_number%&"
1004 If &%localhost_number%& is not set, this value is the fractional part of the
1005 time of reception, normally in units of
1006 microseconds.
1007 but for systems
1008 that must use base 36 instead of base 62 (because of case-insensitive file
1009 systems), the units are
1010 2 us.
1011 .next
1012 If &%localhost_number%& is set, it is multiplied by
1013 500000 (250000) and added to
1014 the fractional part of the time, which in this case is in units of 2 us (4 us).
1015 .endlist
1016 .endlist
1017
1018 After a message has been received, Exim waits for the clock to tick at the
1019 appropriate resolution before proceeding, so that if another message is
1020 received by the same process, or by another process with the same (re-used)
1021 pid, it is guaranteed that the time will be different. In most cases, the clock
1022 will already have ticked while the message was being received.
1023
1024 The exim_msgdate utility (see section &<<SECTexim_msgdate>>&) can be
1025 used to display the date, and optionally the process id, of an Exim
1026 Message ID.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .olist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397
1398 .next
1399 If the &%domains%& option is set, the domain of the address must be in the set
1400 of domains that it defines.
1401 .cindex "tainted data" "de-tainting"
1402 .cindex "de-tainting" "using router domains option"
1403 A match verifies the variable &$domain$& (which carries tainted data)
1404 and assigns an untainted value to the &$domain_data$& variable.
1405 Such an untainted value is often needed in the transport.
1406 For specifics of the matching operation and the resulting untainted value,
1407 refer to section &<<SECTdomainlist>>&.
1408
1409 When an untainted value is wanted, use this option
1410 rather than the generic &%condition%& option.
1411
1412 .next
1413 .vindex "&$local_part_prefix$&"
1414 .vindex "&$local_part_prefix_v$&"
1415 .vindex "&$local_part$&"
1416 .vindex "&$local_part_suffix$&"
1417 .vindex "&$local_part_suffix_v$&"
1418 .cindex affix "router precondition"
1419 If the &%local_parts%& option is set, the local part of the address must be in
1420 the set of local parts that it defines.
1421 A match verifies the variable &$local_part$& (which carries tainted data)
1422 and assigns an untainted value to the &$local_part_data$& variable.
1423 Such an untainted value is often needed in the transport.
1424 For specifics of the matching operation and the resulting untainted value,
1425 refer to section &<<SECTlocparlis>>&.
1426
1427 When an untainted value is wanted, use this option
1428 rather than the generic &%condition%& option.
1429
1430 If &%local_part_prefix%& or
1431 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1432 part before this check. If you want to do precondition tests on local parts
1433 that include affixes, you can do so by using a &%condition%& option (see below)
1434 that uses the variables &$local_part$&, &$local_part_prefix$&,
1435 &$local_part_prefix_v$&, &$local_part_suffix$&
1436 and &$local_part_suffix_v$& as necessary.
1437
1438 .next
1439 .vindex "&$local_user_uid$&"
1440 .vindex "&$local_user_gid$&"
1441 .vindex "&$home$&"
1442 If the &%check_local_user%& option is set, the local part must be the name of
1443 an account on the local host. If this check succeeds, the uid and gid of the
1444 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1445 user's home directory is placed in &$home$&; these values can be used in the
1446 remaining preconditions.
1447
1448 .next
1449 If the &%router_home_directory%& option is set, it is expanded at this point,
1450 because it overrides the value of &$home$&. If this expansion were left till
1451 later, the value of &$home$& as set by &%check_local_user%& would be used in
1452 subsequent tests. Having two different values of &$home$& in the same router
1453 could lead to confusion.
1454
1455 .next
1456 If the &%senders%& option is set, the envelope sender address must be in the
1457 set of addresses that it defines.
1458
1459 .next
1460 If the &%require_files%& option is set, the existence or non-existence of
1461 specified files is tested.
1462
1463 .next
1464 .cindex "customizing" "precondition"
1465 If the &%condition%& option is set, it is evaluated and tested. This option
1466 uses an expanded string to allow you to set up your own custom preconditions.
1467 Expanded strings are described in chapter &<<CHAPexpand>>&.
1468
1469 Note that while using
1470 this option for address matching technically works,
1471 it does not set any de-tainted values.
1472 Such values are often needed, either for router-specific options or
1473 for transport options.
1474 Using the &%domains%& and &%local_parts%& options is usually the most
1475 convenient way to obtain them.
1476 .endlist
1477
1478
1479 Note that &%require_files%& comes near the end of the list, so you cannot use
1480 it to check for the existence of a file in which to lookup up a domain, local
1481 part, or sender. However, as these options are all expanded, you can use the
1482 &%exists%& expansion condition to make such tests within each condition. The
1483 &%require_files%& option is intended for checking files that the router may be
1484 going to use internally, or which are needed by a specific transport (for
1485 example, &_.procmailrc_&).
1486
1487
1488
1489 .section "Delivery in detail" "SECID18"
1490 .cindex "delivery" "in detail"
1491 When a message is to be delivered, the sequence of events is as follows:
1492
1493 .olist
1494 If a system-wide filter file is specified, the message is passed to it. The
1495 filter may add recipients to the message, replace the recipients, discard the
1496 message, cause a new message to be generated, or cause the message delivery to
1497 fail. The format of the system filter file is the same as for Exim user filter
1498 files, described in the separate document entitled &'Exim's interfaces to mail
1499 filtering'&.
1500 .cindex "Sieve filter" "not available for system filter"
1501 (&*Note*&: Sieve cannot be used for system filter files.)
1502
1503 Some additional features are available in system filters &-- see chapter
1504 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1505 filter only once per delivery attempt, however many recipients it has. However,
1506 if there are several delivery attempts because one or more addresses could not
1507 be immediately delivered, the system filter is run each time. The filter
1508 condition &%first_delivery%& can be used to detect the first run of the system
1509 filter.
1510 .next
1511 Each recipient address is offered to each configured router, in turn, subject to
1512 its preconditions, until one is able to handle it. If no router can handle the
1513 address, that is, if they all decline, the address is failed. Because routers
1514 can be targeted at particular domains, several locally handled domains can be
1515 processed entirely independently of each other.
1516 .next
1517 .cindex "routing" "loops in"
1518 .cindex "loop" "while routing"
1519 A router that accepts an address may assign it to a local or a remote
1520 transport. However, the transport is not run at this time. Instead, the address
1521 is placed on a list for the particular transport, which will be run later.
1522 Alternatively, the router may generate one or more new addresses (typically
1523 from alias, forward, or filter files). New addresses are fed back into this
1524 process from the top, but in order to avoid loops, a router ignores any address
1525 which has an identically-named ancestor that was processed by itself.
1526 .next
1527 When all the routing has been done, addresses that have been successfully
1528 handled are passed to their assigned transports. When local transports are
1529 doing real local deliveries, they handle only one address at a time, but if a
1530 local transport is being used as a pseudo-remote transport (for example, to
1531 collect batched SMTP messages for transmission by some other means) multiple
1532 addresses can be handled. Remote transports can always handle more than one
1533 address at a time, but can be configured not to do so, or to restrict multiple
1534 addresses to the same domain.
1535 .next
1536 Each local delivery to a file or a pipe runs in a separate process under a
1537 non-privileged uid, and these deliveries are run one at a time. Remote
1538 deliveries also run in separate processes, normally under a uid that is private
1539 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1540 run in parallel. The maximum number of simultaneous remote deliveries for any
1541 one message is set by the &%remote_max_parallel%& option.
1542 The order in which deliveries are done is not defined, except that all local
1543 deliveries happen before any remote deliveries.
1544 .next
1545 .cindex "queue runner"
1546 When it encounters a local delivery during a queue run, Exim checks its retry
1547 database to see if there has been a previous temporary delivery failure for the
1548 address before running the local transport. If there was a previous failure,
1549 Exim does not attempt a new delivery until the retry time for the address is
1550 reached. However, this happens only for delivery attempts that are part of a
1551 queue run. Local deliveries are always attempted when delivery immediately
1552 follows message reception, even if retry times are set for them. This makes for
1553 better behaviour if one particular message is causing problems (for example,
1554 causing quota overflow, or provoking an error in a filter file).
1555 .next
1556 .cindex "delivery" "retry in remote transports"
1557 Remote transports do their own retry handling, since an address may be
1558 deliverable to one of a number of hosts, each of which may have a different
1559 retry time. If there have been previous temporary failures and no host has
1560 reached its retry time, no delivery is attempted, whether in a queue run or
1561 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1562 .next
1563 If there were any permanent errors, a bounce message is returned to an
1564 appropriate address (the sender in the common case), with details of the error
1565 for each failing address. Exim can be configured to send copies of bounce
1566 messages to other addresses.
1567 .next
1568 .cindex "delivery" "deferral"
1569 If one or more addresses suffered a temporary failure, the message is left on
1570 the queue, to be tried again later. Delivery of these addresses is said to be
1571 &'deferred'&.
1572 .next
1573 When all the recipient addresses have either been delivered or bounced,
1574 handling of the message is complete. The spool files and message log are
1575 deleted, though the message log can optionally be preserved if required.
1576 .endlist
1577
1578
1579
1580
1581 .section "Retry mechanism" "SECID19"
1582 .cindex "delivery" "retry mechanism"
1583 .cindex "retry" "description of mechanism"
1584 .cindex "queue runner"
1585 Exim's mechanism for retrying messages that fail to get delivered at the first
1586 attempt is the queue runner process. You must either run an Exim daemon that
1587 uses the &%-q%& option with a time interval to start queue runners at regular
1588 intervals or use some other means (such as &'cron'&) to start them. If you do
1589 not arrange for queue runners to be run, messages that fail temporarily at the
1590 first attempt will remain in your queue forever. A queue runner process works
1591 its way through the queue, one message at a time, trying each delivery that has
1592 passed its retry time.
1593 You can run several queue runners at once.
1594
1595 Exim uses a set of configured rules to determine when next to retry the failing
1596 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1597 should give up trying to deliver to the address, at which point it generates a
1598 bounce message. If no retry rules are set for a particular host, address, and
1599 error combination, no retries are attempted, and temporary errors are treated
1600 as permanent.
1601
1602
1603
1604 .subsection "Temporary delivery failure" SECID20
1605 .cindex "delivery" "temporary failure"
1606 There are many reasons why a message may not be immediately deliverable to a
1607 particular address. Failure to connect to a remote machine (because it, or the
1608 connection to it, is down) is one of the most common. Temporary failures may be
1609 detected during routing as well as during the transport stage of delivery.
1610 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1611 is on a file system where the user is over quota. Exim can be configured to
1612 impose its own quotas on local mailboxes; where system quotas are set they will
1613 also apply.
1614
1615 If a host is unreachable for a period of time, a number of messages may be
1616 waiting for it by the time it recovers, and sending them in a single SMTP
1617 connection is clearly beneficial. Whenever a delivery to a remote host is
1618 deferred,
1619 .cindex "hints database" "deferred deliveries"
1620 Exim makes a note in its hints database, and whenever a successful
1621 SMTP delivery has happened, it looks to see if any other messages are waiting
1622 for the same host. If any are found, they are sent over the same SMTP
1623 connection, subject to a configuration limit as to the maximum number in any
1624 one connection.
1625
1626
1627
1628 .subsection "Permanent delivery failure" SECID21
1629 .cindex "delivery" "permanent failure"
1630 .cindex "bounce message" "when generated"
1631 When a message cannot be delivered to some or all of its intended recipients, a
1632 bounce message is generated. Temporary delivery failures turn into permanent
1633 errors when their timeout expires. All the addresses that fail in a given
1634 delivery attempt are listed in a single message. If the original message has
1635 many recipients, it is possible for some addresses to fail in one delivery
1636 attempt and others to fail subsequently, giving rise to more than one bounce
1637 message. The wording of bounce messages can be customized by the administrator.
1638 See chapter &<<CHAPemsgcust>>& for details.
1639
1640 .cindex "&'X-Failed-Recipients:'& header line"
1641 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1642 failed addresses, for the benefit of programs that try to analyse such messages
1643 automatically.
1644
1645 .cindex "bounce message" "recipient of"
1646 A bounce message is normally sent to the sender of the original message, as
1647 obtained from the message's envelope. For incoming SMTP messages, this is the
1648 address given in the MAIL command. However, when an address is expanded via a
1649 forward or alias file, an alternative address can be specified for delivery
1650 failures of the generated addresses. For a mailing list expansion (see section
1651 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1652 of the list.
1653
1654
1655
1656 .subsection "Failures to deliver bounce messages" SECID22
1657 .cindex "bounce message" "failure to deliver"
1658 If a bounce message (either locally generated or received from a remote host)
1659 itself suffers a permanent delivery failure, the message is left in the queue,
1660 but it is frozen, awaiting the attention of an administrator. There are options
1661 that can be used to make Exim discard such failed messages, or to keep them
1662 for only a short time (see &%timeout_frozen_after%& and
1663 &%ignore_bounce_errors_after%&).
1664
1665
1666
1667
1668
1669 . ////////////////////////////////////////////////////////////////////////////
1670 . ////////////////////////////////////////////////////////////////////////////
1671
1672 .chapter "Building and installing Exim" "CHID3"
1673 .scindex IIDbuex "building Exim"
1674
1675 .section "Unpacking" "SECID23"
1676 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1677 creates a directory with the name of the current release (for example,
1678 &_exim-&version()_&) into which the following files are placed:
1679
1680 .table2 140pt
1681 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1682 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1683   documented"
1684 .irow &_LICENCE_&         "the GNU General Public Licence"
1685 .irow &_Makefile_&        "top-level make file"
1686 .irow &_NOTICE_&          "conditions for the use of Exim"
1687 .irow &_README_&          "list of files, directories and simple build &&&
1688   instructions"
1689 .endtable
1690
1691 Other files whose names begin with &_README_& may also be present. The
1692 following subdirectories are created:
1693
1694 .table2 140pt
1695 .irow &_Local_&           "an empty directory for local configuration files"
1696 .irow &_OS_&              "OS-specific files"
1697 .irow &_doc_&             "documentation files"
1698 .irow &_exim_monitor_&    "source files for the Exim monitor"
1699 .irow &_scripts_&         "scripts used in the build process"
1700 .irow &_src_&             "remaining source files"
1701 .irow &_util_&            "independent utilities"
1702 .endtable
1703
1704 The main utility programs are contained in the &_src_& directory and are built
1705 with the Exim binary. The &_util_& directory contains a few optional scripts
1706 that may be useful to some sites.
1707
1708
1709 .section "Multiple machine architectures and operating systems" "SECID24"
1710 .cindex "building Exim" "multiple OS/architectures"
1711 The building process for Exim is arranged to make it easy to build binaries for
1712 a number of different architectures and operating systems from the same set of
1713 source files. Compilation does not take place in the &_src_& directory.
1714 Instead, a &'build directory'& is created for each architecture and operating
1715 system.
1716 .cindex "symbolic link" "to build directory"
1717 Symbolic links to the sources are installed in this directory, which is where
1718 the actual building takes place. In most cases, Exim can discover the machine
1719 architecture and operating system for itself, but the defaults can be
1720 overridden if necessary.
1721 .cindex compiler requirements
1722 .cindex compiler version
1723 A C99-capable compiler will be required for the build.
1724
1725
1726 .section "PCRE2 library" "SECTpcre"
1727 .cindex "PCRE2 library"
1728 Exim no longer has an embedded regular-expression library as the vast majority of
1729 modern systems include PCRE2 as a system library, although you may need to
1730 install the PCRE2 package or the PCRE2 development package for your operating
1731 system. If your system has a normal PCRE2 installation the Exim build
1732 process will need no further configuration. If the library or the
1733 headers are in an unusual location you will need to either set the PCRE2_LIBS
1734 and INCLUDE directives appropriately,
1735 or set PCRE2_CONFIG=yes to use the installed &(pcre-config)& command.
1736 If your operating system has no
1737 PCRE2 support then you will need to obtain and build the current PCRE2
1738 from &url(https://github.com/PhilipHazel/pcre2/releases).
1739 More information on PCRE2 is available at &url(https://www.pcre.org/).
1740
1741 .section "DBM libraries" "SECTdb"
1742 .cindex "DBM libraries" "discussion of"
1743 .cindex "hints database" "DBM files used for"
1744 Even if you do not use any DBM files in your configuration, Exim still needs a
1745 DBM library in order to operate, because it uses indexed files for its hints
1746 databases. Unfortunately, there are a number of DBM libraries in existence, and
1747 different operating systems often have different ones installed.
1748
1749 .cindex "Solaris" "DBM library for"
1750 .cindex "IRIX, DBM library for"
1751 .cindex "BSD, DBM library for"
1752 .cindex "Linux, DBM library for"
1753 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1754 Linux distribution, the DBM configuration should happen automatically, and you
1755 may be able to ignore this section. Otherwise, you may have to learn more than
1756 you would like about DBM libraries from what follows.
1757
1758 .cindex "&'ndbm'& DBM library"
1759 Licensed versions of Unix normally contain a library of DBM functions operating
1760 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1761 versions of Unix seem to vary in what they contain as standard. In particular,
1762 some early versions of Linux have no default DBM library, and different
1763 distributors have chosen to bundle different libraries with their packaged
1764 versions. However, the more recent releases seem to have standardized on the
1765 Berkeley DB library.
1766
1767 .new
1768 Ownership of the Berkeley DB library has moved to a major corporation;
1769 development seems to have stalled and documentation is not freely available.
1770 This is probably not tenable for the long term use by Exim.
1771 .wen
1772
1773 Different DBM libraries have different conventions for naming the files they
1774 use. When a program opens a file called &_dbmfile_&, there are several
1775 possibilities:
1776
1777 .olist
1778 A traditional &'ndbm'& implementation, such as that supplied as part of
1779 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1780 .next
1781 .cindex "&'gdbm'& DBM library"
1782 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1783 compatibility interface it makes two different hard links to it with names
1784 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1785 filename is used unmodified.
1786 .next
1787 .cindex "Berkeley DB library"
1788 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1789 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1790 programmer exactly the same as the traditional &'ndbm'& implementation.
1791 .next
1792 If the Berkeley package is used in its native mode, it operates on a single
1793 file called &_dbmfile_&; the programmer's interface is somewhat different to
1794 the traditional &'ndbm'& interface.
1795 .next
1796 To complicate things further, there are several very different versions of the
1797 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1798 2.&'x'& and 3.&'x'& were current for a while,
1799 but the latest versions when Exim last revamped support were numbered 5.&'x'&.
1800 Maintenance of some of the earlier releases has ceased,
1801 and Exim no longer supports versions before 3.&'x'&.
1802 All versions of Berkeley DB could be obtained from
1803 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1804 page with far newer versions listed.
1805 It is probably wise to plan to move your storage configurations away from
1806 Berkeley DB format, as today there are smaller and simpler alternatives more
1807 suited to Exim's usage model.
1808 .next
1809 .cindex "&'tdb'& DBM library"
1810 Yet another DBM library, called &'tdb'&, is available from
1811 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1812 operates on a single file.
1813 .next
1814 It is possible to use sqlite3 (&url(https://www.sqlite.org/index.html))
1815 for the DBM library.
1816 .endlist
1817
1818 .cindex "USE_DB"
1819 .cindex "DBM libraries" "configuration for building"
1820 Exim and its utilities can be compiled to use any of these interfaces. In order
1821 to use any version of the Berkeley DB package in native mode, you must set
1822 USE_DB in an appropriate configuration file (typically
1823 &_Local/Makefile_&). For example:
1824 .code
1825 USE_DB=yes
1826 .endd
1827 Similarly, for gdbm you set USE_GDBM, for tdb you set USE_TDB,
1828 and for sqlite3 you set USE_SQLITE.
1829 An error is diagnosed if you set more than one of these.
1830 You can set USE_NDBM if needed to override an operating system default.
1831
1832 At the lowest level, the build-time configuration sets none of these options,
1833 thereby assuming an interface of type (1). However, some operating system
1834 configuration files (for example, those for the BSD operating systems and
1835 Linux) assume type (4) by setting USE_DB as their default, and the
1836 configuration files for Cygwin set USE_GDBM. Anything you set in
1837 &_Local/Makefile_&, however, overrides these system defaults.
1838
1839 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1840 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1841 in one of these lines:
1842 .code
1843 DBMLIB = -ldb
1844 DBMLIB = -ltdb
1845 DBMLIB = -lsqlite3
1846 DBMLIB = -lgdbm -lgdbm_compat
1847 .endd
1848 The last of those was for a Linux having GDBM provide emulated NDBM facilities.
1849 Settings like that will work if the DBM library is installed in the standard
1850 place. Sometimes it is not, and the library's header file may also not be in
1851 the default path. You may need to set INCLUDE to specify where the header
1852 file is, and to specify the path to the library more fully in DBMLIB, as in
1853 this example:
1854 .code
1855 INCLUDE=-I/usr/local/include/db-4.1
1856 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1857 .endd
1858 There is further detailed discussion about the various DBM libraries in the
1859 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1860
1861 .new
1862 When moving from one DBM library to another,
1863 for the hints databases it suffices to just remove all the files in the
1864 directory named &"db/"& under the spool directory.
1865 This is because hints are only for optimisation and will be rebuilt
1866 during normal operations.
1867 Non-hints DBM databases (used by &"dbm"& lookups in the configuration)
1868 will need individual rebuilds for the new DBM library.
1869 This is not done automatically
1870 .wen
1871
1872
1873
1874 .section "Pre-building configuration" "SECID25"
1875 .cindex "building Exim" "pre-building configuration"
1876 .cindex "configuration for building Exim"
1877 .cindex "&_Local/Makefile_&"
1878 .cindex "&_src/EDITME_&"
1879 Before building Exim, a local configuration file that specifies options
1880 independent of any operating system has to be created with the name
1881 &_Local/Makefile_&. A template for this file is supplied as the file
1882 &_src/EDITME_&, and it contains full descriptions of all the option settings
1883 therein. These descriptions are therefore not repeated here. If you are
1884 building Exim for the first time, the simplest thing to do is to copy
1885 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1886
1887 There are three settings that you must supply, because Exim will not build
1888 without them. They are the location of the runtime configuration file
1889 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1890 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1891 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1892 a colon-separated list of filenames; Exim uses the first of them that exists.
1893
1894 There are a few other parameters that can be specified either at build time or
1895 at runtime, to enable the same binary to be used on a number of different
1896 machines. However, if the locations of Exim's spool directory and log file
1897 directory (if not within the spool directory) are fixed, it is recommended that
1898 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1899 detected early in Exim's execution (such as a malformed configuration file) can
1900 be logged.
1901
1902 .cindex "content scanning" "specifying at build time"
1903 Exim's interfaces for calling virus and spam scanning software directly from
1904 access control lists are not compiled by default. If you want to include these
1905 facilities, you need to set
1906 .code
1907 WITH_CONTENT_SCAN=yes
1908 .endd
1909 in your &_Local/Makefile_&. For details of the facilities themselves, see
1910 chapter &<<CHAPexiscan>>&.
1911
1912
1913 .cindex "&_Local/eximon.conf_&"
1914 .cindex "&_exim_monitor/EDITME_&"
1915 If you are going to build the Exim monitor, a similar configuration process is
1916 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1917 your installation and saved under the name &_Local/eximon.conf_&. If you are
1918 happy with the default settings described in &_exim_monitor/EDITME_&,
1919 &_Local/eximon.conf_& can be empty, but it must exist.
1920
1921 This is all the configuration that is needed in straightforward cases for known
1922 operating systems. However, the building process is set up so that it is easy
1923 to override options that are set by default or by operating-system-specific
1924 configuration files, for example, to change the C compiler, which
1925 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1926 do this.
1927
1928
1929
1930 .section "Support for iconv()" "SECID26"
1931 .cindex "&[iconv()]& support"
1932 .cindex "RFC 2047"
1933 The contents of header lines in messages may be encoded according to the rules
1934 described RFC 2047. This makes it possible to transmit characters that are not
1935 in the ASCII character set, and to label them as being in a particular
1936 character set. When Exim is inspecting header lines by means of the &%$h_%&
1937 mechanism, it decodes them, and translates them into a specified character set
1938 (default is set at build time). The translation is possible only if the operating system
1939 supports the &[iconv()]& function.
1940
1941 However, some of the operating systems that supply &[iconv()]& do not support
1942 very many conversions. The GNU &%libiconv%& library (available from
1943 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1944 systems to remedy this deficiency, as well as on systems that do not supply
1945 &[iconv()]& at all. After installing &%libiconv%&, you should add
1946 .code
1947 HAVE_ICONV=yes
1948 .endd
1949 to your &_Local/Makefile_& and rebuild Exim.
1950
1951
1952
1953 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1954 .cindex "TLS" "including support for TLS"
1955 .cindex "encryption" "including support for"
1956 .cindex "OpenSSL" "building Exim with"
1957 .cindex "GnuTLS" "building Exim with"
1958 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1959 command as per RFC 2487. It can also support clients that expect to
1960 start a TLS session immediately on connection to a non-standard port (see the
1961 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1962 line option).
1963
1964 If you want to build Exim with TLS support, you must first install either the
1965 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1966 implementing SSL.
1967
1968 If you do not want TLS support you should set
1969 .code
1970 DISABLE_TLS=yes
1971 .endd
1972 in &_Local/Makefile_&.
1973
1974 If OpenSSL is installed, you should set
1975 .code
1976 USE_OPENSL=yes
1977 TLS_LIBS=-lssl -lcrypto
1978 .endd
1979 in &_Local/Makefile_&. You may also need to specify the locations of the
1980 OpenSSL library and include files. For example:
1981 .code
1982 USE_OPENSSL=yes
1983 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1984 TLS_INCLUDE=-I/usr/local/openssl/include/
1985 .endd
1986 .cindex "pkg-config" "OpenSSL"
1987 If you have &'pkg-config'& available, then instead you can just use:
1988 .code
1989 USE_OPENSSL=yes
1990 USE_OPENSSL_PC=openssl
1991 .endd
1992 .cindex "USE_GNUTLS"
1993 If GnuTLS is installed, you should set
1994 .code
1995 USE_GNUTLS=yes
1996 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1997 .endd
1998 in &_Local/Makefile_&, and again you may need to specify the locations of the
1999 library and include files. For example:
2000 .code
2001 USE_GNUTLS=yes
2002 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
2003 TLS_INCLUDE=-I/usr/gnu/include
2004 .endd
2005 .cindex "pkg-config" "GnuTLS"
2006 If you have &'pkg-config'& available, then instead you can just use:
2007 .code
2008 USE_GNUTLS=yes
2009 USE_GNUTLS_PC=gnutls
2010 .endd
2011
2012 You do not need to set TLS_INCLUDE if the relevant directory is already
2013 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
2014 given in chapter &<<CHAPTLS>>&.
2015
2016
2017
2018
2019 .section "Use of tcpwrappers" "SECID27"
2020
2021 .cindex "tcpwrappers, building Exim to support"
2022 .cindex "USE_TCP_WRAPPERS"
2023 .cindex "TCP_WRAPPERS_DAEMON_NAME"
2024 .cindex "tcp_wrappers_daemon_name"
2025 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
2026 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
2027 alternative to Exim's own checking facilities for installations that are
2028 already making use of &'tcpwrappers'& for other purposes. To do this, you
2029 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
2030 &_tcpd.h_& to be available at compile time, and also ensure that the library
2031 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
2032 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
2033 you might have
2034 .code
2035 USE_TCP_WRAPPERS=yes
2036 CFLAGS=-O -I/usr/local/include
2037 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2038 .endd
2039 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
2040 files is &"exim"&. For example, the line
2041 .code
2042 exim : LOCAL  192.168.1.  .friendly.domain.example
2043 .endd
2044 in your &_/etc/hosts.allow_& file allows connections from the local host, from
2045 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2046 All other connections are denied. The daemon name used by &'tcpwrappers'&
2047 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2048 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2049 configure file. Consult the &'tcpwrappers'& documentation for
2050 further details.
2051
2052
2053 .section "Including support for IPv6" "SECID28"
2054 .cindex "IPv6" "including support for"
2055 Exim contains code for use on systems that have IPv6 support. Setting
2056 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2057 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2058 where the IPv6 support is not fully integrated into the normal include and
2059 library files.
2060
2061 Two different types of DNS record for handling IPv6 addresses have been
2062 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2063 currently seen as the mainstream. Another record type called A6 was proposed
2064 as better than AAAA because it had more flexibility. However, it was felt to be
2065 over-complex, and its status was reduced to &"experimental"&.
2066 Exim used to
2067 have a compile option for including A6 record support but this has now been
2068 withdrawn.
2069
2070
2071
2072 .section "Dynamically loaded module support" "SECTdynamicmodules"
2073 .cindex "lookup modules"
2074 .cindex "router modules"
2075 .cindex "transport modules"
2076 .cindex "authenticator modules"
2077 .cindex "dynamic modules"
2078 .cindex ".so building"
2079 On some platforms, Exim supports not compiling all lookup types directly into
2080 the main binary, instead putting some into external modules which can be loaded
2081 on demand.
2082 This permits packagers to build Exim with support for lookups with extensive
2083 library dependencies without requiring all systems to install all of those
2084 dependencies.
2085 .new
2086 Any combination of lookup types can be built this way.
2087 All of the lookup modules found as an Exim process starts will be loaded.
2088 .wen
2089
2090 For building
2091 set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2092 installed; Exim will only load modules from that directory, as a security
2093 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2094 for your OS; see &_OS/Makefile-Linux_& for an example.
2095 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2096 see &_src/EDITME_& for details.
2097
2098 Then, for each module to be loaded dynamically, define the relevant
2099 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2100 For example, this will build in lsearch but load sqlite and mysql support
2101 only if each is installed:
2102 .code
2103 LOOKUP_LSEARCH=yes
2104 LOOKUP_SQLITE=2
2105 LOOKUP_MYSQL=2
2106 .endd
2107 Set also &`LOOKUP_`&<&'lookup_type'&>&` INCLUDE`& and
2108 &`LOOKUP_`&<&'lookup_type'&>`_LIBS if needed for each lookup type,
2109 ensuring that duplicates are not present in more global values.
2110
2111 .new
2112 Similarly, authenticator, router and transport drivers can be built
2113 as external modules.
2114 Modules will be searched for as demanded by the runtime configuration,
2115 permitting a smaller Exim binary.
2116
2117 For building, as above but using
2118 &`AUTH_*`&, &`ROUTER_*`& and &`TRANSPORT_*`& instead of &`LOOKUP_*`&,
2119 .wen
2120
2121
2122 .section "The building process" "SECID29"
2123 .cindex "build directory"
2124 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2125 created, run &'make'& at the top level. It determines the architecture and
2126 operating system types, and creates a build directory if one does not exist.
2127 For example, on a Sun system running Solaris 8, the directory
2128 &_build-SunOS5-5.8-sparc_& is created.
2129 .cindex "symbolic link" "to source files"
2130 Symbolic links to relevant source files are installed in the build directory.
2131
2132 If this is the first time &'make'& has been run, it calls a script that builds
2133 a make file inside the build directory, using the configuration files from the
2134 &_Local_& directory. The new make file is then passed to another instance of
2135 &'make'&. This does the real work, building a number of utility scripts, and
2136 then compiling and linking the binaries for the Exim monitor (if configured), a
2137 number of utility programs, and finally Exim itself. The command &`make
2138 makefile`& can be used to force a rebuild of the make file in the build
2139 directory, should this ever be necessary.
2140
2141 If you have problems building Exim, check for any comments there may be in the
2142 &_README_& file concerning your operating system, and also take a look at the
2143 FAQ, where some common problems are covered.
2144
2145
2146
2147 .section 'Output from &"make"&' "SECID283"
2148 The output produced by the &'make'& process for compile lines is often very
2149 unreadable, because these lines can be very long. For this reason, the normal
2150 output is suppressed by default, and instead output similar to that which
2151 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2152 each module that is being compiled or linked. However, it is still possible to
2153 get the full output, by calling &'make'& like this:
2154 .code
2155 FULLECHO='' make -e
2156 .endd
2157 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2158 command reflection in &'make'&. When you ask for the full output, it is
2159 given in addition to the short output.
2160
2161
2162
2163 .section "Overriding build-time options for Exim" "SECToverride"
2164 .cindex "build-time options, overriding"
2165 The main make file that is created at the beginning of the building process
2166 consists of the concatenation of a number of files which set configuration
2167 values, followed by a fixed set of &'make'& instructions. If a value is set
2168 more than once, the last setting overrides any previous ones. This provides a
2169 convenient way of overriding defaults. The files that are concatenated are, in
2170 order:
2171 .display
2172 &_OS/Makefile-Default_&
2173 &_OS/Makefile-_&<&'ostype'&>
2174 &_Local/Makefile_&
2175 &_Local/Makefile-_&<&'ostype'&>
2176 &_Local/Makefile-_&<&'archtype'&>
2177 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2178 &_OS/Makefile-Base_&
2179 .endd
2180 .cindex "&_Local/Makefile_&"
2181 .cindex "building Exim" "operating system type"
2182 .cindex "building Exim" "architecture type"
2183 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2184 architecture type. &_Local/Makefile_& is required to exist, and the building
2185 process fails if it is absent. The other three &_Local_& files are optional,
2186 and are often not needed.
2187
2188 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2189 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2190 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2191 values are used, thereby providing a means of forcing particular settings.
2192 Otherwise, the scripts try to get values from the &%uname%& command. If this
2193 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2194 of &'ad hoc'& transformations are then applied, to produce the standard names
2195 that Exim expects. You can run these scripts directly from the shell in order
2196 to find out what values are being used on your system.
2197
2198
2199 &_OS/Makefile-Default_& contains comments about the variables that are set
2200 therein. Some (but not all) are mentioned below. If there is something that
2201 needs changing, review the contents of this file and the contents of the make
2202 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2203 default values are.
2204
2205
2206 .cindex "building Exim" "overriding default settings"
2207 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2208 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2209 need to change the original files. Instead, you should make the changes by
2210 putting the new values in an appropriate &_Local_& file. For example,
2211 .cindex "Tru64-Unix build-time settings"
2212 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2213 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2214 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2215 called with the option &%-std1%&, to make it recognize some of the features of
2216 Standard C that Exim uses. (Most other compilers recognize Standard C by
2217 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2218 containing the lines
2219 .code
2220 CC=cc
2221 CFLAGS=-std1
2222 .endd
2223 If you are compiling for just one operating system, it may be easier to put
2224 these lines directly into &_Local/Makefile_&.
2225
2226 Keeping all your local configuration settings separate from the distributed
2227 files makes it easy to transfer them to new versions of Exim simply by copying
2228 the contents of the &_Local_& directory.
2229
2230
2231 .cindex "NIS lookup type" "including support for"
2232 .cindex "NIS+ lookup type" "including support for"
2233 .cindex "LDAP" "including support for"
2234 .cindex "lookup" "inclusion in binary"
2235 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2236 lookup, but not all systems have these components installed, so the default is
2237 not to include the relevant code in the binary. All the different kinds of file
2238 and database lookup that Exim supports are implemented as separate code modules
2239 which are included only if the relevant compile-time options are set. In the
2240 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2241 .code
2242 LOOKUP_LDAP=yes
2243 LOOKUP_NIS=yes
2244 LOOKUP_NISPLUS=yes
2245 .endd
2246 and similar settings apply to the other lookup types. They are all listed in
2247 &_src/EDITME_&. In many cases the relevant include files and interface
2248 libraries need to be installed before compiling Exim.
2249 .cindex "cdb" "including support for"
2250 However, there are some optional lookup types (such as cdb) for which
2251 the code is entirely contained within Exim, and no external include
2252 files or libraries are required. When a lookup type is not included in the
2253 binary, attempts to configure Exim to use it cause runtime configuration
2254 errors.
2255
2256 .cindex "pkg-config" "lookups"
2257 .cindex "pkg-config" "authenticators"
2258 Many systems now use a tool called &'pkg-config'& to encapsulate information
2259 about how to compile against a library; Exim has some initial support for
2260 being able to use pkg-config for lookups and authenticators.  For any given
2261 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2262 variable with the &`_PC`& suffix in the name and assign as the value the
2263 name of the package to be queried.  The results of querying via the
2264 &'pkg-config'& command will be added to the appropriate Makefile variables
2265 with &`+=`& directives, so your version of &'make'& will need to support that
2266 syntax.  For instance:
2267 .code
2268 LOOKUP_SQLITE=yes
2269 LOOKUP_SQLITE_PC=sqlite3
2270 AUTH_GSASL=yes
2271 AUTH_GSASL_PC=libgsasl
2272 AUTH_HEIMDAL_GSSAPI=yes
2273 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2274 .endd
2275
2276 .cindex "Perl" "including support for"
2277 Exim can be linked with an embedded Perl interpreter, allowing Perl
2278 subroutines to be called during string expansion. To enable this facility,
2279 .code
2280 EXIM_PERL=perl.o
2281 .endd
2282 must be defined in &_Local/Makefile_&. Details of this facility are given in
2283 chapter &<<CHAPperl>>&.
2284
2285 .cindex "X11 libraries, location of"
2286 The location of the X11 libraries is something that varies a lot between
2287 operating systems, and there may be different versions of X11 to cope
2288 with. Exim itself makes no use of X11, but if you are compiling the Exim
2289 monitor, the X11 libraries must be available.
2290 The following three variables are set in &_OS/Makefile-Default_&:
2291 .code
2292 X11=/usr/X11R6
2293 XINCLUDE=-I$(X11)/include
2294 XLFLAGS=-L$(X11)/lib
2295 .endd
2296 These are overridden in some of the operating-system configuration files. For
2297 example, in &_OS/Makefile-SunOS5_& there is
2298 .code
2299 X11=/usr/openwin
2300 XINCLUDE=-I$(X11)/include
2301 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2302 .endd
2303 If you need to override the default setting for your operating system, place a
2304 definition of all three of these variables into your
2305 &_Local/Makefile-<ostype>_& file.
2306
2307 .cindex "EXTRALIBS"
2308 If you need to add any extra libraries to the link steps, these can be put in a
2309 variable called EXTRALIBS, which appears in all the link commands, but by
2310 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2311 command for linking the main Exim binary, and not for any associated utilities.
2312
2313 .cindex "DBM libraries" "configuration for building"
2314 There is also DBMLIB, which appears in the link commands for binaries that
2315 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2316 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2317 binary, and which can be used, for example, to include additional X11
2318 libraries.
2319
2320 .cindex "configuration file" "editing"
2321 The make file copes with rebuilding Exim correctly if any of the configuration
2322 files are edited. However, if an optional configuration file is deleted, it is
2323 necessary to touch the associated non-optional file (that is,
2324 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2325
2326
2327 .section "OS-specific header files" "SECID30"
2328 .cindex "&_os.h_&"
2329 .cindex "building Exim" "OS-specific C header files"
2330 The &_OS_& directory contains a number of files with names of the form
2331 &_os.h-<ostype>_&. These are system-specific C header files that should not
2332 normally need to be changed. There is a list of macro settings that are
2333 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2334 are porting Exim to a new operating system.
2335
2336
2337
2338 .section "Overriding build-time options for the monitor" "SECID31"
2339 .cindex "building Eximon"
2340 A similar process is used for overriding things when building the Exim monitor,
2341 where the files that are involved are
2342 .display
2343 &_OS/eximon.conf-Default_&
2344 &_OS/eximon.conf-_&<&'ostype'&>
2345 &_Local/eximon.conf_&
2346 &_Local/eximon.conf-_&<&'ostype'&>
2347 &_Local/eximon.conf-_&<&'archtype'&>
2348 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2349 .endd
2350 .cindex "&_Local/eximon.conf_&"
2351 As with Exim itself, the final three files need not exist, and in this case the
2352 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2353 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2354 variables of the same name, preceded by EXIMON_. For example, setting
2355 EXIMON_LOG_DEPTH in the environment overrides the value of
2356 LOG_DEPTH at runtime.
2357 .ecindex IIDbuex
2358
2359
2360 .section "Installing Exim binaries and scripts" "SECID32"
2361 .cindex "installing Exim"
2362 .cindex "BIN_DIRECTORY"
2363 The command &`make install`& runs the &(exim_install)& script with no
2364 arguments. The script copies binaries and utility scripts into the directory
2365 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2366 .cindex "setuid" "installing Exim with"
2367 The install script copies files only if they are newer than the files they are
2368 going to replace. The Exim binary is required to be owned by root and have the
2369 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2370 install`& as root so that it can set up the Exim binary in this way. However, in
2371 some special situations (for example, if a host is doing no local deliveries)
2372 it may be possible to run Exim without making the binary setuid root (see
2373 chapter &<<CHAPsecurity>>& for details).
2374
2375 .cindex "CONFIGURE_FILE"
2376 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2377 in &_Local/Makefile_&. If this names a single file, and the file does not
2378 exist, the default configuration file &_src/configure.default_& is copied there
2379 by the installation script. If a runtime configuration file already exists, it
2380 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2381 alternative files, no default is installed.
2382
2383 .cindex "system aliases file"
2384 .cindex "&_/etc/aliases_&"
2385 One change is made to the default configuration file when it is installed: the
2386 default configuration contains a router that references a system aliases file.
2387 The path to this file is set to the value specified by
2388 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2389 If the system aliases file does not exist, the installation script creates it,
2390 and outputs a comment to the user.
2391
2392 The created file contains no aliases, but it does contain comments about the
2393 aliases a site should normally have. Mail aliases have traditionally been
2394 kept in &_/etc/aliases_&. However, some operating systems are now using
2395 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2396 Exim's configuration if necessary.
2397
2398 The default configuration uses the local host's name as the only local domain,
2399 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2400 running as the local user. System aliases and &_.forward_& files in users' home
2401 directories are supported, but no NIS or NIS+ support is configured. Domains
2402 other than the name of the local host are routed using the DNS, with delivery
2403 over SMTP.
2404
2405 It is possible to install Exim for special purposes (such as building a binary
2406 distribution) in a private part of the file system. You can do this by a
2407 command such as
2408 .code
2409 make DESTDIR=/some/directory/ install
2410 .endd
2411 This has the effect of pre-pending the specified directory to all the file
2412 paths, except the name of the system aliases file that appears in the default
2413 configuration. (If a default alias file is created, its name &'is'& modified.)
2414 For backwards compatibility, ROOT is used if DESTDIR is not set,
2415 but this usage is deprecated.
2416
2417 .cindex "installing Exim" "what is not installed"
2418 Running &'make install'& does not copy the Exim 4 conversion script
2419 &'convert4r4'&. You will probably run this only once if you are
2420 upgrading from Exim 3. None of the documentation files in the &_doc_&
2421 directory are copied, except for the info files when you have set
2422 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2423
2424 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2425 to their names. The Exim binary itself, however, is handled differently. It is
2426 installed under a name that includes the version number and the compile number,
2427 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2428 called &_exim_& to point to the binary. If you are updating a previous version
2429 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2430 from the directory (as seen by other processes).
2431
2432 .cindex "installing Exim" "testing the script"
2433 If you want to see what the &'make install'& will do before running it for
2434 real, you can pass the &%-n%& option to the installation script by this
2435 command:
2436 .code
2437 make INSTALL_ARG=-n install
2438 .endd
2439 The contents of the variable INSTALL_ARG are passed to the installation
2440 script. You do not need to be root to run this test. Alternatively, you can run
2441 the installation script directly, but this must be from within the build
2442 directory. For example, from the top-level Exim directory you could use this
2443 command:
2444 .code
2445 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2446 .endd
2447 .cindex "installing Exim" "install script options"
2448 There are two other options that can be supplied to the installation script.
2449
2450 .ilist
2451 &%-no_chown%& bypasses the call to change the owner of the installed binary
2452 to root, and the call to make it a setuid binary.
2453 .next
2454 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2455 installed binary.
2456 .endlist
2457
2458 INSTALL_ARG can be used to pass these options to the script. For example:
2459 .code
2460 make INSTALL_ARG=-no_symlink install
2461 .endd
2462 The installation script can also be given arguments specifying which files are
2463 to be copied. For example, to install just the Exim binary, and nothing else,
2464 without creating the symbolic link, you could use:
2465 .code
2466 make INSTALL_ARG='-no_symlink exim' install
2467 .endd
2468
2469
2470
2471 .section "Installing info documentation" "SECTinsinfdoc"
2472 .cindex "installing Exim" "&'info'& documentation"
2473 Not all systems use the GNU &'info'& system for documentation, and for this
2474 reason, the Texinfo source of Exim's documentation is not included in the main
2475 distribution. Instead it is available separately from the FTP site (see section
2476 &<<SECTavail>>&).
2477
2478 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2479 source of the documentation is found in the source tree, running &`make
2480 install`& automatically builds the info files and installs them.
2481
2482
2483
2484 .section "Setting up the spool directory" "SECID33"
2485 .cindex "spool directory" "creating"
2486 When it starts up, Exim tries to create its spool directory if it does not
2487 exist. The Exim uid and gid are used for the owner and group of the spool
2488 directory. Sub-directories are automatically created in the spool directory as
2489 necessary.
2490
2491
2492
2493
2494 .section "Testing" "SECID34"
2495 .cindex "testing" "installation"
2496 Having installed Exim, you can check that the runtime configuration file is
2497 syntactically valid by running the following command, which assumes that the
2498 Exim binary directory is within your PATH environment variable:
2499 .code
2500 exim -bV
2501 .endd
2502 If there are any errors in the configuration file, Exim outputs error messages.
2503 Otherwise it outputs the version number and build date,
2504 the DBM library that is being used, and information about which drivers and
2505 other optional code modules are included in the binary.
2506 Some simple routing tests can be done by using the address testing option. For
2507 example,
2508 .display
2509 &`exim -bt`& <&'local username'&>
2510 .endd
2511 should verify that it recognizes a local mailbox, and
2512 .display
2513 &`exim -bt`& <&'remote address'&>
2514 .endd
2515 a remote one. Then try getting it to deliver mail, both locally and remotely.
2516 This can be done by passing messages directly to Exim, without going through a
2517 user agent. For example:
2518 .code
2519 exim -v postmaster@your.domain.example
2520 From: user@your.domain.example
2521 To: postmaster@your.domain.example
2522 Subject: Testing Exim
2523
2524 This is a test message.
2525 ^D
2526 .endd
2527 The &%-v%& option causes Exim to output some verification of what it is doing.
2528 In this case you should see copies of three log lines, one for the message's
2529 arrival, one for its delivery, and one containing &"Completed"&.
2530
2531 .cindex "delivery" "problems with"
2532 If you encounter problems, look at Exim's log files (&'mainlog'& and
2533 &'paniclog'&) to see if there is any relevant information there. Another source
2534 of information is running Exim with debugging turned on, by specifying the
2535 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2536 with debugging turned on by a command of the form
2537 .display
2538 &`exim -d -M`& <&'exim-message-id'&>
2539 .endd
2540 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2541 produces rather a lot of output, but you can cut this down to specific areas.
2542 For example, if you use &%-d-all+route%& only the debugging information
2543 relevant to routing is included. (See the &%-d%& option in chapter
2544 &<<CHAPcommandline>>& for more details.)
2545
2546 .cindex '&"sticky"& bit'
2547 .cindex "lock files"
2548 One specific problem that has shown up on some sites is the inability to do
2549 local deliveries into a shared mailbox directory, because it does not have the
2550 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2551 writing to a mailbox file, and if it cannot create the lock file, the delivery
2552 is deferred. You can get round this either by setting the &"sticky bit"& on the
2553 directory, or by setting a specific group for local deliveries and allowing
2554 that group to create files in the directory (see the comments above the
2555 &(local_delivery)& transport in the default configuration file). Another
2556 approach is to configure Exim not to use lock files, but just to rely on
2557 &[fcntl()]& locking instead. However, you should do this only if all user
2558 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2559 see chapter &<<CHAPappendfile>>&.
2560
2561 One thing that cannot be tested on a system that is already running an MTA is
2562 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2563 &%-oX%& option can be used to run an Exim daemon that listens on some other
2564 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2565 &'exim_checkaccess'& utility can be used to check out policy controls on
2566 incoming SMTP mail.
2567
2568 Testing a new version on a system that is already running Exim can most easily
2569 be done by building a binary with a different CONFIGURE_FILE setting. From
2570 within the runtime configuration, all other file and directory names
2571 that Exim uses can be altered, in order to keep it entirely clear of the
2572 production version.
2573
2574
2575 .section "Replacing another MTA with Exim" "SECID35"
2576 .cindex "replacing another MTA"
2577 Building and installing Exim for the first time does not of itself put it in
2578 general use. The name by which the system's MTA is called by mail user agents
2579 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2580 operating system), and it is necessary to make this name point to the &'exim'&
2581 binary in order to get the user agents to pass messages to Exim. This is
2582 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2583 or &_/usr/lib/sendmail_&
2584 .cindex "symbolic link" "to &'exim'& binary"
2585 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2586 privilege and executable status from the old MTA. It is then necessary to stop
2587 and restart the mailer daemon, if one is running.
2588
2589 .cindex "FreeBSD, MTA indirection"
2590 .cindex "&_/etc/mail/mailer.conf_&"
2591 Some operating systems have introduced alternative ways of switching MTAs. For
2592 example, if you are running FreeBSD, you need to edit the file
2593 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2594 described. A typical example of the contents of this file for running Exim is
2595 as follows:
2596 .code
2597 sendmail            /usr/exim/bin/exim
2598 send-mail           /usr/exim/bin/exim
2599 mailq               /usr/exim/bin/exim -bp
2600 newaliases          /usr/bin/true
2601 .endd
2602 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2603 your Exim installation is &"live"&. Check it by sending a message from your
2604 favourite user agent.
2605
2606 You should consider what to tell your users about the change of MTA. Exim may
2607 have different capabilities to what was previously running, and there are
2608 various operational differences such as the text of messages produced by
2609 command line options and in bounce messages. If you allow your users to make
2610 use of Exim's filtering capabilities, you should make the document entitled
2611 &'Exim's interface to mail filtering'& available to them.
2612
2613
2614
2615 .section "Running the daemon" SECTdaemonLaunch
2616 The most common command line for launching the Exim daemon looks like
2617 .code
2618 exim -bd -q5m
2619 .endd
2620 This starts a daemon which
2621 .ilist
2622 listens for incoming smtp connections, launching handler processes for
2623 each new one
2624 .next
2625 starts a queue-runner process every five minutes, to inspect queued messages
2626 and run delivery attempts on any that have arrived at their retry time
2627 .endlist
2628 Should a queue run take longer than the time between queue-runner starts,
2629 they will run in parallel.
2630 Numbers of jobs of the various types are subject to policy controls
2631 defined in the configuration.
2632
2633
2634 .section "Upgrading Exim" "SECID36"
2635 .cindex "upgrading Exim"
2636 If you are already running Exim on your host, building and installing a new
2637 version automatically makes it available to MUAs, or any other programs that
2638 call the MTA directly. However, if you are running an Exim daemon, you do need
2639 .cindex restart "on HUP signal"
2640 .cindex signal "HUP, to restart"
2641 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2642 new binary. You do not need to stop processing mail in order to install a new
2643 version of Exim. The install script does not modify an existing runtime
2644 configuration file.
2645
2646
2647
2648
2649 .section "Stopping the Exim daemon on Solaris" "SECID37"
2650 .cindex "Solaris" "stopping Exim on"
2651 The standard command for stopping the mailer daemon on Solaris is
2652 .code
2653 /etc/init.d/sendmail stop
2654 .endd
2655 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2656 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2657 for the text &"sendmail"&; this is not present because the actual program name
2658 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2659 solution is to replace the line that finds the process id with something like
2660 .code
2661 pid=`cat /var/spool/exim/exim-daemon.pid`
2662 .endd
2663 to obtain the daemon's pid directly from the file that Exim saves it in.
2664
2665 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2666 still be received from local processes, and if automatic delivery is configured
2667 (the normal case), deliveries will still occur.
2668
2669
2670
2671
2672 . ////////////////////////////////////////////////////////////////////////////
2673 . ////////////////////////////////////////////////////////////////////////////
2674
2675 .chapter "The Exim command line" "CHAPcommandline"
2676 .scindex IIDclo1 "command line" "options"
2677 .scindex IIDclo2 "options" "command line"
2678 Exim's command line takes the standard Unix form of a sequence of options,
2679 each starting with a hyphen character, followed by a number of arguments. The
2680 options are compatible with the main options of Sendmail, and there are also
2681 some additional options, some of which are compatible with Smail 3. Certain
2682 combinations of options do not make sense, and provoke an error if used.
2683 The form of the arguments depends on which options are set.
2684
2685
2686 .section "Setting options by program name" "SECID38"
2687 .cindex "&'mailq'&"
2688 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2689 were present before any other options.
2690 The &%-bp%& option requests a listing of the contents of the mail queue on the
2691 standard output.
2692 This feature is for compatibility with some systems that contain a command of
2693 that name in one of the standard libraries, symbolically linked to
2694 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2695
2696 .cindex "&'rsmtp'&"
2697 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2698 were present before any other options, for compatibility with Smail. The
2699 &%-bS%& option is used for reading in a number of messages in batched SMTP
2700 format.
2701
2702 .cindex "&'rmail'&"
2703 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2704 &%-oee%& options were present before any other options, for compatibility with
2705 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2706
2707 .cindex "&'runq'&"
2708 .cindex "queue runner"
2709 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2710 were present before any other options, for compatibility with Smail. The &%-q%&
2711 option causes a single queue runner process to be started.
2712
2713 .cindex "&'newaliases'&"
2714 .cindex "alias file" "building"
2715 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2716 If Exim is called under the name &'newaliases'& it behaves as if the option
2717 &%-bi%& were present before any other options, for compatibility with Sendmail.
2718 This option is used for rebuilding Sendmail's alias file. Exim does not have
2719 the concept of a single alias file, but can be configured to run a given
2720 command if called with the &%-bi%& option.
2721
2722
2723 .section "Trusted and admin users" "SECTtrustedadmin"
2724 Some Exim options are available only to &'trusted users'& and others are
2725 available only to &'admin users'&. In the description below, the phrases &"Exim
2726 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2727 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2728 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2729
2730 .ilist
2731 .cindex "trusted users" "definition of"
2732 .cindex "user" "trusted definition of"
2733 The trusted users are root, the Exim user, any user listed in the
2734 &%trusted_users%& configuration option, and any user whose current group or any
2735 supplementary group is one of those listed in the &%trusted_groups%&
2736 configuration option. Note that the Exim group is not automatically trusted.
2737
2738 .cindex '&"From"& line'
2739 .cindex "envelope from"
2740 .cindex "envelope sender"
2741 Trusted users are always permitted to use the &%-f%& option or a leading
2742 &"From&~"& line to specify the envelope sender of a message that is passed to
2743 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2744 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2745 users to set envelope senders.
2746
2747 .chindex From:
2748 .chindex Sender:
2749 For a trusted user, there is never any check on the contents of the &'From:'&
2750 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2751 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2752
2753 Trusted users may also specify a host name, host address, interface address,
2754 protocol name, ident value, and authentication data when submitting a message
2755 locally. Thus, they are able to insert messages into Exim's queue locally that
2756 have the characteristics of messages received from a remote host. Untrusted
2757 users may in some circumstances use &%-f%&, but can never set the other values
2758 that are available to trusted users.
2759 .next
2760 .cindex "user" "admin definition of"
2761 .cindex "admin user" "definition of"
2762 The admin users are root, the Exim user, and any user that is a member of the
2763 Exim group or of any group listed in the &%admin_groups%& configuration option.
2764 The current group does not have to be one of these groups.
2765
2766 Admin users are permitted to list the queue, and to carry out certain
2767 operations on messages, for example, to force delivery failures. It is also
2768 necessary to be an admin user in order to see the full information provided by
2769 the Exim monitor, and full debugging output.
2770
2771 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2772 Exim to attempt delivery of messages on its queue is restricted to admin users.
2773 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2774 option false (that is, specifying &%no_prod_requires_admin%&).
2775
2776 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2777 is restricted to admin users unless &%queue_list_requires_admin%& is set
2778 false.
2779 .endlist
2780
2781
2782 &*Warning*&: If you configure your system so that admin users are able to
2783 edit Exim's configuration file, you are giving those users an easy way of
2784 getting root. There is further discussion of this issue at the start of chapter
2785 &<<CHAPconf>>&.
2786
2787
2788
2789
2790 .section "Command line options" "SECID39"
2791 Exim's command line options are described in alphabetical order below. If none
2792 of the options that specifies a specific action (such as starting the daemon or
2793 a queue runner, or testing an address, or receiving a message in a specific
2794 format, or listing the queue) are present, and there is at least one argument
2795 on the command line, &%-bm%& (accept a local message on the standard input,
2796 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2797 outputs a brief message about itself and exits.
2798
2799 . ////////////////////////////////////////////////////////////////////////////
2800 . Insert a stylized XML comment here, to identify the start of the command line
2801 . options. This is for the benefit of the Perl script that automatically
2802 . creates a man page for the options.
2803 . ////////////////////////////////////////////////////////////////////////////
2804
2805 .literal xml
2806 <!-- === Start of command line options === -->
2807 .literal off
2808
2809
2810 .vlist
2811 .cmdopt "--" "--"
2812 .cindex "options" "command line; terminating"
2813 This is a pseudo-option whose only purpose is to terminate the options and
2814 therefore to cause subsequent command line items to be treated as arguments
2815 rather than options, even if they begin with hyphens.
2816
2817 .cmdopt --help
2818 This option causes Exim to output a few sentences stating what it is.
2819 The same output is generated if the Exim binary is called with no options and
2820 no arguments.
2821
2822 .cmdopt --version
2823 This option is an alias for &%-bV%& and causes version information to be
2824 displayed.
2825
2826 .vitem &%-Ac%& &&&
2827        &%-Am%&
2828 .oindex "&%-Ac%&"
2829 .oindex "&%-Am%&"
2830 These options are used by Sendmail for selecting configuration files and are
2831 ignored by Exim.
2832
2833 .cmdopt -B <&'type'&>
2834 .oindex "&%-B%&"
2835 .cindex "8-bit characters"
2836 .cindex "Sendmail compatibility" "8-bit characters"
2837 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2838 clean; it ignores this option.
2839
2840 .cmdopt -bd
2841 .cindex "daemon"
2842 .cindex "SMTP" "listener"
2843 .cindex "queue runner"
2844 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2845 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2846 that the daemon should also initiate periodic queue runs.
2847
2848 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2849 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2850 disconnect from the controlling terminal. When running this way, it can be
2851 stopped by pressing ctrl-C.
2852
2853 By default, Exim listens for incoming connections to the standard SMTP port on
2854 all the host's running interfaces. However, it is possible to listen on other
2855 ports, on multiple ports, and only on specific interfaces. Chapter
2856 &<<CHAPinterfaces>>& contains a description of the options that control this.
2857
2858 When a listening daemon
2859 .cindex "daemon" "process id (pid)"
2860 .cindex "pid (process id)" "of daemon"
2861 is started without the use of &%-oX%& (that is, without overriding the normal
2862 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2863 in Exim's spool directory. This location can be overridden by setting
2864 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2865 running as root.
2866
2867 When &%-oX%& is used on the command line to start a listening daemon, the
2868 process id is not written to the normal pid file path. However, &%-oP%& can be
2869 used to specify a path on the command line if a pid file is required.
2870
2871 The SIGHUP signal
2872 .cindex "SIGHUP"
2873 .cindex restart "on HUP signal"
2874 .cindex signal "HUP, to restart"
2875 .cindex "daemon" "restarting"
2876 .cindex signal "to reload configuration"
2877 .cindex daemon "reload configuration"
2878 .cindex reload configuration
2879 can be used to cause the daemon to re-execute itself. This should be done
2880 whenever Exim's configuration file, or any file that is incorporated into it by
2881 means of the &%.include%& facility, is changed, and also whenever a new version
2882 of Exim is installed. It is not necessary to do this when other files that are
2883 referenced from the configuration (for example, alias files) are changed,
2884 because these are reread each time they are used.
2885
2886 Either a SIGTERM or a SIGINT signal should be used to cause the daemon
2887 to cleanly shut down.
2888 Subprocesses handling recceiving or delivering messages,
2889 or for scanning the queue,
2890 will not be affected by the termination of the daemon process.
2891
2892 .cmdopt -bdf
2893 This option has the same effect as &%-bd%& except that it never disconnects
2894 from the controlling terminal, even when no debugging is specified.
2895
2896 .cmdopt -be
2897 .cindex "testing" "string expansion"
2898 .cindex "expansion" "testing"
2899 Run Exim in expansion testing mode. Exim discards its root privilege, to
2900 prevent ordinary users from using this mode to read otherwise inaccessible
2901 files. If no arguments are given, Exim runs interactively, prompting for lines
2902 of data. Otherwise, it processes each argument in turn.
2903
2904 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2905 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2906 used without command line arguments. If successful, it uses the &[readline()]&
2907 function, which provides extensive line-editing facilities, for reading the
2908 test data. A line history is supported.
2909
2910 Long expansion expressions can be split over several lines by using backslash
2911 continuations. As in Exim's runtime configuration, white space at the start of
2912 continuation lines is ignored. Each argument or data line is passed through the
2913 string expansion mechanism, and the result is output. Variable values from the
2914 configuration file (for example, &$qualify_domain$&) are available, but no
2915 message-specific values (such as &$message_exim_id$&) are set, because no message
2916 is being processed (but see &%-bem%& and &%-Mset%&).
2917
2918 &*Note*&: If you use this mechanism to test lookups, and you change the data
2919 files or databases you are using, you must exit and restart Exim before trying
2920 the same lookup again. Otherwise, because each Exim process caches the results
2921 of lookups, you will just get the same result as before.
2922
2923 Macro processing is done on lines before string-expansion: new macros can be
2924 defined and macros will be expanded.
2925 Because macros in the config file are often used for secrets, those are only
2926 available to admin users.
2927
2928 The word &"set"& at the start of a line, followed by a single space,
2929 is recognised specially as defining a value for a variable.
2930 .cindex "tainted data" "expansion testing"
2931 If the sequence &",t"& is inserted before the space,
2932 the value is marked as tainted.
2933 The syntax is otherwise the same as the ACL modifier &"set ="&.
2934
2935 .cmdopt -bem <&'filename'&>
2936 .cindex "testing" "string expansion"
2937 .cindex "expansion" "testing"
2938 This option operates like &%-be%& except that it must be followed by the name
2939 of a file. For example:
2940 .code
2941 exim -bem /tmp/testmessage
2942 .endd
2943 The file is read as a message (as if receiving a locally-submitted non-SMTP
2944 message) before any of the test expansions are done. Thus, message-specific
2945 variables such as &$message_size$& and &$header_from:$& are available. However,
2946 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2947 recipients are read from the headers in the normal way, and are shown in the
2948 &$recipients$& variable. Note that recipients cannot be given on the command
2949 line, because further arguments are taken as strings to expand (just like
2950 &%-be%&).
2951
2952 .cmdopt -bF <&'filename'&>
2953 .cindex "system filter" "testing"
2954 .cindex "testing" "system filter"
2955 This option is the same as &%-bf%& except that it assumes that the filter being
2956 tested is a system filter. The additional commands that are available only in
2957 system filters are recognized.
2958
2959 .cmdopt -bf <&'filename'&>
2960 .cindex "filter" "testing"
2961 .cindex "testing" "filter file"
2962 .cindex "forward file" "testing"
2963 .cindex "testing" "forward file"
2964 .cindex "Sieve filter" "testing"
2965 This option runs Exim in user filter testing mode; the file is the filter file
2966 to be tested, and a test message must be supplied on the standard input. If
2967 there are no message-dependent tests in the filter, an empty file can be
2968 supplied.
2969
2970 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2971 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2972 filter and a user filter in the same run. For example:
2973 .code
2974 exim -bF /system/filter -bf /user/filter </test/message
2975 .endd
2976 This is helpful when the system filter adds header lines or sets filter
2977 variables that are used by the user filter.
2978
2979 If the test filter file does not begin with one of the special lines
2980 .code
2981 # Exim filter
2982 # Sieve filter
2983 .endd
2984 it is taken to be a normal &_.forward_& file, and is tested for validity under
2985 that interpretation. See sections &<<SECTitenonfilred>>& to
2986 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2987 redirection lists.
2988
2989 The result of an Exim command that uses &%-bf%&, provided no errors are
2990 detected, is a list of the actions that Exim would try to take if presented
2991 with the message for real. More details of filter testing are given in the
2992 separate document entitled &'Exim's interfaces to mail filtering'&.
2993
2994 When testing a filter file,
2995 .cindex "&""From""& line"
2996 .cindex "envelope from"
2997 .cindex "envelope sender"
2998 .oindex "&%-f%&" "for filter testing"
2999 the envelope sender can be set by the &%-f%& option,
3000 or by a &"From&~"& line at the start of the test message. Various parameters
3001 that would normally be taken from the envelope recipient address of the message
3002 can be set by means of additional command line options (see the next four
3003 options).
3004
3005 .cmdopt -bfd <&'domain'&>
3006 .vindex "&$qualify_domain$&"
3007 This sets the domain of the recipient address when a filter file is being
3008 tested by means of the &%-bf%& option. The default is the value of
3009 &$qualify_domain$&.
3010
3011 .cmdopt -bfl <&'local&~part'&>
3012 This sets the local part of the recipient address when a filter file is being
3013 tested by means of the &%-bf%& option. The default is the username of the
3014 process that calls Exim. A local part should be specified with any prefix or
3015 suffix stripped, because that is how it appears to the filter when a message is
3016 actually being delivered.
3017
3018 .cmdopt -bfp <&'prefix'&>
3019 .cindex affix "filter testing"
3020 This sets the prefix of the local part of the recipient address when a filter
3021 file is being tested by means of the &%-bf%& option. The default is an empty
3022 prefix.
3023
3024 .cmdopt -bfs <&'suffix'&>
3025 .cindex affix "filter testing"
3026 This sets the suffix of the local part of the recipient address when a filter
3027 file is being tested by means of the &%-bf%& option. The default is an empty
3028 suffix.
3029
3030 .cmdopt -bh <&'IP&~address'&>
3031 .cindex "testing" "incoming SMTP"
3032 .cindex "SMTP" "testing incoming"
3033 .cindex "testing" "relay control"
3034 .cindex "relaying" "testing configuration"
3035 .cindex "policy control" "testing"
3036 .cindex "debugging" "&%-bh%& option"
3037 This option runs a fake SMTP session as if from the given IP address, using the
3038 standard input and output. The IP address may include a port number at the end,
3039 after a full stop. For example:
3040 .code
3041 exim -bh 10.9.8.7.1234
3042 exim -bh fe80::a00:20ff:fe86:a061.5678
3043 .endd
3044 When an IPv6 address is given, it is converted into canonical form. In the case
3045 of the second example above, the value of &$sender_host_address$& after
3046 conversion to the canonical form is
3047 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
3048
3049 Comments as to what is going on are written to the standard error file. These
3050 include lines beginning with &"LOG"& for anything that would have been logged.
3051 This facility is provided for testing configuration options for incoming
3052 messages, to make sure they implement the required policy. For example, you can
3053 test your relay controls using &%-bh%&.
3054
3055 &*Warning 1*&:
3056 .cindex "RFC 1413"
3057 You can test features of the configuration that rely on ident (RFC 1413)
3058 information by using the &%-oMt%& option. However, Exim cannot actually perform
3059 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3060 connection.
3061
3062 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3063 are also skipped when testing using &%-bh%&. If you want these callouts to
3064 occur, use &%-bhc%& instead.
3065
3066 Messages supplied during the testing session are discarded, and nothing is
3067 written to any of the real log files. There may be pauses when DNS (and other)
3068 lookups are taking place, and of course these may time out. The &%-oMi%& option
3069 can be used to specify a specific IP interface and port if this is important,
3070 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3071 session were authenticated.
3072
3073 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3074 output just states whether a given recipient address from a given host is
3075 acceptable or not. See section &<<SECTcheckaccess>>&.
3076
3077 Features such as authentication and encryption, where the client input is not
3078 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3079 specialized SMTP test program such as
3080 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3081
3082 .cmdopt -bhc <&'IP&~address'&>
3083 This option operates in the same way as &%-bh%&, except that address
3084 verification callouts are performed if required. This includes consulting and
3085 updating the callout cache database.
3086
3087 .cmdopt -bi
3088 .cindex "alias file" "building"
3089 .cindex "building alias file"
3090 .cindex "Sendmail compatibility" "&%-bi%& option"
3091 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3092 Exim does not have the concept of a single alias file, and so it cannot mimic
3093 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3094 tend to appear in various scripts such as NIS make files, so the option must be
3095 recognized.
3096
3097 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3098 configuration option is run, under the uid and gid of the caller of Exim. If
3099 the &%-oA%& option is used, its value is passed to the command as an argument.
3100 The command set by &%bi_command%& may not contain arguments. The command can
3101 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3102 if this is required. If the &%bi_command%& option is not set, calling Exim with
3103 &%-bi%& is a no-op.
3104
3105 . // Keep :help first, then the rest in alphabetical order
3106 .cmdopt -bI:help
3107 .cindex "querying exim information"
3108 We shall provide various options starting &`-bI:`& for querying Exim for
3109 information.  The output of many of these will be intended for machine
3110 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3111 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3112 options shall cause Exim to exit after producing the requested output.
3113
3114 .cmdopt -bI:dscp
3115 .cindex "DSCP" "values"
3116 This option causes Exim to emit an alphabetically sorted list of all
3117 recognised DSCP names.
3118
3119 .cmdopt -bI:sieve
3120 .cindex "Sieve filter" "capabilities"
3121 This option causes Exim to emit an alphabetically sorted list of all supported
3122 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3123 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3124 &`SIEVE`& capability response line.  As the precise list may depend upon
3125 compile-time build options, which this option will adapt to, this is the only
3126 way to guarantee a correct response.
3127
3128 .cmdopt -bm
3129 .cindex "local message reception"
3130 This option runs an Exim receiving process that accepts an incoming,
3131 locally-generated message on the standard input. The recipients are given as the
3132 command arguments (except when &%-t%& is also present &-- see below). Each
3133 argument can be a comma-separated list of RFC 2822 addresses. This is the
3134 default option for selecting the overall action of an Exim call; it is assumed
3135 if no other conflicting option is present.
3136
3137 If any addresses in the message are unqualified (have no domain), they are
3138 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3139 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3140 suppressing this for special cases.
3141
3142 Policy checks on the contents of local messages can be enforced by means of
3143 the non-SMTP ACL. See section &<<SECnonSMTP>>& for details.
3144
3145 .cindex "return code" "for &%-bm%&"
3146 The return code is zero if the message is successfully accepted. Otherwise, the
3147 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3148
3149 The format
3150 .cindex "message" "format"
3151 .cindex "format" "message"
3152 .cindex "&""From""& line"
3153 .cindex "UUCP" "&""From""& line"
3154 .cindex "Sendmail compatibility" "&""From""& line"
3155 of the message must be as defined in RFC 2822, except that, for
3156 compatibility with Sendmail and Smail, a line in one of the forms
3157 .code
3158 From sender Fri Jan  5 12:55 GMT 1997
3159 From sender Fri, 5 Jan 97 12:55:01
3160 .endd
3161 (with the weekday optional, and possibly with additional text after the date)
3162 is permitted to appear at the start of the message. There appears to be no
3163 authoritative specification of the format of this line. Exim recognizes it by
3164 matching against the regular expression defined by the &%uucp_from_pattern%&
3165 option, which can be changed if necessary.
3166
3167 .oindex "&%-f%&" "overriding &""From""& line"
3168 The specified sender is treated as if it were given as the argument to the
3169 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3170 preference to the address taken from the message. The caller of Exim must be a
3171 trusted user for the sender of a message to be set in this way.
3172
3173 .cmdopt -bmalware <&'filename'&>
3174 .cindex "testing", "malware"
3175 .cindex "malware scan test"
3176 This debugging option causes Exim to scan the given file or directory
3177 (depending on the used scanner interface),
3178 using the malware scanning framework.  The option of &%av_scanner%& influences
3179 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3180 the expansion should have defaults which apply to this invocation.  ACLs are
3181 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3182 will never be populated and &%-bmalware%& will fail.
3183
3184 Exim will have changed working directory before resolving the filename, so
3185 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3186 user when it tries to open the file, rather than as the invoking user.
3187 This option requires admin privileges.
3188
3189 The &%-bmalware%& option will not be extended to be more generally useful,
3190 there are better tools for file-scanning.  This option exists to help
3191 administrators verify their Exim and AV scanner configuration.
3192
3193 .cmdopt -bnq
3194 .cindex "address qualification, suppressing"
3195 By default, Exim automatically qualifies unqualified addresses (those
3196 without domains) that appear in messages that are submitted locally (that
3197 is, not over TCP/IP). This qualification applies both to addresses in
3198 envelopes, and addresses in header lines. Sender addresses are qualified using
3199 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3200 defaults to the value of &%qualify_domain%&).
3201
3202 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3203 being used to re-submit messages that originally came from remote hosts after
3204 content scanning, you probably do not want to qualify unqualified addresses in
3205 header lines. (Such lines will be present only if you have not enabled a header
3206 syntax check in the appropriate ACL.)
3207
3208 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3209 messages that originate on the local host. When this is used, unqualified
3210 addresses in the envelope provoke errors (causing message rejection) and
3211 unqualified addresses in header lines are left alone.
3212
3213
3214 .cmdopt -bP
3215 .cindex "configuration options" "extracting"
3216 .cindex "options" "configuration &-- extracting"
3217 If this option is given with no arguments, it causes the values of all Exim's
3218 main configuration options to be written to the standard output. The values
3219 of one or more specific options can be requested by giving their names as
3220 arguments, for example:
3221 .code
3222 exim -bP qualify_domain hold_domains
3223 .endd
3224 .cindex "hiding configuration option values"
3225 .cindex "configuration options" "hiding value of"
3226 .cindex "options" "hiding value of"
3227 However, any option setting that is preceded by the word &"hide"& in the
3228 configuration file is not shown in full, except to an admin user. For other
3229 users, the output is as in this example:
3230 .code
3231 mysql_servers = <value not displayable>
3232 .endd
3233 If &%config%& is given as an argument, the config is
3234 output, as it was parsed, any include file resolved, any comment removed.
3235
3236 If &%config_file%& is given as an argument, the name of the runtime
3237 configuration file is output. (&%configure_file%& works too, for
3238 backward compatibility.)
3239 If a list of configuration files was supplied, the value that is output here
3240 is the name of the file that was actually used.
3241
3242 .cindex "options" "hiding name of"
3243 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3244 name will not be output.
3245
3246 .cindex "daemon" "process id (pid)"
3247 .cindex "pid (process id)" "of daemon"
3248 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3249 directories where log files and daemon pid files are written are output,
3250 respectively. If these values are unset, log files are written in a
3251 sub-directory of the spool directory called &%log%&, and the pid file is
3252 written directly into the spool directory.
3253
3254 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3255 .code
3256 exim -bP +local_domains
3257 .endd
3258 it searches for a matching named list of any type (domain, host, address, or
3259 local part) and outputs what it finds.
3260
3261 .cindex "options" "router &-- extracting"
3262 .cindex "options" "transport &-- extracting"
3263 .cindex "options" "authenticator &-- extracting"
3264 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3265 followed by the name of an appropriate driver instance, the option settings for
3266 that driver are output. For example:
3267 .code
3268 exim -bP transport local_delivery
3269 .endd
3270 The generic driver options are output first, followed by the driver's private
3271 options. A list of the names of drivers of a particular type can be obtained by
3272 using one of the words &%router_list%&, &%transport_list%&, or
3273 &%authenticator_list%&, and a complete list of all drivers with their option
3274 settings can be obtained by using &%routers%&, &%transports%&, or
3275 &%authenticators%&.
3276
3277 .cindex "environment"
3278 If &%environment%& is given as an argument, the set of environment
3279 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3280 variables.
3281
3282 .cindex "options" "macro &-- extracting"
3283 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3284 are available, similarly to the drivers.  Because macros are sometimes used
3285 for storing passwords, this option is restricted.
3286 The output format is one item per line.
3287 For the "-bP macro <name>" form, if no such macro is found
3288 the exit status will be nonzero.
3289
3290 .cmdopt -bp
3291 .cindex "queue" "listing messages in"
3292 .cindex "listing" "messages in the queue"
3293 This option requests a listing of the contents of the mail queue on the
3294 standard output. If the &%-bp%& option is followed by a list of message ids,
3295 just those messages are listed. By default, this option can be used only by an
3296 admin user. However, the &%queue_list_requires_admin%& option can be set false
3297 to allow any user to see the queue.
3298
3299 Each message in the queue is displayed as in the following example:
3300 .code
3301 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3302           red.king@looking-glass.fict.example
3303           <other addresses>
3304 .endd
3305 .cindex "message" "size in queue listing"
3306 .cindex "size" "of message"
3307 The first line contains the length of time the message has been in the queue
3308 (in this case 25 minutes), the size of the message (2.9K), the unique local
3309 identifier for the message, and the message sender, as contained in the
3310 envelope. For bounce messages, the sender address is empty, and appears as
3311 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3312 the default sender address, the user's login name is shown in parentheses
3313 before the sender address.
3314
3315 .cindex "frozen messages" "in queue listing"
3316 If the message is frozen (attempts to deliver it are suspended) then the text
3317 &"*** frozen ***"& is displayed at the end of this line.
3318
3319 The recipients of the message (taken from the envelope, not the headers) are
3320 displayed on subsequent lines. Those addresses to which the message has already
3321 been delivered are marked with the letter D. If an original address gets
3322 expanded into several addresses via an alias or forward file, the original is
3323 displayed with a D only when deliveries for all of its child addresses are
3324 complete.
3325
3326
3327 .cmdopt -bpa
3328 This option operates like &%-bp%&, but in addition it shows delivered addresses
3329 that were generated from the original top level address(es) in each message by
3330 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3331 of just &"D"&.
3332
3333
3334 .cmdopt -bpc
3335 .cindex "queue" "count of messages on"
3336 This option counts the number of messages in the queue, and writes the total
3337 to the standard output. It is restricted to admin users, unless
3338 &%queue_list_requires_admin%& is set false.
3339
3340
3341 .cmdopt -bpi
3342 .cindex queue "list of message IDs"
3343 This option operates like &%-bp%&, but only outputs message ids
3344 (one per line).
3345
3346
3347 .cmdopt -bpr
3348 This option operates like &%-bp%&, but the output is not sorted into
3349 chronological order of message arrival. This can speed it up when there are
3350 lots of messages in the queue, and is particularly useful if the output is
3351 going to be post-processed in a way that doesn't need the sorting.
3352
3353 .cmdopt -bpra
3354 This option is a combination of &%-bpr%& and &%-bpa%&.
3355
3356 .cmdopt -bpri
3357 This option is a combination of &%-bpr%& and &%-bpi%&.
3358
3359 .cmdopt -bpru
3360 This option is a combination of &%-bpr%& and &%-bpu%&.
3361
3362
3363 .cmdopt -bpu
3364 This option operates like &%-bp%& but shows only undelivered top-level
3365 addresses for each message displayed. Addresses generated by aliasing or
3366 forwarding are not shown, unless the message was deferred after processing by a
3367 router with the &%one_time%& option set.
3368
3369
3370 .cmdopt -brt
3371 .cindex "testing" "retry configuration"
3372 .cindex "retry" "configuration testing"
3373 This option is for testing retry rules, and it must be followed by up to three
3374 arguments. It causes Exim to look for a retry rule that matches the values
3375 and to write it to the standard output. For example:
3376 .code
3377 exim -brt bach.comp.mus.example
3378 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3379 .endd
3380 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3381 argument, which is required, can be a complete address in the form
3382 &'local_part@domain'&, or it can be just a domain name. If the second argument
3383 contains a dot, it is interpreted as an optional second domain name; if no
3384 retry rule is found for the first argument, the second is tried. This ties in
3385 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3386 rule is found that matches the host, one that matches the mail domain is
3387 sought. Finally, an argument that is the name of a specific delivery error, as
3388 used in setting up retry rules, can be given. For example:
3389 .code
3390 exim -brt haydn.comp.mus.example quota_3d
3391 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3392 .endd
3393
3394 .cmdopt -brw
3395 .cindex "testing" "rewriting"
3396 .cindex "rewriting" "testing"
3397 This option is for testing address rewriting rules, and it must be followed by
3398 a single argument, consisting of either a local part without a domain, or a
3399 complete address with a fully qualified domain. Exim outputs how this address
3400 would be rewritten for each possible place it might appear. See chapter
3401 &<<CHAPrewrite>>& for further details.
3402
3403 .cmdopt -bS
3404 .cindex "SMTP" "batched incoming"
3405 .cindex "batched SMTP input"
3406 This option is used for batched SMTP input, which is an alternative interface
3407 for non-interactive local message submission. A number of messages can be
3408 submitted in a single run. However, despite its name, this is not really SMTP
3409 input. Exim reads each message's envelope from SMTP commands on the standard
3410 input, but generates no responses. If the caller is trusted, or
3411 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3412 believed; otherwise the sender is always the caller of Exim.
3413
3414 The message itself is read from the standard input, in SMTP format (leading
3415 dots doubled), terminated by a line containing just a single dot. An error is
3416 provoked if the terminating dot is missing. A further message may then follow.
3417
3418 As for other local message submissions, the contents of incoming batch SMTP
3419 messages can be checked using the non-SMTP ACL (see section &<<SECnonSMTP>>&).
3420 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3421 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3422
3423 Some other SMTP commands are recognized in the input. HELO and EHLO act
3424 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3425 QUIT quits, ignoring the rest of the standard input.
3426
3427 .cindex "return code" "for &%-bS%&"
3428 If any error is encountered, reports are written to the standard output and
3429 error streams, and Exim gives up immediately. The return code is 0 if no error
3430 was detected; it is 1 if one or more messages were accepted before the error
3431 was detected; otherwise it is 2.
3432
3433 More details of input using batched SMTP are given in section
3434 &<<SECTincomingbatchedSMTP>>&.
3435
3436 .cmdopt -bs
3437 .cindex "SMTP" "local input"
3438 .cindex "local SMTP input"
3439 This option causes Exim to accept one or more messages by reading SMTP commands
3440 on the standard input, and producing SMTP replies on the standard output. SMTP
3441 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3442 Some user agents use this interface as a way of passing locally-generated
3443 messages to the MTA.
3444
3445 In
3446 .cindex "sender" "source of"
3447 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3448 set, the senders of messages are taken from the SMTP MAIL commands.
3449 Otherwise the content of these commands is ignored and the sender is set up as
3450 the calling user. Unqualified addresses are automatically qualified using
3451 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3452 &%-bnq%& option is used.
3453
3454 .cindex "inetd"
3455 The
3456 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3457 using a listening daemon. Exim can distinguish the two cases by checking
3458 whether the standard input is a TCP/IP socket. When Exim is called from
3459 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3460 above concerning senders and qualification do not apply. In this situation,
3461 Exim behaves in exactly the same way as it does when receiving a message via
3462 the listening daemon.
3463
3464 .cmdopt -bt
3465 .cindex "testing" "addresses"
3466 .cindex "address" "testing"
3467 This option runs Exim in address testing mode, in which each argument is taken
3468 as a recipient address to be tested for deliverability. The results are
3469 written to the standard output. If a test fails, and the caller is not an admin
3470 user, no details of the failure are output, because these might contain
3471 sensitive information such as 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 tested.
3475
3476 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3477 &[readline()]& function, because it is running as &'root'& and there are
3478 security issues.
3479
3480 Each address is handled as if it were the recipient address of a message
3481 (compare the &%-bv%& option). It is passed to the routers and the result is
3482 written to the standard output. However, any router that has
3483 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3484 genuine routing tests if your first router passes everything to a scanner
3485 program.
3486
3487 .cindex "return code" "for &%-bt%&"
3488 The return code is 2 if any address failed outright; it is 1 if no address
3489 failed outright but at least one could not be resolved for some reason. Return
3490 code 0 is given only when all addresses succeed.
3491
3492 .cindex "duplicate addresses"
3493 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3494 addresses after routing is complete, so that only one delivery takes place.
3495 This does not happen when testing with &%-bt%&; the full results of routing are
3496 always shown.
3497
3498 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3499 routers in the configuration makes any tests on the sender address of a
3500 message,
3501 .oindex "&%-f%&" "for address testing"
3502 you can use the &%-f%& option to set an appropriate sender when running
3503 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3504 default qualifying domain. However, if you have set up (for example) routers
3505 whose behaviour depends on the contents of an incoming message, you cannot test
3506 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3507 doing such tests.
3508
3509 .cmdopt -bV
3510 .cindex "version number of Exim"
3511 This option causes Exim to write the current version number, compilation
3512 number, and compilation date of the &'exim'& binary to the standard output.
3513 It also lists the DBM library that is being used, the optional modules (such as
3514 specific lookup types), the drivers that are included in the binary, and the
3515 name of the runtime configuration file that is in use.
3516
3517 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3518 configuration file. However, this is a static check only. It cannot check
3519 values that are to be expanded. For example, although a misspelt ACL verb is
3520 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3521 alone to discover (for example) all the typos in the configuration; some
3522 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3523 dynamic testing facilities.
3524
3525 .cmdopt -bv
3526 .cindex "verifying address" "using &%-bv%&"
3527 .cindex "address" "verification"
3528 This option runs Exim in address verification mode, in which each argument is
3529 taken as a recipient address to be verified by the routers. (This does
3530 not involve any verification callouts). During normal operation, verification
3531 happens mostly as a consequence processing a &%verify%& condition in an ACL
3532 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3533 including callouts, see the &%-bh%& and &%-bhc%& options.
3534
3535 If verification fails, and the caller is not an admin user, no details of the
3536 failure are output, because these might contain sensitive information such as
3537 usernames and passwords for database lookups.
3538
3539 If no arguments are given, Exim runs in an interactive manner, prompting with a
3540 right angle bracket for addresses to be verified.
3541
3542 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3543 &[readline()]& function, because it is running as &'exim'& and there are
3544 security issues.
3545
3546 Verification differs from address testing (the &%-bt%& option) in that routers
3547 that have &%no_verify%& set are skipped, and if the address is accepted by a
3548 router that has &%fail_verify%& set, verification fails. The address is
3549 verified as a recipient if &%-bv%& is used; to test verification for a sender
3550 address, &%-bvs%& should be used.
3551
3552 If the &%-v%& option is not set, the output consists of a single line for each
3553 address, stating whether it was verified or not, and giving a reason in the
3554 latter case. Without &%-v%&, generating more than one address by redirection
3555 causes verification to end successfully, without considering the generated
3556 addresses. However, if just one address is generated, processing continues,
3557 and the generated address must verify successfully for the overall verification
3558 to succeed.
3559
3560 When &%-v%& is set, more details are given of how the address has been handled,
3561 and in the case of address redirection, all the generated addresses are also
3562 considered. Verification may succeed for some and fail for others.
3563
3564 The
3565 .cindex "return code" "for &%-bv%&"
3566 return code is 2 if any address failed outright; it is 1 if no address
3567 failed outright but at least one could not be resolved for some reason. Return
3568 code 0 is given only when all addresses succeed.
3569
3570 If any of the routers in the configuration makes any tests on the sender
3571 address of a message, you should use the &%-f%& option to set an appropriate
3572 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3573 calling user at the default qualifying domain.
3574
3575 .cmdopt -bvs
3576 This option acts like &%-bv%&, but verifies the address as a sender rather
3577 than a recipient address. This affects any rewriting and qualification that
3578 might happen.
3579
3580 .cmdopt -bw
3581 .cindex "daemon"
3582 .cindex "inetd"
3583 .cindex "inetd" "wait mode"
3584 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3585 similarly to the &%-bd%& option.  All port specifications on the command-line
3586 and in the configuration file are ignored.  Queue-running may not be specified.
3587
3588 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3589 listening for connections.  This permits the system to start up and have
3590 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3591 each port only when the first connection is received.
3592
3593 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3594 which the daemon will exit, which should cause inetd to listen once more.
3595
3596 .cmdopt -C <&'filelist'&>
3597 .cindex "configuration file" "alternate"
3598 .cindex "CONFIGURE_FILE"
3599 .cindex "alternate configuration file"
3600 This option causes Exim to find the runtime configuration file from the given
3601 list instead of from the list specified by the CONFIGURE_FILE
3602 compile-time setting. Usually, the list will consist of just a single filename,
3603 but it can be a colon-separated list of names. In this case, the first
3604 file that exists is used. Failure to open an existing file stops Exim from
3605 proceeding any further along the list, and an error is generated.
3606
3607 When this option is used by a caller other than root, and the list is different
3608 from the compiled-in list, Exim gives up its root privilege immediately, and
3609 runs with the real and effective uid and gid set to those of the caller.
3610 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3611 file contains a list of full pathnames, one per line, for configuration files
3612 which are trusted. Root privilege is retained for any configuration file so
3613 listed, as long as the caller is the Exim user (or the user specified in the
3614 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3615 not writeable by inappropriate users or groups.
3616
3617 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3618 configuration using &%-C%& right through message reception and delivery,
3619 even if the caller is root. The reception works, but by that time, Exim is
3620 running as the Exim user, so when it re-executes to regain privilege for the
3621 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3622 test reception and delivery using two separate commands (one to put a message
3623 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3624
3625 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3626 prefix string with which any file named in a &%-C%& command line option
3627 must start. In addition, the filename must not contain the sequence &`/../`&.
3628 However, if the value of the &%-C%& option is identical to the value of
3629 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3630 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3631 unset, any filename can be used with &%-C%&.
3632
3633 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3634 to a directory to which only root has access. This prevents someone who has
3635 broken into the Exim account from running a privileged Exim with an arbitrary
3636 configuration file.
3637
3638 The &%-C%& facility is useful for ensuring that configuration files are
3639 syntactically correct, but cannot be used for test deliveries, unless the
3640 caller is privileged, or unless it is an exotic configuration that does not
3641 require privilege. No check is made on the owner or group of the files
3642 specified by this option.
3643
3644
3645 .vitem &%-D%&<&'macro'&>=<&'value'&>
3646 .oindex "&%-D%&"
3647 .cindex "macro" "setting on command line"
3648 This option can be used to override macro definitions in the configuration file
3649 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3650 unprivileged caller, it causes Exim to give up its root privilege.
3651 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3652 completely disabled, and its use causes an immediate error exit.
3653
3654 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3655 colon-separated list of macros which are considered safe and, if &%-D%& only
3656 supplies macros from this list, and the values are acceptable, then Exim will
3657 not give up root privilege if the caller is root, the Exim run-time user, or
3658 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3659 to be removed in the future.  Acceptable values for the macros satisfy the
3660 regexp: &`^[A-Za-z0-9_/.-]*$`&
3661
3662 The entire option (including equals sign if present) must all be within one
3663 command line item. &%-D%& can be used to set the value of a macro to the empty
3664 string, in which case the equals sign is optional. These two commands are
3665 synonymous:
3666 .code
3667 exim -DABC  ...
3668 exim -DABC= ...
3669 .endd
3670 To include spaces in a macro definition item, quotes must be used. If you use
3671 quotes, spaces are permitted around the macro name and the equals sign. For
3672 example:
3673 .code
3674 exim '-D ABC = something' ...
3675 .endd
3676 &%-D%& may be repeated up to 10 times on a command line.
3677 Only macro names up to 22 letters long can be set.
3678
3679
3680 .vitem &%-d%&<&'debug&~options'&>
3681 .oindex "&%-d%&"
3682 .cindex "debugging" "list of selectors"
3683 .cindex "debugging" "&%-d%& option"
3684 This option causes debugging information to be written to the standard
3685 error stream. It is restricted to admin users because debugging output may show
3686 database queries that contain password information. Also, the details of users'
3687 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3688 writes an error message to the standard error stream and exits with a non-zero
3689 return code.
3690
3691 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3692 standard debugging data is output. This can be reduced, or increased to include
3693 some more rarely needed information, by directly following &%-d%& with a string
3694 made up of names preceded by plus or minus characters. These add or remove sets
3695 of debugging data, respectively. For example, &%-d+filter%& adds filter
3696 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3697 no spaces are allowed in the debug setting. The available debugging categories
3698 are:
3699 .itable none 0 0 2 20* left 80* left
3700 .irow acl            "ACL interpretation"
3701 .irow auth           "authenticators"
3702 .irow deliver        "general delivery logic"
3703 .irow dns            "DNS lookups (see also resolver)"
3704 .irow dnsbl          "DNS black list (aka RBL) code"
3705 .irow exec           "arguments for &[execv()]& calls"
3706 .irow expand         "detailed debugging for string expansions"
3707 .irow filter         "filter handling"
3708 .irow hints_lookup   "hints data lookups"
3709 .irow host_lookup    "all types of name-to-IP address handling"
3710 .irow ident          "ident lookup"
3711 .irow interface      "lists of local interfaces"
3712 .irow lists          "matching things in lists"
3713 .irow load           "system load checks"
3714 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3715                     &<<CHAPlocalscan>>&)"
3716 .irow lookup         "general lookup code and all lookups"
3717 .irow memory         "memory handling"
3718 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3719 .irow pid            "modifier: add pid to debug output lines"
3720 .irow process_info   "setting info for the process log"
3721 .irow queue_run      "queue runs"
3722 .irow receive        "general message reception logic"
3723 .irow resolver       "turn on the DNS resolver's debugging output"
3724 .irow retry          "retry handling"
3725 .irow rewrite        "address rewriting""
3726 .irow route          "address routing"
3727 .irow timestamp      "modifier: add timestamp to debug output lines"
3728 .irow tls            "TLS logic"
3729 .irow transport      "transports"
3730 .irow uid            "changes of uid/gid and looking up uid/gid"
3731 .irow verify         "address verification logic"
3732 .irow all            "almost all of the above (see below), and also &%-v%&"
3733 .endtable
3734 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3735 for &`-all`&. The reason for this is that &`+all`& is something that people
3736 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3737 is included, an awful lot of output that is very rarely of interest is
3738 generated, so it now has to be explicitly requested. However, &`-all`& does
3739 turn everything off.
3740
3741 .cindex "resolver, debugging output"
3742 .cindex "DNS resolver, debugging output"
3743 The &`resolver`& option produces output only if the DNS resolver was compiled
3744 with DEBUG enabled. This is not the case in some operating systems. Also,
3745 unfortunately, debugging output from the DNS resolver is written to stdout
3746 rather than stderr.
3747
3748 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3749 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3750 However, the &`pid`& selector is forced when debugging is turned on for a
3751 daemon, which then passes it on to any re-executed Exims. Exim also
3752 automatically adds the pid to debug lines when several remote deliveries are
3753 run in parallel.
3754
3755 The &`timestamp`& selector causes the current time to be inserted at the start
3756 of all debug output lines. This can be useful when trying to track down delays
3757 in processing.
3758
3759 .cindex debugging "UTF-8 in"
3760 .cindex UTF-8 "in debug output"
3761 The &`noutf8`& selector disables the use of
3762 UTF-8 line-drawing characters to group related information.
3763 When disabled. ascii-art is used instead.
3764 Using the &`+all`& option does not set this modifier,
3765
3766 If the &%debug_print%& option is set in any driver, it produces output whenever
3767 any debugging is selected, or if &%-v%& is used.
3768
3769 .vitem &%-dd%&<&'debug&~options'&>
3770 .oindex "&%-dd%&"
3771 This option behaves exactly like &%-d%& except when used on a command that
3772 starts a daemon process. In that case, debugging is turned off for the
3773 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3774 behaviour of the daemon without creating as much output as full debugging does.
3775
3776 .cmdopt -dropcr
3777 This is an obsolete option that is now a no-op. It used to affect the way Exim
3778 handled CR and LF characters in incoming messages. What happens now is
3779 described in section &<<SECTlineendings>>&.
3780
3781 .cmdopt -E
3782 .cindex "bounce message" "generating"
3783 This option specifies that an incoming message is a locally-generated delivery
3784 failure report. It is used internally by Exim when handling delivery failures
3785 and is not intended for external use. Its only effect is to stop Exim
3786 generating certain messages to the postmaster, as otherwise message cascades
3787 could occur in some situations. As part of the same option, a message id may
3788 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3789 new message contains the id, following &"R="&, as a cross-reference.
3790
3791 .vitem &%-e%&&'x'&
3792 .oindex "&%-e%&&'x'&"
3793 There are a number of Sendmail options starting with &%-oe%& which seem to be
3794 called by various programs without the leading &%o%& in the option. For
3795 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3796 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3797
3798 .cmdopt -F <&'string'&>
3799 .cindex "sender" "name"
3800 .cindex "name" "of sender"
3801 This option sets the sender's full name for use when a locally-generated
3802 message is being accepted. In the absence of this option, the user's &'gecos'&
3803 entry from the password data is used. As users are generally permitted to alter
3804 their &'gecos'& entries, no security considerations are involved. White space
3805 between &%-F%& and the <&'string'&> is optional.
3806
3807 .cmdopt -f <&'address'&>
3808 .cindex "sender" "address"
3809 .cindex "address" "sender"
3810 .cindex "trusted users"
3811 .cindex "envelope from"
3812 .cindex "envelope sender"
3813 .cindex "user" "trusted"
3814 This option sets the address of the envelope sender of a locally-generated
3815 message (also known as the return path). The option can normally be used only
3816 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3817 users to use it.
3818
3819 Processes running as root or the Exim user are always trusted. Other
3820 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3821 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3822 of a local message is set to the caller's login name at the default qualify
3823 domain.
3824
3825 There is one exception to the restriction on the use of &%-f%&: an empty sender
3826 can be specified by any user, trusted or not, to create a message that can
3827 never provoke a bounce. An empty sender can be specified either as an empty
3828 string, or as a pair of angle brackets with nothing between them, as in these
3829 examples of shell commands:
3830 .code
3831 exim -f '<>' user@domain
3832 exim -f "" user@domain
3833 .endd
3834 In addition, the use of &%-f%& is not restricted when testing a filter file
3835 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3836 &%-bv%& options.
3837
3838 Allowing untrusted users to change the sender address does not of itself make
3839 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3840 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3841 though this can be overridden by setting &%no_local_from_check%&.
3842
3843 White
3844 .cindex "&""From""& line"
3845 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3846 given as two arguments or one combined argument). The sender of a
3847 locally-generated message can also be set (when permitted) by an initial
3848 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3849 if &%-f%& is also present, it overrides &"From&~"&.
3850
3851 .cmdopt -G
3852 .cindex "submission fixups, suppressing (command-line)"
3853 This option is equivalent to an ACL applying:
3854 .code
3855 control = suppress_local_fixups
3856 .endd
3857 for every message received.  Note that Sendmail will complain about such
3858 bad formatting, where Exim silently just does not fix it up.  This may change
3859 in future.
3860
3861 As this affects audit information, the caller must be a trusted user to use
3862 this option.
3863
3864 .cmdopt -h <&'number'&>
3865 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3866 This option is accepted for compatibility with Sendmail, but has no effect. (In
3867 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3868 headers.)
3869
3870 .cmdopt -i
3871 .cindex "Solaris" "&'mail'& command"
3872 .cindex "dot" "in incoming non-SMTP message"
3873 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3874 line by itself should not terminate an incoming, non-SMTP message.
3875 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3876 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3877 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3878 by its &'mailx'& command.
3879
3880 .cmdopt -L <&'tag'&>
3881 .cindex "syslog" "process name; set with flag"
3882 This option is equivalent to setting &%syslog_processname%& in the config
3883 file and setting &%log_file_path%& to &`syslog`&.
3884 Its use is restricted to administrators.  The configuration file has to be
3885 read and parsed, to determine access rights, before this is set and takes
3886 effect, so early configuration file errors will not honour this flag.
3887
3888 The tag should not be longer than 32 characters.
3889
3890 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3891 .cindex "forcing delivery"
3892 .cindex "delivery" "forcing attempt"
3893 .cindex "frozen messages" "forcing delivery"
3894 This option requests Exim to run a delivery attempt on each message in turn. If
3895 any of the messages are frozen, they are automatically thawed before the
3896 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3897 and &%hold_domains%& are ignored.
3898
3899 Retry
3900 .cindex "hints database" "overriding retry hints"
3901 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3902 the normal retry time has not yet been reached. This option requires the caller
3903 to be an admin user. However, there is an option called &%prod_requires_admin%&
3904 which can be set false to relax this restriction (and also the same requirement
3905 for the &%-q%&, &%-R%&, and &%-S%& options).
3906
3907 The deliveries happen synchronously, that is, the original Exim process does
3908 not terminate until all the delivery attempts have finished. No output is
3909 produced unless there is a serious error. If you want to see what is happening,
3910 use the &%-v%& option as well, or inspect Exim's main log.
3911
3912 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3913 .cindex "message" "adding recipients"
3914 .cindex "recipient" "adding"
3915 This option requests Exim to add the addresses to the list of recipients of the
3916 message (&"ar"& for &"add recipients"&). The first argument must be a message
3917 id, and the remaining ones must be email addresses. However, if the message is
3918 active (in the middle of a delivery attempt), it is not altered. This option
3919 can be used only by an admin user.
3920
3921 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3922         &~<&'host&~IP'&>&&&
3923         &~<&'sequence&~number'&>&&&
3924         &~<&'message&~id'&>"
3925 .oindex "&%-MC%&"
3926 .cindex "SMTP" "passed connection"
3927 .cindex "SMTP" "multiple deliveries"
3928 .cindex "multiple SMTP deliveries"
3929 This option is not intended for use by external callers. It is used internally
3930 by Exim to invoke another instance of itself to deliver a waiting message using
3931 an existing SMTP connection, which is passed as the standard input. Details are
3932 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3933 must be root or the Exim user in order to use it.
3934
3935 .cmdopt -MCA
3936 This option is not intended for use by external callers. It is used internally
3937 by Exim in conjunction with the &%-MC%& option. It signifies that the
3938 connection to the remote host has been authenticated.
3939
3940 .cmdopt -MCD
3941 This option is not intended for use by external callers. It is used internally
3942 by Exim in conjunction with the &%-MC%& option. It signifies that the
3943 remote host supports the ESMTP &_DSN_& extension.
3944
3945 .cmdopt -MCd
3946 This option is not intended for use by external callers. It is used internally
3947 by Exim in conjunction with the &%-d%& option
3948 to pass on an information string on the purpose of the process.
3949
3950 .cmdopt -MCG <&'queue&~name'&>
3951 This option is not intended for use by external callers. It is used internally
3952 by Exim in conjunction with the &%-MC%& option. It signifies that an
3953 alternate queue is used, named by the following argument.
3954
3955 .cmdopt -MCK
3956 This option is not intended for use by external callers. It is used internally
3957 by Exim in conjunction with the &%-MC%& option. It signifies that a
3958 remote host supports the ESMTP &_CHUNKING_& extension.
3959
3960 .cmdopt -MCL
3961 This option is not intended for use by external callers. It is used internally
3962 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3963 which Exim is connected advertised limits on numbers of mails, recipients or
3964 recipient domains.
3965 The limits are given by the following three arguments.
3966
3967 .cmdopt -MCP
3968 This option is not intended for use by external callers. It is used internally
3969 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3970 which Exim is connected supports pipelining.
3971
3972 .cmdopt -MCp
3973 This option is not intended for use by external callers. It is used internally
3974 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3975 t a remote server is via a SOCKS proxy, using addresses and ports given by
3976 the following four arguments.
3977
3978 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3979 This option is not intended for use by external callers. It is used internally
3980 by Exim in conjunction with the &%-MC%& option when the original delivery was
3981 started by a queue runner. It passes on the process id of the queue runner,
3982 together with the file descriptor number of an open pipe. Closure of the pipe
3983 signals the final completion of the sequence of processes that are passing
3984 messages through the same SMTP connection.
3985
3986 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3987 This option is not intended for use by external callers. It is used internally
3988 by Exim to implement quota checking for local users.
3989
3990 .cmdopt -MCS
3991 This option is not intended for use by external callers. It is used internally
3992 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3993 ESMTP SIZE option should be used on messages delivered down the existing
3994 connection.
3995
3996 .cmdopt -MCT
3997 This option is not intended for use by external callers. It is used internally
3998 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3999 host to which Exim is connected supports TLS encryption.
4000
4001 .vitem &%-MCr%&&~<&'SNI'&> &&&
4002        &%-MCs%&&~<&'SNI'&>
4003 .oindex "&%-MCs%&"
4004 .oindex "&%-MCr%&"
4005 These options are not intended for use by external callers. It is used internally
4006 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
4007 a TLS Server Name Indication was sent as part of the channel establishment.
4008 The argument gives the SNI string.
4009 The "r" variant indicates a DANE-verified connection.
4010
4011 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
4012 This option is not intended for use by external callers. It is used internally
4013 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
4014 connection is being proxied by a parent process for handling TLS encryption.
4015 The arguments give the local address and port being proxied, and the TLS cipher.
4016
4017 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
4018 .cindex "hints database" "not overridden by &%-Mc%&"
4019 .cindex "delivery" "manually started &-- not forced"
4020 This option requests Exim to run a delivery attempt on each message, in turn,
4021 but unlike the &%-M%& option, it does check for retry hints, and respects any
4022 that are found. This option is not very useful to external callers. It is
4023 provided mainly for internal use by Exim when it needs to re-invoke itself in
4024 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
4025 However, &%-Mc%& can be useful when testing, in order to run a delivery that
4026 respects retry times and other options such as &%hold_domains%& that are
4027 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
4028 If you want to run a specific delivery as if in a queue run, you should use
4029 &%-q%& with a message id argument. A distinction between queue run deliveries
4030 and other deliveries is made in one or two places.
4031
4032 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
4033 .cindex "message" "changing sender"
4034 .cindex "sender" "changing"
4035 This option requests Exim to change the sender address in the message to the
4036 given address, which must be a fully qualified address or &"<>"& (&"es"& for
4037 &"edit sender"&). There must be exactly two arguments. The first argument must
4038 be a message id, and the second one an email address. However, if the message
4039 is active (in the middle of a delivery attempt), its status is not altered.
4040 This option can be used only by an admin user.
4041
4042 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
4043 .cindex "freezing messages"
4044 .cindex "message" "manually freezing"
4045 This option requests Exim to mark each listed message as &"frozen"&. This
4046 prevents any delivery attempts taking place until the message is &"thawed"&,
4047 either manually or as a result of the &%auto_thaw%& configuration option.
4048 However, if any of the messages are active (in the middle of a delivery
4049 attempt), their status is not altered. This option can be used only by an admin
4050 user.
4051
4052 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
4053 .cindex "giving up on messages"
4054 .cindex "message" "abandoning delivery attempts"
4055 .cindex "delivery" "abandoning further attempts"
4056 This option requests Exim to give up trying to deliver the listed messages,
4057 including any that are frozen. However, if any of the messages are active,
4058 their status is not altered. For non-bounce messages, a delivery error message
4059 is sent to the sender.
4060 Bounce messages are just discarded. This option can be used only by an admin
4061 user.
4062
4063 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4064 .cindex queue named
4065 .cindex "named queues" "moving messages"
4066 .cindex "queue" "moving messages"
4067 This option requests that each listed message be moved from its current
4068 queue to the given named queue.
4069 The destination queue name argument is required, but can be an empty
4070 string to define the default queue.
4071 If the messages are not currently located in the default queue,
4072 a &%-qG<name>%& option will be required to define the source queue.
4073
4074 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
4075 .cindex "delivery" "cancelling all"
4076 This option requests Exim to mark all the recipient addresses in the messages
4077 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4078 message is active (in the middle of a delivery attempt), its status is not
4079 altered. This option can be used only by an admin user.
4080
4081 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4082 .cindex "delivery" "cancelling by address"
4083 .cindex "recipient" "removing"
4084 .cindex "removing recipients"
4085 This option requests Exim to mark the given addresses as already delivered
4086 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4087 the remaining ones must be email addresses. These are matched to recipient
4088 addresses in the message in a case-sensitive manner. If the message is active
4089 (in the middle of a delivery attempt), its status is not altered. This option
4090 can be used only by an admin user.
4091
4092 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4093 .cindex "removing messages"
4094 .cindex "abandoning mail"
4095 .cindex "message" "manually discarding"
4096 This option requests Exim to remove the given messages from the queue. No
4097 bounce messages are sent; each message is simply forgotten. However, if any of
4098 the messages are active, their status is not altered. This option can be used
4099 only by an admin user or by the user who originally caused the message to be
4100 placed in the queue.
4101
4102 . .new
4103 . .vitem &%-MS%&
4104 . .oindex "&%-MS%&"
4105 . .cindex REQUIRETLS
4106 . This option is used to request REQUIRETLS processing on the message.
4107 . It is used internally by Exim in conjunction with -E when generating
4108 . a bounce message.
4109 . .wen
4110
4111 .cmdopt -Mset <&'message&~id'&>
4112 .cindex "testing" "string expansion"
4113 .cindex "expansion" "testing"
4114 This option is useful only in conjunction with &%-be%& (that is, when testing
4115 string expansions). Exim loads the given message from its spool before doing
4116 the test expansions, thus setting message-specific variables such as
4117 &$message_size$& and the header variables. The &$recipients$& variable is made
4118 available. This feature is provided to make it easier to test expansions that
4119 make use of these variables. However, this option can be used only by an admin
4120 user. See also &%-bem%&.
4121
4122 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4123 .cindex "thawing messages"
4124 .cindex "unfreezing messages"
4125 .cindex "frozen messages" "thawing"
4126 .cindex "message" "thawing frozen"
4127 This option requests Exim to &"thaw"& any of the listed messages that are
4128 &"frozen"&, so that delivery attempts can resume. However, if any of the
4129 messages are active, their status is not altered. This option can be used only
4130 by an admin user.
4131
4132 .cmdopt -Mvb <&'message&~id'&>
4133 .cindex "listing" "message body"
4134 .cindex "message" "listing body of"
4135 This option causes the contents of the message body (-D) spool file to be
4136 written to the standard output. This option can be used only by an admin user.
4137
4138 .cmdopt -Mvc <&'message&~id'&>
4139 .cindex "message" "listing in RFC 2822 format"
4140 .cindex "listing" "message in RFC 2822 format"
4141 This option causes a copy of the complete message (header lines plus body) to
4142 be written to the standard output in RFC 2822 format. This option can be used
4143 only by an admin user.
4144
4145 .cmdopt -Mvh <&'message&~id'&>
4146 .cindex "listing" "message headers"
4147 .cindex "header lines" "listing"
4148 .cindex "message" "listing header lines"
4149 This option causes the contents of the message headers (-H) spool file to be
4150 written to the standard output. This option can be used only by an admin user.
4151
4152 .cmdopt -Mvl <&'message&~id'&>
4153 .cindex "listing" "message log"
4154 .cindex "message" "listing message log"
4155 This option causes the contents of the message log spool file to be written to
4156 the standard output. This option can be used only by an admin user.
4157
4158 .cmdopt -m
4159 This is a synonym for &%-om%& that is accepted by Sendmail
4160 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4161 p. 1M-258), so Exim treats it that way too.
4162
4163 .cmdopt -N
4164 .cindex "debugging" "&%-N%& option"
4165 .cindex "debugging" "suppressing delivery"
4166 This is a debugging option that inhibits delivery of a message at the transport
4167 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4168 it just doesn't actually transport the message, but instead behaves as if it
4169 had successfully done so. However, it does not make any updates to the retry
4170 database, and the log entries for deliveries are flagged with &"*>"& rather
4171 than &"=>"&.
4172
4173 Because &%-N%& discards any message to which it applies, only root or the Exim
4174 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4175 words, an ordinary user can use it only when supplying an incoming message to
4176 which it will apply. Although transportation never fails when &%-N%& is set, an
4177 address may be deferred because of a configuration problem on a transport, or a
4178 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4179 the message, and applies to any subsequent delivery attempts that may happen
4180 for that message.
4181
4182 .cmdopt -n
4183 This option is interpreted by Sendmail to mean &"no aliasing"&.
4184 For normal modes of operation, it is ignored by Exim.
4185 When combined with &%-bP%& it makes the output more terse (suppresses
4186 option names, environment values and config pretty printing).
4187
4188 .cmdopt -O <&'data'&>
4189 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4190 Exim.
4191
4192 .cmdopt -oA <&'file&~name'&>
4193 .cindex "Sendmail compatibility" "&%-oA%& option"
4194 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4195 alternative alias filename. Exim handles &%-bi%& differently; see the
4196 description above.
4197
4198 .cmdopt -oB <&'n'&>
4199 .cindex "SMTP" "passed connection"
4200 .cindex "SMTP" "multiple deliveries"
4201 .cindex "multiple SMTP deliveries"
4202 This is a debugging option which limits the maximum number of messages that can
4203 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4204 transport. If <&'n'&> is omitted, the limit is set to 1.
4205
4206 .cmdopt -odb
4207 .cindex "background delivery"
4208 .cindex "delivery" "in the background"
4209 This option applies to all modes in which Exim accepts incoming messages,
4210 including the listening daemon. It requests &"background"& delivery of such
4211 messages, which means that the accepting process automatically starts a
4212 delivery process for each message received, but does not wait for the delivery
4213 processes to finish.
4214
4215 When all the messages have been received, the reception process exits,
4216 leaving the delivery processes to finish in their own time. The standard output
4217 and error streams are closed at the start of each delivery process.
4218 This is the default action if none of the &%-od%& options are present.
4219
4220 If one of the queueing options in the configuration file
4221 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4222 overrides it if &%queue_only_override%& is set true, which is the default
4223 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4224
4225 .cmdopt -odf
4226 .cindex "foreground delivery"
4227 .cindex "delivery" "in the foreground"
4228 This option requests &"foreground"& (synchronous) delivery when Exim has
4229 accepted a locally-generated message. (For the daemon it is exactly the same as
4230 &%-odb%&.) A delivery process is automatically started to deliver the message,
4231 and Exim waits for it to complete before proceeding.
4232
4233 The original Exim reception process does not finish until the delivery
4234 process for the final message has ended. The standard error stream is left open
4235 during deliveries.
4236
4237 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4238 false and one of the queueing options in the configuration file is in effect.
4239
4240 If there is a temporary delivery error during foreground delivery, the
4241 message is left in the queue for later delivery, and the original reception
4242 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4243 restricted configuration that never queues messages.
4244
4245
4246 .cmdopt -odi
4247 This option is synonymous with &%-odf%&. It is provided for compatibility with
4248 Sendmail.
4249
4250 .cmdopt -odq
4251 .cindex "non-immediate delivery"
4252 .cindex "delivery" "suppressing immediate"
4253 .cindex "queueing incoming messages"
4254 This option applies to all modes in which Exim accepts incoming messages,
4255 including the listening daemon. It specifies that the accepting process should
4256 not automatically start a delivery process for each message received. Messages
4257 are placed in the queue, and remain there until a subsequent queue runner
4258 process encounters them. There are several configuration options (such as
4259 &%queue_only%&) that can be used to queue incoming messages under certain
4260 conditions. This option overrides all of them and also &%-odqs%&. It always
4261 forces queueing.
4262
4263 .cmdopt -odqs
4264 .cindex "SMTP" "delaying delivery"
4265 .cindex "first pass routing"
4266 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4267 However, like &%-odb%& and &%-odi%&, this option has no effect if
4268 &%queue_only_override%& is false and one of the queueing options in the
4269 configuration file is in effect.
4270
4271 When &%-odqs%& does operate, a delivery process is started for each incoming
4272 message, in the background by default, but in the foreground if &%-odi%& is
4273 also present. The recipient addresses are routed, and local deliveries are done
4274 in the normal way. However, if any SMTP deliveries are required, they are not
4275 done at this time, so the message remains in the queue until a subsequent queue
4276 runner process encounters it. Because routing was done, Exim knows which
4277 messages are waiting for which hosts, and so a number of messages for the same
4278 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4279 configuration option has the same effect for specific domains. See also the
4280 &%-qq%& option.
4281
4282 .cmdopt -oee
4283 .cindex "error" "reporting"
4284 If an error is detected while a non-SMTP message is being received (for
4285 example, a malformed address), the error is reported to the sender in a mail
4286 message.
4287
4288 .cindex "return code" "for &%-oee%&"
4289 Provided
4290 this error message is successfully sent, the Exim receiving process
4291 exits with a return code of zero. If not, the return code is 2 if the problem
4292 is that the original message has no recipients, or 1 for any other error.
4293 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4294
4295 .cmdopt -oem
4296 .cindex "error" "reporting"
4297 .cindex "return code" "for &%-oem%&"
4298 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4299 return code, whether or not the error message was successfully sent.
4300 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4301
4302 .cmdopt -oep
4303 .cindex "error" "reporting"
4304 If an error is detected while a non-SMTP message is being received, the
4305 error is reported by writing a message to the standard error file (stderr).
4306 .cindex "return code" "for &%-oep%&"
4307 The return code is 1 for all errors.
4308
4309 .cmdopt -oeq
4310 .cindex "error" "reporting"
4311 This option is supported for compatibility with Sendmail, but has the same
4312 effect as &%-oep%&.
4313
4314 .cmdopt -oew
4315 .cindex "error" "reporting"
4316 This option is supported for compatibility with Sendmail, but has the same
4317 effect as &%-oem%&.
4318
4319 .cmdopt -oi
4320 .cindex "dot" "in incoming non-SMTP message"
4321 This option, which has the same effect as &%-i%&, specifies that a dot on a
4322 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4323 single dot does terminate, though Exim does no special processing for other
4324 lines that start with a dot. This option is set by default if Exim is called as
4325 &'rmail'&. See also &%-ti%&.
4326
4327 .cmdopt -oitrue
4328 This option is treated as synonymous with &%-oi%&.
4329
4330 .cmdopt -oMa <&'host&~address'&>
4331 .cindex "sender" "host address, specifying for local message"
4332 A number of options starting with &%-oM%& can be used to set values associated
4333 with remote hosts on locally-submitted messages (that is, messages not received
4334 over TCP/IP). These options can be used by any caller in conjunction with the
4335 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4336 other circumstances, they are ignored unless the caller is trusted.
4337
4338 The &%-oMa%& option sets the sender host address. This may include a port
4339 number at the end, after a full stop (period). For example:
4340 .code
4341 exim -bs -oMa 10.9.8.7.1234
4342 .endd
4343 An alternative syntax is to enclose the IP address in square brackets,
4344 followed by a colon and the port number:
4345 .code
4346 exim -bs -oMa [10.9.8.7]:1234
4347 .endd
4348 The IP address is placed in the &$sender_host_address$& variable, and the
4349 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4350 are present on the command line, the sender host IP address is taken from
4351 whichever one is last.
4352
4353 .cmdopt -oMaa <&'name'&>
4354 .cindex "authentication" "name, specifying for local message"
4355 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4356 option sets the value of &$sender_host_authenticated$& (the authenticator
4357 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4358 This option can be used with &%-bh%& and &%-bs%& to set up an
4359 authenticated SMTP session without actually using the SMTP AUTH command.
4360
4361 .cmdopt -oMai <&'string'&>
4362 .cindex "authentication" "id, specifying for local message"
4363 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4364 option sets the value of &$authenticated_id$& (the id that was authenticated).
4365 This overrides the default value (the caller's login id, except with &%-bh%&,
4366 where there is no default) for messages from local sources. See chapter
4367 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4368
4369 .cmdopt -oMas <&'address'&>
4370 .cindex "authentication" "sender, specifying for local message"
4371 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4372 option sets the authenticated sender value in &$authenticated_sender$&. It
4373 overrides the sender address that is created from the caller's login id for
4374 messages from local sources, except when &%-bh%& is used, when there is no
4375 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4376 specified on a MAIL command overrides this value. See chapter
4377 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4378
4379 .cmdopt -oMi <&'interface&~address'&>
4380 .cindex "interface" "address, specifying for local message"
4381 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4382 option sets the IP interface address value. A port number may be included,
4383 using the same syntax as for &%-oMa%&. The interface address is placed in
4384 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4385
4386 .cmdopt -oMm <&'message&~reference'&>
4387 .cindex "message reference" "message reference, specifying for local message"
4388 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4389 option sets the message reference, e.g. message-id, and is logged during
4390 delivery. This is useful when some kind of audit trail is required to tie
4391 messages together. The format of the message reference is checked and will
4392 abort if the format is invalid. The option will only be accepted if exim is
4393 running in trusted mode, not as any regular user.
4394
4395 The best example of a message reference is when Exim sends a bounce message.
4396 The message reference is the message-id of the original message for which Exim
4397 is sending the bounce.
4398
4399 .cmdopt -oMr <&'protocol&~name'&>
4400 .cindex "protocol, specifying for local message"
4401 .vindex "&$received_protocol$&"
4402 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4403 option sets the received protocol value that is stored in
4404 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4405 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4406 SMTP protocol names (see the description of &$received_protocol$& in section
4407 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4408 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4409 be set by &%-oMr%&. Repeated use of this option is not supported.
4410
4411 .cmdopt -oMs <&'host&~name'&>
4412 .cindex "sender" "host name, specifying for local message"
4413 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4414 option sets the sender host name in &$sender_host_name$&. When this option is
4415 present, Exim does not attempt to look up a host name from an IP address; it
4416 uses the name it is given.
4417
4418 .cmdopt -oMt <&'ident&~string'&>
4419 .cindex "sender" "ident string, specifying for local message"
4420 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4421 option sets the sender ident value in &$sender_ident$&. The default setting for
4422 local callers is the login id of the calling process, except when &%-bh%& is
4423 used, when there is no default.
4424
4425 .cmdopt -om
4426 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4427 In Sendmail, this option means &"me too"&, indicating that the sender of a
4428 message should receive a copy of the message if the sender appears in an alias
4429 expansion. Exim always does this, so the option does nothing.
4430
4431 .cmdopt -oo
4432 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4433 This option is ignored. In Sendmail it specifies &"old style headers"&,
4434 whatever that means.
4435
4436 .cmdopt -oP <&'path'&>
4437 .cindex "pid (process id)" "of daemon"
4438 .cindex "daemon" "process id (pid)"
4439 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4440 value. The option specifies the file to which the process id of the daemon is
4441 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4442 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4443 because in those cases, the normal pid file is not used.
4444
4445 .cmdopt -oPX
4446 .cindex "pid (process id)" "of daemon"
4447 .cindex "daemon" "process id (pid)"
4448 This option is not intended for general use.
4449 The daemon uses it when terminating due to a SIGTEM, possibly in
4450 combination with &%-oP%&&~<&'path'&>.
4451 It causes the pid file to be removed.
4452
4453 .cmdopt -or <&'time'&>
4454 .cindex "timeout" "for non-SMTP input"
4455 This option sets a timeout value for incoming non-SMTP messages. If it is not
4456 set, Exim will wait forever for the standard input. The value can also be set
4457 by the &%receive_timeout%& option. The format used for specifying times is
4458 described in section &<<SECTtimeformat>>&.
4459
4460 .cmdopt -os <&'time'&>
4461 .cindex "timeout" "for SMTP input"
4462 .cindex "SMTP" "input timeout"
4463 This option sets a timeout value for incoming SMTP messages. The timeout
4464 applies to each SMTP command and block of data. The value can also be set by
4465 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4466 for specifying times is described in section &<<SECTtimeformat>>&.
4467
4468 .cmdopt -ov
4469 This option has exactly the same effect as &%-v%&.
4470
4471 .cmdopt -oX <&'number&~or&~string'&>
4472 .cindex "TCP/IP" "setting listening ports"
4473 .cindex "TCP/IP" "setting listening interfaces"
4474 .cindex "port" "receiving TCP/IP"
4475 This option is relevant only when the &%-bd%& (start listening daemon) option
4476 is also given. It controls which ports and interfaces the daemon uses. Details
4477 of the syntax, and how it interacts with configuration file options, are given
4478 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4479 file is written unless &%-oP%& is also present to specify a pid filename.
4480
4481 .cmdopt -oY
4482 .cindex "daemon notifier socket"
4483 This option controls the creation of an inter-process communications endpoint
4484 by the Exim daemon.
4485 It is only relevant when the &%-bd%& (start listening daemon) option is also
4486 given.
4487 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4488 option is also present.
4489 If this option is given then the socket will not be created.  This is required
4490 if the system is running multiple daemons, in which case it should
4491 be used on all.
4492 The features supported by the socket will not be available in such cases.
4493
4494 The socket is currently used for
4495 .ilist
4496 fast ramp-up of queue runner processes
4497 .next
4498 caching compiled regexes
4499 .next
4500 obtaining a current queue size
4501 .endlist
4502
4503 .cmdopt -pd
4504 .cindex "Perl" "starting the interpreter"
4505 This option applies when an embedded Perl interpreter is linked with Exim (see
4506 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4507 option, forcing the starting of the interpreter to be delayed until it is
4508 needed.
4509
4510 .cmdopt -ps
4511 .cindex "Perl" "starting the interpreter"
4512 This option applies when an embedded Perl interpreter is linked with Exim (see
4513 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4514 option, forcing the starting of the interpreter to occur as soon as Exim is
4515 started.
4516
4517 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4518 .oindex "&%-p%&"
4519 For compatibility with Sendmail, this option is equivalent to
4520 .display
4521 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4522 .endd
4523 It sets the incoming protocol and host name (for trusted callers). The
4524 host name and its colon can be omitted when only the protocol is to be set.
4525 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4526 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4527 or &`s`& using this option (but that does not seem a real limitation).
4528 Repeated use of this option is not supported.
4529
4530 .cmdopt -q
4531 .cindex "queue runner" "starting manually"
4532 This option is normally restricted to admin users. However, there is a
4533 configuration option called &%prod_requires_admin%& which can be set false to
4534 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4535 and &%-S%& options).
4536
4537 .cindex "queue runner" "description of operation"
4538 If other commandline options do not specify an action,
4539 the &%-q%& option starts one queue runner process. This scans the queue of
4540 waiting messages, and runs a delivery process for each one in turn. It waits
4541 for each delivery process to finish before starting the next one. A delivery
4542 process may not actually do any deliveries if the retry times for the addresses
4543 have not been reached. Use &%-qf%& (see below) if you want to override this.
4544
4545 If
4546 .cindex "SMTP" "passed connection"
4547 .cindex "SMTP" "multiple deliveries"
4548 .cindex "multiple SMTP deliveries"
4549 the delivery process spawns other processes to deliver other messages down
4550 passed SMTP connections, the queue runner waits for these to finish before
4551 proceeding.
4552
4553 When all the queued messages have been considered, the original queue runner
4554 process terminates. In other words, a single pass is made over the waiting
4555 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4556 this to be repeated periodically.
4557
4558 Exim processes the waiting messages in an unpredictable order. It isn't very
4559 random, but it is likely to be different each time, which is all that matters.
4560 If one particular message screws up a remote MTA, other messages to the same
4561 MTA have a chance of getting through if they get tried first.
4562
4563 It is possible to cause the messages to be processed in lexical message id
4564 order, which is essentially the order in which they arrived, by setting the
4565 &%queue_run_in_order%& option, but this is not recommended for normal use.
4566
4567 .vitem &%-q%&<&'qflags'&>
4568 The &%-q%& option may be followed by one or more flag letters that change its
4569 behaviour. They are all optional, but if more than one is present, they must
4570 appear in the correct order. Each flag is described in a separate item below.
4571
4572 .vitem &%-qq...%&
4573 .oindex "&%-qq%&"
4574 .cindex "queue" "double scanning"
4575 .cindex "queue" "routing"
4576 .cindex "routing" "whole queue before delivery"
4577 .cindex "first pass routing"
4578 .cindex "queue runner" "two phase"
4579 An option starting with &%-qq%& requests a two-stage queue run. In the first
4580 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4581 every domain. Addresses are routed, local deliveries happen, but no remote
4582 transports are run.
4583
4584 Performance will be best if the &%queue_run_in_order%& option is false.
4585 If that is so and
4586 the &%queue_fast_ramp%& option is true
4587 and a daemon-notifier socket is available
4588 then in the first phase of the run,
4589 once a threshold number of messages are routed for a given host,
4590 a delivery process is forked in parallel with the rest of the scan.
4591
4592 .cindex "hints database" "remembering routing"
4593 The hints database that remembers which messages are waiting for specific hosts
4594 is updated, as if delivery to those hosts had been deferred.
4595
4596 After the first queue scan complete,
4597 a second, normal queue scan is done, with routing and delivery taking
4598 place as normal.
4599 Messages that are routed to the same host should mostly be
4600 delivered down a single SMTP
4601 .cindex "SMTP" "passed connection"
4602 .cindex "SMTP" "multiple deliveries"
4603 .cindex "multiple SMTP deliveries"
4604 connection because of the hints that were set up during the first queue scan.
4605
4606 Two-phase queue runs should be used on systems which, even intermittently,
4607 have a large queue (such as mailing-list operators).
4608 They may also be useful for hosts that are connected to the Internet
4609 intermittently.
4610
4611 .vitem &%-q[q]i...%&
4612 .oindex "&%-qi%&"
4613 .cindex "queue" "initial delivery"
4614 If the &'i'& flag is present, the queue runner runs delivery processes only for
4615 those messages that haven't previously been tried. (&'i'& stands for &"initial
4616 delivery"&.) This can be helpful if you are putting messages in the queue using
4617 &%-odq%& and want a queue runner just to process the new messages.
4618
4619 .vitem &%-q[q][i]f...%&
4620 .oindex "&%-qf%&"
4621 .cindex "queue" "forcing delivery"
4622 .cindex "delivery" "forcing in queue run"
4623 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4624 message, whereas without &'f'& only those non-frozen addresses that have passed
4625 their retry times are tried.
4626
4627 .vitem &%-q[q][i]ff...%&
4628 .oindex "&%-qff%&"
4629 .cindex "frozen messages" "forcing delivery"
4630 If &'ff'& is present, a delivery attempt is forced for every message, whether
4631 frozen or not.
4632
4633 .vitem &%-q[q][i][f[f]]l%&
4634 .oindex "&%-ql%&"
4635 .cindex "queue" "local deliveries only"
4636 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4637 be done. If a message requires any remote deliveries, it remains in the queue
4638 for later delivery.
4639
4640 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4641 .oindex "&%-qG%&"
4642 .cindex queue named
4643 .cindex "named queues"  "deliver from"
4644 .cindex "queue" "delivering specific messages"
4645 If the &'G'& flag and a name is present, the queue runner operates on the
4646 queue with the given name rather than the default queue.
4647 The name should not contain a &'/'& character.
4648 For a periodic queue run (see below)
4649 append to the name a slash and a time value.
4650
4651 If other commandline options specify an action, a &'-qG<name>'& option
4652 will specify a queue to operate on.
4653 For example:
4654 .code
4655 exim -bp -qGquarantine
4656 mailq -qGquarantine
4657 exim -qGoffpeak -Rf @special.domain.example
4658 .endd
4659
4660 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4661 When scanning the queue, Exim can be made to skip over messages whose ids are
4662 lexically less than a given value by following the &%-q%& option with a
4663 starting message id. For example:
4664 .code
4665 exim -q 0t5C6f-0000c8-00
4666 .endd
4667 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4668 second message id is given, messages whose ids are lexically greater than it
4669 are also skipped. If the same id is given twice, for example,
4670 .code
4671 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4672 .endd
4673 just one delivery process is started, for that message. This differs from
4674 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4675 that it counts as a delivery from a queue run. Note that the selection
4676 mechanism does not affect the order in which the messages are scanned. There
4677 are also other ways of selecting specific sets of messages for delivery in a
4678 queue run &-- see &%-R%& and &%-S%&.
4679
4680 .vitem &%-q%&<&'qflags'&><&'time'&>
4681 .cindex "queue runner" "starting periodically"
4682 .cindex "periodic queue running"
4683 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4684 starting a queue runner process at intervals specified by the given time value
4685 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4686 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4687 single daemon process handles both functions. A common way of starting up a
4688 combined daemon at system boot time is to use a command such as
4689 .code
4690 /usr/exim/bin/exim -bd -q30m
4691 .endd
4692 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4693 process every 30 minutes.
4694
4695 .cindex "named queues" "queue runners"
4696 It is possible to set up runners for multiple named queues within one daemon,
4697 For example:
4698 .code
4699 exim -qGhipri/2m -q10m -qqGmailinglist/1h
4700 .endd
4701
4702 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4703 pid file is written unless one is explicitly requested by the &%-oP%& option.
4704
4705 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4706 .oindex "&%-qR%&"
4707 This option is synonymous with &%-R%&. It is provided for Sendmail
4708 compatibility.
4709
4710 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4711 .oindex "&%-qS%&"
4712 This option is synonymous with &%-S%&.
4713
4714 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4715 .oindex "&%-R%&"
4716 .cindex "queue runner" "for specific recipients"
4717 .cindex "delivery" "to given domain"
4718 .cindex "domain" "delivery to"
4719 The <&'rsflags'&> may be empty, in which case the white space before the string
4720 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4721 which are the possible values for <&'rsflags'&>. White space is required if
4722 <&'rsflags'&> is not empty.
4723
4724 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4725 perform a single queue run, except that, when scanning the messages on the
4726 queue, Exim processes only those that have at least one undelivered recipient
4727 address containing the given string, which is checked in a case-independent
4728 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4729 regular expression; otherwise it is a literal string.
4730
4731 If you want to do periodic queue runs for messages with specific recipients,
4732 you can combine &%-R%& with &%-q%& and a time value. For example:
4733 .code
4734 exim -q25m -R @special.domain.example
4735 .endd
4736 This example does a queue run for messages with recipients in the given domain
4737 every 25 minutes. Any additional flags that are specified with &%-q%& are
4738 applied to each queue run.
4739
4740 Once a message is selected for delivery by this mechanism, all its addresses
4741 are processed. For the first selected message, Exim overrides any retry
4742 information and forces a delivery attempt for each undelivered address. This
4743 means that if delivery of any address in the first message is successful, any
4744 existing retry information is deleted, and so delivery attempts for that
4745 address in subsequently selected messages (which are processed without forcing)
4746 will run. However, if delivery of any address does not succeed, the retry
4747 information is updated, and in subsequently selected messages, the failing
4748 address will be skipped.
4749
4750 .cindex "frozen messages" "forcing delivery"
4751 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4752 all selected messages, not just the first; frozen messages are included when
4753 &'ff'& is present.
4754
4755 The &%-R%& option makes it straightforward to initiate delivery of all messages
4756 to a given domain after a host has been down for some time. When the SMTP
4757 command ETRN is accepted by its ACL (see section &<<SECTETRN>>&), its default
4758 effect is to run Exim with the &%-R%& option, but it can be configured to run
4759 an arbitrary command instead.
4760
4761 .cmdopt -r
4762 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4763
4764 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4765 .oindex "&%-S%&"
4766 .cindex "delivery" "from given sender"
4767 .cindex "queue runner" "for specific senders"
4768 This option acts like &%-R%& except that it checks the string against each
4769 message's sender instead of against the recipients. If &%-R%& is also set, both
4770 conditions must be met for a message to be selected. If either of the options
4771 has &'f'& or &'ff'& in its flags, the associated action is taken.
4772
4773 .cmdopt -Tqt <&'times'&>
4774 This is an option that is exclusively for use by the Exim testing suite. It is not
4775 recognized when Exim is run normally. It allows for the setting up of explicit
4776 &"queue times"& so that various warning/retry features can be tested.
4777
4778 .cmdopt -t
4779 .cindex "recipient" "extracting from header lines"
4780 .chindex Bcc:
4781 .chindex Cc:
4782 .chindex To:
4783 When Exim is receiving a locally-generated, non-SMTP message on its standard
4784 input, the &%-t%& option causes the recipients of the message to be obtained
4785 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4786 from the command arguments. The addresses are extracted before any rewriting
4787 takes place and the &'Bcc:'& header line, if present, is then removed.
4788
4789 .cindex "Sendmail compatibility" "&%-t%& option"
4790 If the command has any arguments, they specify addresses to which the message
4791 is &'not'& to be delivered. That is, the argument addresses are removed from
4792 the recipients list obtained from the headers. This is compatible with Smail 3
4793 and in accordance with the documented behaviour of several versions of
4794 Sendmail, as described in man pages on a number of operating systems (e.g.
4795 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4796 argument addresses to those obtained from the headers, and the O'Reilly
4797 Sendmail book documents it that way. Exim can be made to add argument addresses
4798 instead of subtracting them by setting the option
4799 &%extract_addresses_remove_arguments%& false.
4800
4801 .cindex "&%Resent-%& header lines" "with &%-t%&"
4802 If there are any &%Resent-%& header lines in the message, Exim extracts
4803 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4804 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4805 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4806 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4807
4808 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4809 message is resent several times). The RFC also specifies that they should be
4810 added at the front of the message, and separated by &'Received:'& lines. It is
4811 not at all clear how &%-t%& should operate in the present of multiple sets,
4812 nor indeed exactly what constitutes a &"set"&.
4813 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4814 are often added at the end of the header, and if a message is resent more than
4815 once, it is common for the original set of &%Resent-%& headers to be renamed as
4816 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4817
4818 .cmdopt -ti
4819 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4820 compatibility with Sendmail.
4821
4822 .cmdopt -tls-on-connect
4823 .cindex "TLS" "use without STARTTLS"
4824 .cindex "TLS" "automatic start"
4825 This option is available when Exim is compiled with TLS support. It forces all
4826 incoming SMTP connections to behave as if the incoming port is listed in the
4827 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4828 &<<CHAPTLS>>& for further details.
4829
4830
4831 .cmdopt -U
4832 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4833 Sendmail uses this option for &"initial message submission"&, and its
4834 documentation states that in future releases, it may complain about
4835 syntactically invalid messages rather than fixing them when this flag is not
4836 set. Exim ignores this option.
4837
4838 .cmdopt -v
4839 This option causes Exim to write information to the standard error stream,
4840 describing what it is doing. In particular, it shows the log lines for
4841 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4842 dialogue is shown. Some of the log lines shown may not actually be written to
4843 the log if the setting of &%log_selector%& discards them. Any relevant
4844 selectors are shown with each log line. If none are shown, the logging is
4845 unconditional.
4846
4847 .cmdopt -x
4848 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4849 National Language Support extended characters in the body of the mail item"&).
4850 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4851 this option.
4852
4853 .cmdopt -X <&'logfile'&>
4854 This option is interpreted by Sendmail to cause debug information to be sent
4855 to the named file.  It is ignored by Exim.
4856
4857 .cmdopt -z <&'log-line'&>
4858 This option writes its argument to Exim's logfile.
4859 Use is restricted to administrators; the intent is for operational notes.
4860 Quotes should be used to maintain a multi-word item as a single argument,
4861 under most shells.
4862 .endlist
4863
4864 .ecindex IIDclo1
4865 .ecindex IIDclo2
4866
4867
4868 . ////////////////////////////////////////////////////////////////////////////
4869 . Insert a stylized DocBook comment here, to identify the end of the command
4870 . line options. This is for the benefit of the Perl script that automatically
4871 . creates a man page for the options.
4872 . ////////////////////////////////////////////////////////////////////////////
4873
4874 .literal xml
4875 <!-- === End of command line options === -->
4876 .literal off
4877
4878
4879
4880
4881
4882 . ////////////////////////////////////////////////////////////////////////////
4883 . ////////////////////////////////////////////////////////////////////////////
4884
4885
4886 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4887          "The runtime configuration file"
4888
4889 .cindex "runtime configuration"
4890 .cindex "configuration file" "general description"
4891 .cindex "CONFIGURE_FILE"
4892 .cindex "configuration file" "errors in"
4893 .cindex "error" "in configuration file"
4894 .cindex "return code" "for bad configuration"
4895 Exim uses a single runtime configuration file that is read whenever an Exim
4896 binary is executed. Note that in normal operation, this happens frequently,
4897 because Exim is designed to operate in a distributed manner, without central
4898 control.
4899
4900 If a syntax error is detected while reading the configuration file, Exim
4901 writes a message on the standard error, and exits with a non-zero return code.
4902 The message is also written to the panic log. &*Note*&: Only simple syntax
4903 errors can be detected at this time. The values of any expanded options are
4904 not checked until the expansion happens, even when the expansion does not
4905 actually alter the string.
4906
4907 The name of the configuration file is compiled into the binary for security
4908 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4909 most configurations, this specifies a single file. However, it is permitted to
4910 give a colon-separated list of filenames, in which case Exim uses the first
4911 existing file in the list.
4912
4913 .cindex "EXIM_USER"
4914 .cindex "EXIM_GROUP"
4915 .cindex "CONFIGURE_OWNER"
4916 .cindex "CONFIGURE_GROUP"
4917 .cindex "configuration file" "ownership"
4918 .cindex "ownership" "configuration file"
4919 The runtime configuration file must be owned by root or by the user that is
4920 specified at compile time by the CONFIGURE_OWNER option (if set). The
4921 configuration file must not be world-writeable, or group-writeable unless its
4922 group is the root group or the one specified at compile time by the
4923 CONFIGURE_GROUP option.
4924
4925 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4926 to root, anybody who is able to edit the runtime configuration file has an
4927 easy way to run commands as root. If you specify a user or group in the
4928 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4929 who are members of that group will trivially be able to obtain root privileges.
4930
4931 Up to Exim version 4.72, the runtime configuration file was also permitted to
4932 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4933 since it offered a simple privilege escalation for any attacker who managed to
4934 compromise the Exim user account.
4935
4936 A default configuration file, which will work correctly in simple situations,
4937 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4938 defines just one filename, the installation process copies the default
4939 configuration to a new file of that name if it did not previously exist. If
4940 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4941 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4942 configuration.
4943
4944
4945
4946 .section "Using a different configuration file" "SECID40"
4947 .cindex "configuration file" "alternate"
4948 A one-off alternate configuration can be specified by the &%-C%& command line
4949 option, which may specify a single file or a list of files. However, when
4950 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4951 unless the argument for &%-C%& is identical to the built-in value from
4952 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4953 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4954 is useful mainly for checking the syntax of configuration files before
4955 installing them. No owner or group checks are done on a configuration file
4956 specified by &%-C%&, if root privilege has been dropped.
4957
4958 Even the Exim user is not trusted to specify an arbitrary configuration file
4959 with the &%-C%& option to be used with root privileges, unless that file is
4960 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4961 testing a configuration using &%-C%& right through message reception and
4962 delivery, even if the caller is root. The reception works, but by that time,
4963 Exim is running as the Exim user, so when it re-execs to regain privilege for
4964 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4965 can test reception and delivery using two separate commands (one to put a
4966 message in the queue, using &%-odq%&, and another to do the delivery, using
4967 &%-M%&).
4968
4969 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4970 prefix string with which any file named in a &%-C%& command line option must
4971 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4972 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4973 filename can be used with &%-C%&.
4974
4975 One-off changes to a configuration can be specified by the &%-D%& command line
4976 option, which defines and overrides values for macros used inside the
4977 configuration file. However, like &%-C%&, the use of this option by a
4978 non-privileged user causes Exim to discard its root privilege.
4979 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4980 completely disabled, and its use causes an immediate error exit.
4981
4982 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4983 to declare certain macro names trusted, such that root privilege will not
4984 necessarily be discarded.
4985 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4986 considered safe and, if &%-D%& only supplies macros from this list, and the
4987 values are acceptable, then Exim will not give up root privilege if the caller
4988 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4989 transition mechanism and is expected to be removed in the future.  Acceptable
4990 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4991
4992 Some sites may wish to use the same Exim binary on different machines that
4993 share a file system, but to use different configuration files on each machine.
4994 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4995 looks for a file whose name is the configuration filename followed by a dot
4996 and the machine's node name, as obtained from the &[uname()]& function. If this
4997 file does not exist, the standard name is tried. This processing occurs for
4998 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4999
5000 In some esoteric situations different versions of Exim may be run under
5001 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
5002 help with this. See the comments in &_src/EDITME_& for details.
5003
5004
5005
5006 .section "Configuration file format" "SECTconffilfor"
5007 .cindex "configuration file" "format of"
5008 .cindex "format" "configuration file"
5009 Exim's configuration file is divided into a number of different parts. General
5010 option settings must always appear at the start of the file. The other parts
5011 are all optional, and may appear in any order. Each part other than the first
5012 is introduced by the word &"begin"& followed by at least one literal
5013 space, and the name of the part. The optional parts are:
5014
5015 .ilist
5016 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
5017 &<<CHAPACL>>&).
5018 .next
5019 .cindex "AUTH" "configuration"
5020 &'authenticators'&: Configuration settings for the authenticator drivers. These
5021 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
5022 .next
5023 &'routers'&: Configuration settings for the router drivers. Routers process
5024 addresses and determine how the message is to be delivered (see chapters
5025 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
5026 .next
5027 &'transports'&: Configuration settings for the transport drivers. Transports
5028 define mechanisms for copying messages to destinations (see chapters
5029 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
5030 .next
5031 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
5032 If there is no retry section, or if it is empty (that is, no retry rules are
5033 defined), Exim will not retry deliveries. In this situation, temporary errors
5034 are treated the same as permanent errors. Retry rules are discussed in chapter
5035 &<<CHAPretry>>&.
5036 .next
5037 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
5038 when new addresses are generated during delivery. Rewriting is discussed in
5039 chapter &<<CHAPrewrite>>&.
5040 .next
5041 &'local_scan'&: Private options for the &[local_scan()]& function. If you
5042 want to use this feature, you must set
5043 .code
5044 LOCAL_SCAN_HAS_OPTIONS=yes
5045 .endd
5046 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5047 facility are given in chapter &<<CHAPlocalscan>>&.
5048 .endlist
5049
5050 .cindex "configuration file" "leading white space in"
5051 .cindex "configuration file" "trailing white space in"
5052 .cindex "white space" "in configuration file"
5053 Leading and trailing white space in configuration lines is always ignored.
5054
5055 Blank lines in the file, and lines starting with a # character (ignoring
5056 leading white space) are treated as comments and are ignored. &*Note*&: A
5057 # character other than at the beginning of a line is not treated specially,
5058 and does not introduce a comment.
5059
5060 Any non-comment line can be continued by ending it with a backslash. Note that
5061 the general rule for white space means that trailing white space after the
5062 backslash and leading white space at the start of continuation
5063 lines is ignored. Comment lines beginning with # (but not empty lines) may
5064 appear in the middle of a sequence of continuation lines.
5065
5066 A convenient way to create a configuration file is to start from the
5067 default, which is supplied in &_src/configure.default_&, and add, delete, or
5068 change settings as required.
5069
5070 The ACLs, retry rules, and rewriting rules have their own syntax which is
5071 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5072 respectively. The other parts of the configuration file have some syntactic
5073 items in common, and these are described below, from section &<<SECTcos>>&
5074 onwards. Before that, the inclusion, macro, and conditional facilities are
5075 described.
5076
5077
5078
5079 .section "File inclusions in the configuration file" "SECID41"
5080 .cindex "inclusions in configuration file"
5081 .cindex "configuration file" "including other files"
5082 .cindex "&`.include`& in configuration file"
5083 .cindex "&`.include_if_exists`& in configuration file"
5084 You can include other files inside Exim's runtime configuration file by
5085 using this syntax:
5086 .display
5087 &`.include`& <&'filename'&>
5088 &`.include_if_exists`& <&'filename'&>
5089 .endd
5090 on a line by itself. Double quotes round the filename are optional. If you use
5091 the first form, a configuration error occurs if the file does not exist; the
5092 second form does nothing for non-existent files.
5093 The first form allows a relative name. It is resolved relative to
5094 the directory of the including file. For the second form an absolute filename
5095 is required.
5096
5097 Includes may be nested to any depth, but remember that Exim reads its
5098 configuration file often, so it is a good idea to keep them to a minimum.
5099 If you change the contents of an included file, you must HUP the daemon,
5100 because an included file is read only when the configuration itself is read.
5101
5102 The processing of inclusions happens early, at a physical line level, so, like
5103 comment lines, an inclusion can be used in the middle of an option setting,
5104 for example:
5105 .code
5106 hosts_lookup = a.b.c \
5107                .include /some/file
5108 .endd
5109 Include processing happens after macro processing (see below). Its effect is to
5110 process the lines of the included file as if they occurred inline where the
5111 inclusion appears.
5112
5113
5114
5115 .section "Macros in the configuration file" "SECTmacrodefs"
5116 .cindex "macro" "description of"
5117 .cindex "configuration file" "macros"
5118 If a line in the main part of the configuration (that is, before the first
5119 &"begin"& line) begins with an upper case letter, it is taken as a macro
5120 definition, and must be of the form
5121 .display
5122 <&'name'&> = <&'rest of line'&>
5123 .endd
5124 The name must consist of letters, digits, and underscores, and need not all be
5125 in upper case, though that is recommended. The rest of the line, including any
5126 continuations, is the replacement text, and has leading and trailing white
5127 space removed. Quotes are not removed. The replacement text can never end with
5128 a backslash character, but this doesn't seem to be a serious limitation.
5129
5130 Macros may also be defined between router, transport, authenticator, or ACL
5131 definitions. They may not, however, be defined within an individual driver or
5132 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5133
5134 .section "Macro substitution" "SECID42"
5135 Once a macro is defined, all subsequent lines in the file (and any included
5136 files) are scanned for the macro name; if there are several macros, the line is
5137 scanned for each, in turn, in the order in which the macros are defined. The
5138 replacement text is not re-scanned for the current macro, though it is scanned
5139 for subsequently defined macros. For this reason, a macro name may not contain
5140 the name of a previously defined macro as a substring. You could, for example,
5141 define
5142 .display
5143 &`ABCD_XYZ = `&<&'something'&>
5144 &`ABCD = `&<&'something else'&>
5145 .endd
5146 but putting the definitions in the opposite order would provoke a configuration
5147 error. Macro expansion is applied to individual physical lines from the file,
5148 before checking for line continuation or file inclusion (see above). If a line
5149 consists solely of a macro name, and the expansion of the macro is empty, the
5150 line is ignored. A macro at the start of a line may turn the line into a
5151 comment line or a &`.include`& line.
5152
5153
5154 .section "Redefining macros" "SECID43"
5155 Once defined, the value of a macro can be redefined later in the configuration
5156 (or in an included file). Redefinition is specified by using &'=='& instead of
5157 &'='&. For example:
5158 .code
5159 MAC =  initial value
5160 ...
5161 MAC == updated value
5162 .endd
5163 Redefinition does not alter the order in which the macros are applied to the
5164 subsequent lines of the configuration file. It is still the same order in which
5165 the macros were originally defined. All that changes is the macro's value.
5166 Redefinition makes it possible to accumulate values. For example:
5167 .code
5168 MAC =  initial value
5169 ...
5170 MAC == MAC and something added
5171 .endd
5172 This can be helpful in situations where the configuration file is built
5173 from a number of other files.
5174
5175 .section "Overriding macro values" "SECID44"
5176 The values set for macros in the configuration file can be overridden by the
5177 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5178 used, unless called by root or the Exim user. A definition on the command line
5179 using the &%-D%& option causes all definitions and redefinitions within the
5180 file to be ignored.
5181
5182
5183
5184 .section "Example of macro usage" "SECID45"
5185 As an example of macro usage, consider a configuration where aliases are looked
5186 up in a MySQL database. It helps to keep the file less cluttered if long
5187 strings such as SQL statements are defined separately as macros, for example:
5188 .code
5189 ALIAS_QUERY = select mailbox from user where \
5190               login='${quote_mysql:$local_part}';
5191 .endd
5192 This can then be used in a &(redirect)& router setting like this:
5193 .code
5194 data = ${lookup mysql{ALIAS_QUERY}}
5195 .endd
5196 In earlier versions of Exim macros were sometimes used for domain, host, or
5197 address lists. In Exim 4 these are handled better by named lists &-- see
5198 section &<<SECTnamedlists>>&.
5199
5200
5201 .section "Builtin macros" "SECTbuiltinmacros"
5202 Exim defines some macros depending on facilities available, which may
5203 differ due to build-time definitions and from one release to another.
5204 All of these macros start with an underscore.
5205 They can be used to conditionally include parts of a configuration
5206 (see below).
5207
5208 The following classes of macros are defined:
5209 .display
5210 &` _HAVE_*                    `&  build-time defines
5211 &` _DRIVER_ROUTER_*           `&  router drivers
5212 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5213 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5214 &` _EXP_COND_*                `&  expansion conditions
5215 &` _EXP_ITEM_*                `&  expansion items
5216 &` _EXP_OP_*                  `&  expansion operators
5217 &` _EXP_VAR_*                 `&  expansion variables
5218 &` _LOG_*                     `&  log_selector values
5219 &` _OPT_MAIN_*                `&  main config options
5220 &` _OPT_ROUTERS_*             `&  generic router options
5221 &` _OPT_TRANSPORTS_*          `&  generic transport options
5222 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5223 &` _OPT_ROUTER_*_*            `&  private router options
5224 &` _OPT_TRANSPORT_*_*         `&  private transport options
5225 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5226 .endd
5227
5228 Use an &"exim -bP macros"& command to get the list of macros.
5229
5230
5231 .section "Conditional skips in the configuration file" "SECID46"
5232 .cindex "configuration file" "conditional skips"
5233 .cindex "&`.ifdef`&"
5234 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5235 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5236 portions of the configuration file. The processing happens whenever the file is
5237 read (that is, when an Exim binary starts to run).
5238
5239 The implementation is very simple. Instances of the first four directives must
5240 be followed by text that includes the names of one or macros. The condition
5241 that is tested is whether or not any macro substitution has taken place in the
5242 line. Thus:
5243 .code
5244 .ifdef AAA
5245 message_size_limit = 50M
5246 .else
5247 message_size_limit = 100M
5248 .endif
5249 .endd
5250 sets a message size limit of 50M if the macro &`AAA`& is defined
5251 (or &`A`& or &`AA`&), and 100M
5252 otherwise. If there is more than one macro named on the line, the condition
5253 is true if any of them are defined. That is, it is an &"or"& condition. To
5254 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5255
5256 Although you can use a macro expansion to generate one of these directives,
5257 it is not very useful, because the condition &"there was a macro substitution
5258 in this line"& will always be true.
5259
5260 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5261 to clarify complicated nestings.
5262
5263
5264
5265 .section "Common option syntax" "SECTcos"
5266 .cindex "common option syntax"
5267 .cindex "syntax of common options"
5268 .cindex "configuration file" "common option syntax"
5269 For the main set of options, driver options, and &[local_scan()]& options,
5270 each setting is on a line by itself, and starts with a name consisting of
5271 lower-case letters and underscores. Many options require a data value, and in
5272 these cases the name must be followed by an equals sign (with optional white
5273 space) and then the value. For example:
5274 .code
5275 qualify_domain = mydomain.example.com
5276 .endd
5277 .cindex "hiding configuration option values"
5278 .cindex "configuration options" "hiding value of"
5279 .cindex "options" "hiding value of"
5280 Some option settings may contain sensitive data, for example, passwords for
5281 accessing databases. To stop non-admin users from using the &%-bP%& command
5282 line option to read these values, you can precede the option settings with the
5283 word &"hide"&. For example:
5284 .code
5285 hide mysql_servers = localhost/users/admin/secret-password
5286 .endd
5287 For non-admin users, such options are displayed like this:
5288 .code
5289 mysql_servers = <value not displayable>
5290 .endd
5291 If &"hide"& is used on a driver option, it hides the value of that option on
5292 all instances of the same driver.
5293
5294 The following sections describe the syntax used for the different data types
5295 that are found in option settings.
5296
5297
5298 .section "Boolean options" "SECID47"
5299 .cindex "format" "boolean"
5300 .cindex "boolean configuration values"
5301 .oindex "&%no_%&&'xxx'&"
5302 .oindex "&%not_%&&'xxx'&"
5303 Options whose type is given as boolean are on/off switches. There are two
5304 different ways of specifying such options: with and without a data value. If
5305 the option name is specified on its own without data, the switch is turned on;
5306 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5307 boolean options may be followed by an equals sign and one of the words
5308 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5309 the following two settings have exactly the same effect:
5310 .code
5311 queue_only
5312 queue_only = true
5313 .endd
5314 The following two lines also have the same (opposite) effect:
5315 .code
5316 no_queue_only
5317 queue_only = false
5318 .endd
5319 You can use whichever syntax you prefer.
5320
5321
5322
5323
5324 .section "Integer values" "SECID48"
5325 .cindex "integer configuration values"
5326 .cindex "format" "integer"
5327 If an option's type is given as &"integer"&, the value can be given in decimal,
5328 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5329 number is assumed. Otherwise, it is treated as an octal number unless it starts
5330 with the characters &"0x"&, in which case the remainder is interpreted as a
5331 hexadecimal number.
5332
5333 If an integer value is followed by the letter K, it is multiplied by 1024; if
5334 it is followed by the letter M, it is multiplied by 1024x1024;
5335 if by the letter G, 1024x1024x1024.
5336 When the values
5337 of integer option settings are output, values which are an exact multiple of
5338 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5339 and M. The printing style is independent of the actual input format that was
5340 used.
5341
5342
5343 .section "Octal integer values" "SECID49"
5344 .cindex "integer format"
5345 .cindex "format" "octal integer"
5346 If an option's type is given as &"octal integer"&, its value is always
5347 interpreted as an octal number, whether or not it starts with the digit zero.
5348 Such options are always output in octal.
5349
5350
5351 .section "Fixed point numbers" "SECID50"
5352 .cindex "fixed point configuration values"
5353 .cindex "format" "fixed point"
5354 If an option's type is given as &"fixed-point"&, its value must be a decimal
5355 integer, optionally followed by a decimal point and up to three further digits.
5356
5357
5358
5359 .section "Time intervals" "SECTtimeformat"
5360 .cindex "time interval" "specifying in configuration"
5361 .cindex "format" "time interval"
5362 A time interval is specified as a sequence of numbers, each followed by one of
5363 the following letters, with no intervening white space:
5364
5365 .table2 30pt
5366 .irow &%s%& seconds
5367 .irow &%m%& minutes
5368 .irow &%h%& hours
5369 .irow &%d%& days
5370 .irow &%w%& weeks
5371 .endtable
5372
5373 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5374 intervals are output in the same format. Exim does not restrict the values; it
5375 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5376
5377
5378
5379 .section "String values" "SECTstrings"
5380 .cindex "string" "format of configuration values"
5381 .cindex "format" "string"
5382 If an option's type is specified as &"string"&, the value can be specified with
5383 or without double-quotes. If it does not start with a double-quote, the value
5384 consists of the remainder of the line plus any continuation lines, starting at
5385 the first character after any leading white space, with trailing white space
5386 removed, and with no interpretation of the characters in the string. Because
5387 Exim removes comment lines (those beginning with #) at an early stage, they can
5388 appear in the middle of a multi-line string. The following two settings are
5389 therefore equivalent:
5390 .code
5391 trusted_users = uucp:mail
5392 trusted_users = uucp:\
5393                 # This comment line is ignored
5394                 mail
5395 .endd
5396 .cindex "string" "quoted"
5397 .cindex "escape characters in quoted strings"
5398 If a string does start with a double-quote, it must end with a closing
5399 double-quote, and any backslash characters other than those used for line
5400 continuation are interpreted as escape characters, as follows:
5401
5402 .table2 100pt
5403 .irow &`\\`&                     "single backslash"
5404 .irow &`\n`&                     "newline"
5405 .irow &`\r`&                     "carriage return"
5406 .irow &`\t`&                     "tab"
5407 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5408 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5409                                    character"
5410 .endtable
5411
5412 If a backslash is followed by some other character, including a double-quote
5413 character, that character replaces the pair.
5414
5415 Quoting is necessary only if you want to make use of the backslash escapes to
5416 insert special characters, or if you need to specify a value with leading or
5417 trailing spaces. These cases are rare, so quoting is almost never needed in
5418 current versions of Exim. In versions of Exim before 3.14, quoting was required
5419 in order to continue lines, so you may come across older configuration files
5420 and examples that apparently quote unnecessarily.
5421
5422
5423 .section "Expanded strings" "SECID51"
5424 .cindex "expansion" "definition of"
5425 Some strings in the configuration file are subjected to &'string expansion'&,
5426 by which means various parts of the string may be changed according to the
5427 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5428 is as just described; in particular, the handling of backslashes in quoted
5429 strings is done as part of the input process, before expansion takes place.
5430 However, backslash is also an escape character for the expander, so any
5431 backslashes that are required for that reason must be doubled if they are
5432 within a quoted configuration string.
5433
5434
5435 .section "User and group names" "SECID52"
5436 .cindex "user name" "format of"
5437 .cindex "format" "user name"
5438 .cindex "groups" "name format"
5439 .cindex "format" "group name"
5440 User and group names are specified as strings, using the syntax described
5441 above, but the strings are interpreted specially. A user or group name must
5442 either consist entirely of digits, or be a name that can be looked up using the
5443 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5444
5445
5446 .section "List construction" "SECTlistconstruct"
5447 .cindex "list" "syntax of in configuration"
5448 .cindex "format" "list item in configuration"
5449 .cindex "string" "list, definition of"
5450 The data for some configuration options is a list of items, with colon as the
5451 default separator. Many of these options are shown with type &"string list"& in
5452 the descriptions later in this document. Others are listed as &"domain list"&,
5453 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5454 are all the same; however, those other than &"string list"& are subject to
5455 particular kinds of interpretation, as described in chapter
5456 &<<CHAPdomhosaddlists>>&.
5457
5458 In all these cases, the entire list is treated as a single string as far as the
5459 input syntax is concerned. The &%trusted_users%& setting in section
5460 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5461 in a list, it must be entered as two colons. Leading and trailing white space
5462 on each item in a list is ignored. This makes it possible to include items that
5463 start with a colon, and in particular, certain forms of IPv6 address. For
5464 example, the list
5465 .code
5466 local_interfaces = 127.0.0.1 : ::::1
5467 .endd
5468 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5469
5470 &*Note*&: Although leading and trailing white space is ignored in individual
5471 list items, it is not ignored when parsing the list. The spaces around the first
5472 colon in the example above are necessary. If they were not there, the list would
5473 be interpreted as the two items 127.0.0.1:: and 1.
5474
5475 .section "Changing list separators" "SECTlistsepchange"
5476 .cindex "list separator" "changing"
5477 .cindex "IPv6" "addresses in lists"
5478 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5479 introduced to allow the separator character to be changed. If a list begins
5480 with a left angle bracket, followed by any punctuation character, that
5481 character is used instead of colon as the list separator. For example, the list
5482 above can be rewritten to use a semicolon separator like this:
5483 .code
5484 local_interfaces = <; 127.0.0.1 ; ::1
5485 .endd
5486 This facility applies to all lists, with the exception of the list in
5487 &%log_file_path%&. It is recommended that the use of non-colon separators be
5488 confined to circumstances where they really are needed.
5489
5490 .cindex "list separator" "newline as"
5491 .cindex "newline" "as list separator"
5492 It is also possible to use newline and other control characters (those with
5493 code values less than 32, plus DEL) as separators in lists. Such separators
5494 must be provided literally at the time the list is processed. For options that
5495 are string-expanded, you can write the separator using a normal escape
5496 sequence. This will be processed by the expander before the string is
5497 interpreted as a list. For example, if a newline-separated list of domains is
5498 generated by a lookup, you can process it directly by a line such as this:
5499 .code
5500 domains = <\n ${lookup mysql{.....}}
5501 .endd
5502 This avoids having to change the list separator in such data. You are unlikely
5503 to want to use a control character as a separator in an option that is not
5504 expanded, because the value is literal text. However, it can be done by giving
5505 the value in quotes. For example:
5506 .code
5507 local_interfaces = "<\n 127.0.0.1 \n ::1"
5508 .endd
5509 Unlike printing character separators, which can be included in list items by
5510 doubling, it is not possible to include a control character as data when it is
5511 set as the separator. Two such characters in succession are interpreted as
5512 enclosing an empty list item.
5513
5514
5515
5516 .section "Empty items in lists" "SECTempitelis"
5517 .cindex "list" "empty item in"
5518 An empty item at the end of a list is always ignored. In other words, trailing
5519 separator characters are ignored. Thus, the list in
5520 .code
5521 senders = user@domain :
5522 .endd
5523 contains only a single item. If you want to include an empty string as one item
5524 in a list, it must not be the last item. For example, this list contains three
5525 items, the second of which is empty:
5526 .code
5527 senders = user1@domain : : user2@domain
5528 .endd
5529 &*Note*&: There must be white space between the two colons, as otherwise they
5530 are interpreted as representing a single colon data character (and the list
5531 would then contain just one item). If you want to specify a list that contains
5532 just one, empty item, you can do it as in this example:
5533 .code
5534 senders = :
5535 .endd
5536 In this case, the first item is empty, and the second is discarded because it
5537 is at the end of the list.
5538
5539
5540
5541
5542 .section "Format of driver configurations" "SECTfordricon"
5543 .cindex "drivers" "configuration format"
5544 There are separate parts in the configuration for defining routers, transports,
5545 and authenticators. In each part, you are defining a number of driver
5546 instances, each with its own set of options. Each driver instance is defined by
5547 a sequence of lines like this:
5548 .display
5549 <&'instance name'&>:
5550   <&'option'&>
5551   ...
5552   <&'option'&>
5553 .endd
5554 In the following example, the instance name is &(localuser)&, and it is
5555 followed by three options settings:
5556 .code
5557 localuser:
5558   driver = accept
5559   check_local_user
5560   transport = local_delivery
5561 .endd
5562 For each driver instance, you specify which Exim code module it uses &-- by the
5563 setting of the &%driver%& option &-- and (optionally) some configuration
5564 settings. For example, in the case of transports, if you want a transport to
5565 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5566 a local file you would use the &(appendfile)& driver. Each of the drivers is
5567 described in detail in its own separate chapter later in this manual.
5568
5569 You can have several routers, transports, or authenticators that are based on
5570 the same underlying driver (each must have a different instance name).
5571
5572 The order in which routers are defined is important, because addresses are
5573 passed to individual routers one by one, in order. The order in which
5574 transports are defined does not matter at all. The order in which
5575 authenticators are defined is used only when Exim, as a client, is searching
5576 them to find one that matches an authentication mechanism offered by the
5577 server.
5578
5579 .cindex "generic options"
5580 .cindex "options" "generic &-- definition of"
5581 Within a driver instance definition, there are two kinds of option: &'generic'&
5582 and &'private'&. The generic options are those that apply to all drivers of the
5583 same type (that is, all routers, all transports or all authenticators). The
5584 &%driver%& option is a generic option that must appear in every definition.
5585 .cindex "private options"
5586 The private options are special for each driver, and none need appear, because
5587 they all have default values.
5588
5589 The options may appear in any order, except that the &%driver%& option must
5590 precede any private options, since these depend on the particular driver. For
5591 this reason, it is recommended that &%driver%& always be the first option.
5592
5593 Driver instance names, which are used for reference in log entries and
5594 elsewhere, can be any sequence of letters, digits, and underscores (starting
5595 with a letter) and must be unique among drivers of the same type. A router and
5596 a transport (for example) can each have the same name, but no two router
5597 instances can have the same name. The name of a driver instance should not be
5598 confused with the name of the underlying driver module. For example, the
5599 configuration lines:
5600 .code
5601 remote_smtp:
5602   driver = smtp
5603 .endd
5604 create an instance of the &(smtp)& transport driver whose name is
5605 &(remote_smtp)&. The same driver code can be used more than once, with
5606 different instance names and different option settings each time. A second
5607 instance of the &(smtp)& transport, with different options, might be defined
5608 thus:
5609 .code
5610 special_smtp:
5611   driver = smtp
5612   port = 1234
5613   command_timeout = 10s
5614 .endd
5615 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5616 these transport instances from routers, and these names would appear in log
5617 lines.
5618
5619 Comment lines may be present in the middle of driver specifications. The full
5620 list of option settings for any particular driver instance, including all the
5621 defaulted values, can be extracted by making use of the &%-bP%& command line
5622 option.
5623
5624
5625
5626
5627
5628
5629 . ////////////////////////////////////////////////////////////////////////////
5630 . ////////////////////////////////////////////////////////////////////////////
5631
5632 .chapter "The default configuration file" "CHAPdefconfil"
5633 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5634 .cindex "default" "configuration file &""walk through""&"
5635 The default configuration file supplied with Exim as &_src/configure.default_&
5636 is sufficient for a host with simple mail requirements. As an introduction to
5637 the way Exim is configured, this chapter &"walks through"& the default
5638 configuration, giving brief explanations of the settings. Detailed descriptions
5639 of the options are given in subsequent chapters. The default configuration file
5640 itself contains extensive comments about ways you might want to modify the
5641 initial settings. However, note that there are many options that are not
5642 mentioned at all in the default configuration.
5643
5644
5645
5646 .section "Macros" "SECTdefconfmacros"
5647 All macros should be defined before any options.
5648
5649 One macro is specified, but commented out, in the default configuration:
5650 .code
5651 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5652 .endd
5653 If all off-site mail is expected to be delivered to a "smarthost", then set the
5654 hostname here and uncomment the macro.  This will affect which router is used
5655 later on.  If this is left commented out, then Exim will perform direct-to-MX
5656 deliveries using a &(dnslookup)& router.
5657
5658 In addition to macros defined here, Exim includes a number of built-in macros
5659 to enable configuration to be guarded by a binary built with support for a
5660 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5661
5662
5663 .section "Main configuration settings" "SECTdefconfmain"
5664 The main (global) configuration option settings section must always come first
5665 in the file, after the macros.
5666 The first thing you'll see in the file, after some initial comments, is the line
5667 .code
5668 # primary_hostname =
5669 .endd
5670 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5671 to know the official, fully qualified name of your host, and this is where you
5672 can specify it. However, in most cases you do not need to set this option. When
5673 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5674
5675 The first three non-comment configuration lines are as follows:
5676 .code
5677 domainlist local_domains    = @
5678 domainlist relay_to_domains =
5679 hostlist   relay_from_hosts = 127.0.0.1
5680 .endd
5681 These are not, in fact, option settings. They are definitions of two named
5682 domain lists and one named host list. Exim allows you to give names to lists of
5683 domains, hosts, and email addresses, in order to make it easier to manage the
5684 configuration file (see section &<<SECTnamedlists>>&).
5685
5686 The first line defines a domain list called &'local_domains'&; this is used
5687 later in the configuration to identify domains that are to be delivered
5688 on the local host.
5689
5690 .cindex "@ in a domain list"
5691 There is just one item in this list, the string &"@"&. This is a special form
5692 of entry which means &"the name of the local host"&. Thus, if the local host is
5693 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5694 be delivered locally. Because the local host's name is referenced indirectly,
5695 the same configuration file can be used on different hosts.
5696
5697 The second line defines a domain list called &'relay_to_domains'&, but the
5698 list itself is empty. Later in the configuration we will come to the part that
5699 controls mail relaying through the local host; it allows relaying to any
5700 domains in this list. By default, therefore, no relaying on the basis of a mail
5701 domain is permitted.
5702
5703 The third line defines a host list called &'relay_from_hosts'&. This list is
5704 used later in the configuration to permit relaying from any host or IP address
5705 that matches the list. The default contains just the IP address of the IPv4
5706 loopback interface, which means that processes on the local host are able to
5707 submit mail for relaying by sending it over TCP/IP to that interface. No other
5708 hosts are permitted to submit messages for relaying.
5709
5710 Just to be sure there's no misunderstanding: at this point in the configuration
5711 we aren't actually setting up any controls. We are just defining some domains
5712 and hosts that will be used in the controls that are specified later.
5713
5714 The next two configuration lines are genuine option settings:
5715 .code
5716 acl_smtp_rcpt = acl_check_rcpt
5717 acl_smtp_data = acl_check_data
5718 .endd
5719 These options specify &'Access Control Lists'& (ACLs) that are to be used
5720 during an incoming SMTP session for every recipient of a message (every RCPT
5721 command), and after the contents of the message have been received,
5722 respectively. The names of the lists are &'acl_check_rcpt'& and
5723 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5724 section of the configuration. The RCPT ACL controls which recipients are
5725 accepted for an incoming message &-- if a configuration does not provide an ACL
5726 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5727 contents of a message to be checked.
5728
5729 Two commented-out option settings are next:
5730 .code
5731 # av_scanner = clamd:/tmp/clamd
5732 # spamd_address = 127.0.0.1 783
5733 .endd
5734 These are example settings that can be used when Exim is compiled with the
5735 content-scanning extension. The first specifies the interface to the virus
5736 scanner, and the second specifies the interface to SpamAssassin. Further
5737 details are given in chapter &<<CHAPexiscan>>&.
5738
5739 Three more commented-out option settings follow:
5740 .code
5741 # tls_advertise_hosts = *
5742 # tls_certificate = /etc/ssl/exim.crt
5743 # tls_privatekey = /etc/ssl/exim.pem
5744 .endd
5745 These are example settings that can be used when Exim is compiled with
5746 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5747 first one specifies the list of clients that are allowed to use TLS when
5748 connecting to this server; in this case, the wildcard means all clients. The
5749 other options specify where Exim should find its TLS certificate and private
5750 key, which together prove the server's identity to any clients that connect.
5751 More details are given in chapter &<<CHAPTLS>>&.
5752
5753 Another two commented-out option settings follow:
5754 .code
5755 # daemon_smtp_ports = 25 : 465 : 587
5756 # tls_on_connect_ports = 465
5757 .endd
5758 .cindex "port" "465 and 587"
5759 .cindex "port" "for message submission"
5760 .cindex "message" "submission, ports for"
5761 .cindex "submissions protocol"
5762 .cindex "smtps protocol"
5763 .cindex "ssmtp protocol"
5764 .cindex "SMTP" "submissions protocol"
5765 .cindex "SMTP" "ssmtp protocol"
5766 .cindex "SMTP" "smtps protocol"
5767 These options provide better support for roaming users who wish to use this
5768 server for message submission. They are not much use unless you have turned on
5769 TLS (as described in the previous paragraph) and authentication (about which
5770 more in section &<<SECTdefconfauth>>&).
5771 Mail submission from mail clients (MUAs) should be separate from inbound mail
5772 to your domain (MX delivery) for various good reasons (eg, ability to impose
5773 much saner TLS protocol and ciphersuite requirements without unintended
5774 consequences).
5775 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5776 which uses STARTTLS, so this is the &"submission"& port.
5777 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5778 which should be used in preference to 587.
5779 You should also consider deploying SRV records to help clients find
5780 these ports.
5781 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5782
5783 Two more commented-out options settings follow:
5784 .code
5785 # qualify_domain =
5786 # qualify_recipient =
5787 .endd
5788 The first of these specifies a domain that Exim uses when it constructs a
5789 complete email address from a local login name. This is often needed when Exim
5790 receives a message from a local process. If you do not set &%qualify_domain%&,
5791 the value of &%primary_hostname%& is used. If you set both of these options,
5792 you can have different qualification domains for sender and recipient
5793 addresses. If you set only the first one, its value is used in both cases.
5794
5795 .cindex "domain literal" "recognizing format"
5796 The following line must be uncommented if you want Exim to recognize
5797 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5798 (an IP address within square brackets) instead of a named domain.
5799 .code
5800 # allow_domain_literals
5801 .endd
5802 The RFCs still require this form, but many people think that in the modern
5803 Internet it makes little sense to permit mail to be sent to specific hosts by
5804 quoting their IP addresses. This ancient format has been used by people who
5805 try to abuse hosts by using them for unwanted relaying. However, some
5806 people believe there are circumstances (for example, messages addressed to
5807 &'postmaster'&) where domain literals are still useful.
5808
5809 The next configuration line is a kind of trigger guard:
5810 .code
5811 never_users = root
5812 .endd
5813 It specifies that no delivery must ever be run as the root user. The normal
5814 convention is to set up &'root'& as an alias for the system administrator. This
5815 setting is a guard against slips in the configuration.
5816 The list of users specified by &%never_users%& is not, however, the complete
5817 list; the build-time configuration in &_Local/Makefile_& has an option called
5818 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5819 contents of &%never_users%& are added to this list. By default
5820 FIXED_NEVER_USERS also specifies root.
5821
5822 When a remote host connects to Exim in order to send mail, the only information
5823 Exim has about the host's identity is its IP address. The next configuration
5824 line,
5825 .code
5826 host_lookup = *
5827 .endd
5828 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5829 in order to get a host name. This improves the quality of the logging
5830 information, but if you feel it is too expensive, you can remove it entirely,
5831 or restrict the lookup to hosts on &"nearby"& networks.
5832 Note that it is not always possible to find a host name from an IP address,
5833 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5834 unreachable.
5835
5836 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5837 1413 (hence their names):
5838 .code
5839 rfc1413_hosts = *
5840 rfc1413_query_timeout = 0s
5841 .endd
5842 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5843 Few hosts offer RFC1413 service these days; calls have to be
5844 terminated by a timeout and this needlessly delays the startup
5845 of an incoming SMTP connection.
5846 If you have hosts for which you trust RFC1413 and need this
5847 information, you can change this.
5848
5849 This line enables an efficiency SMTP option.  It is negotiated by clients
5850 and not expected to cause problems but can be disabled if needed.
5851 .code
5852 prdr_enable = true
5853 .endd
5854
5855 When Exim receives messages over SMTP connections, it expects all addresses to
5856 be fully qualified with a domain, as required by the SMTP definition. However,
5857 if you are running a server to which simple clients submit messages, you may
5858 find that they send unqualified addresses. The two commented-out options:
5859 .code
5860 # sender_unqualified_hosts =
5861 # recipient_unqualified_hosts =
5862 .endd
5863 show how you can specify hosts that are permitted to send unqualified sender
5864 and recipient addresses, respectively.
5865
5866 The &%log_selector%& option is used to increase the detail of logging
5867 over the default:
5868 .code
5869 log_selector = +smtp_protocol_error +smtp_syntax_error \
5870                +tls_certificate_verified
5871 .endd
5872
5873 The &%percent_hack_domains%& option is also commented out:
5874 .code
5875 # percent_hack_domains =
5876 .endd
5877 It provides a list of domains for which the &"percent hack"& is to operate.
5878 This is an almost obsolete form of explicit email routing. If you do not know
5879 anything about it, you can safely ignore this topic.
5880
5881 The next two settings in the main part of the default configuration are
5882 concerned with messages that have been &"frozen"& on Exim's queue. When a
5883 message is frozen, Exim no longer continues to try to deliver it. Freezing
5884 occurs when a bounce message encounters a permanent failure because the sender
5885 address of the original message that caused the bounce is invalid, so the
5886 bounce cannot be delivered. This is probably the most common case, but there
5887 are also other conditions that cause freezing, and frozen messages are not
5888 always bounce messages.
5889 .code
5890 ignore_bounce_errors_after = 2d
5891 timeout_frozen_after = 7d
5892 .endd
5893 The first of these options specifies that failing bounce messages are to be
5894 discarded after 2 days in the queue. The second specifies that any frozen
5895 message (whether a bounce message or not) is to be timed out (and discarded)
5896 after a week. In this configuration, the first setting ensures that no failing
5897 bounce message ever lasts a week.
5898
5899 Exim queues it's messages in a spool directory. If you expect to have
5900 large queues, you may consider using this option. It splits the spool
5901 directory into subdirectories to avoid file system degradation from
5902 many files in a single directory, resulting in better performance.
5903 Manual manipulation of queued messages becomes more complex (though fortunately
5904 not often needed).
5905 .code
5906 # split_spool_directory = true
5907 .endd
5908
5909 In an ideal world everybody follows the standards. For non-ASCII
5910 messages RFC 2047 is a standard, allowing a maximum line length of 76
5911 characters. Exim adheres that standard and won't process messages which
5912 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5913 In particular, the Exim maintainers have had multiple reports of
5914 problems from Russian administrators of issues until they disable this
5915 check, because of some popular, yet buggy, mail composition software.
5916 .code
5917 # check_rfc2047_length = false
5918 .endd
5919
5920 If you need to be strictly RFC compliant you may wish to disable the
5921 8BITMIME advertisement. Use this, if you exchange mails with systems
5922 that are not 8-bit clean.
5923 .code
5924 # accept_8bitmime = false
5925 .endd
5926
5927 Libraries you use may depend on specific environment settings.  This
5928 imposes a security risk (e.g. PATH). There are two lists:
5929 &%keep_environment%& for the variables to import as they are, and
5930 &%add_environment%& for variables we want to set to a fixed value.
5931 Note that TZ is handled separately, by the &%timezone%& runtime
5932 option and by the TIMEZONE_DEFAULT buildtime option.
5933 .code
5934 # keep_environment = ^LDAP
5935 # add_environment = PATH=/usr/bin::/bin
5936 .endd
5937
5938
5939 .section "ACL configuration" "SECID54"
5940 .cindex "default" "ACLs"
5941 .cindex "&ACL;" "default configuration"
5942 In the default configuration, the ACL section follows the main configuration.
5943 It starts with the line
5944 .code
5945 begin acl
5946 .endd
5947 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5948 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5949 and &%acl_smtp_data%& above.
5950
5951 .cindex "RCPT" "ACL for"
5952 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5953 RCPT command specifies one of the message's recipients. The ACL statements
5954 are considered in order, until the recipient address is either accepted or
5955 rejected. The RCPT command is then accepted or rejected, according to the
5956 result of the ACL processing.
5957 .code
5958 acl_check_rcpt:
5959 .endd
5960 This line, consisting of a name terminated by a colon, marks the start of the
5961 ACL, and names it.
5962 .code
5963 accept  hosts = :
5964 .endd
5965 This ACL statement accepts the recipient if the sending host matches the list.
5966 But what does that strange list mean? It doesn't actually contain any host
5967 names or IP addresses. The presence of the colon puts an empty item in the
5968 list; Exim matches this only if the incoming message did not come from a remote
5969 host, because in that case, the remote hostname is empty. The colon is
5970 important. Without it, the list itself is empty, and can never match anything.
5971
5972 What this statement is doing is to accept unconditionally all recipients in
5973 messages that are submitted by SMTP from local processes using the standard
5974 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5975 manner.
5976 .code
5977 deny    domains       = +local_domains
5978         local_parts   = ^[.] : ^.*[@%!/|]
5979         message       = Restricted characters in address
5980
5981 deny    domains       = !+local_domains
5982         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5983         message       = Restricted characters in address
5984 .endd
5985 These statements are concerned with local parts that contain any of the
5986 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5987 Although these characters are entirely legal in local parts (in the case of
5988 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5989 in Internet mail addresses.
5990
5991 The first three have in the past been associated with explicitly routed
5992 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5993 option). Addresses containing these characters are regularly tried by spammers
5994 in an attempt to bypass relaying restrictions, and also by open relay testing
5995 programs. Unless you really need them it is safest to reject these characters
5996 at this early stage. This configuration is heavy-handed in rejecting these
5997 characters for all messages it accepts from remote hosts. This is a deliberate
5998 policy of being as safe as possible.
5999
6000 The first rule above is stricter, and is applied to messages that are addressed
6001 to one of the local domains handled by this host. This is implemented by the
6002 first condition, which restricts it to domains that are listed in the
6003 &'local_domains'& domain list. The &"+"& character is used to indicate a
6004 reference to a named list. In this configuration, there is just one domain in
6005 &'local_domains'&, but in general there may be many.
6006
6007 The second condition on the first statement uses two regular expressions to
6008 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
6009 or &"|"&. If you have local accounts that include these characters, you will
6010 have to modify this rule.
6011
6012 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
6013 allows them because they have been encountered in practice. (Consider the
6014 common convention of local parts constructed as
6015 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
6016 the author of Exim, who has no second initial.) However, a local part starting
6017 with a dot or containing &"/../"& can cause trouble if it is used as part of a
6018 filename (for example, for a mailing list). This is also true for local parts
6019 that contain slashes. A pipe symbol can also be troublesome if the local part
6020 is incorporated unthinkingly into a shell command line.
6021
6022 The second rule above applies to all other domains, and is less strict. This
6023 allows your own users to send outgoing messages to sites that use slashes
6024 and vertical bars in their local parts. It blocks local parts that begin
6025 with a dot, slash, or vertical bar, but allows these characters within the
6026 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
6027 and &"!"& is blocked, as before. The motivation here is to prevent your users
6028 (or your users' viruses) from mounting certain kinds of attack on remote sites.
6029 .code
6030 accept  local_parts   = postmaster
6031         domains       = +local_domains
6032 .endd
6033 This statement, which has two conditions, accepts an incoming address if the
6034 local part is &'postmaster'& and the domain is one of those listed in the
6035 &'local_domains'& domain list. The &"+"& character is used to indicate a
6036 reference to a named list. In this configuration, there is just one domain in
6037 &'local_domains'&, but in general there may be many.
6038
6039 The presence of this statement means that mail to postmaster is never blocked
6040 by any of the subsequent tests. This can be helpful while sorting out problems
6041 in cases where the subsequent tests are incorrectly denying access.
6042 .code
6043 require verify        = sender
6044 .endd
6045 This statement requires the sender address to be verified before any subsequent
6046 ACL statement can be used. If verification fails, the incoming recipient
6047 address is refused. Verification consists of trying to route the address, to
6048 see if a bounce message could be delivered to it. In the case of remote
6049 addresses, basic verification checks only the domain, but &'callouts'& can be
6050 used for more verification if required. Section &<<SECTaddressverification>>&
6051 discusses the details of address verification.
6052 .code
6053 accept  hosts         = +relay_from_hosts
6054         control       = submission
6055 .endd
6056 This statement accepts the address if the message is coming from one of the
6057 hosts that are defined as being allowed to relay through this host. Recipient
6058 verification is omitted here, because in many cases the clients are dumb MUAs
6059 that do not cope well with SMTP error responses. For the same reason, the
6060 second line specifies &"submission mode"& for messages that are accepted. This
6061 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6062 messages that are deficient in some way, for example, because they lack a
6063 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6064 probably add recipient verification here, and disable submission mode.
6065 .code
6066 accept  authenticated = *
6067         control       = submission
6068 .endd
6069 This statement accepts the address if the client host has authenticated itself.
6070 Submission mode is again specified, on the grounds that such messages are most
6071 likely to come from MUAs. The default configuration does not define any
6072 authenticators, though it does include some nearly complete commented-out
6073 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6074 fact authenticate until you complete the authenticator definitions.
6075 .code
6076 require message = relay not permitted
6077         domains = +local_domains : +relay_to_domains
6078 .endd
6079 This statement rejects the address if its domain is neither a local domain nor
6080 one of the domains for which this host is a relay.
6081 .code
6082 require verify = recipient
6083 .endd
6084 This statement requires the recipient address to be verified; if verification
6085 fails, the address is rejected.
6086 .code
6087 # deny    dnslists    = black.list.example
6088 #         message     = rejected because $sender_host_address \
6089 #                       is in a black list at $dnslist_domain\n\
6090 #                       $dnslist_text
6091 #
6092 # warn    dnslists    = black.list.example
6093 #         add_header  = X-Warning: $sender_host_address is in \
6094 #                       a black list at $dnslist_domain
6095 #         log_message = found in $dnslist_domain
6096 .endd
6097 These commented-out lines are examples of how you could configure Exim to check
6098 sending hosts against a DNS black list. The first statement rejects messages
6099 from blacklisted hosts, whereas the second just inserts a warning header
6100 line.
6101 .code
6102 # require verify = csa
6103 .endd
6104 This commented-out line is an example of how you could turn on client SMTP
6105 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6106 records.
6107 .code
6108 accept
6109 .endd
6110 The final statement in the first ACL unconditionally accepts any recipient
6111 address that has successfully passed all the previous tests.
6112 .code
6113 acl_check_data:
6114 .endd
6115 This line marks the start of the second ACL, and names it. Most of the contents
6116 of this ACL are commented out:
6117 .code
6118 # deny    malware   = *
6119 #         message   = This message contains a virus \
6120 #                     ($malware_name).
6121 .endd
6122 These lines are examples of how to arrange for messages to be scanned for
6123 viruses when Exim has been compiled with the content-scanning extension, and a
6124 suitable virus scanner is installed. If the message is found to contain a
6125 virus, it is rejected with the given custom error message.
6126 .code
6127 # warn    spam      = nobody
6128 #         message   = X-Spam_score: $spam_score\n\
6129 #                     X-Spam_score_int: $spam_score_int\n\
6130 #                     X-Spam_bar: $spam_bar\n\
6131 #                     X-Spam_report: $spam_report
6132 .endd
6133 These lines are an example of how to arrange for messages to be scanned by
6134 SpamAssassin when Exim has been compiled with the content-scanning extension,
6135 and SpamAssassin has been installed. The SpamAssassin check is run with
6136 &`nobody`& as its user parameter, and the results are added to the message as a
6137 series of extra header line. In this case, the message is not rejected,
6138 whatever the spam score.
6139 .code
6140 accept
6141 .endd
6142 This final line in the DATA ACL accepts the message unconditionally.
6143
6144
6145 .section "Router configuration" "SECID55"
6146 .cindex "default" "routers"
6147 .cindex "routers" "default"
6148 The router configuration comes next in the default configuration, introduced
6149 by the line
6150 .code
6151 begin routers
6152 .endd
6153 Routers are the modules in Exim that make decisions about where to send
6154 messages. An address is passed to each router, in turn, until it is either
6155 accepted, or failed. This means that the order in which you define the routers
6156 matters. Each router is fully described in its own chapter later in this
6157 manual. Here we give only brief overviews.
6158 .code
6159 # domain_literal:
6160 #   driver = ipliteral
6161 #   domains = !+local_domains
6162 #   transport = remote_smtp
6163 .endd
6164 .cindex "domain literal" "default router"
6165 This router is commented out because the majority of sites do not want to
6166 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6167 you uncomment this router, you also need to uncomment the setting of
6168 &%allow_domain_literals%& in the main part of the configuration.
6169
6170 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6171 macro has been defined, per
6172 .code
6173 .ifdef ROUTER_SMARTHOST
6174 smarthost:
6175 #...
6176 .else
6177 dnslookup:
6178 #...
6179 .endif
6180 .endd
6181
6182 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6183 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6184 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6185 skip these routers because of the &%domains%& option.
6186
6187 .code
6188 smarthost:
6189   driver = manualroute
6190   domains = ! +local_domains
6191   transport = smarthost_smtp
6192   route_data = ROUTER_SMARTHOST
6193   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6194   no_more
6195 .endd
6196 This router only handles mail which is not to any local domains; this is
6197 specified by the line
6198 .code
6199 domains = ! +local_domains
6200 .endd
6201 The &%domains%& option lists the domains to which this router applies, but the
6202 exclamation mark is a negation sign, so the router is used only for domains
6203 that are not in the domain list called &'local_domains'& (which was defined at
6204 the start of the configuration). The plus sign before &'local_domains'&
6205 indicates that it is referring to a named list. Addresses in other domains are
6206 passed on to the following routers.
6207
6208 The name of the router driver is &(manualroute)& because we are manually
6209 specifying how mail should be routed onwards, instead of using DNS MX.
6210 While the name of this router instance is arbitrary, the &%driver%& option must
6211 be one of the driver modules that is in the Exim binary.
6212
6213 With no pre-conditions other than &%domains%&, all mail for non-local domains
6214 will be handled by this router, and the &%no_more%& setting will ensure that no
6215 other routers will be used for messages matching the pre-conditions.  See
6216 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6217 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6218 and the macro supplies the value; the address is then queued for the
6219 &(smarthost_smtp)& transport.
6220
6221 .code
6222 dnslookup:
6223   driver = dnslookup
6224   domains = ! +local_domains
6225   transport = remote_smtp
6226   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6227   no_more
6228 .endd
6229 The &%domains%& option behaves as per smarthost, above.
6230
6231 The name of the router driver is &(dnslookup)&,
6232 and is specified by the &%driver%& option. Do not be confused by the fact that
6233 the name of this router instance is the same as the name of the driver. The
6234 instance name is arbitrary, but the name set in the &%driver%& option must be
6235 one of the driver modules that is in the Exim binary.
6236
6237 The &(dnslookup)& router routes addresses by looking up their domains in the
6238 DNS in order to obtain a list of hosts to which the address is routed. If the
6239 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6240 specified by the &%transport%& option. If the router does not find the domain
6241 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6242 the address fails and is bounced.
6243
6244 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6245 be entirely ignored. This option is present because a number of cases have been
6246 encountered where MX records in the DNS point to host names
6247 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6248 Completely ignoring these IP addresses causes Exim to fail to route the
6249 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6250 continue to try to deliver the message periodically until the address timed
6251 out.
6252 .code
6253 system_aliases:
6254   driver = redirect
6255   allow_fail
6256   allow_defer
6257   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6258 # user = exim
6259   file_transport = address_file
6260   pipe_transport = address_pipe
6261 .endd
6262 Control reaches this and subsequent routers only for addresses in the local
6263 domains. This router checks to see whether the local part is defined as an
6264 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6265 data that it looks up from that file. If no data is found for the local part,
6266 the value of the &%data%& option is empty, causing the address to be passed to
6267 the next router.
6268
6269 &_/etc/aliases_& is a conventional name for the system aliases file that is
6270 often used. That is why it is referenced by from the default configuration
6271 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6272 &_Local/Makefile_& before building Exim.
6273 .code
6274 userforward:
6275   driver = redirect
6276   check_local_user
6277 # local_part_suffix = +* : -*
6278 # local_part_suffix_optional
6279   file = $home/.forward
6280 # allow_filter
6281   no_verify
6282   no_expn
6283   check_ancestor
6284   file_transport = address_file
6285   pipe_transport = address_pipe
6286   reply_transport = address_reply
6287 .endd
6288 This is the most complicated router in the default configuration. It is another
6289 redirection router, but this time it is looking for forwarding data set up by
6290 individual users. The &%check_local_user%& setting specifies a check that the
6291 local part of the address is the login name of a local user. If it is not, the
6292 router is skipped. The two commented options that follow &%check_local_user%&,
6293 namely:
6294 .code
6295 # local_part_suffix = +* : -*
6296 # local_part_suffix_optional
6297 .endd
6298 .vindex "&$local_part_suffix$&"
6299 show how you can specify the recognition of local part suffixes. If the first
6300 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6301 by any sequence of characters, is removed from the local part and placed in the
6302 variable &$local_part_suffix$&. The second suffix option specifies that the
6303 presence of a suffix in the local part is optional. When a suffix is present,
6304 the check for a local login uses the local part with the suffix removed.
6305
6306 When a local user account is found, the file called &_.forward_& in the user's
6307 home directory is consulted. If it does not exist, or is empty, the router
6308 declines. Otherwise, the contents of &_.forward_& are interpreted as
6309 redirection data (see chapter &<<CHAPredirect>>& for more details).
6310
6311 .cindex "Sieve filter" "enabling in default router"
6312 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6313 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6314 is commented out by default), the contents of the file are interpreted as a set
6315 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6316 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6317 separate document entitled &'Exim's interfaces to mail filtering'&.
6318
6319 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6320 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6321 There are two reasons for doing this:
6322
6323 .olist
6324 Whether or not a local user has a &_.forward_& file is not really relevant when
6325 checking an address for validity; it makes sense not to waste resources doing
6326 unnecessary work.
6327 .next
6328 More importantly, when Exim is verifying addresses or handling an EXPN
6329 command during an SMTP session, it is running as the Exim user, not as root.
6330 The group is the Exim group, and no additional groups are set up.
6331 It may therefore not be possible for Exim to read users' &_.forward_& files at
6332 this time.
6333 .endlist
6334
6335 The setting of &%check_ancestor%& prevents the router from generating a new
6336 address that is the same as any previous address that was redirected. (This
6337 works round a problem concerning a bad interaction between aliasing and
6338 forwarding &-- see section &<<SECTredlocmai>>&).
6339
6340 The final three option settings specify the transports that are to be used when
6341 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6342 auto-reply, respectively. For example, if a &_.forward_& file contains
6343 .code
6344 a.nother@elsewhere.example, /home/spqr/archive
6345 .endd
6346 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6347 transport.
6348 .code
6349 localuser:
6350   driver = accept
6351   check_local_user
6352 # local_part_suffix = +* : -*
6353 # local_part_suffix_optional
6354   transport = local_delivery
6355 .endd
6356 The final router sets up delivery into local mailboxes, provided that the local
6357 part is the name of a local login, by accepting the address and assigning it to
6358 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6359 routers, so the address is bounced. The commented suffix settings fulfil the
6360 same purpose as they do for the &(userforward)& router.
6361
6362
6363 .section "Transport configuration" "SECID56"
6364 .cindex "default" "transports"
6365 .cindex "transports" "default"
6366 Transports define mechanisms for actually delivering messages. They operate
6367 only when referenced from routers, so the order in which they are defined does
6368 not matter. The transports section of the configuration starts with
6369 .code
6370 begin transports
6371 .endd
6372 Two remote transports and four local transports are defined.
6373 .code
6374 remote_smtp:
6375   driver = smtp
6376   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6377 .ifdef _HAVE_PRDR
6378   hosts_try_prdr = *
6379 .endif
6380 .endd
6381 This transport is used for delivering messages over SMTP connections.
6382 The list of remote hosts comes from the router.
6383 The &%message_size_limit%& usage is a hack to avoid sending on messages
6384 with over-long lines.
6385
6386 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6387 negotiated between client and server and not expected to cause problems
6388 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6389 use of the &%hosts_try_prdr%& configuration option.
6390
6391 The other remote transport is used when delivering to a specific smarthost
6392 with whom there must be some kind of existing relationship, instead of the
6393 usual federated system.
6394
6395 .code
6396 smarthost_smtp:
6397   driver = smtp
6398   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6399   multi_domain
6400   #
6401 .ifdef _HAVE_TLS
6402   # Comment out any of these which you have to, then file a Support
6403   # request with your smarthost provider to get things fixed:
6404   hosts_require_tls = *
6405   tls_verify_hosts = *
6406   # As long as tls_verify_hosts is enabled, this this will have no effect,
6407   # but if you have to comment it out then this will at least log whether
6408   # you succeed or not:
6409   tls_try_verify_hosts = *
6410   #
6411   # The SNI name should match the name which we'll expect to verify;
6412   # many mail systems don't use SNI and this doesn't matter, but if it does,
6413   # we need to send a name which the remote site will recognize.
6414   # This _should_ be the name which the smarthost operators specified as
6415   # the hostname for sending your mail to.
6416   tls_sni = ROUTER_SMARTHOST
6417   #
6418 .ifdef _HAVE_OPENSSL
6419   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6420 .endif
6421 .ifdef _HAVE_GNUTLS
6422   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6423 .endif
6424 .endif
6425 .ifdef _HAVE_PRDR
6426   hosts_try_prdr = *
6427 .endif
6428 .endd
6429 After the same &%message_size_limit%& hack, we then specify that this Transport
6430 can handle messages to multiple domains in one run.  The assumption here is
6431 that you're routing all non-local mail to the same place and that place is
6432 happy to take all messages from you as quickly as possible.
6433 All other options depend upon built-in macros; if Exim was built without TLS support
6434 then no other options are defined.
6435 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6436 and versions using the &%tls_require_ciphers%& option, where the value to be
6437 used depends upon the library providing TLS.
6438 Beyond that, the options adopt the stance that you should have TLS support available
6439 from your smarthost on today's Internet, so we turn on requiring TLS for the
6440 mail to be delivered, and requiring that the certificate be valid, and match
6441 the expected hostname.  The &%tls_sni%& option can be used by service providers
6442 to select an appropriate certificate to present to you and here we re-use the
6443 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6444 You want to specify the hostname which you'll expect to validate for, and that
6445 should not be subject to insecure tampering via DNS results.
6446
6447 For the &%hosts_try_prdr%& option see the previous transport.
6448
6449 All other options are defaulted.
6450 .code
6451 local_delivery:
6452   driver = appendfile
6453   file = /var/mail/$local_part_data
6454   delivery_date_add
6455   envelope_to_add
6456   return_path_add
6457 # group = mail
6458 # mode = 0660
6459 .endd
6460 This &(appendfile)& transport is used for local delivery to user mailboxes in
6461 traditional BSD mailbox format.
6462
6463 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6464 as it is provided by a potential bad actor.
6465 Instead we use &$local_part_data$&,
6466 the result of looking up &$local_part$& in the user database
6467 (done by using &%check_local_user%& in the the router).
6468
6469 By default &(appendfile)& runs under the uid and gid of the
6470 local user, which requires the sticky bit to be set on the &_/var/mail_&
6471 directory. Some systems use the alternative approach of running mail deliveries
6472 under a particular group instead of using the sticky bit. The commented options
6473 show how this can be done.
6474
6475 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6476 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6477 similarly-named options above.
6478 .code
6479 address_pipe:
6480   driver = pipe
6481   return_output
6482 .endd
6483 This transport is used for handling deliveries to pipes that are generated by
6484 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6485 option specifies that any output on stdout or stderr generated by the pipe is to
6486 be returned to the sender.
6487 .code
6488 address_file:
6489   driver = appendfile
6490   delivery_date_add
6491   envelope_to_add
6492   return_path_add
6493 .endd
6494 This transport is used for handling deliveries to files that are generated by
6495 redirection. The name of the file is not specified in this instance of
6496 &(appendfile)&, because it comes from the &(redirect)& router.
6497 .code
6498 address_reply:
6499   driver = autoreply
6500 .endd
6501 This transport is used for handling automatic replies generated by users'
6502 filter files.
6503
6504
6505
6506 .section "Default retry rule" "SECID57"
6507 .cindex "retry" "default rule"
6508 .cindex "default" "retry rule"
6509 The retry section of the configuration file contains rules which affect the way
6510 Exim retries deliveries that cannot be completed at the first attempt. It is
6511 introduced by the line
6512 .code
6513 begin retry
6514 .endd
6515 In the default configuration, there is just one rule, which applies to all
6516 errors:
6517 .code
6518 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6519 .endd
6520 This causes any temporarily failing address to be retried every 15 minutes for
6521 2 hours, then at intervals starting at one hour and increasing by a factor of
6522 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6523 is not delivered after 4 days of temporary failure, it is bounced. The time is
6524 measured from first failure, not from the time the message was received.
6525
6526 If the retry section is removed from the configuration, or is empty (that is,
6527 if no retry rules are defined), Exim will not retry deliveries. This turns
6528 temporary errors into permanent errors.
6529
6530
6531 .section "Rewriting configuration" "SECID58"
6532 The rewriting section of the configuration, introduced by
6533 .code
6534 begin rewrite
6535 .endd
6536 contains rules for rewriting addresses in messages as they arrive. There are no
6537 rewriting rules in the default configuration file.
6538
6539
6540
6541 .section "Authenticators configuration" "SECTdefconfauth"
6542 .cindex "AUTH" "configuration"
6543 The authenticators section of the configuration, introduced by
6544 .code
6545 begin authenticators
6546 .endd
6547 defines mechanisms for the use of the SMTP AUTH command. The default
6548 configuration file contains two commented-out example authenticators
6549 which support plaintext username/password authentication using the
6550 standard PLAIN mechanism and the traditional but non-standard LOGIN
6551 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6552 to support most MUA software.
6553
6554 The example PLAIN authenticator looks like this:
6555 .code
6556 #PLAIN:
6557 #  driver                  = plaintext
6558 #  server_set_id           = $auth2
6559 #  server_prompts          = :
6560 #  server_condition        = Authentication is not yet configured
6561 #  server_advertise_condition = ${if def:tls_in_cipher }
6562 .endd
6563 And the example LOGIN authenticator looks like this:
6564 .code
6565 #LOGIN:
6566 #  driver                  = plaintext
6567 #  server_set_id           = $auth1
6568 #  server_prompts          = <| Username: | Password:
6569 #  server_condition        = Authentication is not yet configured
6570 #  server_advertise_condition = ${if def:tls_in_cipher }
6571 .endd
6572
6573 The &%server_set_id%& option makes Exim remember the authenticated username
6574 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6575 &%server_prompts%& option configures the &(plaintext)& authenticator so
6576 that it implements the details of the specific authentication mechanism,
6577 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6578 when Exim offers authentication to clients; in the examples, this is only
6579 when TLS or SSL has been started, so to enable the authenticators you also
6580 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6581
6582 The &%server_condition%& setting defines how to verify that the username and
6583 password are correct. In the examples it just produces an error message.
6584 To make the authenticators work, you can use a string expansion
6585 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6586
6587 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6588 usercode and password are in different positions.
6589 Chapter &<<CHAPplaintext>>& covers both.
6590
6591 .ecindex IIDconfiwal
6592
6593
6594
6595 . ////////////////////////////////////////////////////////////////////////////
6596 . ////////////////////////////////////////////////////////////////////////////
6597
6598 .chapter "Regular expressions" "CHAPregexp"
6599
6600 .cindex "regular expressions" "library"
6601 .cindex "PCRE2"
6602 Exim supports the use of regular expressions in many of its options. It
6603 uses the PCRE2 regular expression library; this provides regular expression
6604 matching that is compatible with Perl 5. The syntax and semantics of
6605 regular expressions is discussed in
6606 online Perl manpages, in
6607 many Perl reference books, and also in
6608 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6609 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6610 . --- the http: URL here redirects to another page with the ISBN in the URL
6611 . --- where trying to use https: just redirects back to http:, so sticking
6612 . --- to the old URL for now.  2018-09-07.
6613
6614 The documentation for the syntax and semantics of the regular expressions that
6615 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6616 description is included here. The PCRE2 functions are called from Exim using
6617 the default option settings (that is, with no PCRE2 options set), except that
6618 the PCRE2_CASELESS option is set when the matching is required to be
6619 case-insensitive.
6620
6621 In most cases, when a regular expression is required in an Exim configuration,
6622 it has to start with a circumflex, in order to distinguish it from plain text
6623 or an &"ends with"& wildcard. In this example of a configuration setting, the
6624 second item in the colon-separated list is a regular expression.
6625 .code
6626 domains = a.b.c : ^\\d{3} : *.y.z : ...
6627 .endd
6628 The doubling of the backslash is required because of string expansion that
6629 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6630 of this issue, and a way of avoiding the need for doubling backslashes. The
6631 regular expression that is eventually used in this example contains just one
6632 backslash. The circumflex is included in the regular expression, and has the
6633 normal effect of &"anchoring"& it to the start of the string that is being
6634 matched.
6635
6636 There are, however, two cases where a circumflex is not required for the
6637 recognition of a regular expression: these are the &%match%& condition in a
6638 string expansion, and the &%matches%& condition in an Exim filter file. In
6639 these cases, the relevant string is always treated as a regular expression; if
6640 it does not start with a circumflex, the expression is not anchored, and can
6641 match anywhere in the subject string.
6642
6643 In all cases, if you want a regular expression to match at the end of a string,
6644 you must code the $ metacharacter to indicate this. For example:
6645 .code
6646 domains = ^\\d{3}\\.example
6647 .endd
6648 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6649 You need to use:
6650 .code
6651 domains = ^\\d{3}\\.example\$
6652 .endd
6653 if you want &'example'& to be the top-level domain. The backslash before the
6654 $ is needed because string expansion also interprets dollar characters.
6655
6656
6657
6658 . ////////////////////////////////////////////////////////////////////////////
6659 . ////////////////////////////////////////////////////////////////////////////
6660
6661 .chapter "File and database lookups" "CHAPfdlookup"
6662 .scindex IIDfidalo1 "file" "lookups"
6663 .scindex IIDfidalo2 "database" "lookups"
6664 .cindex "lookup" "description of"
6665 Exim can be configured to look up data in files or databases as it processes
6666 messages. Two different kinds of syntax are used:
6667
6668 .olist
6669 A string that is to be expanded may contain explicit lookup requests. These
6670 cause parts of the string to be replaced by data that is obtained from the
6671 lookup. Lookups of this type are conditional expansion items. Different results
6672 can be defined for the cases of lookup success and failure. See chapter
6673 &<<CHAPexpand>>&, where string expansions are described in detail.
6674 The key for the lookup is &*specified*& as part of the string to be expanded.
6675 .next
6676 Lists of domains, hosts, and email addresses can contain lookup requests as a
6677 way of avoiding excessively long linear lists. In this case, the data that is
6678 returned by the lookup is often (but not always) discarded; whether the lookup
6679 succeeds or fails is what really counts. These kinds of list are described in
6680 chapter &<<CHAPdomhosaddlists>>&.
6681 Depending on the lookup type (see below)
6682 the key for the lookup may need to be &*specified*& as above
6683 or may be &*implicit*&,
6684 given by the context in which the list is being checked.
6685 .endlist
6686
6687 String expansions, lists, and lookups interact with each other in such a way
6688 that there is no order in which to describe any one of them that does not
6689 involve references to the others. Each of these three chapters makes more sense
6690 if you have read the other two first. If you are reading this for the first
6691 time, be aware that some of it will make a lot more sense after you have read
6692 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6693
6694 .section "Examples of different lookup syntax" "SECID60"
6695 It is easy to confuse the two different kinds of lookup, especially as the
6696 lists that may contain the second kind are always expanded before being
6697 processed as lists. Therefore, they may also contain lookups of the first kind.
6698 Be careful to distinguish between the following two examples:
6699 .code
6700 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6701 domains = lsearch;/some/file
6702 .endd
6703 .ilist
6704 The first uses a string expansion, the result of which must be a domain list.
6705 The key for an expansion-style lookup must be given explicitly.
6706 No strings have been specified for a successful or a failing lookup; the
6707 defaults in this case are the looked-up data and an empty string, respectively.
6708 The expansion takes place before the string is processed as a list, and the
6709 file that is searched could contain lines like this:
6710 .code
6711 192.168.3.4: domain1:domain2:...
6712 192.168.1.9: domain3:domain4:...
6713 .endd
6714 When the lookup succeeds, the result of the expansion is a list of domains (and
6715 possibly other types of item that are allowed in domain lists).
6716 .cindex "tainted data" "de-tainting"
6717 .cindex "de-tainting" "using a lookup expansion"
6718 The result of the expansion is not tainted.
6719
6720 .next
6721 In the second example, the lookup is a single item in a domain list. It causes
6722 Exim to use a lookup to see if the domain that is being processed can be found
6723 in the file.
6724 The file could contains lines like this:
6725 .code
6726 domain1:
6727 domain2:
6728 .endd
6729 Any data that follows the keys is not relevant when checking that the domain
6730 matches the list item.
6731
6732 The key for a list-style lookup is implicit, from the lookup context, if
6733 the lookup is a single-key type (see below).
6734 For query-style lookup types the query must be given explicitly.
6735 .endlist
6736
6737 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6738 Consider a file containing lines like this:
6739 .code
6740 192.168.5.6: lsearch;/another/file
6741 .endd
6742 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6743 first &%domains%& setting above generates the second setting, which therefore
6744 causes a second lookup to occur.
6745
6746 The lookup type may optionally be followed by a comma
6747 and a comma-separated list of options.
6748 Each option is a &"name=value"& pair.
6749 Whether an option is meaningful depends on the lookup type.
6750
6751 All lookups support the option &"cache=no_rd"&.
6752 If this is given then the cache that Exim manages for lookup results
6753 is not checked before doing the lookup.
6754 The result of the lookup is still written to the cache.
6755
6756 The rest of this chapter describes the different lookup types that are
6757 available. Any of them can be used in any part of the configuration where a
6758 lookup is permitted.
6759
6760
6761 .section "Lookup types" "SECID61"
6762 .cindex "lookup" "types of"
6763 .cindex "single-key lookup" "definition of"
6764 Two different types of data lookup are implemented:
6765
6766 .ilist
6767 The &'single-key'& type requires the specification of a file in which to look,
6768 and a single key to search for. The key must be a non-empty string for the
6769 lookup to succeed. The lookup type determines how the file is searched.
6770 .cindex "tainted data" "single-key lookups"
6771 The file string may not be tainted.
6772
6773 .cindex "tainted data" "de-tainting"
6774 .cindex "de-tainting" "using a single-key lookup"
6775 All single-key lookups support the option &"ret=key"&.
6776 If this is given and the lookup
6777 (either underlying implementation or cached value)
6778 returns data, the result is replaced with a non-tainted
6779 version of the lookup key.
6780
6781 .next
6782 .cindex "query-style lookup" "definition of"
6783 The &'query-style'& type accepts a generalized database query. No particular
6784 key value is assumed by Exim for query-style lookups. You can use whichever
6785 Exim variables you need to construct the database query.
6786
6787 For the string-expansion kind of lookups, the query is given in the first
6788 bracketed argument of the &${lookup ...}$& expansion.
6789 For the list-argument kind of lookup the query is given by the remainder of the
6790 list item after the first semicolon.
6791
6792 .cindex "tainted data" "quoting for lookups"
6793 If tainted data is used in the query then it should be quoted by
6794 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6795 appropriate for the lookup.
6796 .endlist
6797
6798 The code for each lookup type is in a separate source file that is included in
6799 the binary of Exim only if the corresponding compile-time option is set. The
6800 default settings in &_src/EDITME_& are:
6801 .code
6802 LOOKUP_DBM=yes
6803 LOOKUP_LSEARCH=yes
6804 .endd
6805 which means that only linear searching and DBM lookups are included by default.
6806 For some types of lookup (e.g. SQL databases), you need to install appropriate
6807 libraries and header files before building Exim.
6808
6809
6810
6811
6812 .section "Single-key lookup types" "SECTsinglekeylookups"
6813 .cindex "lookup" "single-key types"
6814 .cindex "single-key lookup" "list of types"
6815 The following single-key lookup types are implemented:
6816
6817 .subsection cdb
6818 .cindex "cdb" "description of"
6819 .cindex "lookup" "cdb"
6820 .cindex "binary zero" "in lookup key"
6821 The given file is searched as a Constant DataBase file, using the key
6822 string without a terminating binary zero. The cdb format is designed for
6823 indexed files that are read frequently and never updated, except by total
6824 re-creation. As such, it is particularly suitable for large files containing
6825 aliases or other indexed data referenced by an MTA. Information about cdb and
6826 tools for building the files can be found in several places:
6827 .display
6828 &url(https://cr.yp.to/cdb.html)
6829 &url(https://www.corpit.ru/mjt/tinycdb.html)
6830 &url(https://packages.debian.org/stable/utils/freecdb)
6831 &url(https://github.com/philpennock/cdbtools) (in Go)
6832 .endd
6833 A cdb distribution is not needed in order to build Exim with cdb support,
6834 because the code for reading cdb files is included directly in Exim itself.
6835 However, no means of building or testing cdb files is provided with Exim, so
6836 you need to obtain a cdb distribution in order to do this.
6837
6838 .subsection dbm
6839 .cindex "DBM" "lookup type"
6840 .cindex "lookup" "dbm"
6841 .cindex "binary zero" "in lookup key"
6842 Calls to DBM library functions are used to extract data from the given
6843 DBM file by looking up the record with the given key. A terminating binary
6844 zero is included in the key that is passed to the DBM library. See section
6845 &<<SECTdb>>& for a discussion of DBM libraries.
6846
6847 .cindex "Berkeley DB library" "file format"
6848 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6849 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6850 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6851 the DB_UNKNOWN option. This enables it to handle any of the types of database
6852 that the library supports, and can be useful for accessing DBM files created by
6853 other applications. (For earlier DB versions, DB_HASH is always used.)
6854
6855 .subsection dbmjz
6856 .cindex "lookup" "dbmjz"
6857 .cindex "lookup" "dbm &-- embedded NULs"
6858 .cindex "sasldb2"
6859 .cindex "dbmjz lookup type"
6860 This is the same as &(dbm)&, except that the lookup key is
6861 interpreted as an Exim list; the elements of the list are joined together with
6862 ASCII NUL characters to form the lookup key.  An example usage would be to
6863 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6864 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6865 &(cram_md5)& authenticator.
6866
6867 .subsection dbmnz
6868 .cindex "lookup" "dbmnz"
6869 .cindex "lookup" "dbm &-- terminating zero"
6870 .cindex "binary zero" "in lookup key"
6871 .cindex "Courier"
6872 .cindex "&_/etc/userdbshadow.dat_&"
6873 .cindex "dbmnz lookup type"
6874 This is the same as &(dbm)&, except that a terminating binary zero
6875 is not included in the key that is passed to the DBM library. You may need this
6876 if you want to look up data in files that are created by or shared with some
6877 other application that does not use terminating zeros. For example, you need to
6878 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6879 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6880 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6881 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6882
6883 .subsection dsearch
6884 .cindex "lookup" "dsearch"
6885 .cindex "dsearch lookup type"
6886 The given file must be an absolute directory path; this is searched for an entry
6887 whose name is the key by calling the &[lstat()]& function.
6888 Unless the options (below) permit a path,
6889 the key may not contain any forward slash characters.
6890 If &[lstat()]& succeeds then so does the lookup.
6891 .cindex "tainted data" "dsearch result"
6892 The result is regarded as untainted.
6893
6894 Options for the lookup can be given by appending them after the word "dsearch",
6895 separated by a comma.  Options, if present, are a comma-separated list having
6896 each element starting with a tag name and an equals.
6897
6898 Three options are supported, for the return value and for filtering match
6899 candidates.
6900 The "ret" option requests an alternate result value of
6901 the entire path for the entry. Example:
6902 .code
6903 ${lookup {passwd} dsearch,ret=full {/etc}}
6904 .endd
6905 The default result is just the requested entry.
6906
6907 The "filter" option requests that only directory entries of a given type
6908 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6909 not matching "." or ".."). Example:
6910 .code
6911 ${lookup {passwd} dsearch,filter=file {/etc}}
6912 .endd
6913 The default matching is for any entry type, including directories
6914 and symlinks.
6915
6916 The "key" option relaxes the restriction that only a simple path component can
6917 be searched for, to permit a sequence of path components. Example:
6918 .code
6919 ${lookup {foo/bar} dsearch,key=path {/etc}}
6920 .endd
6921 If this option is used, a ".." component in the key is specifically disallowed.
6922 The default operation is that the key may only be a single path component.
6923
6924 An example of how this
6925 lookup can be used to support virtual domains is given in section
6926 &<<SECTvirtualdomains>>&.
6927
6928 .subsection iplsearch
6929 .cindex "lookup" "iplsearch"
6930 .cindex "iplsearch lookup type"
6931 The given file is a text file containing keys and data. A key is
6932 terminated by a colon or white space or the end of the line. The keys in the
6933 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6934 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6935 being interpreted as a key terminator. For example:
6936 .code
6937 1.2.3.4:           data for 1.2.3.4
6938 192.168.0.0/16:    data for 192.168.0.0/16
6939 "abcd::cdab":      data for abcd::cdab
6940 "abcd:abcd::/32"   data for abcd:abcd::/32
6941 .endd
6942 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6943 file is searched linearly, using the CIDR masks where present, until a matching
6944 key is found. The first key that matches is used; there is no attempt to find a
6945 &"best"& match. Apart from the way the keys are matched, the processing for
6946 &(iplsearch)& is the same as for &(lsearch)&.
6947
6948 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6949 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6950 lookup types support only literal keys.
6951
6952 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6953 the implicit key is the host's IP address rather than its name
6954 (see section &<<SECThoslispatsikey>>&).
6955
6956 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6957 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6958 notation before executing the lookup.)
6959
6960 One option is supported, "ret=full", to request the return of the entire line
6961 rather than omitting the key portion.
6962 Note however that the key portion will have been de-quoted.
6963
6964 .subsection json
6965 .cindex lookup json
6966 .cindex json "lookup type"
6967 .cindex JSON expansions
6968 The given file is a text file with a JSON structure.
6969 An element of the structure is extracted, defined by the search key.
6970 The key is a list of subelement selectors
6971 (colon-separated by default but changeable in the usual way)
6972 which are applied in turn to select smaller and smaller portions
6973 of the JSON structure.
6974 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6975 nunbered array element is selected.
6976 Otherwise it must apply to a JSON object; the named element is selected.
6977 The final resulting element can be a simple JSON type or a JSON object
6978 or array; for the latter two a string-representation of the JSON
6979 is returned.
6980 For elements of type string, the returned value is de-quoted.
6981
6982
6983 .subsection lmdb
6984 .cindex LMDB
6985 .cindex lookup lmdb
6986 .cindex database lmdb
6987 The given file is an LMDB database.
6988 LMDB is a memory-mapped key-value store,
6989 with API modeled loosely on that of BerkeleyDB.
6990 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6991 for the feature set and operation modes.
6992
6993 Exim provides read-only access via the LMDB C library.
6994 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6995 or your operating system package repository.
6996 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6997
6998 You will need to separately create the LMDB database file,
6999 possibly using the &"mdb_load"& utility.
7000
7001
7002 .subsection lsearch
7003 .cindex "linear search"
7004 .cindex "lookup" "lsearch"
7005 .cindex "lsearch lookup type"
7006 .cindex "case sensitivity" "in lsearch lookup"
7007 The given file is a text file that is searched linearly for a
7008 line beginning with the search key, terminated by a colon or white space or the
7009 end of the line. The search is case-insensitive; that is, upper and lower case
7010 letters are treated as the same. The first occurrence of the key that is found
7011 in the file is used.
7012
7013 White space between the key and the colon is permitted. The remainder of the
7014 line, with leading and trailing white space removed, is the data. This can be
7015 continued onto subsequent lines by starting them with any amount of white
7016 space, but only a single space character is included in the data at such a
7017 junction. If the data begins with a colon, the key must be terminated by a
7018 colon, for example:
7019 .code
7020 baduser:  :fail:
7021 .endd
7022 Empty lines and lines beginning with # are ignored, even if they occur in the
7023 middle of an item. This is the traditional textual format of alias files. Note
7024 that the keys in an &(lsearch)& file are literal strings. There is no
7025 wildcarding of any kind.
7026
7027 .cindex "lookup" "lsearch &-- colons in keys"
7028 .cindex "white space" "in lsearch key"
7029 In most &(lsearch)& files, keys are not required to contain colons or #
7030 characters, or white space. However, if you need this feature, it is available.
7031 If a key begins with a doublequote character, it is terminated only by a
7032 matching quote (or end of line), and the normal escaping rules apply to its
7033 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
7034 quoted keys (exactly as for unquoted keys). There is no special handling of
7035 quotes for the data part of an &(lsearch)& line.
7036
7037 .subsection nis
7038 .cindex "NIS lookup type"
7039 .cindex "lookup" "NIS"
7040 .cindex "binary zero" "in lookup key"
7041 The given file is the name of a NIS map, and a NIS lookup is done with
7042 the given key, without a terminating binary zero. There is a variant called
7043 &(nis0)& which does include the terminating binary zero in the key. This is
7044 reportedly needed for Sun-style alias files. Exim does not recognize NIS
7045 aliases; the full map names must be used.
7046
7047 .subsection (n)wildlsearch
7048 .cindex "wildlsearch lookup type"
7049 .cindex "lookup" "wildlsearch"
7050 .cindex "nwildlsearch lookup type"
7051 .cindex "lookup" "nwildlsearch"
7052 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
7053 &(lsearch)&, but instead of being interpreted as a literal string, each key in
7054 the file may be wildcarded. The difference between these two lookup types is
7055 that for &(wildlsearch)&, each key in the file is string-expanded before being
7056 used, whereas for &(nwildlsearch)&, no expansion takes place.
7057
7058 .cindex "case sensitivity" "in (n)wildlsearch lookup"
7059 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
7060 file that are regular expressions can be made case-sensitive by the use of
7061 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7062
7063 .olist
7064 The string may begin with an asterisk to mean &"ends with"&. For example:
7065 .code
7066 *.a.b.c       data for anything.a.b.c
7067 *fish         data for anythingfish
7068 .endd
7069 .next
7070 The string may begin with a circumflex to indicate a regular expression. For
7071 example, for &(wildlsearch)&:
7072 .code
7073 ^\N\d+\.a\.b\N    data for <digits>.a.b
7074 .endd
7075 Note the use of &`\N`& to disable expansion of the contents of the regular
7076 expression. If you are using &(nwildlsearch)&, where the keys are not
7077 string-expanded, the equivalent entry is:
7078 .code
7079 ^\d+\.a\.b        data for <digits>.a.b
7080 .endd
7081 The case-insensitive flag is set at the start of compiling the regular
7082 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7083 For example, to make the entire pattern case-sensitive:
7084 .code
7085 ^(?-i)\d+\.a\.b        data for <digits>.a.b
7086 .endd
7087
7088 If the regular expression contains white space or colon characters, you must
7089 either quote it (see &(lsearch)& above), or represent these characters in other
7090 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7091 colon. This may be easier than quoting, because if you quote, you have to
7092 escape all the backslashes inside the quotes.
7093
7094 &*Note*&: It is not possible to capture substrings in a regular expression
7095 match for later use, because the results of all lookups are cached. If a lookup
7096 is repeated, the result is taken from the cache, and no actual pattern matching
7097 takes place. The values of all the numeric variables are unset after a
7098 &((n)wildlsearch)& match.
7099
7100 .next
7101 Although I cannot see it being of much use, the general matching function that
7102 is used to implement &((n)wildlsearch)& means that the string may begin with a
7103 lookup name terminated by a semicolon, and followed by lookup data. For
7104 example:
7105 .code
7106 cdb;/some/file  data for keys that match the file
7107 .endd
7108 The data that is obtained from the nested lookup is discarded.
7109 .endlist olist
7110
7111 Keys that do not match any of these patterns are interpreted literally. The
7112 continuation rules for the data are the same as for &(lsearch)&, and keys may
7113 be followed by optional colons.
7114
7115 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7116 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7117 lookup types support only literal keys.
7118
7119 .subsection spf
7120 .cindex "spf lookup type"
7121 .cindex "lookup" "spf"
7122 If Exim is built with SPF support, manual lookups can be done
7123 (as opposed to the standard ACL condition method).
7124 For details see section &<<SECSPF>>&.
7125
7126
7127 .section "Query-style lookup types" "SECTquerystylelookups"
7128 .cindex "lookup" "query-style types"
7129 .cindex "query-style lookup" "list of types"
7130 The supported query-style lookup types are listed below. Further details about
7131 many of them are given in later sections.
7132
7133 .subsection dnsdb
7134 .cindex "DNS" "as a lookup type"
7135 .cindex "lookup" "DNS"
7136 This does a DNS search for one or more records whose domain names
7137 are given in the supplied query. The resulting data is the contents of the
7138 records. See section &<<SECTdnsdb>>&.
7139
7140 .subsection ibase
7141 .cindex "InterBase lookup type"
7142 .cindex "lookup" "InterBase"
7143 This does a lookup in an InterBase database.
7144
7145 .subsection ldap
7146 .cindex "LDAP" "lookup type"
7147 .cindex "lookup" "LDAP"
7148 This does an LDAP lookup using a query in the form of a URL, and
7149 returns attributes from a single entry. There is a variant called &(ldapm)&
7150 that permits values from multiple entries to be returned. A third variant
7151 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7152 any attribute values. See section &<<SECTldap>>&.
7153
7154 .subsection mysql
7155 .cindex "MySQL" "lookup type"
7156 .cindex "lookup" "MySQL"
7157 The format of the query is an SQL statement that is passed to a
7158 MySQL database. See section &<<SECTsql>>&.
7159
7160 .subsection nisplus
7161 .cindex "NIS+ lookup type"
7162 .cindex "lookup" "NIS+"
7163 This does a NIS+ lookup using a query that can specify the name of
7164 the field to be returned. See section &<<SECTnisplus>>&.
7165
7166 .subsection oracle
7167 .cindex "Oracle" "lookup type"
7168 .cindex "lookup" "Oracle"
7169 The format of the query is an SQL statement that is passed to an
7170 Oracle database. See section &<<SECTsql>>&.
7171
7172 .subsection passwd
7173 .cindex "lookup" "passwd"
7174 .cindex "passwd lookup type"
7175 .cindex "&_/etc/passwd_&"
7176 This is a query-style lookup with queries that are just user names. The
7177 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7178 success, the result string is the same as you would get from an &(lsearch)&
7179 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7180 password value. For example:
7181 .code
7182 *:42:42:King Rat:/home/kr:/bin/bash
7183 .endd
7184
7185 .subsection pgsql
7186 .cindex "PostgreSQL lookup type"
7187 .cindex "lookup" "PostgreSQL"
7188 The format of the query is an SQL statement that is passed to a
7189 PostgreSQL database. See section &<<SECTsql>>&.
7190
7191 .subsection redis
7192 .cindex "Redis lookup type"
7193 .cindex lookup Redis
7194 The format of the query is either a simple get or simple set,
7195 passed to a Redis database. See section &<<SECTsql>>&.
7196
7197 .subsection sqlite
7198 .cindex "sqlite lookup type"
7199 .cindex "lookup" "sqlite"
7200 The format of the query is
7201 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7202
7203 .subsection testdb
7204 This is a lookup type that is used for testing Exim. It is
7205 not likely to be useful in normal operation.
7206
7207 .subsection whoson
7208 .cindex "whoson lookup type"
7209 .cindex "lookup" "whoson"
7210 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7211 allows a server to check whether a particular (dynamically allocated) IP
7212 address is currently allocated to a known (trusted) user and, optionally, to
7213 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7214 at one time for &"POP before SMTP"& authentication, but that approach has been
7215 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7216 &"POP before SMTP"& checking using ACL statements such as
7217 .code
7218 require condition = \
7219   ${lookup whoson {$sender_host_address}{yes}{no}}
7220 .endd
7221 The query consists of a single IP address. The value returned is the name of
7222 the authenticated user, which is stored in the variable &$value$&. However, in
7223 this example, the data in &$value$& is not used; the result of the lookup is
7224 one of the fixed strings &"yes"& or &"no"&.
7225
7226
7227
7228 .section "Temporary errors in lookups" "SECID63"
7229 .cindex "lookup" "temporary error in"
7230 Lookup functions can return temporary error codes if the lookup cannot be
7231 completed. For example, an SQL or LDAP database might be unavailable. For this
7232 reason, it is not advisable to use a lookup that might do this for critical
7233 options such as a list of local domains.
7234
7235 When a lookup cannot be completed in a router or transport, delivery
7236 of the message (to the relevant address) is deferred, as for any other
7237 temporary error. In other circumstances Exim may assume the lookup has failed,
7238 or may give up altogether.
7239
7240
7241
7242 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7243 .cindex "wildcard lookups"
7244 .cindex "lookup" "default values"
7245 .cindex "lookup" "wildcard"
7246 .cindex "lookup" "* added to type"
7247 .cindex "default" "in single-key lookups"
7248 In this context, a &"default value"& is a value specified by the administrator
7249 that is to be used if a lookup fails.
7250
7251 &*Note:*& This section applies only to single-key lookups. For query-style
7252 lookups, the facilities of the query language must be used. An attempt to
7253 specify a default for a query-style lookup provokes an error.
7254
7255 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7256 and the initial lookup fails, the key &"*"& is looked up in the file to
7257 provide a default value. See also the section on partial matching below.
7258
7259 .cindex "*@ with single-key lookup"
7260 .cindex "lookup" "*@ added to type"
7261 .cindex "alias file" "per-domain default"
7262 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7263 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7264 character, a second lookup is done with everything before the last @ replaced
7265 by *. This makes it possible to provide per-domain defaults in alias files
7266 that include the domains in the keys. If the second lookup fails (or doesn't
7267 take place because there is no @ in the key), &"*"& is looked up.
7268 For example, a &(redirect)& router might contain:
7269 .code
7270 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7271 .endd
7272 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7273 looks up these keys, in this order:
7274 .code
7275 jane@eyre.example
7276 *@eyre.example
7277 *
7278 .endd
7279 The data is taken from whichever key it finds first. &*Note*&: In an
7280 &(lsearch)& file, this does not mean the first of these keys in the file. A
7281 complete scan is done for each key, and only if it is not found at all does
7282 Exim move on to try the next key.
7283
7284
7285
7286 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7287 .cindex "partial matching"
7288 .cindex "wildcard lookups"
7289 .cindex "lookup" "partial matching"
7290 .cindex "lookup" "wildcard"
7291 .cindex "asterisk" "in search type"
7292 The normal operation of a single-key lookup is to search the file for an exact
7293 match with the given key. However, in a number of situations where domains are
7294 being looked up, it is useful to be able to do partial matching. In this case,
7295 information in the file that has a key starting with &"*."& is matched by any
7296 domain that ends with the components that follow the full stop. For example, if
7297 a key in a DBM file is
7298 .code
7299 *.dates.fict.example
7300 .endd
7301 then when partial matching is enabled this is matched by (amongst others)
7302 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7303 by &'dates.fict.example'&, if that does not appear as a separate key in the
7304 file.
7305
7306 &*Note*&: Partial matching is not available for query-style lookups. It is
7307 also not available for any lookup items in address lists (see section
7308 &<<SECTaddresslist>>&).
7309
7310 Partial matching is implemented by doing a series of separate lookups using
7311 keys constructed by modifying the original subject key. This means that it can
7312 be used with any of the single-key lookup types, provided that
7313 partial matching keys
7314 beginning with a special prefix (default &"*."&) are included in the data file.
7315 Keys in the file that do not begin with the prefix are matched only by
7316 unmodified subject keys when partial matching is in use.
7317
7318 Partial matching is requested by adding the string &"partial-"& to the front of
7319 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7320 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7321 is added at the start of the subject key, and it is looked up again. If that
7322 fails, further lookups are tried with dot-separated components removed from the
7323 start of the subject key, one-by-one, and &"*."& added on the front of what
7324 remains.
7325
7326 A minimum number of two non-* components are required. This can be adjusted
7327 by including a number before the hyphen in the search type. For example,
7328 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7329 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7330 subject key is &'2250.dates.fict.example'& then the following keys are looked
7331 up when the minimum number of non-* components is two:
7332 .code
7333 2250.dates.fict.example
7334 *.2250.dates.fict.example
7335 *.dates.fict.example
7336 *.fict.example
7337 .endd
7338 As soon as one key in the sequence is successfully looked up, the lookup
7339 finishes.
7340
7341 .cindex "lookup" "partial matching &-- changing prefix"
7342 .cindex "prefix" "for partial matching"
7343 The use of &"*."& as the partial matching prefix is a default that can be
7344 changed. The motivation for this feature is to allow Exim to operate with file
7345 formats that are used by other MTAs. A different prefix can be supplied in
7346 parentheses instead of the hyphen after &"partial"&. For example:
7347 .code
7348 domains = partial(.)lsearch;/some/file
7349 .endd
7350 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7351 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7352 components is unchanged). The prefix may consist of any punctuation characters
7353 other than a closing parenthesis. It may be empty, for example:
7354 .code
7355 domains = partial1()cdb;/some/file
7356 .endd
7357 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7358 &`a.b.c`&, &`b.c`&, and &`c`&.
7359
7360 If &"partial0"& is specified, what happens at the end (when the lookup with
7361 just one non-wild component has failed, and the original key is shortened right
7362 down to the null string) depends on the prefix:
7363
7364 .ilist
7365 If the prefix has zero length, the whole lookup fails.
7366 .next
7367 If the prefix has length 1, a lookup for just the prefix is done. For
7368 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7369 .next
7370 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7371 remainder is looked up. With the default prefix, therefore, the final lookup is
7372 for &"*"& on its own.
7373 .next
7374 Otherwise, the whole prefix is looked up.
7375 .endlist
7376
7377
7378 If the search type ends in &"*"& or &"*@"& (see section
7379 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7380 this implies happens after all partial lookups have failed. If &"partial0"& is
7381 specified, adding &"*"& to the search type has no effect with the default
7382 prefix, because the &"*"& key is already included in the sequence of partial
7383 lookups. However, there might be a use for lookup types such as
7384 &"partial0(.)lsearch*"&.
7385
7386 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7387 in domain lists and the like. Partial matching works only in terms of
7388 dot-separated components; a key such as &`*fict.example`&
7389 in a database file is useless, because the asterisk in a partial matching
7390 subject key is always followed by a dot.
7391
7392 When the lookup is done from a string-expansion,
7393 the variables &$1$& and &$2$& contain the wild and non-wild parts of the key
7394 during the expansion of the replacement text.
7395 They return to their previous values at the end of the lookup item.
7396
7397
7398
7399
7400 .section "Lookup caching" "SECID64"
7401 .cindex "lookup" "caching"
7402 .cindex "caching" "lookup data"
7403 Exim caches all lookup results in order to avoid needless repetition of
7404 lookups. However, because (apart from the daemon) Exim operates as a collection
7405 of independent, short-lived processes, this caching applies only within a
7406 single Exim process. There is no inter-process lookup caching facility.
7407
7408 If an option &"cache=no_rd"& is used on the lookup then
7409 the cache is only written to, cached data is not used for the operation
7410 and a real lookup is done.
7411
7412 For single-key lookups, Exim keeps the relevant files open in case there is
7413 another lookup that needs them. In some types of configuration this can lead to
7414 many files being kept open for messages with many recipients. To avoid hitting
7415 the operating system limit on the number of simultaneously open files, Exim
7416 closes the least recently used file when it needs to open more files than its
7417 own internal limit, which can be changed via the &%lookup_open_max%& option.
7418
7419 The single-key lookup files are closed and the lookup caches are flushed at
7420 strategic points during delivery &-- for example, after all routing is
7421 complete.
7422
7423
7424
7425
7426 .section "Quoting lookup data" "SECID65"
7427 .cindex "lookup" "quoting"
7428 .cindex "quoting" "in lookups"
7429 When data from an incoming message is included in a query-style lookup, there
7430 is the possibility of special characters in the data messing up the syntax of
7431 the query. For example, a NIS+ query that contains
7432 .code
7433 [name=$local_part]
7434 .endd
7435 will be broken if the local part happens to contain a closing square bracket.
7436 For NIS+, data can be enclosed in double quotes like this:
7437 .code
7438 [name="$local_part"]
7439 .endd
7440 but this still leaves the problem of a double quote in the data. The rule for
7441 NIS+ is that double quotes must be doubled. Other lookup types have different
7442 rules, and to cope with the differing requirements, an expansion operator
7443 of the following form is provided:
7444 .code
7445 ${quote_<lookup-type>:<string>}
7446 .endd
7447 For example, the way to write the NIS+ query is
7448 .code
7449 [name="${quote_nisplus:$local_part}"]
7450 .endd
7451 .cindex "tainted data" "in lookups"
7452 &*All*& tainted data used in a query-style lookup must be quoted
7453 using a mechanism appropriate for the lookup type.
7454 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7455 operator can be used for all lookup types, but has no effect for single-key
7456 lookups, since no quoting is ever needed in their key strings.
7457
7458
7459
7460
7461 .section "More about dnsdb" "SECTdnsdb"
7462 .cindex "dnsdb lookup"
7463 .cindex "lookup" "dnsdb"
7464 .cindex "DNS" "as a lookup type"
7465 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7466 of a record type and a domain name, separated by an equals sign. For example,
7467 an expansion string could contain:
7468 .code
7469 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7470 .endd
7471 If the lookup succeeds, the result is placed in &$value$&, which in this case
7472 is used on its own as the result. If the lookup does not succeed, the
7473 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7474 &<<SECTforexpfai>>& for an explanation of what this means.
7475
7476 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7477 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7478 If no type is given, TXT is assumed.
7479
7480 For any record type, if multiple records are found, the data is returned as a
7481 concatenation, with newline as the default separator. The order, of course,
7482 depends on the DNS resolver. You can specify a different separator character
7483 between multiple records by putting a right angle-bracket followed immediately
7484 by the new separator at the start of the query. For example:
7485 .code
7486 ${lookup dnsdb{>: a=host1.example}}
7487 .endd
7488 It is permitted to specify a space as the separator character. Further
7489 white space is ignored.
7490 For lookup types that return multiple fields per record,
7491 an alternate field separator can be specified using a comma after the main
7492 separator character, followed immediately by the field separator.
7493
7494 .cindex "PTR record" "in &(dnsdb)& lookup"
7495 When the type is PTR,
7496 the data can be an IP address, written as normal; inversion and the addition of
7497 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7498 .code
7499 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7500 .endd
7501 If the data for a PTR record is not a syntactically valid IP address, it is not
7502 altered and nothing is added.
7503
7504 .cindex "MX record" "in &(dnsdb)& lookup"
7505 .cindex "SRV record" "in &(dnsdb)& lookup"
7506 For an MX lookup, both the preference value and the host name are returned for
7507 each record, separated by a space. For an SRV lookup, the priority, weight,
7508 port, and host name are returned for each record, separated by spaces.
7509 The field separator can be modified as above.
7510
7511 .cindex "TXT record" "in &(dnsdb)& lookup"
7512 .cindex "SPF record" "in &(dnsdb)& lookup"
7513 For TXT records with multiple items of data, only the first item is returned,
7514 unless a field separator is specified.
7515 To concatenate items without a separator, use a semicolon instead.
7516 For SPF records the
7517 default behaviour is to concatenate multiple items without using a separator.
7518 .code
7519 ${lookup dnsdb{>\n,: txt=a.b.example}}
7520 ${lookup dnsdb{>\n; txt=a.b.example}}
7521 ${lookup dnsdb{spf=example.org}}
7522 .endd
7523 It is permitted to specify a space as the separator character. Further
7524 white space is ignored.
7525
7526 .cindex "SOA record" "in &(dnsdb)& lookup"
7527 For an SOA lookup, while no result is obtained the lookup is redone with
7528 successively more leading components dropped from the given domain.
7529 Only the primary-nameserver field is returned unless a field separator is
7530 specified.
7531 .code
7532 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7533 .endd
7534
7535 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7536 .cindex "dnsdb modifiers"
7537 .cindex "modifiers" "dnsdb"
7538 .cindex "options" "dnsdb"
7539 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7540 each followed by a comma,
7541 that may appear before the record type.
7542
7543 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7544 temporary DNS error for any of them, the behaviour is controlled by
7545 a defer-option modifier.
7546 The possible keywords are
7547 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7548 With &"strict"& behaviour, any temporary DNS error causes the
7549 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7550 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7551 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7552 error causes the whole lookup to defer only if none of the other lookups
7553 succeed. The default is &"lax"&, so the following lookups are equivalent:
7554 .code
7555 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7556 ${lookup dnsdb{a=one.host.com:two.host.com}}
7557 .endd
7558 Thus, in the default case, as long as at least one of the DNS lookups
7559 yields some data, the lookup succeeds.
7560
7561 .cindex "DNSSEC" "dns lookup"
7562 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7563 The possible keywords are
7564 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7565 With &"strict"& or &"lax"& DNSSEC information is requested
7566 with the lookup.
7567 With &"strict"& a response from the DNS resolver that
7568 is not labelled as authenticated data
7569 is treated as equivalent to a temporary DNS error.
7570 The default is &"lax"&.
7571
7572 See also the &$lookup_dnssec_authenticated$& variable.
7573
7574 .cindex timeout "dns lookup"
7575 .cindex "DNS" timeout
7576 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7577 The form is &"retrans_VAL"& where VAL is an Exim time specification
7578 (e.g. &"5s"&).
7579 The default value is set by the main configuration option &%dns_retrans%&.
7580
7581 Retries for the dnsdb lookup can be controlled by a retry modifier.
7582 The form if &"retry_VAL"& where VAL is an integer.
7583 The default count is set by the main configuration option &%dns_retry%&.
7584
7585 .cindex caching "of dns lookup"
7586 .cindex TTL "of dns lookup"
7587 .cindex DNS TTL
7588 Dnsdb lookup results are cached within a single process (and its children).
7589 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7590 value of the set of returned DNS records.
7591
7592
7593 .subsection "Pseudo dnsdb record types" SECID66
7594 .cindex "MX record" "in &(dnsdb)& lookup"
7595 By default, both the preference value and the host name are returned for
7596 each MX record, separated by a space. If you want only host names, you can use
7597 the pseudo-type MXH:
7598 .code
7599 ${lookup dnsdb{mxh=a.b.example}}
7600 .endd
7601 In this case, the preference values are omitted, and just the host names are
7602 returned.
7603
7604 .cindex "name server for enclosing domain"
7605 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7606 records on the given domain, but if none are found, it removes the first
7607 component of the domain name, and tries again. This process continues until NS
7608 records are found or there are no more components left (or there is a DNS
7609 error). In other words, it may return the name servers for a top-level domain,
7610 but it never returns the root name servers. If there are no NS records for the
7611 top-level domain, the lookup fails. Consider these examples:
7612 .code
7613 ${lookup dnsdb{zns=xxx.quercite.com}}
7614 ${lookup dnsdb{zns=xxx.edu}}
7615 .endd
7616 Assuming that in each case there are no NS records for the full domain name,
7617 the first returns the name servers for &%quercite.com%&, and the second returns
7618 the name servers for &%edu%&.
7619
7620 You should be careful about how you use this lookup because, unless the
7621 top-level domain does not exist, the lookup always returns some host names. The
7622 sort of use to which this might be put is for seeing if the name servers for a
7623 given domain are on a blacklist. You can probably assume that the name servers
7624 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7625 such a list.
7626
7627 .cindex "CSA" "in &(dnsdb)& lookup"
7628 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7629 records according to the CSA rules, which are described in section
7630 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7631 not sufficient because of the extra parent domain search behaviour of CSA. The
7632 result of a successful lookup such as:
7633 .code
7634 ${lookup dnsdb {csa=$sender_helo_name}}
7635 .endd
7636 has two space-separated fields: an authorization code and a target host name.
7637 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7638 authorization required but absent, or &"?"& for unknown.
7639
7640 .cindex "A+" "in &(dnsdb)& lookup"
7641 The pseudo-type A+ performs an AAAA
7642 and then an A lookup.  All results are returned; defer processing
7643 (see below) is handled separately for each lookup.  Example:
7644 .code
7645 ${lookup dnsdb {>; a+=$sender_helo_name}}
7646 .endd
7647
7648
7649 .subsection "Multiple dnsdb lookups" SECID67
7650 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7651 However, you can specify a list of domains or IP addresses in a single
7652 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7653 the default separator, but with the ability to change this. For example:
7654 .code
7655 ${lookup dnsdb{one.domain.com:two.domain.com}}
7656 ${lookup dnsdb{a=one.host.com:two.host.com}}
7657 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7658 .endd
7659 In order to retain backwards compatibility, there is one special case: if
7660 the lookup type is PTR and no change of separator is specified, Exim looks
7661 to see if the rest of the string is precisely one IPv6 address. In this
7662 case, it does not treat it as a list.
7663
7664 The data from each lookup is concatenated, with newline separators by default,
7665 in the same way that multiple DNS records for a single item are handled. A
7666 different separator can be specified, as described above.
7667
7668
7669
7670
7671 .section "More about LDAP" "SECTldap"
7672 .cindex "LDAP" "lookup, more about"
7673 .cindex "lookup" "LDAP"
7674 .cindex "Solaris" "LDAP"
7675 The original LDAP implementation came from the University of Michigan; this has
7676 become &"Open LDAP"&, and there are now two different releases. Another
7677 implementation comes from Netscape, and Solaris 7 and subsequent releases
7678 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7679 the lookup function level, their error handling is different. For this reason
7680 it is necessary to set a compile-time variable when building Exim with LDAP, to
7681 indicate which LDAP library is in use. One of the following should appear in
7682 your &_Local/Makefile_&:
7683 .code
7684 LDAP_LIB_TYPE=UMICHIGAN
7685 LDAP_LIB_TYPE=OPENLDAP1
7686 LDAP_LIB_TYPE=OPENLDAP2
7687 LDAP_LIB_TYPE=NETSCAPE
7688 LDAP_LIB_TYPE=SOLARIS
7689 .endd
7690 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7691 same interface as the University of Michigan version.
7692
7693 There are three LDAP lookup types in Exim. These behave slightly differently in
7694 the way they handle the results of a query:
7695
7696 .ilist
7697 &(ldap)& requires the result to contain just one entry; if there are more, it
7698 gives an error.
7699 .next
7700 &(ldapdn)& also requires the result to contain just one entry, but it is the
7701 Distinguished Name that is returned rather than any attribute values.
7702 .next
7703 &(ldapm)& permits the result to contain more than one entry; the attributes
7704 from all of them are returned.
7705 .endlist
7706
7707
7708 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7709 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7710 the data returned by a successful lookup is described in the next section.
7711 First we explain how LDAP queries are coded.
7712
7713
7714 .subsection "Format of LDAP queries" SECTforldaque
7715 .cindex "LDAP" "query format"
7716 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7717 the configuration of a &(redirect)& router one might have this setting:
7718 .code
7719 data = ${lookup ldap \
7720   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7721   c=UK?mailbox?base?}}
7722 .endd
7723 .cindex "LDAP" "with TLS"
7724 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7725 secure (encrypted) LDAP connections. The second of these ensures that an
7726 encrypted TLS connection is used.
7727
7728 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7729 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7730 See the &%ldap_start_tls%& option.
7731
7732 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7733 controlled. Every part of the TLS configuration can be configured by settings in
7734 &_exim.conf_&. Depending on the version of the client libraries installed on
7735 your system, some of the initialization may have required setting options in
7736 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7737 certificates. This revealed a nuance where the current UID that exim was
7738 running as could affect which config files it read. With Exim 4.83, these
7739 methods become optional, only taking effect if not specifically set in
7740 &_exim.conf_&.
7741
7742
7743 .subsection "LDAP quoting" SECID68
7744 .cindex "LDAP" "quoting"
7745 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7746 and the second because the LDAP query is represented as a URL. Furthermore,
7747 within an LDAP query, two different kinds of quoting are required. For this
7748 reason, there are two different LDAP-specific quoting operators.
7749
7750 The &%quote_ldap%& operator is designed for use on strings that are part of
7751 filter specifications. Conceptually, it first does the following conversions on
7752 the string:
7753 .code
7754 *   =>   \2A
7755 (   =>   \28
7756 )   =>   \29
7757 \   =>   \5C
7758 .endd
7759 in accordance with RFC 2254. The resulting string is then quoted according
7760 to the rules for URLs, that is, all non-alphanumeric characters except
7761 .code
7762 ! $ ' - . _ ( ) * +
7763 .endd
7764 are converted to their hex values, preceded by a percent sign. For example:
7765 .code
7766 ${quote_ldap: a(bc)*, a<yz>; }
7767 .endd
7768 yields
7769 .code
7770 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7771 .endd
7772 Removing the URL quoting, this is (with a leading and a trailing space):
7773 .code
7774 a\28bc\29\2A, a<yz>;
7775 .endd
7776 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7777 base DN specifications in queries. Conceptually, it first converts the string
7778 by inserting a backslash in front of any of the following characters:
7779 .code
7780 , + " \ < > ;
7781 .endd
7782 It also inserts a backslash before any leading spaces or # characters, and
7783 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7784 is then quoted according to the rules for URLs. For example:
7785 .code
7786 ${quote_ldap_dn: a(bc)*, a<yz>; }
7787 .endd
7788 yields
7789 .code
7790 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7791 .endd
7792 Removing the URL quoting, this is (with a trailing space):
7793 .code
7794 \ a(bc)*\, a\<yz\>\;\
7795 .endd
7796 There are some further comments about quoting in the section on LDAP
7797 authentication below.
7798
7799
7800 .subsection "LDAP connections" SECID69
7801 .cindex "LDAP" "connections"
7802 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7803 is in use, via a Unix domain socket. The example given above does not specify
7804 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7805 by starting it with
7806 .code
7807 ldap://<hostname>:<port>/...
7808 .endd
7809 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7810 used. When no server is specified in a query, a list of default servers is
7811 taken from the &%ldap_default_servers%& configuration option. This supplies a
7812 colon-separated list of servers which are tried in turn until one successfully
7813 handles a query, or there is a serious error. Successful handling either
7814 returns the requested data, or indicates that it does not exist. Serious errors
7815 are syntactical, or multiple values when only a single value is expected.
7816 Errors which cause the next server to be tried are connection failures, bind
7817 failures, and timeouts.
7818
7819 For each server name in the list, a port number can be given. The standard way
7820 of specifying a host and port is to use a colon separator (RFC 1738). Because
7821 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7822 doubled. For example
7823 .code
7824 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7825 .endd
7826 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7827 to the LDAP library with no server name, and the library's default (normally
7828 the local host) is used.
7829
7830 If you are using the OpenLDAP library, you can connect to an LDAP server using
7831 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7832 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7833 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7834 not available.
7835
7836 For this type of connection, instead of a host name for the server, a pathname
7837 for the socket is required, and the port number is not relevant. The pathname
7838 can be specified either as an item in &%ldap_default_servers%&, or inline in
7839 the query. In the former case, you can have settings such as
7840 .code
7841 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7842 .endd
7843 When the pathname is given in the query, you have to escape the slashes as
7844 &`%2F`& to fit in with the LDAP URL syntax. For example:
7845 .code
7846 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7847 .endd
7848 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7849 a pathname, it uses the Unix domain socket code, even if the query actually
7850 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7851 socket connection. This behaviour means that you can use a setting of
7852 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7853 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7854 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7855 backup host.
7856
7857 If an explicit &`ldapi`& type is given in a query when a host name is
7858 specified, an error is diagnosed. However, if there are more items in
7859 &%ldap_default_servers%&, they are tried. In other words:
7860
7861 .ilist
7862 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7863 interface.
7864 .next
7865 Using &`ldapi`& with a host name causes an error.
7866 .endlist
7867
7868
7869 Using &`ldapi`& with no host or path in the query, and no setting of
7870 &%ldap_default_servers%&, does whatever the library does by default.
7871
7872
7873
7874 .subsection "LDAP authentication and control information" SECID70
7875 .cindex "LDAP" "authentication"
7876 The LDAP URL syntax provides no way of passing authentication and other control
7877 information to the server. To make this possible, the URL in an LDAP query may
7878 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7879 spaces. If a value contains spaces it must be enclosed in double quotes, and
7880 when double quotes are used, backslash is interpreted in the usual way inside
7881 them. The following names are recognized:
7882 .itable none 0 0 2 20* left 80* left
7883 .irow DEREFERENCE "set the dereferencing parameter"
7884 .irow NETTIME     "set a timeout for a network operation"
7885 .irow USER        "set the DN, for authenticating the LDAP bind"
7886 .irow PASS        "set the password, likewise"
7887 .irow REFERRALS   "set the referrals parameter"
7888 .irow SERVERS     "set alternate server list for this query only"
7889 .irow SIZE        "set the limit for the number of entries returned"
7890 .irow TIME        "set the maximum waiting time for a query"
7891 .endtable
7892 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7893 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7894 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7895 library from trying to follow referrals issued by the LDAP server.
7896
7897 .cindex LDAP timeout
7898 .cindex timeout "LDAP lookup"
7899 The name CONNECT is an obsolete name for NETTIME, retained for
7900 backwards compatibility. This timeout (specified as a number of seconds) is
7901 enforced from the client end for operations that can be carried out over a
7902 network. Specifically, it applies to network connections and calls to the
7903 &'ldap_result()'& function. If the value is greater than zero, it is used if
7904 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7905 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7906 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7907 Netscape SDK; for OpenLDAP no action is taken.
7908
7909 The TIME parameter (also a number of seconds) is passed to the server to
7910 set a server-side limit on the time taken to complete a search.
7911
7912 The SERVERS parameter allows you to specify an alternate list of ldap servers
7913 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7914 default list of ldap servers, and a single lookup can specify a single ldap
7915 server to use.  But when you need to do a lookup with a list of servers that is
7916 different than the default list (maybe different order, maybe a completely
7917 different set of servers), the SERVERS parameter allows you to specify this
7918 alternate list (colon-separated).
7919
7920 Here is an example of an LDAP query in an Exim lookup that uses some of these
7921 values. This is a single line, folded to fit on the page:
7922 .code
7923 ${lookup ldap
7924   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7925   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7926   {$value}fail}
7927 .endd
7928 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7929 any of the auxiliary data. Exim configuration settings that include lookups
7930 which contain password information should be preceded by &"hide"& to prevent
7931 non-admin users from using the &%-bP%& option to see their values.
7932
7933 The auxiliary data items may be given in any order. The default is no
7934 connection timeout (the system timeout is used), no user or password, no limit
7935 on the number of entries returned, and no time limit on queries.
7936
7937 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7938 removes any URL quoting that it may contain before passing it to the LDAP library.
7939 Apparently
7940 some libraries do this for themselves, but some do not. Removing the URL
7941 quoting has two advantages:
7942
7943 .ilist
7944 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7945 DNs as with DNs inside actual queries.
7946 .next
7947 It permits spaces inside USER= DNs.
7948 .endlist
7949
7950 For example, a setting such as
7951 .code
7952 USER=cn=${quote_ldap_dn:$1}
7953 .endd
7954 should work even if &$1$& contains spaces.
7955
7956 Expanded data for the PASS= value should be quoted using the &%quote%&
7957 expansion operator, rather than the LDAP quote operators. The only reason this
7958 field needs quoting is to ensure that it conforms to the Exim syntax, which
7959 does not allow unquoted spaces. For example:
7960 .code
7961 PASS=${quote:$3}
7962 .endd
7963 The LDAP authentication mechanism can be used to check passwords as part of
7964 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7965 &<<CHAPexpand>>&.
7966
7967
7968
7969 .subsection "Format of data returned by LDAP" SECID71
7970 .cindex "LDAP" "returned data formats"
7971 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7972 as a sequence of values, for example
7973 .code
7974 cn=manager,o=University of Cambridge,c=UK
7975 .endd
7976 The &(ldap)& lookup type generates an error if more than one entry matches the
7977 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7978 the result between the data from different entries. It is possible for multiple
7979 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7980 you know that whatever values are returned all came from a single entry in the
7981 directory.
7982
7983 In the common case where you specify a single attribute in your LDAP query, the
7984 result is not quoted, and does not contain the attribute name. If the attribute
7985 has multiple values, they are separated by commas. Any comma that is
7986 part of an attribute's value is doubled.
7987
7988 If you specify multiple attributes, the result contains space-separated, quoted
7989 strings, each preceded by the attribute name and an equals sign. Within the
7990 quotes, the quote character, backslash, and newline are escaped with
7991 backslashes, and commas are used to separate multiple values for the attribute.
7992 Any commas in attribute values are doubled
7993 (permitting treatment of the values as a comma-separated list).
7994 Apart from the escaping, the string within quotes takes the same form as the
7995 output when a single attribute is requested. Specifying no attributes is the
7996 same as specifying all of an entry's attributes.
7997
7998 Here are some examples of the output format. The first line of each pair is an
7999 LDAP query, and the second is the data that is returned. The attribute called
8000 &%attr1%& has two values, one of them with an embedded comma, whereas
8001 &%attr2%& has only one value. Both attributes are derived from &%attr%&
8002 (they have SUP &%attr%& in their schema definitions).
8003
8004 .code
8005 ldap:///o=base?attr1?sub?(uid=fred)
8006 value1.1,value1,,2
8007
8008 ldap:///o=base?attr2?sub?(uid=fred)
8009 value two
8010
8011 ldap:///o=base?attr?sub?(uid=fred)
8012 value1.1,value1,,2,value two
8013
8014 ldap:///o=base?attr1,attr2?sub?(uid=fred)
8015 attr1="value1.1,value1,,2" attr2="value two"
8016
8017 ldap:///o=base??sub?(uid=fred)
8018 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
8019 .endd
8020 You can
8021 make use of Exim's &%-be%& option to run expansion tests and thereby check the
8022 results of LDAP lookups.
8023 The &%extract%& operator in string expansions can be used to pick out
8024 individual fields from data that consists of &'key'&=&'value'& pairs.
8025 The &%listextract%& operator should be used to pick out individual values
8026 of attributes, even when only a single value is expected.
8027 The doubling of embedded commas allows you to use the returned data as a
8028 comma separated list (using the "<," syntax for changing the input list separator).
8029
8030
8031
8032
8033 .section "More about NIS+" "SECTnisplus"
8034 .cindex "NIS+ lookup type"
8035 .cindex "lookup" "NIS+"
8036 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
8037 and field name. If this is given, the result of a successful query is the
8038 contents of the named field; otherwise the result consists of a concatenation
8039 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
8040 values containing spaces are quoted. For example, the query
8041 .code
8042 [name=mg1456],passwd.org_dir
8043 .endd
8044 might return the string
8045 .code
8046 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
8047 home=/home/mg1456 shell=/bin/bash shadow=""
8048 .endd
8049 (split over two lines here to fit on the page), whereas
8050 .code
8051 [name=mg1456],passwd.org_dir:gcos
8052 .endd
8053 would just return
8054 .code
8055 Martin Guerre
8056 .endd
8057 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8058 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8059 operator is to double any quote characters within the text.
8060
8061
8062
8063 .section "SQL lookups" "SECTsql"
8064 .cindex "SQL lookup types"
8065 .cindex "MySQL" "lookup type"
8066 .cindex "PostgreSQL lookup type"
8067 .cindex "lookup" "MySQL"
8068 .cindex "lookup" "PostgreSQL"
8069 .cindex "Oracle" "lookup type"
8070 .cindex "lookup" "Oracle"
8071 .cindex "InterBase lookup type"
8072 .cindex "lookup" "InterBase"
8073 .cindex "Redis lookup type"
8074 .cindex lookup Redis
8075 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8076 and SQLite
8077 databases. Queries for these databases contain SQL statements, so an example
8078 might be
8079 .code
8080 ${lookup mysql{select mailbox from users where id='userx'}\
8081   {$value}fail}
8082 .endd
8083 If the result of the query contains more than one field, the data for each
8084 field in the row is returned, preceded by its name, so the result of
8085 .code
8086 ${lookup pgsql{select home,name from users where id='userx'}\
8087   {$value}}
8088 .endd
8089 might be
8090 .code
8091 home=/home/userx name="Mister X"
8092 .endd
8093 Empty values and values containing spaces are double quoted, with embedded
8094 quotes escaped by a backslash. If the result of the query contains just one
8095 field, the value is passed back verbatim, without a field name, for example:
8096 .code
8097 Mister X
8098 .endd
8099 If the result of the query yields more than one row, it is all concatenated,
8100 with a newline between the data for each row.
8101
8102
8103 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
8104 .cindex "MySQL" "lookup type"
8105 .cindex "PostgreSQL lookup type"
8106 .cindex "lookup" "MySQL"
8107 .cindex "lookup" "PostgreSQL"
8108 .cindex "Oracle" "lookup type"
8109 .cindex "lookup" "Oracle"
8110 .cindex "InterBase lookup type"
8111 .cindex "lookup" "InterBase"
8112 .cindex "Redis lookup type"
8113 .cindex lookup Redis
8114 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8115 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8116 or &%redis_servers%&
8117 option (as appropriate) must be set to a colon-separated list of server
8118 information.
8119 .oindex &%mysql_servers%&
8120 .oindex &%pgsql_servers%&
8121 .oindex &%oracle_servers%&
8122 .oindex &%ibase_servers%&
8123 .oindex &%redis_servers%&
8124 (For MySQL and PostgreSQL, the global option need not be set if all
8125 queries contain their own server information &-- see section
8126 &<<SECTspeserque>>&.)
8127 For all but Redis
8128 each item in the list is a slash-separated list of four
8129 items: host name, database name, user name, and password. In the case of
8130 Oracle, the host name field is used for the &"service name"&, and the database
8131 name field is not used and should be empty. For example:
8132 .code
8133 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8134 .endd
8135 Because password data is sensitive, you should always precede the setting with
8136 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8137 option. Here is an example where two MySQL servers are listed:
8138 .code
8139 hide mysql_servers = localhost/users/root/secret:\
8140                      otherhost/users/root/othersecret
8141 .endd
8142 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8143 because this is a colon-separated list, the colon has to be doubled. For each
8144 query, these parameter groups are tried in order until a connection is made and
8145 a query is successfully processed. The result of a query may be that no data is
8146 found, but that is still a successful query. In other words, the list of
8147 servers provides a backup facility, not a list of different places to look.
8148
8149 For Redis the global option need not be specified if all queries contain their
8150 own server information &-- see section &<<SECTspeserque>>&.
8151 If specified, the option must be set to a colon-separated list of server
8152 information.
8153 Each item in the list is a slash-separated list of three items:
8154 host, database number, and password.
8155 .olist
8156 The host is required and may be either an IPv4 address and optional
8157 port number (separated by a colon, which needs doubling due to the
8158 higher-level list), or a Unix socket pathname enclosed in parentheses
8159 .next
8160 The database number is optional; if present that number is selected in the backend
8161 .next
8162 The password is optional; if present it is used to authenticate to the backend
8163 .endlist
8164
8165 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8166 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8167 respectively, and the characters single-quote, double-quote, and backslash
8168 itself are escaped with backslashes.
8169
8170 The &%quote_redis%& expansion operator
8171 escapes whitespace and backslash characters with a backslash.
8172
8173 .subsection "Specifying the server in the query" SECTspeserque
8174 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8175 it is possible to specify a list of servers with an individual query. This is
8176 done by appending a comma-separated option to the query type:
8177 .display
8178 &`,servers=`&&'server1:server2:server3:...'&
8179 .endd
8180 Each item in the list may take one of two forms:
8181 .olist
8182 If it contains no slashes it is assumed to be just a host name. The appropriate
8183 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8184 of the same name, and the remaining parameters (database, user, password) are
8185 taken from there.
8186 .next
8187 If it contains any slashes, it is taken as a complete parameter set.
8188 .endlist
8189 The list of servers is used in exactly the same way as the global list.
8190 Once a connection to a server has happened and a query has been
8191 successfully executed, processing of the lookup ceases.
8192
8193 This feature is intended for use in master/slave situations where updates
8194 are occurring and you want to update the master rather than a slave. If the
8195 master is in the list as a backup for reading, you might have a global setting
8196 like this:
8197 .code
8198 mysql_servers = slave1/db/name/pw:\
8199                 slave2/db/name/pw:\
8200                 master/db/name/pw
8201 .endd
8202 In an updating lookup, you could then write:
8203 .code
8204 ${lookup mysql,servers=master {UPDATE ...} }
8205 .endd
8206 That query would then be sent only to the master server. If, on the other hand,
8207 the master is not to be used for reading, and so is not present in the global
8208 option, you can still update it by a query of this form:
8209 .code
8210 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8211 .endd
8212
8213 A now-deprecated syntax places the servers specification before the query,
8214 semicolon separated:
8215 .code
8216 ${lookup mysql{servers=master; UPDATE ...} }
8217 .endd
8218 The new version avoids issues with tainted
8219 arguments explicitly expanded as part of the query.
8220 The entire string within the braces becomes tainted,
8221 including the server sepcification - which is not permissible.
8222 If the older sytax is used, a warning message will be logged.
8223 This syntax will be removed in a future release.
8224
8225 &*Note*&: server specifications in list-style lookups are still problematic.
8226
8227
8228 .subsection "Special MySQL features" SECID73
8229 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8230 causes a connection to the server on the local host by means of a Unix domain
8231 socket. An alternate socket can be specified in parentheses.
8232 An option group name for MySQL option files can be specified in square brackets;
8233 the default value is &"exim"&.
8234 The full syntax of each item in &%mysql_servers%& is:
8235 .display
8236 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8237   <&'database'&>/<&'user'&>/<&'password'&>
8238 .endd
8239 Any of the four sub-parts of the first field can be omitted. For normal use on
8240 the local host it can be left blank or set to just &"localhost"&.
8241
8242 No database need be supplied &-- but if it is absent here, it must be given in
8243 the queries.
8244
8245 If a MySQL query is issued that does not request any data (an insert, update,
8246 or delete command), the result of the lookup is the number of rows affected.
8247
8248 &*Warning*&: This can be misleading. If an update does not actually change
8249 anything (for example, setting a field to the value it already has), the result
8250 is zero because no rows are affected.
8251
8252 To get an encryted connection, use a Mysql option file with the required
8253 parameters for the connection.
8254
8255
8256 .subsection "Special PostgreSQL features" SECID74
8257 PostgreSQL lookups can also use Unix domain socket connections to the database.
8258 This is usually faster and costs less CPU time than a TCP/IP connection.
8259 However it can be used only if the mail server runs on the same machine as the
8260 database server. A configuration line for PostgreSQL via Unix domain sockets
8261 looks like this:
8262 .code
8263 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8264 .endd
8265 In other words, instead of supplying a host name, a path to the socket is
8266 given. The path name is enclosed in parentheses so that its slashes aren't
8267 visually confused with the delimiters for the other server parameters.
8268
8269 If a PostgreSQL query is issued that does not request any data (an insert,
8270 update, or delete command), the result of the lookup is the number of rows
8271 affected.
8272
8273 .subsection "More about SQLite" SECTsqlite
8274 .cindex "lookup" "SQLite"
8275 .cindex "sqlite lookup type"
8276 SQLite is different to the other SQL lookups because a filename is required in
8277 addition to the SQL query. An SQLite database is a single file, and there is no
8278 daemon as in the other SQL databases.
8279
8280 .oindex &%sqlite_dbfile%&
8281 There are two ways of
8282 specifying the file.
8283 The first is by using the &%sqlite_dbfile%& main option.
8284 The second, which allows separate files for each query,
8285 is to use an option appended, comma-separated, to the &"sqlite"&
8286 lookup type word.  The option is the word &"file"&, then an equals,
8287 then the filename.
8288 The filename in this case cannot contain whitespace or open-brace charachters.
8289
8290 A deprecated method is available, prefixing the query with the filename
8291 separated by white space.
8292 This means that
8293 .cindex "tainted data" "sqlite file"
8294 the query cannot use any tainted values, as that taints
8295 the entire query including the filename - resulting in a refusal to open
8296 the file.
8297
8298 In all the above cases the filename must be an absolute path.
8299
8300 Here is a lookup expansion example:
8301 .code
8302 sqlite_dbfile = /some/thing/sqlitedb
8303 ...
8304 ${lookup sqlite {select name from aliases where id='userx';}}
8305 .endd
8306 In a list, the syntax is similar. For example:
8307 .code
8308 domainlist relay_to_domains = sqlite;\
8309    select * from relays where ip='$sender_host_address';
8310 .endd
8311 The only character affected by the &%quote_sqlite%& operator is a single
8312 quote, which it doubles.
8313
8314 .cindex timeout SQLite
8315 .cindex sqlite "lookup timeout"
8316 The SQLite library handles multiple simultaneous accesses to the database
8317 internally. Multiple readers are permitted, but only one process can
8318 update at once. Attempts to access the database while it is being updated
8319 are rejected after a timeout period, during which the SQLite library
8320 waits for the lock to be released. In Exim, the default timeout is set
8321 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8322 option.
8323
8324 .subsection "More about Redis" SECTredis
8325 .cindex "lookup" "Redis"
8326 .cindex "redis lookup type"
8327 Redis is a non-SQL database. Commands are simple get and set.
8328 Examples:
8329 .code
8330 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8331 ${lookup redis{get keyname}}
8332 .endd
8333
8334 As of release 4.91, "lightweight" support for Redis Cluster is available.
8335 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8336 of which must be reachable from the running exim instance. If the cluster has
8337 master/slave replication, the list must contain all the master and slave
8338 servers.
8339
8340 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8341 immediately follow the redirection but treats the response as a DEFER, moving on
8342 to the next server in the &%redis_servers%& list until the correct server is
8343 reached.
8344
8345 .ecindex IIDfidalo1
8346 .ecindex IIDfidalo2
8347
8348
8349 . ////////////////////////////////////////////////////////////////////////////
8350 . ////////////////////////////////////////////////////////////////////////////
8351
8352 .chapter "Domain, host, address, and local part lists" &&&
8353          "CHAPdomhosaddlists" &&&
8354          "Domain, host, and address lists"
8355 .scindex IIDdohoadli "lists of domains; hosts; etc."
8356 A number of Exim configuration options contain lists of domains, hosts,
8357 email addresses, or local parts. For example, the &%hold_domains%& option
8358 contains a list of domains whose delivery is currently suspended. These lists
8359 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8360 arguments to expansion conditions such as &%match_domain%&.
8361
8362 Each item in one of these lists is a pattern to be matched against a domain,
8363 host, email address, or local part, respectively. In the sections below, the
8364 different types of pattern for each case are described, but first we cover some
8365 general facilities that apply to all four kinds of list.
8366
8367 Note that other parts of Exim use a &'string list'& which does not
8368 support all the complexity available in
8369 domain, host, address and local part lists.
8370
8371
8372
8373 .section "Results of list checking" SECTlistresults
8374 The primary result of doing a list check is a truth value.
8375 In some contexts additional information is stored
8376 about the list element that matched:
8377 .vlist
8378 .vitem hosts
8379 A &%hosts%& ACL condition
8380 will store a result in the &$host_data$& variable.
8381 .vitem local_parts
8382 A &%local_parts%& router option or &%local_parts%& ACL condition
8383 will store a result in the &$local_part_data$& variable.
8384 .vitem domains
8385 A &%domains%& router option or &%domains%& ACL condition
8386 will store a result in the &$domain_data$& variable.
8387 .vitem senders
8388 A &%senders%& router option or &%senders%& ACL condition
8389 will store a result in the &$sender_data$& variable.
8390 .vitem recipients
8391 A &%recipients%& ACL condition
8392 will store a result in the &$recipient_data$& variable.
8393 .endlist
8394
8395 The detail of the additional information depends on the
8396 type of match and is given below as the &*value*& information.
8397
8398
8399
8400
8401 .section "Expansion of lists" "SECTlistexpand"
8402 .cindex "expansion" "of lists"
8403 Each list is expanded as a single string before it is used.
8404 .cindex "tainted data" tracking
8405 &*Note*&: As a result, if any componend was tainted then the
8406 entire result string becomes tainted.
8407
8408 &'Exception: the router headers_remove option, where list-item
8409 splitting is done before string-expansion.'&
8410
8411 The result of
8412 expansion must be a list, possibly containing empty items, which is split up
8413 into separate items for matching. By default, colon is the separator character,
8414 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8415 &<<SECTempitelis>>& for details of the list syntax; the second of these
8416 discusses the way to specify empty list items.
8417
8418
8419 If the string expansion is forced to fail, Exim behaves as if the item it is
8420 testing (domain, host, address, or local part) is not in the list. Other
8421 expansion failures cause temporary errors.
8422
8423 If an item in a list is a regular expression, backslashes, dollars and possibly
8424 other special characters in the expression must be protected against
8425 misinterpretation by the string expander. The easiest way to do this is to use
8426 the &`\N`& expansion feature to indicate that the contents of the regular
8427 expression should not be expanded. For example, in an ACL you might have:
8428 .code
8429 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8430                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8431 .endd
8432 The first item is a regular expression that is protected from expansion by
8433 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8434 senders based on the receiving domain.
8435
8436
8437
8438
8439 .subsection "Negated items in lists" SECID76
8440 .cindex "list" "negation"
8441 .cindex "negation" "in lists"
8442 Items in a list may be positive or negative. Negative items are indicated by a
8443 leading exclamation mark, which may be followed by optional white space. A list
8444 defines a set of items (domains, etc). When Exim processes one of these lists,
8445 it is trying to find out whether a domain, host, address, or local part
8446 (respectively) is in the set that is defined by the list. It works like this:
8447
8448 The list is scanned from left to right. If a positive item is matched, the
8449 subject that is being checked is in the set; if a negative item is matched, the
8450 subject is not in the set. If the end of the list is reached without the
8451 subject having matched any of the patterns, it is in the set if the last item
8452 was a negative one, but not if it was a positive one. For example, the list in
8453 .code
8454 domainlist relay_to_domains = !a.b.c : *.b.c
8455 .endd
8456 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8457 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8458 list is positive. However, if the setting were
8459 .code
8460 domainlist relay_to_domains = !a.b.c
8461 .endd
8462 then all domains other than &'a.b.c'& would match because the last item in the
8463 list is negative. In other words, a list that ends with a negative item behaves
8464 as if it had an extra item &`:*`& on the end.
8465
8466 Another way of thinking about positive and negative items in lists is to read
8467 the connector as &"or"& after a positive item and as &"and"& after a negative
8468 item.
8469
8470
8471
8472 .subsection "File names in lists" SECTfilnamlis
8473 .cindex "list" "filename in"
8474 If an item in a domain, host, address, or local part list is an absolute
8475 filename (beginning with a slash character), each line of the file is read and
8476 processed as if it were an independent item in the list, except that further
8477 filenames are not allowed,
8478 and no expansion of the data from the file takes place.
8479 Empty lines in the file are ignored, and the file may also contain comment
8480 lines:
8481
8482 .ilist
8483 For domain and host lists, if a # character appears anywhere in a line of the
8484 file, it and all following characters are ignored.
8485 .next
8486 Because local parts may legitimately contain # characters, a comment in an
8487 address list or local part list file is recognized only if # is preceded by
8488 white space or the start of the line. For example:
8489 .code
8490 not#comment@x.y.z   # but this is a comment
8491 .endd
8492 .endlist
8493
8494 Putting a filename in a list has the same effect as inserting each line of the
8495 file as an item in the list (blank lines and comments excepted). However, there
8496 is one important difference: the file is read each time the list is processed,
8497 so if its contents vary over time, Exim's behaviour changes.
8498
8499 If a filename is preceded by an exclamation mark, the sense of any match
8500 within the file is inverted. For example, if
8501 .code
8502 hold_domains = !/etc/nohold-domains
8503 .endd
8504 and the file contains the lines
8505 .code
8506 !a.b.c
8507 *.b.c
8508 .endd
8509 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8510 any domain matching &`*.b.c`& is not.
8511
8512
8513
8514 .subsection "An lsearch file is not an out-of-line list" SECID77
8515 As will be described in the sections that follow, lookups can be used in lists
8516 to provide indexed methods of checking list membership. There has been some
8517 confusion about the way &(lsearch)& lookups work in lists. Because
8518 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8519 sometimes thought that it is allowed to contain wild cards and other kinds of
8520 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8521 always fixed strings, just as for any other single-key lookup type.
8522
8523 If you want to use a file to contain wild-card patterns that form part of a
8524 list, just give the filename on its own, without a search type, as described
8525 in the previous section. You could also use the &(wildlsearch)& or
8526 &(nwildlsearch)&, but there is no advantage in doing this.
8527
8528
8529
8530
8531 .subsection "Named lists" SECTnamedlists
8532 .cindex "named lists"
8533 .cindex "list" "named"
8534 A list of domains, hosts, email addresses, or local parts can be given a name
8535 which is then used to refer to the list elsewhere in the configuration. This is
8536 particularly convenient if the same list is required in several different
8537 places. It also allows lists to be given meaningful names, which can improve
8538 the readability of the configuration. For example, it is conventional to define
8539 a domain list called &'local_domains'& for all the domains that are handled
8540 locally on a host, using a configuration line such as
8541 .code
8542 domainlist local_domains = localhost:my.dom.example
8543 .endd
8544 Named lists are referenced by giving their name preceded by a plus sign, so,
8545 for example, a router that is intended to handle local domains would be
8546 configured with the line
8547 .code
8548 domains = +local_domains
8549 .endd
8550 The first router in a configuration is often one that handles all domains
8551 except the local ones, using a configuration with a negated item like this:
8552 .code
8553 dnslookup:
8554   driver = dnslookup
8555   domains = ! +local_domains
8556   transport = remote_smtp
8557   no_more
8558 .endd
8559 The four kinds of named list are created by configuration lines starting with
8560 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8561 respectively. Then there follows the name that you are defining, followed by an
8562 equals sign and the list itself. For example:
8563 .code
8564 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8565 addresslist bad_senders = cdb;/etc/badsenders
8566 .endd
8567 A named list may refer to other named lists:
8568 .code
8569 domainlist  dom1 = first.example : second.example
8570 domainlist  dom2 = +dom1 : third.example
8571 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8572 .endd
8573 &*Warning*&: If the last item in a referenced list is a negative one, the
8574 effect may not be what you intended, because the negation does not propagate
8575 out to the higher level. For example, consider:
8576 .code
8577 domainlist  dom1 = !a.b
8578 domainlist  dom2 = +dom1 : *.b
8579 .endd
8580 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8581 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8582 means it matches the second list as well. The effect is not the same as
8583 .code
8584 domainlist  dom2 = !a.b : *.b
8585 .endd
8586 where &'x.y'& does not match. It's best to avoid negation altogether in
8587 referenced lists if you can.
8588
8589 .cindex "hiding named list values"
8590 .cindex "named lists" "hiding value of"
8591 Some named list definitions may contain sensitive data, for example, passwords for
8592 accessing databases. To stop non-admin users from using the &%-bP%& command
8593 line option to read these values, you can precede the definition with the
8594 word &"hide"&. For example:
8595 .code
8596 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8597 .endd
8598
8599
8600 Named lists may have a performance advantage. When Exim is routing an
8601 address or checking an incoming message, it caches the result of tests on named
8602 lists. So, if you have a setting such as
8603 .code
8604 domains = +local_domains
8605 .endd
8606 on several of your routers
8607 or in several ACL statements,
8608 the actual test is done only for the first one. However, the caching works only
8609 if there are no expansions within the list itself or any sublists that it
8610 references. In other words, caching happens only for lists that are known to be
8611 the same each time they are referenced.
8612
8613 By default, there may be up to 16 named lists of each type. This limit can be
8614 extended by changing a compile-time variable. The use of domain and host lists
8615 is recommended for concepts such as local domains, relay domains, and relay
8616 hosts. The default configuration is set up like this.
8617
8618
8619
8620 .subsection "Named lists compared with macros" SECID78
8621 .cindex "list" "named compared with macro"
8622 .cindex "macro" "compared with named list"
8623 At first sight, named lists might seem to be no different from macros in the
8624 configuration file. However, macros are just textual substitutions. If you
8625 write
8626 .code
8627 ALIST = host1 : host2
8628 auth_advertise_hosts = !ALIST
8629 .endd
8630 it probably won't do what you want, because that is exactly the same as
8631 .code
8632 auth_advertise_hosts = !host1 : host2
8633 .endd
8634 Notice that the second host name is not negated. However, if you use a host
8635 list, and write
8636 .code
8637 hostlist alist = host1 : host2
8638 auth_advertise_hosts = ! +alist
8639 .endd
8640 the negation applies to the whole list, and so that is equivalent to
8641 .code
8642 auth_advertise_hosts = !host1 : !host2
8643 .endd
8644
8645
8646 .subsection "Named list caching" SECID79
8647 .cindex "list" "caching of named"
8648 .cindex "caching" "named lists"
8649 While processing a message, Exim caches the result of checking a named list if
8650 it is sure that the list is the same each time. In practice, this means that
8651 the cache operates only if the list contains no $ characters, which guarantees
8652 that it will not change when it is expanded. Sometimes, however, you may have
8653 an expanded list that you know will be the same each time within a given
8654 message. For example:
8655 .code
8656 domainlist special_domains = \
8657            ${lookup{$sender_host_address}cdb{/some/file}}
8658 .endd
8659 This provides a list of domains that depends only on the sending host's IP
8660 address. If this domain list is referenced a number of times (for example,
8661 in several ACL lines, or in several routers) the result of the check is not
8662 cached by default, because Exim does not know that it is going to be the
8663 same list each time.
8664
8665 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8666 cache the result anyway. For example:
8667 .code
8668 domainlist_cache special_domains = ${lookup{...
8669 .endd
8670 If you do this, you should be absolutely sure that caching is going to do
8671 the right thing in all cases. When in doubt, leave it out.
8672
8673
8674
8675 .section "Domain lists" "SECTdomainlist"
8676 .cindex "domain list" "patterns for"
8677 .cindex "list" "domain list"
8678 Domain lists contain patterns that are to be matched against a mail domain.
8679 The following types of item may appear in domain lists:
8680
8681 .ilist
8682 .cindex "primary host name"
8683 .cindex "host name" "matched in domain list"
8684 .oindex "&%primary_hostname%&"
8685 .cindex "domain list" "matching primary host name"
8686 .cindex "@ in a domain list"
8687 If a pattern consists of a single @ character, it matches the local host name,
8688 as set by the &%primary_hostname%& option (or defaulted). This makes it
8689 possible to use the same configuration file on several different hosts that
8690 differ only in their names.
8691
8692 The value for a match will be the primary host name.
8693
8694
8695 .next
8696 .cindex "@[] in a domain list"
8697 .cindex "domain list" "matching local IP interfaces"
8698 .cindex "domain literal"
8699 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8700 in square brackets (as in an email address that contains a domain literal), but
8701 only if that IP address is recognized as local for email routing purposes. The
8702 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8703 control which of a host's several IP addresses are treated as local.
8704 In today's Internet, the use of domain literals is controversial;
8705 see the &%allow_domain_literals%& main option.
8706
8707 The value for a match will be the string &`@[]`&.
8708
8709
8710 .next
8711 .cindex "@mx_any"
8712 .cindex "@mx_primary"
8713 .cindex "@mx_secondary"
8714 .cindex "domain list" "matching MX pointers to local host"
8715 If a pattern consists of the string &`@mx_any`& it matches any domain that
8716 has an MX record pointing to the local host or to any host that is listed in
8717 .oindex "&%hosts_treat_as_local%&"
8718 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8719 are similar, except that the first matches only when a primary MX target is the
8720 local host, and the second only when no primary MX target is the local host,
8721 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8722 preference value &-- there may of course be more than one of them.
8723
8724 The MX lookup that takes place when matching a pattern of this type is
8725 performed with the resolver options for widening names turned off. Thus, for
8726 example, a single-component domain will &'not'& be expanded by adding the
8727 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8728 options of the &(dnslookup)& router for a discussion of domain widening.
8729
8730 Sometimes you may want to ignore certain IP addresses when using one of these
8731 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8732 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8733 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8734 on a router). For example:
8735 .code
8736 domains = @mx_any/ignore=127.0.0.1
8737 .endd
8738 This example matches any domain that has an MX record pointing to one of
8739 the local host's IP addresses other than 127.0.0.1.
8740
8741 The list of IP addresses is in fact processed by the same code that processes
8742 host lists, so it may contain CIDR-coded network specifications and it may also
8743 contain negative items.
8744
8745 Because the list of IP addresses is a sublist within a domain list, you have to
8746 be careful about delimiters if there is more than one address. Like any other
8747 list, the default delimiter can be changed. Thus, you might have:
8748 .code
8749 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8750           an.other.domain : ...
8751 .endd
8752 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8753 involved, it is easiest to change the delimiter for the main list as well:
8754 .code
8755 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8756           an.other.domain ? ...
8757 .endd
8758 The value for a match will be the list element string (starting &`@mx_`&).
8759
8760
8761 .next
8762 .cindex "asterisk" "in domain list"
8763 .cindex "domain list" "asterisk in"
8764 .cindex "domain list" "matching &""ends with""&"
8765 If a pattern starts with an asterisk, the remaining characters of the pattern
8766 are compared with the terminating characters of the domain. The use of &"*"& in
8767 domain lists differs from its use in partial matching lookups. In a domain
8768 list, the character following the asterisk need not be a dot, whereas partial
8769 matching works only in terms of dot-separated components. For example, a domain
8770 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8771 &'cipher.key.ex'&.
8772
8773 The value for a match will be the list element string (starting with the asterisk).
8774 Additionally, &$0$& will be set to the matched string
8775 and &$1$& to the variable portion which the asterisk matched.
8776
8777 .next
8778 .cindex "regular expressions" "in domain list"
8779 .cindex "domain list" "matching regular expression"
8780 If a pattern starts with a circumflex character, it is treated as a regular
8781 expression, and matched against the domain using a regular expression matching
8782 function. The circumflex is treated as part of the regular expression.
8783 Email domains are case-independent, so this regular expression match is by
8784 default case-independent, but you can make it case-dependent by starting it
8785 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8786 are given in chapter &<<CHAPregexp>>&.
8787
8788 &*Warning*&: Because domain lists are expanded before being processed, you
8789 must escape any backslash and dollar characters in the regular expression, or
8790 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8791 it is not to be expanded (unless you really do want to build a regular
8792 expression by expansion, of course).
8793
8794 The value for a match will be the list element string (starting with the circumflex).
8795 Additionally, &$0$& will be set to the string matching the regular expression,
8796 and &$1$& (onwards) to any submatches identified by parentheses.
8797
8798
8799
8800 .next
8801 .cindex "lookup" "in domain list"
8802 .cindex "domain list" "matching by lookup"
8803 If a pattern starts with the name of a single-key lookup type followed by a
8804 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8805 must be a filename in a suitable format for the lookup type. For example, for
8806 &"cdb;"& it must be an absolute path:
8807 .code
8808 domains = cdb;/etc/mail/local_domains.cdb
8809 .endd
8810 The appropriate type of lookup is done on the file using the domain name as the
8811 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8812 only in whether or not the key is present in the file. However, when a lookup
8813 is used for the &%domains%& option on a router
8814 or a &%domains%& condition in an ACL statement, the value is preserved in the
8815 &$domain_data$& variable and can be referred to in other router options or
8816 other statements in the same ACL.
8817 .cindex "tainted data" "de-tainting"
8818 .cindex "de-tainting" "using ACL domains condition"
8819 The value will be untainted.
8820
8821 &*Note*&: If the data result of the lookup (as opposed to the key)
8822 is empty, then this empty value is stored in &$domain_data$&.
8823 The option to return the key for the lookup, as the value,
8824 may be what is wanted.
8825
8826
8827 .next
8828 Any of the single-key lookup type names may be preceded by
8829 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8830 .code
8831 domains = partial-dbm;/partial/domains
8832 .endd
8833 This causes partial matching logic to be invoked; a description of how this
8834 works is given in section &<<SECTpartiallookup>>&.
8835
8836 .next
8837 .cindex "asterisk" "in lookup type"
8838 Any of the single-key lookup types may be followed by an asterisk. This causes
8839 a default lookup for a key consisting of a single asterisk to be done if the
8840 original lookup fails. This is not a useful feature when using a domain list to
8841 select particular domains (because any domain would match), but it might have
8842 value if the result of the lookup is being used via the &$domain_data$&
8843 expansion variable.
8844
8845 .next
8846 If the pattern starts with the name of a query-style lookup type followed by a
8847 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8848 pattern must be an appropriate query for the lookup type, as described in
8849 chapter &<<CHAPfdlookup>>&. For example:
8850 .code
8851 hold_domains = mysql;select domain from holdlist \
8852   where domain = '${quote_mysql:$domain}';
8853 .endd
8854 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8855 example, it doesn't matter what field you select). Exim is interested only in
8856 whether or not the query succeeds. However, when a lookup is used for the
8857 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8858 variable and can be referred to in other options.
8859 .cindex "tainted data" "de-tainting"
8860 .cindex "de-tainting" "using router domains option"
8861 The value will be untainted.
8862
8863 .next
8864 If the pattern starts with the name of a lookup type
8865 of either kind (single-key or query-style) it may be
8866 followed by a comma and options,
8867 The options are lookup-type specific and consist of a comma-separated list.
8868 Each item starts with a tag and and equals "=" sign.
8869
8870 .next
8871 .cindex "domain list" "matching literal domain name"
8872 If none of the above cases apply, a caseless textual comparison is made
8873 between the pattern and the domain.
8874
8875 The value for a match will be the list element string.
8876 .cindex "tainted data" "de-tainting"
8877 Note that this is commonly untainted
8878 (depending on the way the list was created).
8879 Specifically, explicit text in the configuration file in not tainted.
8880 This is a useful way of obtaining an untainted equivalent to
8881 the domain, for later operations.
8882
8883 However if the list (including one-element lists)
8884 is created by expanding a variable containing tainted data,
8885 it is tainted and so will the match value be.
8886 .endlist
8887
8888
8889 Here is an example that uses several different kinds of pattern:
8890 .code
8891 domainlist funny_domains = \
8892   @ : \
8893   lib.unseen.edu : \
8894   *.foundation.fict.example : \
8895   \N^[1-2]\d{3}\.fict\.example$\N : \
8896   partial-dbm;/opt/data/penguin/book : \
8897   nis;domains.byname : \
8898   nisplus;[name=$domain,status=local],domains.org_dir
8899 .endd
8900 There are obvious processing trade-offs among the various matching modes. Using
8901 an asterisk is faster than a regular expression, and listing a few names
8902 explicitly probably is too. The use of a file or database lookup is expensive,
8903 but may be the only option if hundreds of names are required. Because the
8904 patterns are tested in order, it makes sense to put the most commonly matched
8905 patterns earlier.
8906
8907
8908
8909 .section "Host lists" "SECThostlist"
8910 .cindex "host list" "patterns in"
8911 .cindex "list" "host list"
8912 Host lists are used to control what remote hosts are allowed to do. For
8913 example, some hosts may be allowed to use the local host as a relay, and some
8914 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8915 two different ways, by name or by IP address. In a host list, some types of
8916 pattern are matched to a host name, and some are matched to an IP address.
8917 You need to be particularly careful with this when single-key lookups are
8918 involved, to ensure that the right value is being used as the key.
8919
8920
8921 .subsection "Special host list patterns" SECID80
8922 .cindex "empty item in hosts list"
8923 .cindex "host list" "empty string in"
8924 If a host list item is the empty string, it matches only when no remote host is
8925 involved. This is the case when a message is being received from a local
8926 process using SMTP on the standard input, that is, when a TCP/IP connection is
8927 not used.
8928
8929 .cindex "asterisk" "in host list"
8930 The special pattern &"*"& in a host list matches any host or no host. Neither
8931 the IP address nor the name is actually inspected.
8932
8933
8934
8935 .subsection "Host list patterns that match by IP address" SECThoslispatip
8936 .cindex "host list" "matching IP addresses"
8937 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8938 the incoming address actually appears in the IPv6 host as
8939 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8940 list, it is converted into a traditional IPv4 address first. (Not all operating
8941 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8942 concerns.)
8943
8944 The following types of pattern in a host list check the remote host by
8945 inspecting its IP address:
8946
8947 .ilist
8948 If the pattern is a plain domain name (not a regular expression, not starting
8949 with *, not a lookup of any kind), Exim calls the operating system function
8950 to find the associated IP address(es). Exim uses the newer
8951 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8952 This typically causes a forward DNS lookup of the name. The result is compared
8953 with the IP address of the subject host.
8954
8955 If there is a temporary problem (such as a DNS timeout) with the host name
8956 lookup, a temporary error occurs. For example, if the list is being used in an
8957 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8958 temporary SMTP error code. If no IP address can be found for the host name,
8959 what happens is described in section &<<SECTbehipnot>>& below.
8960
8961 .next
8962 .cindex "@ in a host list"
8963 If the pattern is &"@"&, the primary host name is substituted and used as a
8964 domain name, as just described.
8965
8966 .next
8967 If the pattern is an IP address, it is matched against the IP address of the
8968 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8969 IPv6 addresses can be given in colon-separated format, but the colons have to
8970 be doubled so as not to be taken as item separators when the default list
8971 separator is used. IPv6 addresses are recognized even when Exim is compiled
8972 without IPv6 support. This means that if they appear in a host list on an
8973 IPv4-only host, Exim will not treat them as host names. They are just addresses
8974 that can never match a client host.
8975
8976 .next
8977 .cindex "@[] in a host list"
8978 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8979 the local host. For example, if the local host is an IPv4 host with one
8980 interface address 10.45.23.56, these two ACL statements have the same effect:
8981 .code
8982 accept hosts = 127.0.0.1 : 10.45.23.56
8983 accept hosts = @[]
8984 .endd
8985 .next
8986 .cindex "CIDR notation"
8987 If the pattern is an IP address followed by a slash and a mask length, for
8988 example
8989 .code
8990 10.11.42.0/24
8991 .endd
8992 , it is matched against the IP address of the subject
8993 host under the given mask. This allows an entire network of hosts to be
8994 included (or excluded) by a single item. The mask uses CIDR notation; it
8995 specifies the number of address bits that must match, starting from the most
8996 significant end of the address.
8997
8998 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8999 of a range of addresses. It is the number of bits in the network portion of the
9000 address. The above example specifies a 24-bit netmask, so it matches all 256
9001 addresses in the 10.11.42.0 network. An item such as
9002 .code
9003 192.168.23.236/31
9004 .endd
9005 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
9006 32 for an IPv4 address is the same as no mask at all; just a single address
9007 matches.
9008
9009 Here is another example which shows an IPv4 and an IPv6 network:
9010 .code
9011 recipient_unqualified_hosts = 192.168.0.0/16: \
9012                               3ffe::ffff::836f::::/48
9013 .endd
9014 The doubling of list separator characters applies only when these items
9015 appear inline in a host list. It is not required when indirecting via a file.
9016 For example:
9017 .code
9018 recipient_unqualified_hosts = /opt/exim/unqualnets
9019 .endd
9020 could make use of a file containing
9021 .code
9022 172.16.0.0/12
9023 3ffe:ffff:836f::/48
9024 .endd
9025 to have exactly the same effect as the previous example. When listing IPv6
9026 addresses inline, it is usually more convenient to use the facility for
9027 changing separator characters. This list contains the same two networks:
9028 .code
9029 recipient_unqualified_hosts = <; 172.16.0.0/12; \
9030                                  3ffe:ffff:836f::/48
9031 .endd
9032 The separator is changed to semicolon by the leading &"<;"& at the start of the
9033 list.
9034 .endlist
9035
9036
9037
9038 .subsection "Host list patterns for single-key lookups by host address" &&&
9039          SECThoslispatsikey
9040 .cindex "host list" "lookup of IP address"
9041 When a host is to be identified by a single-key lookup of its complete IP
9042 address, the pattern takes this form:
9043 .display
9044 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9045 .endd
9046 For example:
9047 .code
9048 hosts_lookup = net-cdb;/hosts-by-ip.db
9049 .endd
9050 The text form of the IP address of the subject host is used as the lookup key.
9051 IPv6 addresses are converted to an unabbreviated form, using lower case
9052 letters, with dots as separators because colon is the key terminator in
9053 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9054 quoting the keys, but this is a facility that was added later.] The data
9055 returned by the lookup is not used.
9056
9057 .cindex "IP address" "masking"
9058 .cindex "host list" "masked IP address"
9059 Single-key lookups can also be performed using masked IP addresses, using
9060 patterns of this form:
9061 .display
9062 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9063 .endd
9064 For example:
9065 .code
9066 net24-dbm;/networks.db
9067 .endd
9068 The IP address of the subject host is masked using <&'number'&> as the mask
9069 length. A textual string is constructed from the masked value, followed by the
9070 mask, and this is used as the lookup key. For example, if the host's IP address
9071 is 192.168.34.6, the key that is looked up for the above example is
9072 &"192.168.34.0/24"&.
9073
9074 When an IPv6 address is converted to a string, dots are normally used instead
9075 of colons, so that keys in &(lsearch)& files need not contain colons (which
9076 terminate &(lsearch)& keys). This was implemented some time before the ability
9077 to quote keys was made available in &(lsearch)& files. However, the more
9078 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9079 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9080 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9081 converted using colons and not dots.
9082 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9083 addresses are always used.
9084 The latter are converted to IPv4 addresses, in dotted-quad form.
9085
9086 Ideally, it would be nice to tidy up this anomalous situation by changing to
9087 colons in all cases, given that quoting is now available for &(lsearch)&.
9088 However, this would be an incompatible change that might break some existing
9089 configurations.
9090
9091 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9092 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9093 the former case the key strings include the mask value, whereas in the latter
9094 case the IP address is used on its own.
9095
9096
9097
9098 .subsection "Host list patterns that match by host name" SECThoslispatnam
9099 .cindex "host" "lookup failures"
9100 .cindex "unknown host name"
9101 .cindex "host list" "matching host name"
9102 There are several types of pattern that require Exim to know the name of the
9103 remote host. These are either wildcard patterns or lookups by name. (If a
9104 complete hostname is given without any wildcarding, it is used to find an IP
9105 address to match against, as described in section &<<SECThoslispatip>>&
9106 above.)
9107
9108 If the remote host name is not already known when Exim encounters one of these
9109 patterns, it has to be found from the IP address.
9110 Although many sites on the Internet are conscientious about maintaining reverse
9111 DNS data for their hosts, there are also many that do not do this.
9112 Consequently, a name cannot always be found, and this may lead to unwanted
9113 effects. Take care when configuring host lists with wildcarded name patterns.
9114 Consider what will happen if a name cannot be found.
9115
9116 Because of the problems of determining host names from IP addresses, matching
9117 against host names is not as common as matching against IP addresses.
9118
9119 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9120 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9121 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9122 are done can be changed by setting the &%host_lookup_order%& option. For
9123 security, once Exim has found one or more names, it looks up the IP addresses
9124 for these names and compares them with the IP address that it started with.
9125 Only those names whose IP addresses match are accepted. Any other names are
9126 discarded. If no names are left, Exim behaves as if the host name cannot be
9127 found. In the most common case there is only one name and one IP address.
9128
9129 There are some options that control what happens if a host name cannot be
9130 found. These are described in section &<<SECTbehipnot>>& below.
9131
9132 .cindex "host" "alias for"
9133 .cindex "alias for host"
9134 As a result of aliasing, hosts may have more than one name. When processing any
9135 of the following types of pattern, all the host's names are checked:
9136
9137 .ilist
9138 .cindex "asterisk" "in host list"
9139 If a pattern starts with &"*"& the remainder of the item must match the end of
9140 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9141 &'.b.c'&. This special simple form is provided because this is a very common
9142 requirement. Other kinds of wildcarding require the use of a regular
9143 expression.
9144 .next
9145 .cindex "regular expressions" "in host list"
9146 .cindex "host list" "regular expression in"
9147 If the item starts with &"^"& it is taken to be a regular expression which is
9148 matched against the host name. Host names are case-independent, so this regular
9149 expression match is by default case-independent, but you can make it
9150 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9151 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9152 example,
9153 .code
9154 ^(a|b)\.c\.d$
9155 .endd
9156 is a regular expression that matches either of the two hosts &'a.c.d'& or
9157 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9158 that backslash and dollar characters are not misinterpreted as part of the
9159 string expansion. The simplest way to do this is to use &`\N`& to mark that
9160 part of the string as non-expandable. For example:
9161 .code
9162 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9163 .endd
9164 &*Warning*&: If you want to match a complete host name, you must include the
9165 &`$`& terminating metacharacter in the regular expression, as in the above
9166 example. Without it, a match at the start of the host name is all that is
9167 required.
9168 .endlist
9169
9170
9171
9172
9173 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9174 .cindex "host" "lookup failures, permanent"
9175 While processing a host list, Exim may need to look up an IP address from a
9176 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9177 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9178 behaviour when it fails to find the information it is seeking is the same.
9179
9180 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9181 apply to temporary DNS errors, whose handling is described in the next section.
9182
9183 .cindex "&`+include_unknown`&"
9184 .cindex "&`+ignore_unknown`&"
9185 Exim parses a host list from left to right. If it encounters a permanent
9186 lookup failure in any item in the host list before it has found a match,
9187 Exim treats it as a failure and the default behavior is as if the host
9188 does not match the list. This may not always be what you want to happen.
9189 To change Exim's behaviour, the special items &`+include_unknown`& or
9190 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9191 not recognized in an indirected file).
9192
9193 .ilist
9194 If any item that follows &`+include_unknown`& requires information that
9195 cannot found, Exim behaves as if the host does match the list. For example,
9196 .code
9197 host_reject_connection = +include_unknown:*.enemy.ex
9198 .endd
9199 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9200 any hosts whose name it cannot find.
9201
9202 .next
9203 If any item that follows &`+ignore_unknown`& requires information that cannot
9204 be found, Exim ignores that item and proceeds to the rest of the list. For
9205 example:
9206 .code
9207 accept hosts = +ignore_unknown : friend.example : \
9208                192.168.4.5
9209 .endd
9210 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9211 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9212 name can be found for 192.168.4.5, it is rejected.
9213 .endlist
9214
9215 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9216 list. The effect of each one lasts until the next, or until the end of the
9217 list.
9218
9219 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9220          SECTmixwilhos
9221 .cindex "host list" "mixing names and addresses in"
9222
9223 This section explains the host/ip processing logic with the same concepts
9224 as the previous section, but specifically addresses what happens when a
9225 wildcarded hostname is one of the items in the hostlist.
9226
9227 .ilist
9228 If you have name lookups or wildcarded host names and
9229 IP addresses in the same host list, you should normally put the IP
9230 addresses first. For example, in an ACL you could have:
9231 .code
9232 accept hosts = 10.9.8.7 : *.friend.example
9233 .endd
9234 The reason you normally would order it this way lies in the
9235 left-to-right way that Exim processes lists.  It can test IP addresses
9236 without doing any DNS lookups, but when it reaches an item that requires
9237 a host name, it fails if it cannot find a host name to compare with the
9238 pattern. If the above list is given in the opposite order, the
9239 &%accept%& statement fails for a host whose name cannot be found, even
9240 if its IP address is 10.9.8.7.
9241
9242 .next
9243 If you really do want to do the name check first, and still recognize the IP
9244 address, you can rewrite the ACL like this:
9245 .code
9246 accept hosts = *.friend.example
9247 accept hosts = 10.9.8.7
9248 .endd
9249 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9250 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9251 &`+ignore_unknown`&, which was discussed in depth in the first example in
9252 this section.
9253 .endlist
9254
9255
9256 .subsection "Temporary DNS errors when looking up host information" &&&
9257          SECTtemdnserr
9258 .cindex "host" "lookup failures, temporary"
9259 .cindex "&`+include_defer`&"
9260 .cindex "&`+ignore_defer`&"
9261 A temporary DNS lookup failure normally causes a defer action (except when
9262 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9263 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9264 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9265 section. These options should be used with care, probably only in non-critical
9266 host lists such as whitelists.
9267
9268
9269
9270 .subsection "Host list patterns for single-key lookups by host name" &&&
9271          SECThoslispatnamsk
9272 .cindex "unknown host name"
9273 .cindex "host list" "matching host name"
9274 If a pattern is of the form
9275 .display
9276 <&'single-key-search-type'&>;<&'search-data'&>
9277 .endd
9278 for example
9279 .code
9280 dbm;/host/accept/list
9281 .endd
9282 a single-key lookup is performed, using the host name as its key. If the
9283 lookup succeeds, the host matches the item. The actual data that is looked up
9284 is not used.
9285
9286 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9287 keys in the file, not IP addresses. If you want to do lookups based on IP
9288 addresses, you must precede the search type with &"net-"&
9289 (see section &<<SECThoslispatsikey>>&).
9290 There is, however, no reason why you could not use
9291 two items in the same list, one doing an address lookup and one doing a name
9292 lookup, both using the same file.
9293
9294
9295
9296 .subsection "Host list patterns for query-style lookups" SECID81
9297 If a pattern is of the form
9298 .display
9299 <&'query-style-search-type'&>;<&'query'&>
9300 .endd
9301 the query is obeyed, and if it succeeds, the host matches the item. The actual
9302 data that is looked up is not used. The variables &$sender_host_address$& and
9303 &$sender_host_name$& can be used in the query. For example:
9304 .code
9305 hosts_lookup = pgsql;\
9306   select ip from hostlist where ip='$sender_host_address'
9307 .endd
9308 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9309 can use the &%sg%& expansion item to change this if you need to. If you want to
9310 use masked IP addresses in database queries, you can use the &%mask%& expansion
9311 operator.
9312
9313 If the query contains a reference to &$sender_host_name$&, Exim automatically
9314 looks up the host name if it has not already done so. (See section
9315 &<<SECThoslispatnam>>& for comments on finding host names.)
9316
9317 Historical note: prior to release 4.30, Exim would always attempt to find a
9318 host name before running the query, unless the search type was preceded by
9319 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9320 still recognized for query-style lookups, but its presence or absence has no
9321 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9322 See section &<<SECThoslispatsikey>>&.)
9323
9324
9325
9326
9327
9328 .section "Address lists" "SECTaddresslist"
9329 .cindex "list" "address list"
9330 .cindex "address list" "empty item"
9331 .cindex "address list" "patterns"
9332 Address lists contain patterns that are matched against mail addresses. There
9333 is one special case to be considered: the sender address of a bounce message is
9334 always empty. You can test for this by providing an empty item in an address
9335 list. For example, you can set up a router to process bounce messages by
9336 using this option setting:
9337 .code
9338 senders = :
9339 .endd
9340 The presence of the colon creates an empty item. If you do not provide any
9341 data, the list is empty and matches nothing. The empty sender can also be
9342 detected by a regular expression that matches an empty string,
9343 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9344
9345 Non-empty items in an address list can be straightforward email addresses. For
9346 example:
9347 .code
9348 senders = jbc@askone.example : hs@anacreon.example
9349 .endd
9350 A certain amount of wildcarding is permitted. If a pattern contains an @
9351 character, but is not a regular expression and does not begin with a
9352 semicolon-terminated lookup type (described below), the local part of the
9353 subject address is compared with the local part of the pattern, which may start
9354 with an asterisk. If the local parts match, the domain is checked in exactly
9355 the same way as for a pattern in a domain list. For example, the domain can be
9356 wildcarded, refer to a named list, or be a lookup:
9357 .code
9358 deny senders = *@*.spamming.site:\
9359                *@+hostile_domains:\
9360                bozo@partial-lsearch;/list/of/dodgy/sites:\
9361                *@dbm;/bad/domains.db
9362 .endd
9363 .cindex "local part" "starting with !"
9364 .cindex "address list" "local part starting with !"
9365 If a local part that begins with an exclamation mark is required, it has to be
9366 specified using a regular expression, because otherwise the exclamation mark is
9367 treated as a sign of negation, as is standard in lists.
9368
9369 If a non-empty pattern that is not a regular expression or a lookup does not
9370 contain an @ character, it is matched against the domain part of the subject
9371 address. The only two formats that are recognized this way are a literal
9372 domain, or a domain pattern that starts with *. In both these cases, the effect
9373 is the same as if &`*@`& preceded the pattern. For example:
9374 .code
9375 deny senders = enemy.domain : *.enemy.domain
9376 .endd
9377
9378 The following kinds of more complicated address list pattern can match any
9379 address, including the empty address that is characteristic of bounce message
9380 senders:
9381
9382 .ilist
9383 .cindex "regular expressions" "in address list"
9384 .cindex "address list" "regular expression in"
9385 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9386 done against the complete address, with the pattern as the regular expression.
9387 You must take care that backslash and dollar characters are not misinterpreted
9388 as part of the string expansion. The simplest way to do this is to use &`\N`&
9389 to mark that part of the string as non-expandable. For example:
9390 .code
9391 deny senders = \N^.*this.*@example\.com$\N : \
9392                \N^\d{8}.+@spamhaus.example$\N : ...
9393 .endd
9394 The &`\N`& sequences are removed by the expansion, so these items do indeed
9395 start with &"^"& by the time they are being interpreted as address patterns.
9396
9397 .next
9398 .cindex "address list" "lookup for complete address"
9399 Complete addresses can be looked up by using a pattern that starts with a
9400 lookup type terminated by a semicolon, followed by the data for the lookup. For
9401 example:
9402 .code
9403 deny senders = cdb;/etc/blocked.senders : \
9404   mysql;select address from blocked where \
9405   address='${quote_mysql:$sender_address}'
9406 .endd
9407 Both query-style and single-key lookup types can be used. For a single-key
9408 lookup type, Exim uses the complete address as the key. However, empty keys are
9409 not supported for single-key lookups, so a match against the empty address
9410 always fails. This restriction does not apply to query-style lookups.
9411
9412 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9413 cannot be used, and is ignored if specified, with an entry being written to the
9414 panic log.
9415 .cindex "*@ with single-key lookup"
9416 However, you can configure lookup defaults, as described in section
9417 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9418 default. For example, with this lookup:
9419 .code
9420 accept senders = lsearch*@;/some/file
9421 .endd
9422 the file could contains lines like this:
9423 .code
9424 user1@domain1.example
9425 *@domain2.example
9426 .endd
9427 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9428 that are tried is:
9429 .code
9430 nimrod@jaeger.example
9431 *@jaeger.example
9432 *
9433 .endd
9434 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9435 would mean that every address matches, thus rendering the test useless.
9436
9437 &*Warning 2*&: Do not confuse these two kinds of item:
9438 .code
9439 deny recipients = dbm*@;/some/file
9440 deny recipients = *@dbm;/some/file
9441 .endd
9442 The first does a whole address lookup, with defaulting, as just described,
9443 because it starts with a lookup type. The second matches the local part and
9444 domain independently, as described in a bullet point below.
9445 .endlist
9446
9447
9448 The following kinds of address list pattern can match only non-empty addresses.
9449 If the subject address is empty, a match against any of these pattern types
9450 always fails.
9451
9452
9453 .ilist
9454 .cindex "@@ with single-key lookup"
9455 .cindex "address list" "@@ lookup type"
9456 .cindex "address list" "split local part and domain"
9457 If a pattern starts with &"@@"& followed by a single-key lookup item
9458 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9459 split into a local part and a domain. The domain is looked up in the file. If
9460 it is not found, there is no match. If it is found, the data that is looked up
9461 from the file is treated as a colon-separated list of local part patterns, each
9462 of which is matched against the subject local part in turn.
9463
9464 .cindex "asterisk" "in address list"
9465 The lookup may be a partial one, and/or one involving a search for a default
9466 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9467 patterns that are looked up can be regular expressions or begin with &"*"&, or
9468 even be further lookups. They may also be independently negated. For example,
9469 with
9470 .code
9471 deny senders = @@dbm;/etc/reject-by-domain
9472 .endd
9473 the data from which the DBM file is built could contain lines like
9474 .code
9475 baddomain.com:  !postmaster : *
9476 .endd
9477 to reject all senders except &%postmaster%& from that domain.
9478
9479 .cindex "local part" "starting with !"
9480 If a local part that actually begins with an exclamation mark is required, it
9481 has to be specified using a regular expression. In &(lsearch)& files, an entry
9482 may be split over several lines by indenting the second and subsequent lines,
9483 but the separating colon must still be included at line breaks. White space
9484 surrounding the colons is ignored. For example:
9485 .code
9486 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9487   spammer3 : spammer4
9488 .endd
9489 As in all colon-separated lists in Exim, a colon can be included in an item by
9490 doubling.
9491
9492 If the last item in the list starts with a right angle-bracket, the remainder
9493 of the item is taken as a new key to look up in order to obtain a continuation
9494 list of local parts. The new key can be any sequence of characters. Thus one
9495 might have entries like
9496 .code
9497 aol.com: spammer1 : spammer 2 : >*
9498 xyz.com: spammer3 : >*
9499 *:       ^\d{8}$
9500 .endd
9501 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9502 local parts for all domains, in addition to the specific local parts listed for
9503 each domain. Of course, using this feature costs another lookup each time a
9504 chain is followed, but the effort needed to maintain the data is reduced.
9505
9506 .cindex "loop" "in lookups"
9507 It is possible to construct loops using this facility, and in order to catch
9508 them, the chains may be no more than fifty items long.
9509
9510 .next
9511 The @@<&'lookup'&> style of item can also be used with a query-style
9512 lookup, but in this case, the chaining facility is not available. The lookup
9513 can only return a single list of local parts.
9514 .endlist
9515
9516 &*Warning*&: There is an important difference between the address list items
9517 in these two examples:
9518 .code
9519 senders = +my_list
9520 senders = *@+my_list
9521 .endd
9522 In the first one, &`my_list`& is a named address list, whereas in the second
9523 example it is a named domain list.
9524
9525
9526
9527
9528 .subsection "Case of letters in address lists" SECTcasletadd
9529 .cindex "case of local parts"
9530 .cindex "address list" "case forcing"
9531 .cindex "case forcing in address lists"
9532 Domains in email addresses are always handled caselessly, but for local parts
9533 case may be significant on some systems (see &%caseful_local_part%& for how
9534 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9535 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9536 blocking lists should be done in a case-independent manner. Since most address
9537 lists in Exim are used for this kind of control, Exim attempts to do this by
9538 default.
9539
9540 The domain portion of an address is always lowercased before matching it to an
9541 address list. The local part is lowercased by default, and any string
9542 comparisons that take place are done caselessly. This means that the data in
9543 the address list itself, in files included as plain filenames, and in any file
9544 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9545 keys in files that are looked up by a search type other than &(lsearch)& (which
9546 works caselessly) must be in lower case, because these lookups are not
9547 case-independent.
9548
9549 .cindex "&`+caseful`&"
9550 To allow for the possibility of caseful address list matching, if an item in
9551 an address list is the string &"+caseful"&, the original case of the local
9552 part is restored for any comparisons that follow, and string comparisons are no
9553 longer case-independent. This does not affect the domain, which remains in
9554 lower case. However, although independent matches on the domain alone are still
9555 performed caselessly, regular expressions that match against an entire address
9556 become case-sensitive after &"+caseful"& has been seen.
9557
9558
9559
9560 .section "Local part lists" "SECTlocparlis"
9561 .cindex "list" "local part list"
9562 .cindex "local part" "list"
9563 These behave in the same way as domain and host lists, with the following
9564 changes:
9565
9566 Case-sensitivity in local part lists is handled in the same way as for address
9567 lists, as just described. The &"+caseful"& item can be used if required. In a
9568 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9569 set false, the subject is lowercased and the matching is initially
9570 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9571 matching in the local part list, but not elsewhere in the router. If
9572 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9573 option is case-sensitive from the start.
9574
9575 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9576 comments are handled in the same way as address lists &-- they are recognized
9577 only if the # is preceded by white space or the start of the line.
9578 Otherwise, local part lists are matched in the same way as domain lists, except
9579 that the special items that refer to the local host (&`@`&, &`@[]`&,
9580 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9581 Refer to section &<<SECTdomainlist>>& for details of the other available item
9582 types.
9583 .ecindex IIDdohoadli
9584
9585
9586
9587
9588 . ////////////////////////////////////////////////////////////////////////////
9589 . ////////////////////////////////////////////////////////////////////////////
9590
9591 .chapter "String expansions" "CHAPexpand"
9592 .scindex IIDstrexp "expansion" "of strings"
9593 Many strings in Exim's runtime configuration are expanded before use. Some of
9594 them are expanded every time they are used; others are expanded only once.
9595
9596 When a string is being expanded it is copied verbatim from left to right except
9597 .cindex expansion "string concatenation"
9598 when a dollar or backslash character is encountered. A dollar specifies the
9599 start of a portion of the string that is interpreted and replaced as described
9600 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9601 escape character, as described in the following section.
9602
9603 .cindex "tainted data" tracking
9604 If any porttion of the result string is tainted, the entire result is.
9605
9606 Whether a string is expanded depends upon the context.  Usually this is solely
9607 dependent upon the option for which a value is sought; in this documentation,
9608 options for which string expansion is performed are marked with &dagger; after
9609 the data type.  ACL rules always expand strings.  A couple of expansion
9610 conditions do not expand some of the brace-delimited branches, for security
9611 reasons,
9612 .cindex "tainted data" expansion
9613 .cindex "tainted data" definition
9614 .cindex expansion "tainted data"
9615 and expansion of data deriving from the sender (&"tainted data"&)
9616 is not permitted (including acessing a file using a tainted name).
9617
9618 Common ways of obtaining untainted equivalents of variables with
9619 tainted values
9620 .cindex "tainted data" "de-tainting"
9621 come down to using the tainted value as a lookup key in a trusted database.
9622 This database could be the filesystem structure,
9623 or the password file,
9624 or accessed via a DBMS.
9625 Specific methods are indexed under &"de-tainting"&.
9626
9627
9628
9629 .section "Literal text in expanded strings" "SECTlittext"
9630 .cindex "expansion" "including literal text"
9631 An uninterpreted dollar can be included in an expanded string by putting a
9632 backslash in front of it. A backslash can be used to prevent any special
9633 character being treated specially in an expansion, including backslash itself.
9634 If the string appears in quotes in the configuration file, two backslashes are
9635 required because the quotes themselves cause interpretation of backslashes when
9636 the string is read in (see section &<<SECTstrings>>&).
9637
9638 .cindex "expansion" "non-expandable substrings"
9639 A portion of the string can specified as non-expandable by placing it between
9640 two occurrences of &`\N`&. This is particularly useful for protecting regular
9641 expressions, which often contain backslashes and dollar signs. For example:
9642 .code
9643 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9644 .endd
9645 On encountering the first &`\N`&, the expander copies subsequent characters
9646 without interpretation until it reaches the next &`\N`& or the end of the
9647 string.
9648
9649
9650
9651 .section "Character escape sequences in expanded strings" "SECID82"
9652 .cindex "expansion" "escape sequences"
9653 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9654 expanded string is recognized as an escape sequence for the character newline,
9655 carriage return, or tab, respectively. A backslash followed by up to three
9656 octal digits is recognized as an octal encoding for a single character, and a
9657 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9658 encoding.
9659
9660 These escape sequences are also recognized in quoted strings when they are read
9661 in. Their interpretation in expansions as well is useful for unquoted strings,
9662 and for other cases such as looked-up strings that are then expanded.
9663
9664
9665 .section "Testing string expansions" "SECID83"
9666 .cindex "expansion" "testing"
9667 .cindex "testing" "string expansion"
9668 .oindex "&%-be%&"
9669 Many expansions can be tested by calling Exim with the &%-be%& option. This
9670 takes the command arguments, or lines from the standard input if there are no
9671 arguments, runs them through the string expansion code, and writes the results
9672 to the standard output. Variables based on configuration values are set up, but
9673 since no message is being processed, variables such as &$local_part$& have no
9674 value. Nevertheless the &%-be%& option can be useful for checking out file and
9675 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9676 and &%nhash%&.
9677
9678 When reading lines from the standard input,
9679 macros can be defined and ACL variables can be set.
9680 For example:
9681 .code
9682 MY_MACRO = foo
9683 set acl_m_myvar = bar
9684 .endd
9685 Such macros and variables can then be used in later input lines.
9686
9687 Exim gives up its root privilege when it is called with the &%-be%& option, and
9688 instead runs under the uid and gid it was called with, to prevent users from
9689 using &%-be%& for reading files to which they do not have access.
9690
9691 .oindex "&%-bem%&"
9692 If you want to test expansions that include variables whose values are taken
9693 from a message, there are two other options that can be used. The &%-bem%&
9694 option is like &%-be%& except that it is followed by a filename. The file is
9695 read as a message before doing the test expansions. For example:
9696 .code
9697 exim -bem /tmp/test.message '$h_subject:'
9698 .endd
9699 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9700 Exim message identifier. For example:
9701 .code
9702 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9703 .endd
9704 This loads the message from Exim's spool before doing the test expansions, and
9705 is therefore restricted to admin users.
9706
9707
9708 .section "Forced expansion failure" "SECTforexpfai"
9709 .cindex "expansion" "forced failure"
9710 A number of expansions that are described in the following section have
9711 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9712 (which are sometimes called &"curly brackets"&). Which of the two strings is
9713 used depends on some condition that is evaluated as part of the expansion. If,
9714 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9715 the entire string expansion fails in a way that can be detected by the code
9716 that requested the expansion. This is called &"forced expansion failure"&, and
9717 its consequences depend on the circumstances. In some cases it is no different
9718 from any other expansion failure, but in others a different action may be
9719 taken. Such variations are mentioned in the documentation of the option that is
9720 being expanded.
9721
9722
9723
9724
9725 .section "Expansion items" "SECTexpansionitems"
9726 The following items are recognized in expanded strings. White space may be used
9727 between sub-items that are keywords or substrings enclosed in braces inside an
9728 outer set of braces, to improve readability. &*Warning*&: Within braces,
9729 white space is significant.
9730
9731 .vlist
9732 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9733 .cindex "expansion" "variables"
9734 Substitute the contents of the named variable, for example:
9735 .code
9736 $local_part
9737 ${domain}
9738 .endd
9739 The second form can be used to separate the name from subsequent alphanumeric
9740 characters. This form (using braces) is available only for variables; it does
9741 &'not'& apply to message headers. The names of the variables are given in
9742 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9743 given, the expansion fails.
9744
9745 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9746 .cindex "expansion" "operators"
9747 The string is first itself expanded, and then the operation specified by
9748 <&'op'&> is applied to it. For example:
9749 .code
9750 ${lc:$local_part}
9751 .endd
9752 The string starts with the first character after the colon, which may be
9753 leading white space. A list of operators is given in section &<<SECTexpop>>&
9754 below. The operator notation is used for simple expansion items that have just
9755 one argument, because it reduces the number of braces and therefore makes the
9756 string easier to understand.
9757
9758 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9759 This item inserts &"basic"& header lines. It is described with the &%header%&
9760 expansion item below.
9761
9762
9763 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9764 .cindex "expansion" "calling an acl"
9765 .cindex "&%acl%&" "call from expansion"
9766 The name and zero to nine argument strings are first expanded separately.  The expanded
9767 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9768 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9769 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9770 and may use the variables; if another acl expansion is used the values
9771 are restored after it returns.  If the ACL sets
9772 a value using a "message =" modifier and returns accept or deny, the value becomes
9773 the result of the expansion.
9774 If no message is set and the ACL returns accept or deny
9775 the expansion result is an empty string.
9776 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9777
9778
9779 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9780 .cindex authentication "results header"
9781 .chindex Authentication-Results:
9782 .cindex authentication "expansion item"
9783 This item returns a string suitable for insertion as an
9784 &'Authentication-Results:'&
9785 header line.
9786 The given <&'authserv-id'&> is included in the result; typically this
9787 will be a domain name identifying the system performing the authentications.
9788 Methods that might be present in the result include:
9789 .code
9790 none
9791 iprev
9792 auth
9793 spf
9794 dkim
9795 .endd
9796
9797 Example use (as an ACL modifier):
9798 .code
9799       add_header = :at_start:${authresults {$primary_hostname}}
9800 .endd
9801 This is safe even if no authentication results are available
9802 and would generally be placed in the DATA ACL.
9803
9804
9805 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9806        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9807 .cindex "expansion" "extracting certificate fields"
9808 .cindex "&%certextract%&" "certificate fields"
9809 .cindex "certificate" "extracting fields"
9810 The <&'certificate'&> must be a variable of type certificate.
9811 The field name is expanded and used to retrieve the relevant field from
9812 the certificate.  Supported fields are:
9813 .display
9814 &`version        `&
9815 &`serial_number  `&
9816 &`subject        `& RFC4514 DN
9817 &`issuer         `& RFC4514 DN
9818 &`notbefore      `& time
9819 &`notafter       `& time
9820 &`sig_algorithm  `&
9821 &`signature      `&
9822 &`subj_altname   `& tagged list
9823 &`ocsp_uri       `& list
9824 &`crl_uri        `& list
9825 .endd
9826 If the field is found,
9827 <&'string2'&> is expanded, and replaces the whole item;
9828 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9829 variable &$value$& contains the value that has been extracted. Afterwards, it
9830 is restored to any previous value it might have had.
9831
9832 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9833 key is not found. If {<&'string2'&>} is also omitted, the value that was
9834 extracted is used.
9835
9836 Some field names take optional modifiers, appended and separated by commas.
9837
9838 The field selectors marked as "RFC4514" above
9839 output a Distinguished Name string which is
9840 not quite
9841 parseable by Exim as a comma-separated tagged list
9842 (the exceptions being elements containing commas).
9843 RDN elements of a single type may be selected by
9844 a modifier of the type label; if so the expansion
9845 result is a list (newline-separated by default).
9846 The separator may be changed by another modifier of
9847 a right angle-bracket followed immediately by the new separator.
9848 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9849
9850 The field selectors marked as "time" above
9851 take an optional modifier of "int"
9852 for which the result is the number of seconds since epoch.
9853 Otherwise the result is a human-readable string
9854 in the timezone selected by the main "timezone" option.
9855
9856 The field selectors marked as "list" above return a list,
9857 newline-separated by default,
9858 (embedded separator characters in elements are doubled).
9859 The separator may be changed by a modifier of
9860 a right angle-bracket followed immediately by the new separator.
9861
9862 The field selectors marked as "tagged" above
9863 prefix each list element with a type string and an equals sign.
9864 Elements of only one type may be selected by a modifier
9865 which is one of "dns", "uri" or "mail";
9866 if so the element tags are omitted.
9867
9868 If not otherwise noted field values are presented in human-readable form.
9869
9870 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9871        {*&<&'arg'&>&*}...}*&"
9872 .cindex &%dlfunc%&
9873 This expansion dynamically loads and then calls a locally-written C function.
9874 This functionality is available only if Exim is compiled with
9875 .code
9876 EXPAND_DLFUNC=yes
9877 .endd
9878 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9879 object so that it doesn't reload the same object file in the same Exim process
9880 (but of course Exim does start new processes frequently).
9881
9882 There may be from zero to eight arguments to the function.
9883
9884 When compiling
9885 a local function that is to be called in this way,
9886 first &_DLFUNC_IMPL_& should be defined,
9887 and second &_local_scan.h_& should be included.
9888 The Exim variables and functions that are defined by that API
9889 are also available for dynamically loaded functions. The function itself
9890 must have the following type:
9891 .code
9892 int dlfunction(uschar **yield, int argc, uschar *argv[])
9893 .endd
9894 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9895 function should return one of the following values:
9896
9897 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9898 into the expanded string that is being built.
9899
9900 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9901 from &'yield'&, if it is set.
9902
9903 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9904 taken from &'yield'& if it is set.
9905
9906 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9907
9908 When compiling a function that is to be used in this way with gcc,
9909 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9910 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9911
9912
9913 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9914 .cindex "expansion" "extracting value from environment"
9915 .cindex "environment" "values from"
9916 The key is first expanded separately, and leading and trailing white space
9917 removed.
9918 This is then searched for as a name in the environment.
9919 If a variable is found then its value is placed in &$value$&
9920 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9921
9922 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9923 appear, for example:
9924 .code
9925 ${env{USER}{$value} fail }
9926 .endd
9927 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9928 {<&'string1'&>} must be present for &"fail"& to be recognized.
9929
9930 If {<&'string2'&>} is omitted an empty string is substituted on
9931 search failure.
9932 If {<&'string1'&>} is omitted the search result is substituted on
9933 search success.
9934
9935 The environment is adjusted by the &%keep_environment%& and
9936 &%add_environment%& main section options.
9937
9938
9939 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9940        {*&<&'string3'&>&*}}*&"
9941 .cindex "expansion" "extracting substrings by key"
9942 .cindex "&%extract%&" "substrings by key"
9943 The key and <&'string1'&> are first expanded separately. Leading and trailing
9944 white space is removed from the key (but not from any of the strings). The key
9945 must not be empty and must not consist entirely of digits.
9946 The expanded <&'string1'&> must be of the form:
9947 .display
9948 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9949 .endd
9950 .vindex "&$value$&"
9951 where the equals signs and spaces (but not both) are optional. If any of the
9952 values contain white space, they must be enclosed in double quotes, and any
9953 values that are enclosed in double quotes are subject to escape processing as
9954 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9955 for the value that corresponds to the key. The search is case-insensitive. If
9956 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9957 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9958 variable &$value$& contains the value that has been extracted. Afterwards, it
9959 is restored to any previous value it might have had.
9960
9961 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9962 key is not found. If {<&'string2'&>} is also omitted, the value that was
9963 extracted is used. Thus, for example, these two expansions are identical, and
9964 yield &"2001"&:
9965 .code
9966 ${extract{gid}{uid=1984 gid=2001}}
9967 ${extract{gid}{uid=1984 gid=2001}{$value}}
9968 .endd
9969 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9970 appear, for example:
9971 .code
9972 ${extract{Z}{A=... B=...}{$value} fail }
9973 .endd
9974 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9975 {<&'string2'&>} must be present for &"fail"& to be recognized.
9976
9977 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9978        {*&<&'string3'&>&*}}*&" &&&
9979        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9980        {*&<&'string3'&>&*}}*&"
9981 .cindex "expansion" "extracting from JSON object"
9982 .cindex JSON expansions
9983 The key and <&'string1'&> are first expanded separately. Leading and trailing
9984 white space is removed from the key (but not from any of the strings). The key
9985 must not be empty and must not consist entirely of digits.
9986 The expanded <&'string1'&> must be of the form:
9987 .display
9988 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9989 .endd
9990 .vindex "&$value$&"
9991 The braces, commas and colons, and the quoting of the member name are required;
9992 the spaces are optional.
9993 Matching of the key against the member names is done case-sensitively.
9994 For the &"json"& variant,
9995 if a returned value is a JSON string, it retains its leading and
9996 trailing quotes.
9997 For the &"jsons"& variant, which is intended for use with JSON strings, the
9998 leading and trailing quotes are removed from the returned value.
9999 . XXX should be a UTF-8 compare
10000
10001 The results of matching are handled as above.
10002
10003
10004 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
10005         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10006 .cindex "expansion" "extracting substrings by number"
10007 .cindex "&%extract%&" "substrings by number"
10008 The <&'number'&> argument must consist entirely of decimal digits,
10009 apart from leading and trailing white space, which is ignored.
10010 This is what distinguishes this form of &%extract%& from the previous kind. It
10011 behaves in the same way, except that, instead of extracting a named field, it
10012 extracts from <&'string1'&> the field whose number is given as the first
10013 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
10014 <&'string3'&> as before.
10015
10016 The fields in the string are separated by any one of the characters in the
10017 separator string. These may include space or tab characters.
10018 The first field is numbered one. If the number is negative, the fields are
10019 counted from the end of the string, with the rightmost one numbered -1. If the
10020 number given is zero, the entire string is returned. If the modulus of the
10021 number is greater than the number of fields in the string, the result is the
10022 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
10023 provided. For example:
10024 .code
10025 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
10026 .endd
10027 yields &"42"&, and
10028 .code
10029 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
10030 .endd
10031 yields &"99"&. Two successive separators mean that the field between them is
10032 empty (for example, the fifth field above).
10033
10034
10035 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
10036         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
10037        "&*${extract jsons{*&<&'number'&>&*}}&&&
10038         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10039 .cindex "expansion" "extracting from JSON array"
10040 .cindex JSON expansions
10041 The <&'number'&> argument must consist entirely of decimal digits,
10042 apart from leading and trailing white space, which is ignored.
10043
10044 Field selection and result handling is as above;
10045 there is no choice of field separator.
10046 For the &"json"& variant,
10047 if a returned value is a JSON string, it retains its leading and
10048 trailing quotes.
10049 For the &"jsons"& variant, which is intended for use with JSON strings, the
10050 leading and trailing quotes are removed from the returned value.
10051
10052
10053 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
10054 .cindex "list" "selecting by condition"
10055 .cindex "expansion" "selecting from list by condition"
10056 .vindex "&$item$&"
10057 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10058 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10059 For each item
10060 in this list, its value is placed in &$item$&, and then the condition is
10061 evaluated.
10062 Any modification of &$value$& by this evaluation is discarded.
10063 If the condition is true, &$item$& is added to the output as an
10064 item in a new list; if the condition is false, the item is discarded. The
10065 separator used for the output list is the same as the one used for the
10066 input, but a separator setting is not included in the output. For example:
10067 .code
10068 ${filter{a:b:c}{!eq{$item}{b}}}
10069 .endd
10070 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10071 to what it was before.
10072 See also the &%map%& and &%reduce%& expansion items.
10073
10074
10075 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10076 .cindex "hash function" "textual"
10077 .cindex "expansion" "textual hash"
10078 This is a textual hashing function, and was the first to be implemented in
10079 early versions of Exim. In current releases, there are other hashing functions
10080 (numeric, MD5, and SHA-1), which are described below.
10081
10082 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10083 <&'n'&>. If you are using fixed values for these numbers, that is, if
10084 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10085 use the simpler operator notation that avoids some of the braces:
10086 .code
10087 ${hash_<n>_<m>:<string>}
10088 .endd
10089 The second number is optional (in both notations). If <&'n'&> is greater than
10090 or equal to the length of the string, the expansion item returns the string.
10091 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10092 function to the string. The new string consists of characters taken from the
10093 first <&'m'&> characters of the string
10094 .code
10095 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10096 .endd
10097 If <&'m'&> is not present the value 26 is used, so that only lower case
10098 letters appear. For example:
10099 .display
10100 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10101 &`$hash{5}{monty}}           `&   yields  &`monty`&
10102 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10103 .endd
10104
10105 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10106         &*$h_*&<&'header&~name'&>&*:*&" &&&
10107        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10108         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10109        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10110         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10111        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10112         &*$rh_*&<&'header&~name'&>&*:*&"
10113 .cindex "expansion" "header insertion"
10114 .vindex "&$header_$&"
10115 .vindex "&$bheader_$&"
10116 .vindex "&$lheader_$&"
10117 .vindex "&$rheader_$&"
10118 .cindex "header lines" "in expansion strings"
10119 .cindex "header lines" "character sets"
10120 .cindex "header lines" "decoding"
10121 Substitute the contents of the named message header line, for example
10122 .code
10123 $header_reply-to:
10124 .endd
10125 The newline that terminates a header line is not included in the expansion, but
10126 internal newlines (caused by splitting the header line over several physical
10127 lines) may be present.
10128
10129 The difference between the four pairs of expansions is in the way
10130 the data in the header line is interpreted.
10131
10132 .ilist
10133 .cindex "white space" "in header lines"
10134 &%rheader%& gives the original &"raw"& content of the header line, with no
10135 processing at all, and without the removal of leading and trailing white space.
10136
10137 .next
10138 .cindex "list" "of header lines"
10139 &%lheader%& gives a colon-separated list, one element per header when there
10140 are multiple headers with a given name.
10141 Any embedded colon characters within an element are doubled, so normal Exim
10142 list-processing facilities can be used.
10143 The terminating newline of each element is removed; in other respects
10144 the content is &"raw"&.
10145
10146 .next
10147 .cindex "base64 encoding" "in header lines"
10148 &%bheader%& removes leading and trailing white space, and then decodes base64
10149 or quoted-printable MIME &"words"& within the header text, but does no
10150 character set translation. If decoding of what looks superficially like a MIME
10151 &"word"& fails, the raw string is returned. If decoding
10152 .cindex "binary zero" "in header line"
10153 produces a binary zero character, it is replaced by a question mark &-- this is
10154 what Exim does for binary zeros that are actually received in header lines.
10155
10156 .next
10157 &%header%& tries to translate the string as decoded by &%bheader%& to a
10158 standard character set. This is an attempt to produce the same string as would
10159 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10160 returned. Translation is attempted only on operating systems that support the
10161 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10162 a system Makefile or in &_Local/Makefile_&.
10163 .endlist ilist
10164
10165 In a filter file, the target character set for &%header%& can be specified by a
10166 command of the following form:
10167 .code
10168 headers charset "UTF-8"
10169 .endd
10170 This command affects all references to &$h_$& (or &$header_$&) expansions in
10171 subsequently obeyed filter commands. In the absence of this command, the target
10172 character set in a filter is taken from the setting of the &%headers_charset%&
10173 option in the runtime configuration. The value of this option defaults to the
10174 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10175 ISO-8859-1.
10176
10177 Header names follow the syntax of RFC 2822, which states that they may contain
10178 any printing characters except space and colon. Consequently, curly brackets
10179 &'do not'& terminate header names, and should not be used to enclose them as
10180 if they were variables. Attempting to do so causes a syntax error.
10181
10182 Only header lines that are common to all copies of a message are visible to
10183 this mechanism. These are the original header lines that are received with the
10184 message, and any that are added by an ACL statement or by a system
10185 filter. Header lines that are added to a particular copy of a message by a
10186 router or transport are not accessible.
10187
10188 For incoming SMTP messages, no header lines are visible in
10189 ACLs that are obeyed before the data phase completes,
10190 because the header structure is not set up until the message is received.
10191 They are visible in DKIM, PRDR and DATA ACLs.
10192 Header lines that are added in a RCPT ACL (for example)
10193 are saved until the message's incoming header lines are available, at which
10194 point they are added.
10195 When any of the above ACLs are
10196 running, however, header lines added by earlier ACLs are visible.
10197
10198 Upper case and lower case letters are synonymous in header names. If the
10199 following character is white space, the terminating colon may be omitted, but
10200 this is not recommended, because you may then forget it when it is needed. When
10201 white space terminates the header name, this white space is included in the
10202 expanded string.  If the message does not contain the given header, the
10203 expansion item is replaced by an empty string. (See the &%def%& condition in
10204 section &<<SECTexpcond>>& for a means of testing for the existence of a
10205 header.)
10206
10207 If there is more than one header with the same name, they are all concatenated
10208 to form the substitution string, up to a maximum length of 64K. Unless
10209 &%rheader%& is being used, leading and trailing white space is removed from
10210 each header before concatenation, and a completely empty header is ignored. A
10211 newline character is then inserted between non-empty headers, but there is no
10212 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10213 those headers that contain lists of addresses, a comma is also inserted at the
10214 junctions between headers. This does not happen for the &%rheader%& expansion.
10215
10216 .cindex "tainted data" "message headers"
10217 When the headers are from an incoming message,
10218 the result of expanding any of these variables is tainted.
10219
10220
10221 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10222 .cindex "expansion" "hmac hashing"
10223 .cindex &%hmac%&
10224 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10225 shared secret and some text into a message authentication code, as specified in
10226 RFC 2104. This differs from &`${md5:secret_text...}`& or
10227 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10228 cryptographic hash, allowing for authentication that is not possible with MD5
10229 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10230 present. For example:
10231 .code
10232 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10233 .endd
10234 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10235 produces:
10236 .code
10237 dd97e3ba5d1a61b5006108f8c8252953
10238 .endd
10239 As an example of how this might be used, you might put in the main part of
10240 an Exim configuration:
10241 .code
10242 SPAMSCAN_SECRET=cohgheeLei2thahw
10243 .endd
10244 In a router or a transport you could then have:
10245 .code
10246 headers_add = \
10247   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10248   ${hmac{md5}{SPAMSCAN_SECRET}\
10249   {${primary_hostname},${message_exim_id},$h_message-id:}}
10250 .endd
10251 Then given a message, you can check where it was scanned by looking at the
10252 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10253 this header line is authentic by recomputing the authentication code from the
10254 host name, message ID and the &'Message-id:'& header line. This can be done
10255 using Exim's &%-be%& option, or by other means, for example, by using the
10256 &'hmac_md5_hex()'& function in Perl.
10257
10258
10259 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10260 .cindex "expansion" "conditional"
10261 .cindex "&%if%&, expansion item"
10262 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10263 item; otherwise <&'string2'&> is used. The available conditions are described
10264 in section &<<SECTexpcond>>& below. For example:
10265 .code
10266 ${if eq {$local_part}{postmaster} {yes}{no} }
10267 .endd
10268 The second string need not be present; if it is not and the condition is not
10269 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10270 be present instead of the second string (without any curly brackets). In this
10271 case, the expansion is forced to fail if the condition is not true (see section
10272 &<<SECTforexpfai>>&).
10273
10274 If both strings are omitted, the result is the string &`true`& if the condition
10275 is true, and the empty string if the condition is false. This makes it less
10276 cumbersome to write custom ACL and router conditions. For example, instead of
10277 .code
10278 condition = ${if >{$acl_m4}{3}{true}{false}}
10279 .endd
10280 you can use
10281 .code
10282 condition = ${if >{$acl_m4}{3}}
10283 .endd
10284
10285
10286
10287 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10288 .cindex expansion "imap folder"
10289 .cindex "&%imapfolder%& expansion item"
10290 This item converts a (possibly multilevel, or with non-ASCII characters)
10291 folder specification to a Maildir name for filesystem use.
10292 For information on internationalisation support see &<<SECTi18nMDA>>&.
10293
10294
10295
10296 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10297 .cindex "expansion" "string truncation"
10298 .cindex "&%length%& expansion item"
10299 The &%length%& item is used to extract the initial portion of a string. Both
10300 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10301 you are using a fixed value for the number, that is, if <&'string1'&> does not
10302 change when expanded, you can use the simpler operator notation that avoids
10303 some of the braces:
10304 .code
10305 ${length_<n>:<string>}
10306 .endd
10307 The result of this item is either the first <&'n'&> bytes or the whole
10308 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10309 &%strlen%&, which gives the length of a string.
10310 All measurement is done in bytes and is not UTF-8 aware.
10311
10312
10313 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10314         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10315 .cindex "expansion" "extracting list elements by number"
10316 .cindex "&%listextract%&" "extract list elements by number"
10317 .cindex "list" "extracting elements by number"
10318 The <&'number'&> argument must consist entirely of decimal digits,
10319 apart from an optional leading minus,
10320 and leading and trailing white space (which is ignored).
10321
10322 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10323 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10324
10325 The first field of the list is numbered one.
10326 If the number is negative, the fields are
10327 counted from the end of the list, with the rightmost one numbered -1.
10328 The numbered element of the list is extracted and placed in &$value$&,
10329 then <&'string2'&> is expanded as the result.
10330
10331 If the modulus of the
10332 number is zero or greater than the number of fields in the string,
10333 the result is the expansion of <&'string3'&>.
10334
10335 For example:
10336 .code
10337 ${listextract{2}{x:42:99}}
10338 .endd
10339 yields &"42"&, and
10340 .code
10341 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10342 .endd
10343 yields &"result: 42"&.
10344
10345 If {<&'string3'&>} is omitted, an empty string is used for string3.
10346 If {<&'string2'&>} is also omitted, the value that was
10347 extracted is used.
10348 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10349
10350
10351 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10352 .cindex quoting "for list"
10353 .cindex list quoting
10354 This item doubles any occurrence of the separator character
10355 in the given string.
10356 An empty string is replaced with a single space.
10357 This converts the string into a safe form for use as a list element,
10358 in a list using the given separator.
10359
10360
10361 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10362         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10363        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10364         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10365 .cindex "expansion" "lookup in"
10366 .cindex "file" "lookups"
10367 .cindex "lookup" "in expanded string"
10368 The two forms of lookup item specify data lookups in files and databases, as
10369 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10370 lookups, and the second is used for query-style lookups. The <&'key'&>,
10371 <&'file'&>, and <&'query'&> strings are expanded before use.
10372
10373 If there is any white space in a lookup item which is part of a filter command,
10374 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10375 other place where white space is significant, the lookup item must be enclosed
10376 in double quotes. The use of data lookups in users' filter files may be locked
10377 out by the system administrator.
10378
10379 .vindex "&$value$&"
10380 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10381 During its expansion, the variable &$value$& contains the data returned by the
10382 lookup. Afterwards it reverts to the value it had previously (at the outer
10383 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10384 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10385 string on failure. If <&'string2'&> is provided, it can itself be a nested
10386 lookup, thus providing a mechanism for looking up a default value when the
10387 original lookup fails.
10388
10389 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10390 data for the outer lookup while the parameters of the second lookup are
10391 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10392 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10393 appear, and in this case, if the lookup fails, the entire expansion is forced
10394 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10395 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10396 successful lookup, and nothing in the case of failure.
10397
10398 For single-key lookups, the string &"partial"& is permitted to precede the
10399 search type in order to do partial matching, and * or *@ may follow a search
10400 type to request default lookups if the key does not match (see sections
10401 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10402
10403 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10404 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10405 and non-wild parts of the key during the expansion of the replacement text.
10406 They return to their previous values at the end of the lookup item.
10407
10408 This example looks up the postmaster alias in the conventional alias file:
10409 .code
10410 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10411 .endd
10412 This example uses NIS+ to look up the full name of the user corresponding to
10413 the local part of an address, forcing the expansion to fail if it is not found:
10414 .code
10415 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10416   {$value}fail}
10417 .endd
10418
10419
10420 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10421 .cindex "expansion" "list creation"
10422 .vindex "&$item$&"
10423 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10424 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10425 For each item
10426 in this list, its value is place in &$item$&, and then <&'string2'&> is
10427 expanded and added to the output as an item in a new list. The separator used
10428 for the output list is the same as the one used for the input, but a separator
10429 setting is not included in the output. For example:
10430 .code
10431 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10432 .endd
10433 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10434 value of &$item$& is restored to what it was before. See also the &%filter%&
10435 and &%reduce%& expansion items.
10436
10437 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10438 .cindex "expansion" "numeric hash"
10439 .cindex "hash function" "numeric"
10440 The three strings are expanded; the first two must yield numbers. Call them
10441 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10442 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10443 can use the simpler operator notation that avoids some of the braces:
10444 .code
10445 ${nhash_<n>_<m>:<string>}
10446 .endd
10447 The second number is optional (in both notations). If there is only one number,
10448 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10449 processed by a div/mod hash function that returns two numbers, separated by a
10450 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10451 example,
10452 .code
10453 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10454 .endd
10455 returns the string &"6/33"&.
10456
10457
10458
10459 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10460 .cindex "Perl" "use in expanded string"
10461 .cindex "expansion" "calling Perl from"
10462 This item is available only if Exim has been built to include an embedded Perl
10463 interpreter. The subroutine name and the arguments are first separately
10464 expanded, and then the Perl subroutine is called with those arguments. No
10465 additional arguments need be given; the maximum number permitted, including the
10466 name of the subroutine, is nine.
10467
10468 The return value of the subroutine is inserted into the expanded string, unless
10469 the return value is &%undef%&. In that case, the entire expansion is
10470 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10471 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10472 in a scalar context, thus the return value is a scalar.  For example, if you
10473 return a Perl vector, the return value is the size of the vector,
10474 not its contents.
10475
10476 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10477 with the error message that was passed to &%die%&. More details of the embedded
10478 Perl facility are given in chapter &<<CHAPperl>>&.
10479
10480 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10481 out the use of this expansion item in filter files.
10482
10483
10484 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10485 .cindex "&%prvs%& expansion item"
10486 The first argument is a complete email address and the second is secret
10487 keystring. The third argument, specifying a key number, is optional. If absent,
10488 it defaults to 0. The result of the expansion is a prvs-signed email address,
10489 to be typically used with the &%return_path%& option on an &(smtp)& transport
10490 as part of a bounce address tag validation (BATV) scheme. For more discussion
10491 and an example, see section &<<SECTverifyPRVS>>&.
10492
10493 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10494         {*&<&'string'&>&*}}*&"
10495 .cindex "&%prvscheck%& expansion item"
10496 This expansion item is the complement of the &%prvs%& item. It is used for
10497 checking prvs-signed addresses. If the expansion of the first argument does not
10498 yield a syntactically valid prvs-signed address, the whole item expands to the
10499 empty string. When the first argument does expand to a syntactically valid
10500 prvs-signed address, the second argument is expanded, with the prvs-decoded
10501 version of the address and the key number extracted from the address in the
10502 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10503
10504 These two variables can be used in the expansion of the second argument to
10505 retrieve the secret. The validity of the prvs-signed address is then checked
10506 against the secret. The result is stored in the variable &$prvscheck_result$&,
10507 which is empty for failure or &"1"& for success.
10508
10509 The third argument is optional; if it is missing, it defaults to an empty
10510 string. This argument is now expanded. If the result is an empty string, the
10511 result of the expansion is the decoded version of the address. This is the case
10512 whether or not the signature was valid. Otherwise, the result of the expansion
10513 is the expansion of the third argument.
10514
10515 All three variables can be used in the expansion of the third argument.
10516 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10517 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10518
10519 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10520 .cindex "expansion" "inserting an entire file"
10521 .cindex "file" "inserting into expansion"
10522 .cindex "&%readfile%& expansion item"
10523 The filename and end-of-line (eol) string are first expanded separately. The file is
10524 then read, and its contents replace the entire item. All newline characters in
10525 the file are replaced by the end-of-line string if it is present. Otherwise,
10526 newlines are left in the string.
10527 String expansion is not applied to the contents of the file. If you want this,
10528 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10529 the string expansion fails.
10530
10531 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10532 locks out the use of this expansion item in filter files.
10533
10534
10535
10536 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10537         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10538 .cindex "expansion" "inserting from a socket"
10539 .cindex "socket, use of in expansion"
10540 .cindex "&%readsocket%& expansion item"
10541 This item inserts data from a Unix domain or TCP socket into the expanded
10542 string. The minimal way of using it uses just two arguments, as in these
10543 examples:
10544 .code
10545 ${readsocket{/socket/name}{request string}}
10546 ${readsocket{inet:some.host:1234}{request string}}
10547 .endd
10548 For a Unix domain socket, the first substring must be the path to the socket.
10549 For an Internet socket, the first substring must contain &`inet:`& followed by
10550 a host name or IP address, followed by a colon and a port, which can be a
10551 number or the name of a TCP port in &_/etc/services_&. An IP address may
10552 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10553 example:
10554 .code
10555 ${readsocket{inet:[::1]:1234}{request string}}
10556 .endd
10557 Only a single host name may be given, but if looking it up yields more than
10558 one IP address, they are each tried in turn until a connection is made. For
10559 both kinds of socket, Exim makes a connection, writes the request string
10560 (unless it is an empty string; no terminating NUL is ever sent)
10561 and reads from the socket until an end-of-file
10562 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10563 extend what can be done. Firstly, you can vary the timeout. For example:
10564 .code
10565 ${readsocket{/socket/name}{request string}{3s}}
10566 .endd
10567
10568 The third argument is a list of options, of which the first element is the timeout
10569 and must be present if any options are given.
10570 Further elements are options of form &'name=value'&.
10571 Example:
10572 .code
10573 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10574 .endd
10575
10576 The following option names are recognised:
10577 .ilist
10578 &*cache*&
10579 Defines if the result data can be cached for use by a later identical
10580 request in the same process.
10581 Values are &"yes"& or &"no"& (the default).
10582 If not, all cached results for this connection specification
10583 will be invalidated.
10584
10585 .next
10586 &*shutdown*&
10587 Defines whether or not a write-shutdown is done on the connection after
10588 sending the request. Values are &"yes"& (the default) or &"no"&
10589 (preferred, eg. by some webservers).
10590
10591 .next
10592 &*sni*&
10593 Controls the use of Server Name Identification on the connection.
10594 Any nonempty value will be the SNI sent; TLS will be forced.
10595
10596 .next
10597 &*tls*&
10598 Controls the use of TLS on the connection.
10599 Values are &"yes"& or &"no"& (the default).
10600 If it is enabled, a shutdown as described above is never done.
10601 .endlist
10602
10603
10604 A fourth argument allows you to change any newlines that are in the data
10605 that is read, in the same way as for &%readfile%& (see above). This example
10606 turns them into spaces:
10607 .code
10608 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10609 .endd
10610 As with all expansions, the substrings are expanded before the processing
10611 happens. Errors in these sub-expansions cause the expansion to fail. In
10612 addition, the following errors can occur:
10613
10614 .ilist
10615 Failure to create a socket file descriptor;
10616 .next
10617 Failure to connect the socket;
10618 .next
10619 Failure to write the request string;
10620 .next
10621 Timeout on reading from the socket.
10622 .endlist
10623
10624 By default, any of these errors causes the expansion to fail. However, if
10625 you supply a fifth substring, it is expanded and used when any of the above
10626 errors occurs. For example:
10627 .code
10628 ${readsocket{/socket/name}{request string}{3s}{\n}\
10629   {socket failure}}
10630 .endd
10631 You can test for the existence of a Unix domain socket by wrapping this
10632 expansion in &`${if exists`&, but there is a race condition between that test
10633 and the actual opening of the socket, so it is safer to use the fifth argument
10634 if you want to be absolutely sure of avoiding an expansion error for a
10635 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10636
10637 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10638 locks out the use of this expansion item in filter files.
10639
10640
10641 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10642 .cindex "expansion" "reducing a list to a scalar"
10643 .cindex "list" "reducing to a scalar"
10644 .vindex "&$value$&"
10645 .vindex "&$item$&"
10646 This operation reduces a list to a single, scalar string. After expansion,
10647 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10648 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10649 Then <&'string2'&> is expanded and
10650 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10651 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10652 them. The result of that expansion is assigned to &$value$& before the next
10653 iteration. When the end of the list is reached, the final value of &$value$& is
10654 added to the expansion output. The &%reduce%& expansion item can be used in a
10655 number of ways. For example, to add up a list of numbers:
10656 .code
10657 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10658 .endd
10659 The result of that expansion would be &`6`&. The maximum of a list of numbers
10660 can be found:
10661 .code
10662 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10663 .endd
10664 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10665 restored to what they were before. See also the &%filter%& and &%map%&
10666 expansion items.
10667
10668 . A bit of a special-case logic error in writing an expansion;
10669 . probably not worth including in the mainline of documentation.
10670 . If only we had footnotes (the html output variant is the problem).
10671 .
10672 . .new
10673 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10674 . and that condition modifies &$value$&,
10675 . then the string expansions dependent on the condition cannot use
10676 . the &$value$& of the reduce iteration.
10677 . .wen
10678
10679 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10680 This item inserts &"raw"& header lines. It is described with the &%header%&
10681 expansion item in section &<<SECTexpansionitems>>& above.
10682
10683 .vitem "&*${run<&'options'&> {*&<&'command&~string'&>&*}{*&<&'string1'&>&*}&&&
10684         {*&<&'string2'&>&*}}*&"
10685 .cindex "expansion" "running a command"
10686 .cindex "&%run%& expansion item"
10687 This item runs an external command, as a subprocess.
10688 One option is supported after the word &'run'&, comma-separated
10689 and without whitespace.
10690
10691 If the option &'preexpand'& is not used,
10692 the command string before expansion is split into individual arguments by spaces
10693 and then each argument is separately expanded.
10694 Then the command is run
10695 in a separate process, but under the same uid and gid.  As in other command
10696 executions from Exim, a shell is not used by default. If the command requires
10697 a shell, you must explicitly code it.
10698 The command name may not be tainted, but the remaining arguments can be.
10699
10700 &*Note*&: if tainted arguments are used, they are supplied by a
10701 potential attacker;
10702 a careful assessment for security vulnerabilities should be done.
10703
10704 If the option &'preexpand'& is used,
10705 the command string is first expanded as a whole.
10706 The expansion result is split apart into individual arguments by spaces,
10707 and then the command is run as above.
10708 Since the arguments are split by spaces, when there is a variable expansion
10709 which has an empty result, it will cause the situation that the argument will
10710 simply be omitted when the program is actually executed by Exim. If the
10711 script/program requires a specific number of arguments and the expanded
10712 variable could possibly result in this empty expansion, the variable must be
10713 quoted. This is more difficult if the expanded variable itself could result
10714 in a string containing quotes, because it would interfere with the quotes
10715 around the command arguments. A possible guard against this is to wrap the
10716 variable in the &%sg%& operator to change any quote marks to some other
10717 character.
10718 Neither the command nor any argument may be tainted.
10719
10720 The standard input for the command exists, but is empty. The standard output
10721 and standard error are set to the same file descriptor.
10722 .cindex "return code" "from &%run%& expansion"
10723 .vindex "&$value$&"
10724 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10725 and replaces the entire item; during this expansion, the standard output/error
10726 from the command is in the variable &$value$&. If the command fails,
10727 <&'string2'&>, if present, is expanded and used. Once again, during the
10728 expansion, the standard output/error from the command is in the variable
10729 &$value$&.
10730
10731 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10732 can be the word &"fail"& (not in braces) to force expansion failure if the
10733 command does not succeed. If both strings are omitted, the result is contents
10734 of the standard output/error on success, and nothing on failure.
10735
10736 .vindex "&$run_in_acl$&"
10737 The standard output/error of the command is put in the variable &$value$&.
10738 In this ACL example, the output of a command is logged for the admin to
10739 troubleshoot:
10740 .code
10741 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10742       log_message  = Output of id: $value
10743 .endd
10744 If the command requires shell idioms, such as the > redirect operator, the
10745 shell must be invoked directly, such as with:
10746 .code
10747 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10748 .endd
10749 Note that &$value$& will not persist beyond the reception of a single message.
10750
10751 .vindex "&$runrc$&"
10752 The return code from the command is put in the variable &$runrc$&, and this
10753 remains set afterwards, so in a filter file you can do things like this:
10754 .code
10755 if "${run{x y z}{}}$runrc" is 1 then ...
10756   elif $runrc is 2 then ...
10757   ...
10758 endif
10759 .endd
10760 If execution of the command fails (for example, the command does not exist),
10761 the return code is 127 &-- the same code that shells use for non-existent
10762 commands.
10763
10764 &*Warning*&: In a router or transport, you cannot assume the order in which
10765 option values are expanded, except for those preconditions whose order of
10766 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10767 by the expansion of one option, and use it in another.
10768
10769 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10770 out the use of this expansion item in filter files.
10771
10772
10773 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10774 .cindex "expansion" "string substitution"
10775 .cindex "&%sg%& expansion item"
10776 This item works like Perl's substitution operator (s) with the global (/g)
10777 option; hence its name. However, unlike the Perl equivalent, Exim does not
10778 modify the subject string; instead it returns the modified string for insertion
10779 into the overall expansion. The item takes three arguments: the subject string,
10780 a regular expression, and a substitution string. For example:
10781 .code
10782 ${sg{abcdefabcdef}{abc}{xyz}}
10783 .endd
10784 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10785 if any $, } or \ characters are required in the regular expression or in the
10786 substitution string, they have to be escaped. For example:
10787 .code
10788 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10789 .endd
10790 yields &"defabc"&, and
10791 .code
10792 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10793 .endd
10794 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10795 the regular expression from string expansion.
10796
10797 The regular expression is compiled in 8-bit mode, working against bytes
10798 rather than any Unicode-aware character handling.
10799
10800
10801 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10802 .cindex sorting "a list"
10803 .cindex list sorting
10804 .cindex expansion "list sorting"
10805 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10806 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10807 The <&'comparator'&> argument is interpreted as the operator
10808 of a two-argument expansion condition.
10809 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10810 The comparison should return true when applied to two values
10811 if the first value should sort before the second value.
10812 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10813 the element being placed in &$item$&,
10814 to give values for comparison.
10815
10816 The item result is a sorted list,
10817 with the original list separator,
10818 of the list elements (in full) of the original.
10819
10820 Examples:
10821 .code
10822 ${sort{3:2:1:4}{<}{$item}}
10823 .endd
10824 sorts a list of numbers, and
10825 .code
10826 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10827 .endd
10828 will sort an MX lookup into priority order.
10829
10830
10831
10832 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10833 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10834
10835
10836
10837 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10838 .cindex "&%substr%& expansion item"
10839 .cindex "substring extraction"
10840 .cindex "expansion" "substring extraction"
10841 The three strings are expanded; the first two must yield numbers. Call them
10842 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10843 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10844 can use the simpler operator notation that avoids some of the braces:
10845 .code
10846 ${substr_<n>_<m>:<subject>}
10847 .endd
10848 The second number is optional (in both notations).
10849 If it is absent in the simpler format, the preceding underscore must also be
10850 omitted.
10851
10852 The &%substr%& item can be used to extract more general substrings than
10853 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10854 length required. For example
10855 .code
10856 ${substr{3}{2}{$local_part}}
10857 .endd
10858 If the starting offset is greater than the string length the result is the
10859 null string; if the length plus starting offset is greater than the string
10860 length, the result is the right-hand part of the string, starting from the
10861 given offset. The first byte (character) in the string has offset zero.
10862
10863 The &%substr%& expansion item can take negative offset values to count
10864 from the right-hand end of its operand. The last byte (character) is offset -1,
10865 the second-last is offset -2, and so on. Thus, for example,
10866 .code
10867 ${substr{-5}{2}{1234567}}
10868 .endd
10869 yields &"34"&. If the absolute value of a negative offset is greater than the
10870 length of the string, the substring starts at the beginning of the string, and
10871 the length is reduced by the amount of overshoot. Thus, for example,
10872 .code
10873 ${substr{-5}{2}{12}}
10874 .endd
10875 yields an empty string, but
10876 .code
10877 ${substr{-3}{2}{12}}
10878 .endd
10879 yields &"1"&.
10880
10881 When the second number is omitted from &%substr%&, the remainder of the string
10882 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10883 string preceding the offset point are taken. For example, an offset of -1 and
10884 no length, as in these semantically identical examples:
10885 .code
10886 ${substr_-1:abcde}
10887 ${substr{-1}{abcde}}
10888 .endd
10889 yields all but the last character of the string, that is, &"abcd"&.
10890
10891 All measurement is done in bytes and is not UTF-8 aware.
10892
10893
10894
10895 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10896         {*&<&'replacements'&>&*}}*&"
10897 .cindex "expansion" "character translation"
10898 .cindex "&%tr%& expansion item"
10899 This item does single-character (in bytes) translation on its subject string. The second
10900 argument is a list of characters to be translated in the subject string. Each
10901 matching character is replaced by the corresponding character from the
10902 replacement list. For example
10903 .code
10904 ${tr{abcdea}{ac}{13}}
10905 .endd
10906 yields &`1b3de1`&. If there are duplicates in the second character string, the
10907 last occurrence is used. If the third string is shorter than the second, its
10908 last character is replicated. However, if it is empty, no translation takes
10909 place.
10910
10911 All character handling is done in bytes and is not UTF-8 aware.
10912
10913 .endlist
10914
10915
10916
10917 .section "Expansion operators" "SECTexpop"
10918 .cindex "expansion" "operators"
10919 For expansion items that perform transformations on a single argument string,
10920 the &"operator"& notation is used because it is simpler and uses fewer braces.
10921 The substring is first expanded before the operation is applied to it. The
10922 following operations can be performed:
10923
10924 .vlist
10925 .vitem &*${address:*&<&'string'&>&*}*&
10926 .cindex "expansion" "RFC 2822 address handling"
10927 .cindex "&%address%& expansion item"
10928 The string is interpreted as an RFC 2822 address, as it might appear in a
10929 header line, and the effective address is extracted from it. If the string does
10930 not parse successfully, the result is empty.
10931
10932 The parsing correctly handles SMTPUTF8 Unicode in the string.
10933
10934
10935 .vitem &*${addresses:*&<&'string'&>&*}*&
10936 .cindex "expansion" "RFC 2822 address handling"
10937 .cindex "&%addresses%& expansion item"
10938 The string (after expansion) is interpreted as a list of addresses in RFC
10939 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10940 operative address (&'local-part@domain'&) is extracted from each item, and the
10941 result of the expansion is a colon-separated list, with appropriate
10942 doubling of colons should any happen to be present in the email addresses.
10943 Syntactically invalid RFC2822 address items are omitted from the output.
10944
10945 It is possible to specify a character other than colon for the output
10946 separator by starting the string with > followed by the new separator
10947 character. For example:
10948 .code
10949 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10950 .endd
10951 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10952 first, so if the expanded string starts with >, it may change the output
10953 separator unintentionally. This can be avoided by setting the output
10954 separator explicitly:
10955 .code
10956 ${addresses:>:$h_from:}
10957 .endd
10958
10959 Compare the &%address%& (singular)
10960 expansion item, which extracts the working address from a single RFC2822
10961 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10962 processing lists.
10963
10964 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10965 a strict interpretation of header line formatting.  Exim parses the bare,
10966 unquoted portion of an email address and if it finds a comma, treats it as an
10967 email address separator. For the example header line:
10968 .code
10969 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10970 .endd
10971 The first example below demonstrates that Q-encoded email addresses are parsed
10972 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10973 It does not see the comma because it's still encoded as "=2C".  The second
10974 example below is passed the contents of &`$header_from:`&, meaning it gets
10975 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10976 The third example shows that the presence of a comma is skipped when it is
10977 quoted.  The fourth example shows SMTPUTF8 handling.
10978 .code
10979 # exim -be '${addresses:From: \
10980 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10981 user@example.com
10982 # exim -be '${addresses:From: Last, First <user@example.com>}'
10983 Last:user@example.com
10984 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10985 user@example.com
10986 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10987 フィリップ@example.jp
10988 .endd
10989
10990 .vitem &*${base32:*&<&'digits'&>&*}*&
10991 .cindex "&%base32%& expansion item"
10992 .cindex "expansion" "conversion to base 32"
10993 The string must consist entirely of decimal digits. The number is converted to
10994 base 32 and output as a (empty, for zero) string of characters.
10995 Only lowercase letters are used.
10996
10997 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10998 .cindex "&%base32d%& expansion item"
10999 .cindex "expansion" "conversion to base 32"
11000 The string must consist entirely of base-32 digits.
11001 The number is converted to decimal and output as a string.
11002
11003 .vitem &*${base62:*&<&'digits'&>&*}*&
11004 .cindex "&%base62%& expansion item"
11005 .cindex "expansion" "conversion to base 62"
11006 The string must consist entirely of decimal digits. The number is converted to
11007 base 62 and output as a string of six characters, including leading zeros. In
11008 the few operating environments where Exim uses base 36 instead of base 62 for
11009 its message identifiers (because those systems do not have case-sensitive
11010 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
11011 to be absolutely clear: this is &'not'& base64 encoding.
11012
11013 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
11014 .cindex "&%base62d%& expansion item"
11015 .cindex "expansion" "conversion to base 62"
11016 The string must consist entirely of base-62 digits, or, in operating
11017 environments where Exim uses base 36 instead of base 62 for its message
11018 identifiers, base-36 digits. The number is converted to decimal and output as a
11019 string.
11020
11021 .vitem &*${base64:*&<&'string'&>&*}*&
11022 .cindex "expansion" "base64 encoding"
11023 .cindex "base64 encoding" "in string expansion"
11024 .cindex "&%base64%& expansion item"
11025 .cindex certificate "base64 of DER"
11026 This operator converts a string into one that is base64 encoded.
11027
11028 If the string is a single variable of type certificate,
11029 returns the base64 encoding of the DER form of the certificate.
11030
11031
11032 .vitem &*${base64d:*&<&'string'&>&*}*&
11033 .cindex "expansion" "base64 decoding"
11034 .cindex "base64 decoding" "in string expansion"
11035 .cindex "&%base64d%& expansion item"
11036 This operator converts a base64-encoded string into the un-coded form.
11037
11038
11039 .vitem &*${domain:*&<&'string'&>&*}*&
11040 .cindex "domain" "extraction"
11041 .cindex "expansion" "domain extraction"
11042 The string is interpreted as an RFC 2822 address and the domain is extracted
11043 from it. If the string does not parse successfully, the result is empty.
11044
11045
11046 .vitem &*${escape:*&<&'string'&>&*}*&
11047 .cindex "expansion" "escaping non-printing characters"
11048 .cindex "&%escape%& expansion item"
11049 If the string contains any non-printing characters, they are converted to
11050 escape sequences starting with a backslash. Whether characters with the most
11051 significant bit set (so-called &"8-bit characters"&) count as printing or not
11052 is controlled by the &%print_topbitchars%& option.
11053
11054 .vitem &*${escape8bit:*&<&'string'&>&*}*&
11055 .cindex "expansion" "escaping 8-bit characters"
11056 .cindex "&%escape8bit%& expansion item"
11057 If the string contains any characters with the most significant bit set,
11058 they are converted to escape sequences starting with a backslash.
11059 Backslashes and DEL characters are also converted.
11060
11061
11062 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
11063 .cindex "expansion" "expression evaluation"
11064 .cindex "expansion" "arithmetic expression"
11065 .cindex "&%eval%& expansion item"
11066 These items supports simple arithmetic and bitwise logical operations in
11067 expansion strings. The string (after expansion) must be a conventional
11068 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
11069 logical operators, and parentheses. All operations are carried out using
11070 integer arithmetic. The operator priorities are as follows (the same as in the
11071 C programming language):
11072 .table2 70pt 300pt
11073 .irow &'highest:'& "not (~), negate (-)"
11074 .irow ""   "multiply (*), divide (/), remainder (%)"
11075 .irow ""   "plus (+), minus (-)"
11076 .irow ""   "shift-left (<<), shift-right (>>)"
11077 .irow ""   "and (&&)"
11078 .irow ""   "xor (^)"
11079 .irow &'lowest:'&  "or (|)"
11080 .endtable
11081 Binary operators with the same priority are evaluated from left to right. White
11082 space is permitted before or after operators.
11083
11084 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11085 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11086 decimal, even if they start with a leading zero; hexadecimal numbers are not
11087 permitted. This can be useful when processing numbers extracted from dates or
11088 times, which often do have leading zeros.
11089
11090 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11091 or 1024*1024*1024,
11092 respectively. Negative numbers are supported. The result of the computation is
11093 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11094
11095 .display
11096 &`${eval:1+1}            `&  yields 2
11097 &`${eval:1+2*3}          `&  yields 7
11098 &`${eval:(1+2)*3}        `&  yields 9
11099 &`${eval:2+42%5}         `&  yields 4
11100 &`${eval:0xc&amp;5}          `&  yields 4
11101 &`${eval:0xc|5}          `&  yields 13
11102 &`${eval:0xc^5}          `&  yields 9
11103 &`${eval:0xc>>1}         `&  yields 6
11104 &`${eval:0xc<<1}         `&  yields 24
11105 &`${eval:~255&amp;0x1234}    `&  yields 4608
11106 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11107 .endd
11108
11109 As a more realistic example, in an ACL you might have
11110 .code
11111 deny   condition =                    \
11112          ${if and {                   \
11113            {>{$rcpt_count}{10}}       \
11114            {                          \
11115            <                          \
11116              {$recipients_count}      \
11117              {${eval:$rcpt_count/2}}  \
11118            }                          \
11119          }{yes}{no}}
11120        message = Too many bad recipients
11121 .endd
11122 The condition is true if there have been more than 10 RCPT commands and
11123 fewer than half of them have resulted in a valid recipient.
11124
11125
11126 .vitem &*${expand:*&<&'string'&>&*}*&
11127 .cindex "expansion" "re-expansion of substring"
11128 The &%expand%& operator causes a string to be expanded for a second time. For
11129 example,
11130 .code
11131 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11132 .endd
11133 first looks up a string in a file while expanding the operand for &%expand%&,
11134 and then re-expands what it has found.
11135
11136
11137 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11138 .cindex "Unicode"
11139 .cindex "UTF-8" "conversion from"
11140 .cindex "expansion" "UTF-8 conversion"
11141 .cindex "&%from_utf8%& expansion item"
11142 The world is slowly moving towards Unicode, although there are no standards for
11143 email yet. However, other applications (including some databases) are starting
11144 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11145 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11146 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11147 the result is an undefined sequence of bytes.
11148
11149 Unicode code points with values less than 256 are compatible with ASCII and
11150 ISO-8859-1 (also known as Latin-1).
11151 For example, character 169 is the copyright symbol in both cases, though the
11152 way it is encoded is different. In UTF-8, more than one byte is needed for
11153 characters with code values greater than 127, whereas ISO-8859-1 is a
11154 single-byte encoding (but thereby limited to 256 characters). This makes
11155 translation from UTF-8 to ISO-8859-1 straightforward.
11156
11157
11158 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11159 .cindex "hash function" "textual"
11160 .cindex "expansion" "textual hash"
11161 The &%hash%& operator is a simpler interface to the hashing function that can
11162 be used when the two parameters are fixed numbers (as opposed to strings that
11163 change when expanded). The effect is the same as
11164 .code
11165 ${hash{<n>}{<m>}{<string>}}
11166 .endd
11167 See the description of the general &%hash%& item above for details. The
11168 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11169
11170
11171
11172 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11173 .cindex header "wrapping operator"
11174 .cindex expansion "header wrapping"
11175 This operator line-wraps its argument in a way useful for headers.
11176 The &'cols'& value gives the column number to wrap after,
11177 the &'limit'& gives a limit number of result characters to truncate at.
11178 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11179 the defaults are 80 and 998.
11180 Wrapping will be inserted at a space if possible before the
11181 column number is reached.
11182 Whitespace at a chosen wrap point is removed.
11183 A line-wrap consists of a newline followed by a tab,
11184 and the tab is counted as 8 columns.
11185
11186
11187
11188 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11189 .cindex "base64 encoding" "conversion from hex"
11190 .cindex "expansion" "hex to base64"
11191 .cindex "&%hex2b64%& expansion item"
11192 This operator converts a hex string into one that is base64 encoded. This can
11193 be useful for processing the output of the various hashing functions.
11194
11195
11196
11197 .vitem &*${hexquote:*&<&'string'&>&*}*&
11198 .cindex "quoting" "hex-encoded unprintable characters"
11199 .cindex "&%hexquote%& expansion item"
11200 This operator converts non-printable characters in a string into a hex
11201 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11202 as is, and other byte values are converted to &`\xNN`&, for example, a
11203 byte value 127 is converted to &`\x7f`&.
11204
11205
11206 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11207 .cindex "&%ipv6denorm%& expansion item"
11208 .cindex "IP address" normalisation
11209 This expands an IPv6 address to a full eight-element colon-separated set
11210 of hex digits including leading zeroes.
11211 A trailing ipv4-style dotted-decimal set is converted to hex.
11212 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11213
11214 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11215 .cindex "&%ipv6norm%& expansion item"
11216 .cindex "IP address" normalisation
11217 .cindex "IP address" "canonical form"
11218 This converts an IPv6 address to canonical form.
11219 Leading zeroes of groups are omitted, and the longest
11220 set of zero-valued groups is replaced with a double colon.
11221 A trailing ipv4-style dotted-decimal set is converted to hex.
11222 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11223
11224
11225 .vitem &*${lc:*&<&'string'&>&*}*&
11226 .cindex "case forcing in strings"
11227 .cindex "string" "case forcing"
11228 .cindex "lower casing"
11229 .cindex "expansion" "case forcing"
11230 .cindex "&%lc%& expansion item"
11231 This forces the letters in the string into lower-case, for example:
11232 .code
11233 ${lc:$local_part}
11234 .endd
11235 Case is defined per the system C locale.
11236
11237 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11238 .cindex "expansion" "string truncation"
11239 .cindex "&%length%& expansion item"
11240 The &%length%& operator is a simpler interface to the &%length%& function that
11241 can be used when the parameter is a fixed number (as opposed to a string that
11242 changes when expanded). The effect is the same as
11243 .code
11244 ${length{<number>}{<string>}}
11245 .endd
11246 See the description of the general &%length%& item above for details. Note that
11247 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11248 when &%length%& is used as an operator.
11249 All measurement is done in bytes and is not UTF-8 aware.
11250
11251
11252 .vitem &*${listcount:*&<&'string'&>&*}*&
11253 .cindex "expansion" "list item count"
11254 .cindex "list" "item count"
11255 .cindex "list" "count of items"
11256 .cindex "&%listcount%& expansion item"
11257 The string is interpreted as a list and the number of items is returned.
11258
11259
11260 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11261 .cindex "expansion" "named list"
11262 .cindex "&%listnamed%& expansion item"
11263 The name is interpreted as a named list and the content of the list is returned,
11264 expanding any referenced lists, re-quoting as needed for colon-separation.
11265 If the optional type is given it must be one of "a", "d", "h" or "l"
11266 and selects address-, domain-, host- or localpart- lists to search among respectively.
11267 Otherwise all types are searched in an undefined order and the first
11268 matching list is returned.
11269 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11270 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11271
11272
11273 .vitem &*${local_part:*&<&'string'&>&*}*&
11274 .cindex "expansion" "local part extraction"
11275 .cindex "&%local_part%& expansion item"
11276 The string is interpreted as an RFC 2822 address and the local part is
11277 extracted from it. If the string does not parse successfully, the result is
11278 empty.
11279 The parsing correctly handles SMTPUTF8 Unicode in the string.
11280
11281
11282 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11283        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11284 .cindex "masked IP address"
11285 .cindex "IP address" "masking"
11286 .cindex "CIDR notation"
11287 .cindex "expansion" "IP address masking"
11288 .cindex "&%mask%& expansion item"
11289 If the form of the string to be operated on is not an IP address followed by a
11290 slash and an integer (that is, a network address in CIDR notation), the
11291 expansion fails. Otherwise, this operator converts the IP address to binary,
11292 masks off the least significant bits according to the bit count, and converts
11293 the result back to text, with mask appended. For example,
11294 .code
11295 ${mask:10.111.131.206/28}
11296 .endd
11297 returns the string &"10.111.131.192/28"&.
11298
11299 Since this operation is expected to
11300 be mostly used for looking up masked addresses in files, the
11301 normal
11302 result for an IPv6
11303 address uses dots to separate components instead of colons, because colon
11304 terminates a key string in lsearch files. So, for example,
11305 .code
11306 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11307 .endd
11308 returns the string
11309 .code
11310 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11311 .endd
11312 If the optional form &*mask_n*& is used, IPv6 address result are instead
11313 returned in normailsed form, using colons and with zero-compression.
11314 Letters in IPv6 addresses are always output in lower case.
11315
11316
11317 .vitem &*${md5:*&<&'string'&>&*}*&
11318 .cindex "MD5 hash"
11319 .cindex "expansion" "MD5 hash"
11320 .cindex certificate fingerprint
11321 .cindex "&%md5%& expansion item"
11322 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11323 as a 32-digit hexadecimal number, in which any letters are in lower case.
11324
11325 If the string is a single variable of type certificate,
11326 returns the MD5 hash fingerprint of the certificate.
11327
11328
11329 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11330 .cindex "expansion" "numeric hash"
11331 .cindex "hash function" "numeric"
11332 The &%nhash%& operator is a simpler interface to the numeric hashing function
11333 that can be used when the two parameters are fixed numbers (as opposed to
11334 strings that change when expanded). The effect is the same as
11335 .code
11336 ${nhash{<n>}{<m>}{<string>}}
11337 .endd
11338 See the description of the general &%nhash%& item above for details.
11339
11340
11341 .vitem &*${quote:*&<&'string'&>&*}*&
11342 .cindex "quoting" "in string expansions"
11343 .cindex "expansion" "quoting"
11344 .cindex "&%quote%& expansion item"
11345 The &%quote%& operator puts its argument into double quotes if it
11346 is an empty string or
11347 contains anything other than letters, digits, underscores, dots, and hyphens.
11348 Any occurrences of double quotes and backslashes are escaped with a backslash.
11349 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11350 respectively For example,
11351 .code
11352 ${quote:ab"*"cd}
11353 .endd
11354 becomes
11355 .code
11356 "ab\"*\"cd"
11357 .endd
11358 The place where this is useful is when the argument is a substitution from a
11359 variable or a message header.
11360
11361 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11362 .cindex "&%quote_local_part%& expansion item"
11363 This operator is like &%quote%&, except that it quotes the string only if
11364 required to do so by the rules of RFC 2822 for quoting local parts. For
11365 example, a plus sign would not cause quoting (but it would for &%quote%&).
11366 If you are creating a new email address from the contents of &$local_part$&
11367 (or any other unknown data), you should always use this operator.
11368
11369 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11370 will likely use the quoting form.
11371 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11372
11373
11374 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11375 .cindex "quoting" "lookup-specific"
11376 This operator applies lookup-specific quoting rules to the string. Each
11377 query-style lookup type has its own quoting rules which are described with
11378 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11379 .code
11380 ${quote_ldap:two * two}
11381 .endd
11382 returns
11383 .code
11384 two%20%5C2A%20two
11385 .endd
11386 For single-key lookup types, no quoting is ever necessary and this operator
11387 yields an unchanged string.
11388
11389
11390 .vitem &*${randint:*&<&'n'&>&*}*&
11391 .cindex "random number"
11392 This operator returns a somewhat random number which is less than the
11393 supplied number and is at least 0.  The quality of this randomness depends
11394 on how Exim was built; the values are not suitable for keying material.
11395 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11396 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11397 for versions of GnuTLS with that function.
11398 Otherwise, the implementation may be arc4random(), random() seeded by
11399 srandomdev() or srandom(), or a custom implementation even weaker than
11400 random().
11401
11402
11403 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11404 .cindex "expansion" "IP address"
11405 This operator reverses an IP address; for IPv4 addresses, the result is in
11406 dotted-quad decimal form, while for IPv6 addresses the result is in
11407 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11408 for DNS.  For example,
11409 .code
11410 ${reverse_ip:192.0.2.4}
11411 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11412 .endd
11413 returns
11414 .code
11415 4.2.0.192
11416 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
11417 .endd
11418
11419
11420 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11421 .cindex "expansion" "RFC 2047"
11422 .cindex "RFC 2047" "expansion operator"
11423 .cindex "&%rfc2047%& expansion item"
11424 This operator encodes text according to the rules of RFC 2047. This is an
11425 encoding that is used in header lines to encode non-ASCII characters. It is
11426 assumed that the input string is in the encoding specified by the
11427 &%headers_charset%& option, which gets its default at build time. If the string
11428 contains only characters in the range 33&--126, and no instances of the
11429 characters
11430 .code
11431 ? = ( ) < > @ , ; : \ " . [ ] _
11432 .endd
11433 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11434 string, using as many &"encoded words"& as necessary to encode all the
11435 characters.
11436
11437
11438 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11439 .cindex "expansion" "RFC 2047"
11440 .cindex "RFC 2047" "decoding"
11441 .cindex "&%rfc2047d%& expansion item"
11442 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11443 bytes are replaced by question marks. Characters are converted into the
11444 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11445 not recognized unless &%check_rfc2047_length%& is set false.
11446
11447 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11448 access a header line, RFC 2047 decoding is done automatically. You do not need
11449 to use this operator as well.
11450
11451
11452
11453 .vitem &*${rxquote:*&<&'string'&>&*}*&
11454 .cindex "quoting" "in regular expressions"
11455 .cindex "regular expressions" "quoting"
11456 .cindex "&%rxquote%& expansion item"
11457 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11458 characters in its argument. This is useful when substituting the values of
11459 variables or headers inside regular expressions.
11460
11461
11462 .vitem &*${sha1:*&<&'string'&>&*}*&
11463 .cindex "SHA-1 hash"
11464 .cindex "expansion" "SHA-1 hashing"
11465 .cindex certificate fingerprint
11466 .cindex "&%sha1%& expansion item"
11467 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11468 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11469
11470 If the string is a single variable of type certificate,
11471 returns the SHA-1 hash fingerprint of the certificate.
11472
11473
11474 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11475        &*${sha2:*&<&'string'&>&*}*& &&&
11476        &*${sha2_<n>:*&<&'string'&>&*}*&
11477 .cindex "SHA-256 hash"
11478 .cindex "SHA-2 hash"
11479 .cindex certificate fingerprint
11480 .cindex "expansion" "SHA-256 hashing"
11481 .cindex "&%sha256%& expansion item"
11482 .cindex "&%sha2%& expansion item"
11483 The &%sha256%& operator computes the SHA-256 hash value of the string
11484 and returns
11485 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11486
11487 If the string is a single variable of type certificate,
11488 returns the SHA-256 hash fingerprint of the certificate.
11489
11490 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11491 (except for certificates, which are not supported).
11492 Finally, if an underbar
11493 and a number is appended it specifies the output length, selecting a
11494 member of the SHA-2 family of hash functions.
11495 Values of 256, 384 and 512 are accepted, with 256 being the default.
11496
11497
11498 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11499        &*${sha3_<n>:*&<&'string'&>&*}*&
11500 .cindex "SHA3 hash"
11501 .cindex "expansion" "SHA3 hashing"
11502 .cindex "&%sha3%& expansion item"
11503 The &%sha3%& operator computes the SHA3-256 hash value of the string
11504 and returns
11505 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11506
11507 If a number is appended, separated by an underbar, it specifies
11508 the output length.  Values of 224, 256, 384 and 512 are accepted;
11509 with 256 being the default.
11510
11511 The &%sha3%& expansion item is only supported if Exim has been
11512 compiled with GnuTLS 3.5.0 or later,
11513 or OpenSSL 1.1.1 or later.
11514 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11515
11516
11517 .vitem &*${stat:*&<&'string'&>&*}*&
11518 .cindex "expansion" "statting a file"
11519 .cindex "file" "extracting characteristics"
11520 .cindex "&%stat%& expansion item"
11521 The string, after expansion, must be a file path. A call to the &[stat()]&
11522 function is made for this path. If &[stat()]& fails, an error occurs and the
11523 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11524 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11525 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11526 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11527 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11528 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11529 can extract individual fields using the &%extract%& expansion item.
11530
11531 The use of the &%stat%& expansion in users' filter files can be locked out by
11532 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11533 systems for files larger than 2GB.
11534
11535 .vitem &*${str2b64:*&<&'string'&>&*}*&
11536 .cindex "&%str2b64%& expansion item"
11537 Now deprecated, a synonym for the &%base64%& expansion operator.
11538
11539
11540
11541 .vitem &*${strlen:*&<&'string'&>&*}*&
11542 .cindex "expansion" "string length"
11543 .cindex "string" "length in expansion"
11544 .cindex "&%strlen%& expansion item"
11545 The item is replaced by the length of the expanded string, expressed as a
11546 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11547 All measurement is done in bytes and is not UTF-8 aware.
11548
11549
11550 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11551 .cindex "&%substr%& expansion item"
11552 .cindex "substring extraction"
11553 .cindex "expansion" "substring expansion"
11554 The &%substr%& operator is a simpler interface to the &%substr%& function that
11555 can be used when the two parameters are fixed numbers (as opposed to strings
11556 that change when expanded). The effect is the same as
11557 .code
11558 ${substr{<start>}{<length>}{<string>}}
11559 .endd
11560 See the description of the general &%substr%& item above for details. The
11561 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11562 All measurement is done in bytes and is not UTF-8 aware.
11563
11564 .vitem &*${time_eval:*&<&'string'&>&*}*&
11565 .cindex "&%time_eval%& expansion item"
11566 .cindex "time interval" "decoding"
11567 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11568 seconds.
11569
11570 .vitem &*${time_interval:*&<&'string'&>&*}*&
11571 .cindex "&%time_interval%& expansion item"
11572 .cindex "time interval" "formatting"
11573 The argument (after sub-expansion) must be a sequence of decimal digits that
11574 represents an interval of time as a number of seconds. It is converted into a
11575 number of larger units and output in Exim's normal time format, for example,
11576 &`1w3d4h2m6s`&.
11577
11578 .vitem &*${uc:*&<&'string'&>&*}*&
11579 .cindex "case forcing in strings"
11580 .cindex "string" "case forcing"
11581 .cindex "upper casing"
11582 .cindex "expansion" "case forcing"
11583 .cindex "&%uc%& expansion item"
11584 This forces the letters in the string into upper-case.
11585 Case is defined per the system C locale.
11586
11587 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11588 .cindex "correction of invalid utf-8 sequences in strings"
11589 .cindex "utf-8" "utf-8 sequences"
11590 .cindex "incorrect utf-8"
11591 .cindex "expansion" "utf-8 forcing"
11592 .cindex "&%utf8clean%& expansion item"
11593 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11594 In versions of Exim before 4.92, this did not correctly do so for a truncated
11595 final codepoint's encoding, and the character would be silently dropped.
11596 If you must handle detection of this scenario across both sets of Exim behavior,
11597 the complexity will depend upon the task.
11598 For instance, to detect if the first character is multibyte and a 1-byte
11599 extraction can be successfully used as a path component (as is common for
11600 dividing up delivery folders), you might use:
11601 .code
11602 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11603 .endd
11604 (which will false-positive if the first character of the local part is a
11605 literal question mark).
11606
11607 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11608        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11609        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11610        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11611 .cindex expansion UTF-8
11612 .cindex UTF-8 expansion
11613 .cindex EAI
11614 .cindex internationalisation
11615 .cindex "&%utf8_domain_to_alabel%& expansion item"
11616 .cindex "&%utf8_domain_from_alabel%& expansion item"
11617 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11618 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11619 These convert EAI mail name components between UTF-8 and a-label forms.
11620 For information on internationalisation support see &<<SECTi18nMTA>>&.
11621
11622
11623 .vitem &*${xtextd:*&<&'string'&>&*}*&
11624 .cindex "text forcing in strings"
11625 .cindex "string" "xtext decoding"
11626 .cindex "xtext"
11627 .cindex "&%xtextd%& expansion item"
11628 This performs xtext decoding of the string (per RFC 3461 section 4).
11629
11630
11631
11632 .endlist
11633
11634
11635
11636
11637
11638
11639 .section "Expansion conditions" "SECTexpcond"
11640 .scindex IIDexpcond "expansion" "conditions"
11641 The following conditions are available for testing by the &%${if%& construct
11642 while expanding strings:
11643
11644 .vlist
11645 .vitem &*!*&<&'condition'&>
11646 .cindex "expansion" "negating a condition"
11647 .cindex "negation" "in expansion condition"
11648 Preceding any condition with an exclamation mark negates the result of the
11649 condition.
11650
11651 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11652 .cindex "numeric comparison"
11653 .cindex "expansion" "numeric comparison"
11654 There are a number of symbolic operators for doing numeric comparisons. They
11655 are:
11656 .itable none 0 0 2 10* left 90* left
11657 .irow "=   " "equal"
11658 .irow "==  " "equal"
11659 .irow ">   " "greater"
11660 .irow ">=  " "greater or equal"
11661 .irow "<   " "less"
11662 .irow "<=  " "less or equal"
11663 .endtable
11664 For example:
11665 .code
11666 ${if >{$message_size}{10M} ...
11667 .endd
11668 Note that the general negation operator provides for inequality testing. The
11669 two strings must take the form of optionally signed decimal integers,
11670 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11671 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11672 As a special case, the numerical value of an empty string is taken as
11673 zero.
11674
11675 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11676 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11677 10M, not if 10M is larger than &$message_size$&.
11678
11679
11680 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11681         {*&<&'arg2'&>&*}...}*&
11682 .cindex "expansion" "calling an acl"
11683 .cindex "&%acl%&" "expansion condition"
11684 The name and zero to nine argument strings are first expanded separately.  The expanded
11685 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11686 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11687 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11688 and may use the variables; if another acl expansion is used the values
11689 are restored after it returns.  If the ACL sets
11690 a value using a "message =" modifier the variable $value becomes
11691 the result of the expansion, otherwise it is empty.
11692 If the ACL returns accept the condition is true; if deny, false.
11693 If the ACL returns defer the result is a forced-fail.
11694
11695 .vitem &*bool&~{*&<&'string'&>&*}*&
11696 .cindex "expansion" "boolean parsing"
11697 .cindex "&%bool%& expansion condition"
11698 This condition turns a string holding a true or false representation into
11699 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11700 (case-insensitively); also integer numbers map to true if non-zero,
11701 false if zero.
11702 An empty string is treated as false.
11703 Leading and trailing whitespace is ignored;
11704 thus a string consisting only of whitespace is false.
11705 All other string values will result in expansion failure.
11706
11707 When combined with ACL variables, this expansion condition will let you
11708 make decisions in one place and act on those decisions in another place.
11709 For example:
11710 .code
11711 ${if bool{$acl_m_privileged_sender} ...
11712 .endd
11713
11714
11715 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11716 .cindex "expansion" "boolean parsing"
11717 .cindex "&%bool_lax%& expansion condition"
11718 Like &%bool%&, this condition turns a string into a boolean state.  But
11719 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11720 loose definition that the Router &%condition%& option uses.  The empty string
11721 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11722 true.  Leading and trailing whitespace is ignored.
11723
11724 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11725
11726 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11727 .cindex "expansion" "encrypted comparison"
11728 .cindex "encrypted strings, comparing"
11729 .cindex "&%crypteq%& expansion condition"
11730 This condition is included in the Exim binary if it is built to support any
11731 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11732 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11733 included in the binary.
11734
11735 The &%crypteq%& condition has two arguments. The first is encrypted and
11736 compared against the second, which is already encrypted. The second string may
11737 be in the LDAP form for storing encrypted strings, which starts with the
11738 encryption type in curly brackets, followed by the data. If the second string
11739 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11740 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11741 Typically this will be a field from a password file. An example of an encrypted
11742 string in LDAP form is:
11743 .code
11744 {md5}CY9rzUYh03PK3k6DJie09g==
11745 .endd
11746 If such a string appears directly in an expansion, the curly brackets have to
11747 be quoted, because they are part of the expansion syntax. For example:
11748 .code
11749 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11750 .endd
11751 The following encryption types (whose names are matched case-independently) are
11752 supported:
11753
11754 .ilist
11755 .cindex "MD5 hash"
11756 .cindex "base64 encoding" "in encrypted password"
11757 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11758 printable characters to compare with the remainder of the second string. If the
11759 length of the comparison string is 24, Exim assumes that it is base64 encoded
11760 (as in the above example). If the length is 32, Exim assumes that it is a
11761 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11762 comparison fails.
11763
11764 .next
11765 .cindex "SHA-1 hash"
11766 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11767 printable characters to compare with the remainder of the second string. If the
11768 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11769 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11770 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11771
11772 .next
11773 .cindex "&[crypt()]&"
11774 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11775 only the first eight characters of the password. However, in modern operating
11776 systems this is no longer true, and in many cases the entire password is used,
11777 whatever its length.
11778
11779 .next
11780 .cindex "&[crypt16()]&"
11781 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11782 use up to 16 characters of the password in some operating systems. Again, in
11783 modern operating systems, more characters may be used.
11784 .endlist
11785 Exim has its own version of &[crypt16()]&, which is just a double call to
11786 &[crypt()]&. For operating systems that have their own version, setting
11787 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11788 operating system version instead of its own. This option is set by default in
11789 the OS-dependent &_Makefile_& for those operating systems that are known to
11790 support &[crypt16()]&.
11791
11792 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11793 it was not using the same algorithm as some operating systems' versions. It
11794 turns out that as well as &[crypt16()]& there is a function called
11795 &[bigcrypt()]& in some operating systems. This may or may not use the same
11796 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11797
11798 However, since there is now a move away from the traditional &[crypt()]&
11799 functions towards using SHA1 and other algorithms, tidying up this area of
11800 Exim is seen as very low priority.
11801
11802 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11803 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11804 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11805 default is &`{crypt}`&. Whatever the default, you can always use either
11806 function by specifying it explicitly in curly brackets.
11807
11808 .vitem &*def:*&<&'variable&~name'&>
11809 .cindex "expansion" "checking for empty variable"
11810 .cindex "&%def%& expansion condition"
11811 The &%def%& condition must be followed by the name of one of the expansion
11812 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11813 variable does not contain the empty string. For example:
11814 .code
11815 ${if def:sender_ident {from $sender_ident}}
11816 .endd
11817 Note that the variable name is given without a leading &%$%& character. If the
11818 variable does not exist, the expansion fails.
11819
11820 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11821         &~&*def:h_*&<&'header&~name'&>&*:*&"
11822 .cindex "expansion" "checking header line existence"
11823 This condition is true if a message is being processed and the named header
11824 exists in the message. For example,
11825 .code
11826 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11827 .endd
11828 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11829 the header name must be terminated by a colon if white space does not follow.
11830
11831 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11832        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11833 .cindex "string" "comparison"
11834 .cindex "expansion" "string comparison"
11835 .cindex "&%eq%& expansion condition"
11836 .cindex "&%eqi%& expansion condition"
11837 The two substrings are first expanded. The condition is true if the two
11838 resulting strings are identical. For &%eq%& the comparison includes the case of
11839 letters, whereas for &%eqi%& the comparison is case-independent, where
11840 case is defined per the system C locale.
11841
11842 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11843 .cindex "expansion" "file existence test"
11844 .cindex "file" "existence test"
11845 .cindex "&%exists%&, expansion condition"
11846 The substring is first expanded and then interpreted as an absolute path. The
11847 condition is true if the named file (or directory) exists. The existence test
11848 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11849 users' filter files may be locked out by the system administrator.
11850
11851 &*Note:*& Testing a path using this condition is not a sufficient way of
11852 de-tainting it.
11853 Consider using a dsearch lookup.
11854
11855 .vitem &*first_delivery*&
11856 .cindex "delivery" "first"
11857 .cindex "first delivery"
11858 .cindex "expansion" "first delivery test"
11859 .cindex "&%first_delivery%& expansion condition"
11860 .cindex retry condition
11861 This condition, which has no data, is true during a message's first delivery
11862 attempt. It is false during any subsequent delivery attempts.
11863
11864
11865 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11866        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11867 .cindex "list" "iterative conditions"
11868 .cindex "expansion" "&*forall*& condition"
11869 .cindex "expansion" "&*forany*& condition"
11870 .vindex "&$item$&"
11871 These conditions iterate over a list. The first argument is expanded to form
11872 the list. By default, the list separator is a colon, but it can be changed by
11873 the normal method (&<<SECTlistsepchange>>&).
11874 The second argument is interpreted as a condition that is to
11875 be applied to each item in the list in turn. During the interpretation of the
11876 condition, the current list item is placed in a variable called &$item$&.
11877 .ilist
11878 For &*forany*&, interpretation stops if the condition is true for any item, and
11879 the result of the whole condition is true. If the condition is false for all
11880 items in the list, the overall condition is false.
11881 .next
11882 For &*forall*&, interpretation stops if the condition is false for any item,
11883 and the result of the whole condition is false. If the condition is true for
11884 all items in the list, the overall condition is true.
11885 .endlist
11886 Note that negation of &*forany*& means that the condition must be false for all
11887 items for the overall condition to succeed, and negation of &*forall*& means
11888 that the condition must be false for at least one item.
11889
11890 Example:
11891 .code
11892 ${if forany{$recipients_list}{match{$item}{^user3@}}{yes}{no}}
11893 .endd
11894 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11895 being processed, to enable these expansion items to be nested.
11896
11897 To scan a named list, expand it with the &*listnamed*& operator.
11898
11899 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11900        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11901        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11902        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11903 .cindex JSON "iterative conditions"
11904 .cindex JSON expansions
11905 .cindex expansion "&*forall_json*& condition"
11906 .cindex expansion "&*forany_json*& condition"
11907 .cindex expansion "&*forall_jsons*& condition"
11908 .cindex expansion "&*forany_jsons*& condition"
11909 As for the above, except that the first argument must, after expansion,
11910 be a JSON array.
11911 The array separator is not changeable.
11912 For the &"jsons"& variants the elements are expected to be JSON strings
11913 and have their quotes removed before the evaluation of the condition.
11914
11915
11916
11917 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11918        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11919 .cindex "string" "comparison"
11920 .cindex "expansion" "string comparison"
11921 .cindex "&%ge%& expansion condition"
11922 .cindex "&%gei%& expansion condition"
11923 The two substrings are first expanded. The condition is true if the first
11924 string is lexically greater than or equal to the second string. For &%ge%& the
11925 comparison includes the case of letters, whereas for &%gei%& the comparison is
11926 case-independent.
11927 Case and collation order are defined per the system C locale.
11928
11929 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11930        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11931 .cindex "string" "comparison"
11932 .cindex "expansion" "string comparison"
11933 .cindex "&%gt%& expansion condition"
11934 .cindex "&%gti%& expansion condition"
11935 The two substrings are first expanded. The condition is true if the first
11936 string is lexically greater than the second string. For &%gt%& the comparison
11937 includes the case of letters, whereas for &%gti%& the comparison is
11938 case-independent.
11939 Case and collation order are defined per the system C locale.
11940
11941
11942 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11943 SRS decode.  See SECT &<<SECTSRS>>& for details.
11944
11945
11946 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11947        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11948 .cindex "string" "comparison"
11949 .cindex "list" "iterative conditions"
11950 Both strings are expanded; the second string is treated as a list of simple
11951 strings; if the first string is a member of the second, then the condition
11952 is true.
11953 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11954
11955 These are simpler to use versions of the more powerful &*forany*& condition.
11956 Examples, and the &*forany*& equivalents:
11957 .code
11958 ${if inlist{needle}{foo:needle:bar}}
11959   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11960 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11961   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11962 .endd
11963
11964 The variable &$value$& will be set for a successful match and can be
11965 used in the success clause of an &%if%& expansion item using the condition.
11966 .cindex "tainted data" "de-tainting"
11967 .cindex "de-tainting" "using an inlist expansion condition"
11968 It will have the same taint status as the list; expansions such as
11969 .code
11970 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11971 .endd
11972 can be used for de-tainting.
11973 Any previous &$value$& is restored after the if.
11974
11975
11976 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11977        &*isip4&~{*&<&'string'&>&*}*& &&&
11978        &*isip6&~{*&<&'string'&>&*}*&
11979 .cindex "IP address" "testing string format"
11980 .cindex "string" "testing for IP address"
11981 .cindex "&%isip%& expansion condition"
11982 .cindex "&%isip4%& expansion condition"
11983 .cindex "&%isip6%& expansion condition"
11984 The substring is first expanded, and then tested to see if it has the form of
11985 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11986 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11987
11988 For an IPv4 address, the test is for four dot-separated components, each of
11989 which consists of from one to three digits. For an IPv6 address, up to eight
11990 colon-separated components are permitted, each containing from one to four
11991 hexadecimal digits. There may be fewer than eight components if an empty
11992 component (adjacent colons) is present. Only one empty component is permitted.
11993
11994 &*Note*&: The checks used to be just on the form of the address; actual numerical
11995 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11996 check.
11997 This is no longer the case.
11998
11999 The main use of these tests is to distinguish between IP addresses and
12000 host names, or between IPv4 and IPv6 addresses. For example, you could use
12001 .code
12002 ${if isip4{$sender_host_address}...
12003 .endd
12004 to test which IP version an incoming SMTP connection is using.
12005
12006 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
12007 .cindex "LDAP" "use for authentication"
12008 .cindex "expansion" "LDAP authentication test"
12009 .cindex "&%ldapauth%& expansion condition"
12010 This condition supports user authentication using LDAP. See section
12011 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
12012 queries. For this use, the query must contain a user name and password. The
12013 query itself is not used, and can be empty. The condition is true if the
12014 password is not empty, and the user name and password are accepted by the LDAP
12015 server. An empty password is rejected without calling LDAP because LDAP binds
12016 with an empty password are considered anonymous regardless of the username, and
12017 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
12018 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
12019 this can be used.
12020
12021
12022 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
12023        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12024 .cindex "string" "comparison"
12025 .cindex "expansion" "string comparison"
12026 .cindex "&%le%& expansion condition"
12027 .cindex "&%lei%& expansion condition"
12028 The two substrings are first expanded. The condition is true if the first
12029 string is lexically less than or equal to the second string. For &%le%& the
12030 comparison includes the case of letters, whereas for &%lei%& the comparison is
12031 case-independent.
12032 Case and collation order are defined per the system C locale.
12033
12034 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
12035        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12036 .cindex "string" "comparison"
12037 .cindex "expansion" "string comparison"
12038 .cindex "&%lt%& expansion condition"
12039 .cindex "&%lti%& expansion condition"
12040 The two substrings are first expanded. The condition is true if the first
12041 string is lexically less than the second string. For &%lt%& the comparison
12042 includes the case of letters, whereas for &%lti%& the comparison is
12043 case-independent.
12044 Case and collation order are defined per the system C locale.
12045
12046
12047 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12048 .cindex "expansion" "regular expression comparison"
12049 .cindex "regular expressions" "match in expanded string"
12050 .cindex "&%match%& expansion condition"
12051 The two substrings are first expanded. The second is then treated as a regular
12052 expression and applied to the first. Because of the pre-expansion, if the
12053 regular expression contains dollar, or backslash characters, they must be
12054 escaped. Care must also be taken if the regular expression contains braces
12055 (curly brackets). A closing brace must be escaped so that it is not taken as a
12056 premature termination of <&'string2'&>. The easiest approach is to use the
12057 &`\N`& feature to disable expansion of the regular expression.
12058 For example,
12059 .code
12060 ${if match {$local_part}{\N^\d{3}\N} ...
12061 .endd
12062 If the whole expansion string is in double quotes, further escaping of
12063 backslashes is also required.
12064
12065 The condition is true if the regular expression match succeeds.
12066 The regular expression is not required to begin with a circumflex
12067 metacharacter, but if there is no circumflex, the expression is not anchored,
12068 and it may match anywhere in the subject, not just at the start. If you want
12069 the pattern to match at the end of the subject, you must include the &`$`&
12070 metacharacter at an appropriate point.
12071 All character handling is done in bytes and is not UTF-8 aware,
12072 but we might change this in a future Exim release.
12073
12074 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
12075 At the start of an &%if%& expansion the values of the numeric variable
12076 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
12077 succeeds causes them to be reset to the substrings of that condition and they
12078 will have these values during the expansion of the success string. At the end
12079 of the &%if%& expansion, the previous values are restored. After testing a
12080 combination of conditions using &%or%&, the subsequent values of the numeric
12081 variables are those of the condition that succeeded.
12082
12083 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12084 .cindex "&%match_address%& expansion condition"
12085 See &*match_local_part*&.
12086
12087 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12088 .cindex "&%match_domain%& expansion condition"
12089 See &*match_local_part*&.
12090
12091 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12092 .cindex "&%match_ip%& expansion condition"
12093 This condition matches an IP address to a list of IP address patterns. It must
12094 be followed by two argument strings. The first (after expansion) must be an IP
12095 address or an empty string. The second (not expanded) is a restricted host
12096 list that can match only an IP address, not a host name. For example:
12097 .code
12098 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12099 .endd
12100 The specific types of host list item that are permitted in the list are:
12101
12102 .ilist
12103 An IP address, optionally with a CIDR mask.
12104 .next
12105 A single asterisk, which matches any IP address.
12106 .next
12107 An empty item, which matches only if the IP address is empty. This could be
12108 useful for testing for a locally submitted message or one from specific hosts
12109 in a single test such as
12110 . ==== As this is a nested list, any displays it contains must be indented
12111 . ==== as otherwise they are too far to the left. This comment applies to
12112 . ==== the use of xmlto plus fop. There's no problem when formatting with
12113 . ==== sdop, with or without the extra indent.
12114 .code
12115   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12116 .endd
12117 where the first item in the list is the empty string.
12118 .next
12119 The item @[] matches any of the local host's interface addresses.
12120 .next
12121 Single-key lookups are assumed to be like &"net-"& style lookups in host lists
12122 (see section &<<SECThoslispatsikey>>&),
12123 even if &`net-`& is not specified. There is never any attempt to turn the IP
12124 address into a host name. The most common type of linear search for
12125 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12126 masks. For example:
12127 .code
12128   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12129 .endd
12130 It is of course possible to use other kinds of lookup, and in such a case, you
12131 do need to specify the &`net-`& prefix if you want to specify a specific
12132 address mask, for example:
12133 .code
12134   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12135 .endd
12136 However, unless you are combining a &%match_ip%& condition with others, it is
12137 just as easy to use the fact that a lookup is itself a condition, and write:
12138 .code
12139   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12140 .endd
12141 .endlist ilist
12142
12143 Note that <&'string2'&> is not itself subject to string expansion, unless
12144 Exim was built with the EXPAND_LISTMATCH_RHS option.
12145
12146 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12147
12148 The variable &$value$& will be set for a successful match and can be
12149 used in the success clause of an &%if%& expansion item using the condition.
12150 Any previous &$value$& is restored after the if.
12151
12152 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12153 .cindex "domain list" "in expansion condition"
12154 .cindex "address list" "in expansion condition"
12155 .cindex "local part" "list, in expansion condition"
12156 .cindex "&%match_local_part%& expansion condition"
12157 This condition, together with &%match_address%& and &%match_domain%&, make it
12158 possible to test domain, address, and local part lists within expansions. Each
12159 condition requires two arguments: an item and a list to match. A trivial
12160 example is:
12161 .code
12162 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12163 .endd
12164 In each case, the second argument may contain any of the allowable items for a
12165 list of the appropriate type. Also, because the second argument
12166 is a standard form of list, it is possible to refer to a named list.
12167 Thus, you can use conditions like this:
12168 .code
12169 ${if match_domain{$domain}{+local_domains}{...
12170 .endd
12171 .cindex "&`+caseful`&"
12172 For address lists, the matching starts off caselessly, but the &`+caseful`&
12173 item can be used, as in all address lists, to cause subsequent items to
12174 have their local parts matched casefully. Domains are always matched
12175 caselessly.
12176
12177 The variable &$value$& will be set for a successful match and can be
12178 used in the success clause of an &%if%& expansion item using the condition.
12179 .cindex "tainted data" "de-tainting"
12180 .cindex "de-tainting" "using a match_local_part expansion condition"
12181 It will have the same taint status as the list; expansions such as
12182 .code
12183 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12184 .endd
12185 can be used for de-tainting.
12186 Any previous &$value$& is restored after the if.
12187
12188 Note that <&'string2'&> is not itself subject to string expansion, unless
12189 Exim was built with the EXPAND_LISTMATCH_RHS option.
12190
12191 &*Note*&: Host lists are &'not'& supported in this way. This is because
12192 hosts have two identities: a name and an IP address, and it is not clear
12193 how to specify cleanly how such a test would work. However, IP addresses can be
12194 matched using &%match_ip%&.
12195
12196 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12197 .cindex "PAM authentication"
12198 .cindex "AUTH" "with PAM"
12199 .cindex "Solaris" "PAM support"
12200 .cindex "expansion" "PAM authentication test"
12201 .cindex "&%pam%& expansion condition"
12202 &'Pluggable Authentication Modules'&
12203 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12204 available in Solaris
12205 and in some GNU/Linux distributions.
12206 The Exim support, which is intended for use in conjunction with
12207 the SMTP AUTH command, is available only if Exim is compiled with
12208 .code
12209 SUPPORT_PAM=yes
12210 .endd
12211 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12212 in some releases of GNU/Linux &%-ldl%& is also needed.
12213
12214 The argument string is first expanded, and the result must be a
12215 colon-separated list of strings. Leading and trailing white space is ignored.
12216 The PAM module is initialized with the service name &"exim"& and the user name
12217 taken from the first item in the colon-separated data string (<&'string1'&>).
12218 The remaining items in the data string are passed over in response to requests
12219 from the authentication function. In the simple case there will only be one
12220 request, for a password, so the data consists of just two strings.
12221
12222 There can be problems if any of the strings are permitted to contain colon
12223 characters. In the usual way, these have to be doubled to avoid being taken as
12224 separators.
12225 The &%listquote%& expansion item can be used for this.
12226 For example, the configuration
12227 of a LOGIN authenticator might contain this setting:
12228 .code
12229 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12230 .endd
12231 In some operating systems, PAM authentication can be done only from a process
12232 running as root. Since Exim is running as the Exim user when receiving
12233 messages, this means that PAM cannot be used directly in those systems.
12234 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12235
12236
12237 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12238 .cindex "&'pwcheck'& daemon"
12239 .cindex "Cyrus"
12240 .cindex "expansion" "&'pwcheck'& authentication test"
12241 .cindex "&%pwcheck%& expansion condition"
12242 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12243 This is one way of making it possible for passwords to be checked by a process
12244 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12245 deprecated. Its replacement is &'saslauthd'& (see below).
12246
12247 The pwcheck support is not included in Exim by default. You need to specify
12248 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12249 building Exim. For example:
12250 .code
12251 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12252 .endd
12253 You do not need to install the full Cyrus software suite in order to use
12254 the pwcheck daemon. You can compile and install just the daemon alone
12255 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12256 access to the &_/var/pwcheck_& directory.
12257
12258 The &%pwcheck%& condition takes one argument, which must be the user name and
12259 password, separated by a colon. For example, in a LOGIN authenticator
12260 configuration, you might have this:
12261 .code
12262 server_condition = ${if pwcheck{$auth1:$auth2}}
12263 .endd
12264 Again, for a PLAIN authenticator configuration, this would be:
12265 .code
12266 server_condition = ${if pwcheck{$auth2:$auth3}}
12267 .endd
12268 .vitem &*queue_running*&
12269 .cindex "queue runner" "detecting when delivering from"
12270 .cindex "expansion" "queue runner test"
12271 .cindex "&%queue_running%& expansion condition"
12272 This condition, which has no data, is true during delivery attempts that are
12273 initiated by queue runner processes, and false otherwise.
12274
12275
12276 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12277 .cindex "Radius"
12278 .cindex "expansion" "Radius authentication"
12279 .cindex "&%radius%& expansion condition"
12280 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12281 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12282 the Radius client configuration file in order to build Exim with Radius
12283 support.
12284
12285 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12286 library, using the original API. If you are using release 0.4.0 or later of
12287 this library, you need to set
12288 .code
12289 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12290 .endd
12291 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12292 &%libradius%& library that comes with FreeBSD. To do this, set
12293 .code
12294 RADIUS_LIB_TYPE=RADLIB
12295 .endd
12296 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12297 You may also have to supply a suitable setting in EXTRALIBS so that the
12298 Radius library can be found when Exim is linked.
12299
12300 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12301 Radius client library, which calls the Radius server. The condition is true if
12302 the authentication is successful. For example:
12303 .code
12304 server_condition = ${if radius{<arguments>}}
12305 .endd
12306
12307
12308 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12309         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12310 .cindex "&'saslauthd'& daemon"
12311 .cindex "Cyrus"
12312 .cindex "expansion" "&'saslauthd'& authentication test"
12313 .cindex "&%saslauthd%& expansion condition"
12314 This condition supports user authentication using the Cyrus &'saslauthd'&
12315 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12316 Using this daemon is one way of making it possible for passwords to be checked
12317 by a process that is not running as root.
12318
12319 The saslauthd support is not included in Exim by default. You need to specify
12320 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12321 building Exim. For example:
12322 .code
12323 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12324 .endd
12325 You do not need to install the full Cyrus software suite in order to use
12326 the saslauthd daemon. You can compile and install just the daemon alone
12327 from the Cyrus SASL library.
12328
12329 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12330 two are mandatory. For example:
12331 .code
12332 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12333 .endd
12334 The service and the realm are optional (which is why the arguments are enclosed
12335 in their own set of braces). For details of the meaning of the service and
12336 realm, and how to run the daemon, consult the Cyrus documentation.
12337 .endlist vlist
12338
12339
12340
12341 .section "Combining expansion conditions" "SECID84"
12342 .cindex "expansion" "combining conditions"
12343 Several conditions can be tested at once by combining them using the &%and%&
12344 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12345 conditions on their own, and precede their lists of sub-conditions. Each
12346 sub-condition must be enclosed in braces within the overall braces that contain
12347 the list. No repetition of &%if%& is used.
12348
12349
12350 .vlist
12351 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12352 .cindex "&""or""& expansion condition"
12353 .cindex "expansion" "&""or""& of conditions"
12354 The sub-conditions are evaluated from left to right. The condition is true if
12355 any one of the sub-conditions is true.
12356 For example,
12357 .code
12358 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12359 .endd
12360 When a true sub-condition is found, the following ones are parsed but not
12361 evaluated. If there are several &"match"& sub-conditions the values of the
12362 numeric variables afterwards are taken from the first one that succeeds.
12363
12364 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12365 .cindex "&""and""& expansion condition"
12366 .cindex "expansion" "&""and""& of conditions"
12367 The sub-conditions are evaluated from left to right. The condition is true if
12368 all of the sub-conditions are true. If there are several &"match"&
12369 sub-conditions, the values of the numeric variables afterwards are taken from
12370 the last one. When a false sub-condition is found, the following ones are
12371 parsed but not evaluated.
12372 .endlist
12373 .ecindex IIDexpcond
12374
12375
12376
12377
12378 .section "Expansion variables" "SECTexpvar"
12379 .cindex "expansion" "variables, list of"
12380 This section contains an alphabetical list of all the expansion variables. Some
12381 of them are available only when Exim is compiled with specific options such as
12382 support for TLS or the content scanning extension.
12383 .cindex "tainted data"
12384 Variables marked as &'tainted'& are likely to carry data supplied by
12385 a potential attacker.
12386 Variables without such marking may also, depending on how their
12387 values are created.
12388 Such variables should not be further expanded,
12389 used as filenames
12390 or used as command-line arguments for external commands.
12391
12392 .vlist
12393 .vitem "&$0$&, &$1$&, etc"
12394 .cindex "numerical variables (&$1$& &$2$& etc)"
12395 When a &%match%& expansion condition succeeds, these variables contain the
12396 captured substrings identified by the regular expression during subsequent
12397 processing of the success string of the containing &%if%& expansion item.
12398 In the expansion condition case
12399 they do not retain their values afterwards; in fact, their previous
12400 values are restored at the end of processing an &%if%& item. The numerical
12401 variables may also be set externally by some other matching process which
12402 precedes the expansion of the string. For example, the commands available in
12403 Exim filter files include an &%if%& command with its own regular expression
12404 matching condition.
12405 If the subject string was tainted then any captured substring will also be.
12406
12407 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12408 Within an acl condition, expansion condition or expansion item
12409 any arguments are copied to these variables,
12410 any unused variables being made empty.
12411
12412 .vitem "&$acl_c...$&"
12413 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12414 can be given any name that starts with &$acl_c$& and is at least six characters
12415 long, but the sixth character must be either a digit or an underscore. For
12416 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12417 variables persist throughout the lifetime of an SMTP connection. They can be
12418 used to pass information between ACLs and between different invocations of the
12419 same ACL. When a message is received, the values of these variables are saved
12420 with the message, and can be accessed by filters, routers, and transports
12421 during subsequent delivery.
12422
12423 .vitem "&$acl_m...$&"
12424 These variables are like the &$acl_c...$& variables, except that their values
12425 are reset after a message has been received. Thus, if several messages are
12426 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12427 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12428 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12429 message is received, the values of these variables are saved with the message,
12430 and can be accessed by filters, routers, and transports during subsequent
12431 delivery.
12432
12433 .vitem &$acl_narg$&
12434 Within an acl condition, expansion condition or expansion item
12435 this variable has the number of arguments.
12436
12437 .vitem &$acl_verify_message$&
12438 .vindex "&$acl_verify_message$&"
12439 After an address verification has failed, this variable contains the failure
12440 message. It retains its value for use in subsequent modifiers of the verb.
12441 The message can be preserved by coding like this:
12442 .code
12443 warn !verify = sender
12444      set acl_m0 = $acl_verify_message
12445 .endd
12446 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12447 &%log_message%& modifiers, to include information about the verification
12448 failure.
12449 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12450
12451 .vitem &$address_data$&
12452 .vindex "&$address_data$&"
12453 This variable is set by means of the &%address_data%& option in routers. The
12454 value then remains with the address while it is processed by subsequent routers
12455 and eventually a transport. If the transport is handling multiple addresses,
12456 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12457 for more details. &*Note*&: The contents of &$address_data$& are visible in
12458 user filter files.
12459
12460 If &$address_data$& is set when the routers are called from an ACL to verify
12461 a recipient address, the final value is still in the variable for subsequent
12462 conditions and modifiers of the ACL statement. If routing the address caused it
12463 to be redirected to just one address, the child address is also routed as part
12464 of the verification, and in this case the final value of &$address_data$& is
12465 from the child's routing.
12466
12467 If &$address_data$& is set when the routers are called from an ACL to verify a
12468 sender address, the final value is also preserved, but this time in
12469 &$sender_address_data$&, to distinguish it from data from a recipient
12470 address.
12471
12472 In both cases (recipient and sender verification), the value does not persist
12473 after the end of the current ACL statement. If you want to preserve
12474 these values for longer, you can save them in ACL variables.
12475
12476 .vitem &$address_file$&
12477 .vindex "&$address_file$&"
12478 When, as a result of aliasing, forwarding, or filtering, a message is directed
12479 to a specific file, this variable holds the name of the file when the transport
12480 is running. At other times, the variable is empty. For example, using the
12481 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12482 .code
12483 /home/r2d2/savemail
12484 .endd
12485 then when the &(address_file)& transport is running, &$address_file$&
12486 contains the text string &`/home/r2d2/savemail`&.
12487 .cindex "Sieve filter" "value of &$address_file$&"
12488 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12489 then up to the transport configuration to generate an appropriate absolute path
12490 to the relevant file.
12491
12492 .vitem &$address_pipe$&
12493 .vindex "&$address_pipe$&"
12494 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12495 this variable holds the pipe command when the transport is running.
12496
12497 .vitem "&$auth1$& &-- &$auth4$&"
12498 .vindex "&$auth1$&, &$auth2$&, etc"
12499 These variables are used in SMTP authenticators (see chapters
12500 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12501
12502 .vitem &$authenticated_id$&
12503 .cindex "authentication" "id"
12504 .vindex "&$authenticated_id$&"
12505 When a server successfully authenticates a client it may be configured to
12506 preserve some of the authentication information in the variable
12507 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12508 user/password authenticator configuration might preserve the user name for use
12509 in the routers. Note that this is not the same information that is saved in
12510 &$sender_host_authenticated$&.
12511
12512 When a message is submitted locally (that is, not over a TCP connection)
12513 the value of &$authenticated_id$& is normally the login name of the calling
12514 process. However, a trusted user can override this by means of the &%-oMai%&
12515 command line option.
12516 This second case also sets up information used by the
12517 &$authresults$& expansion item.
12518
12519 .vitem &$authenticated_fail_id$&
12520 .cindex "authentication" "fail" "id"
12521 .vindex "&$authenticated_fail_id$&"
12522 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12523 will contain the failed authentication id. If more than one authentication
12524 id is attempted, it will contain only the last one. The variable is
12525 available for processing in the ACL's, generally the quit or notquit ACL.
12526 A message to a local recipient could still be accepted without requiring
12527 authentication, which means this variable could also be visible in all of
12528 the ACL's as well.
12529
12530
12531 .tvar &$authenticated_sender$&
12532 .cindex "sender" "authenticated"
12533 .cindex "authentication" "sender"
12534 .cindex "AUTH" "on MAIL command"
12535 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12536 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12537 described in section &<<SECTauthparamail>>&. Unless the data is the string
12538 &"<>"&, it is set as the authenticated sender of the message, and the value is
12539 available during delivery in the &$authenticated_sender$& variable. If the
12540 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12541
12542 .vindex "&$qualify_domain$&"
12543 When a message is submitted locally (that is, not over a TCP connection), the
12544 value of &$authenticated_sender$& is an address constructed from the login
12545 name of the calling process and &$qualify_domain$&, except that a trusted user
12546 can override this by means of the &%-oMas%& command line option.
12547
12548
12549 .vitem &$authentication_failed$&
12550 .cindex "authentication" "failure"
12551 .vindex "&$authentication_failed$&"
12552 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12553 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12554 possible to distinguish between &"did not try to authenticate"&
12555 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12556 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12557 is empty and &$authentication_failed$& is set to &"1"&).
12558 Failure includes cancellation of a authentication attempt,
12559 and any negative response to an AUTH command,
12560 (including, for example, an attempt to use an undefined mechanism).
12561
12562 .vitem &$av_failed$&
12563 .cindex "content scanning" "AV scanner failure"
12564 This variable is available when Exim is compiled with the content-scanning
12565 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12566 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12567 the ACL malware condition.
12568
12569 .vitem &$body_linecount$&
12570 .cindex "message body" "line count"
12571 .cindex "body of message" "line count"
12572 .vindex "&$body_linecount$&"
12573 When a message is being received or delivered, this variable contains the
12574 number of lines in the message's body. See also &$message_linecount$&.
12575
12576 .vitem &$body_zerocount$&
12577 .cindex "message body" "binary zero count"
12578 .cindex "body of message" "binary zero count"
12579 .cindex "binary zero" "in message body"
12580 .vindex "&$body_zerocount$&"
12581 When a message is being received or delivered, this variable contains the
12582 number of binary zero bytes (ASCII NULs) in the message's body.
12583
12584 .vitem &$bounce_recipient$&
12585 .vindex "&$bounce_recipient$&"
12586 This is set to the recipient address of a bounce message while Exim is creating
12587 it. It is useful if a customized bounce message text file is in use (see
12588 chapter &<<CHAPemsgcust>>&).
12589
12590 .vitem &$bounce_return_size_limit$&
12591 .vindex "&$bounce_return_size_limit$&"
12592 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12593 up to a multiple of 1000. It is useful when a customized error message text
12594 file is in use (see chapter &<<CHAPemsgcust>>&).
12595
12596 .vitem &$caller_gid$&
12597 .cindex "gid (group id)" "caller"
12598 .vindex "&$caller_gid$&"
12599 The real group id under which the process that called Exim was running. This is
12600 not the same as the group id of the originator of a message (see
12601 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12602 incarnation normally contains the Exim gid.
12603
12604 .vitem &$caller_uid$&
12605 .cindex "uid (user id)" "caller"
12606 .vindex "&$caller_uid$&"
12607 The real user id under which the process that called Exim was running. This is
12608 not the same as the user id of the originator of a message (see
12609 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12610 incarnation normally contains the Exim uid.
12611
12612 .vitem &$callout_address$&
12613 .vindex "&$callout_address$&"
12614 After a callout for verification, spamd or malware daemon service, the
12615 address that was connected to.
12616
12617 .vitem &$compile_number$&
12618 .vindex "&$compile_number$&"
12619 The building process for Exim keeps a count of the number
12620 of times it has been compiled. This serves to distinguish different
12621 compilations of the same version of Exim.
12622
12623 .vitem &$config_dir$&
12624 .vindex "&$config_dir$&"
12625 The directory name of the main configuration file. That is, the content of
12626 &$config_file$& with the last component stripped. The value does not
12627 contain the trailing slash. If &$config_file$& does not contain a slash,
12628 &$config_dir$& is ".".
12629
12630 .vitem &$config_file$&
12631 .vindex "&$config_file$&"
12632 The name of the main configuration file Exim is using.
12633
12634 .vitem &$connection_id$&
12635 .vindex "&$connection_id$&"
12636 .cindex connection "identifier logging"
12637 An identifier for the accepted connection, for use in custom logging.
12638
12639 .vitem &$dkim_verify_status$&
12640 Results of DKIM verification.
12641 For details see section &<<SECDKIMVFY>>&.
12642
12643 .vitem &$dkim_cur_signer$& &&&
12644        &$dkim_verify_reason$& &&&
12645        &$dkim_domain$& &&&
12646        &$dkim_identity$& &&&
12647        &$dkim_selector$& &&&
12648        &$dkim_algo$& &&&
12649        &$dkim_canon_body$& &&&
12650        &$dkim_canon_headers$& &&&
12651        &$dkim_copiedheaders$& &&&
12652        &$dkim_bodylength$& &&&
12653        &$dkim_created$& &&&
12654        &$dkim_expires$& &&&
12655        &$dkim_headernames$& &&&
12656        &$dkim_key_testing$& &&&
12657        &$dkim_key_nosubdomains$& &&&
12658        &$dkim_key_srvtype$& &&&
12659        &$dkim_key_granularity$& &&&
12660        &$dkim_key_notes$& &&&
12661        &$dkim_key_length$&
12662 These variables are only available within the DKIM ACL.
12663 For details see section &<<SECDKIMVFY>>&.
12664
12665 .vitem &$dkim_signers$&
12666 .vindex &$dkim_signers$&
12667 When a message has been received this variable contains
12668 a colon-separated list of signer domains and identities for the message.
12669 For details see section &<<SECDKIMVFY>>&.
12670
12671 .vitem &$dmarc_domain_policy$& &&&
12672        &$dmarc_status$& &&&
12673        &$dmarc_status_text$& &&&
12674        &$dmarc_used_domains$&
12675 Results of DMARC verification.
12676 For details see section &<<SECDMARC>>&.
12677
12678 .vitem &$dnslist_domain$& &&&
12679        &$dnslist_matched$& &&&
12680        &$dnslist_text$& &&&
12681        &$dnslist_value$&
12682 .vindex "&$dnslist_domain$&"
12683 .vindex "&$dnslist_matched$&"
12684 .vindex "&$dnslist_text$&"
12685 .vindex "&$dnslist_value$&"
12686 .cindex "black list (DNS)"
12687 When a DNS (black) list lookup succeeds, these variables are set to contain
12688 the following data from the lookup: the list's domain name, the key that was
12689 looked up, the contents of any associated TXT record, and the value from the
12690 main A record. See section &<<SECID204>>& for more details.
12691
12692 .tvar &$domain$&
12693 When an address is being routed, or delivered on its own, this variable
12694 contains the domain. Uppercase letters in the domain are converted into lower
12695 case for &$domain$&.
12696
12697 Global address rewriting happens when a message is received, so the value of
12698 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12699 is set during user filtering, but not during system filtering, because a
12700 message may have many recipients and the system filter is called just once.
12701
12702 When more than one address is being delivered at once (for example, several
12703 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12704 have the same domain. Transports can be restricted to handling only one domain
12705 at a time if the value of &$domain$& is required at transport time &-- this is
12706 the default for local transports. For further details of the environment in
12707 which local transports are run, see chapter &<<CHAPenvironment>>&.
12708
12709 .oindex "&%delay_warning_condition%&"
12710 At the end of a delivery, if all deferred addresses have the same domain, it is
12711 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12712
12713 The &$domain$& variable is also used in some other circumstances:
12714
12715 .ilist
12716 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12717 the recipient address. The domain of the &'sender'& address is in
12718 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12719 normally set during the running of the MAIL ACL. However, if the sender address
12720 is verified with a callout during the MAIL ACL, the sender domain is placed in
12721 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12722 the &(smtp)& transport.
12723
12724 .next
12725 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12726 &$domain$& contains the domain portion of the address that is being rewritten;
12727 it can be used in the expansion of the replacement address, for example, to
12728 rewrite domains by file lookup.
12729
12730 .next
12731 With one important exception, whenever a domain list is being scanned,
12732 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12733 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12734 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12735 that, in a RCPT ACL, the sender domain list can be dependent on the
12736 recipient domain (which is what is in &$domain$& at this time).
12737
12738 .next
12739 .cindex "ETRN" "value of &$domain$&"
12740 .oindex "&%smtp_etrn_command%&"
12741 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12742 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12743 .endlist
12744
12745 .cindex "tainted data"
12746 If the origin of the data is an incoming message,
12747 the result of expanding this variable is tainted and may not
12748 be further expanded or used as a filename.
12749 When an untainted version is needed, one should be obtained from
12750 looking up the value in a local (therefore trusted) database.
12751 Often &$domain_data$& is usable in this role.
12752
12753
12754 .vitem &$domain_data$&
12755 .vindex "&$domain_data$&"
12756 When the &%domains%& condition on a router
12757 or an ACL
12758 matches a domain
12759 against a list, the match value is copied to &$domain_data$&.
12760 This is an enhancement over previous versions of Exim, when it only
12761 applied to the data read by a lookup.
12762 For details on match values see section &<<SECTlistresults>>& et. al.
12763
12764 If the router routes the
12765 address to a transport, the value is available in that transport. If the
12766 transport is handling multiple addresses, the value from the first address is
12767 used.
12768
12769 &$domain_data$& set in an ACL is available during
12770 the rest of the ACL statement.
12771
12772 .vitem &$exim_gid$&
12773 .vindex "&$exim_gid$&"
12774 This variable contains the numerical value of the Exim group id.
12775
12776 .vitem &$exim_path$&
12777 .vindex "&$exim_path$&"
12778 This variable contains the path to the Exim binary.
12779
12780 .vitem &$exim_uid$&
12781 .vindex "&$exim_uid$&"
12782 This variable contains the numerical value of the Exim user id.
12783
12784 .vitem &$exim_version$&
12785 .vindex "&$exim_version$&"
12786 This variable contains the version string of the Exim build.
12787 The first character is a major version number, currently 4.
12788 Then after a dot, the next group of digits is a minor version number.
12789 There may be other characters following the minor version.
12790 This value may be overridden by the &%exim_version%& main config option.
12791
12792 .vitem &$header_$&<&'name'&>
12793 .tmark
12794 This is not strictly an expansion variable. It is expansion syntax for
12795 inserting the message header line with the given name. Note that the name must
12796 be terminated by colon or white space, because it may contain a wide variety of
12797 characters. Note also that braces must &'not'& be used.
12798 See the full description in section &<<SECTexpansionitems>>& above.
12799
12800 .vitem &$headers_added$&
12801 .vindex "&$headers_added$&"
12802 Within an ACL this variable contains the headers added so far by
12803 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12804 The headers are a newline-separated list.
12805
12806 .vitem &$home$&
12807 .vindex "&$home$&"
12808 When the &%check_local_user%& option is set for a router, the user's home
12809 directory is placed in &$home$& when the check succeeds. In particular, this
12810 means it is set during the running of users' filter files. A router may also
12811 explicitly set a home directory for use by a transport; this can be overridden
12812 by a setting on the transport itself.
12813
12814 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12815 of the environment variable HOME, which is subject to the
12816 &%keep_environment%& and &%add_environment%& main config options.
12817
12818 .vitem &$host$&
12819 .vindex "&$host$&"
12820 If a router assigns an address to a transport (any transport), and passes a
12821 list of hosts with the address, the value of &$host$& when the transport starts
12822 to run is the name of the first host on the list. Note that this applies both
12823 to local and remote transports.
12824
12825 .cindex "transport" "filter"
12826 .cindex "filter" "transport filter"
12827 For the &(smtp)& transport, if there is more than one host, the value of
12828 &$host$& changes as the transport works its way through the list. In
12829 particular, when the &(smtp)& transport is expanding its options for encryption
12830 using TLS, or for specifying a transport filter (see chapter
12831 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12832 is connected.
12833
12834 When used in the client part of an authenticator configuration (see chapter
12835 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12836 client is connected.
12837
12838
12839 .vitem &$host_address$&
12840 .vindex "&$host_address$&"
12841 This variable is set to the remote host's IP address whenever &$host$& is set
12842 for a remote connection. It is also set to the IP address that is being checked
12843 when the &%ignore_target_hosts%& option is being processed.
12844
12845 .vitem &$host_data$&
12846 .vindex "&$host_data$&"
12847 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12848 result of the lookup is made available in the &$host_data$& variable. This
12849 allows you, for example, to do things like this:
12850 .code
12851 deny  hosts = net-lsearch;/some/file
12852       message = $host_data
12853 .endd
12854
12855 .vitem &$host_lookup_deferred$&
12856 .cindex "host name" "lookup, failure of"
12857 .vindex "&$host_lookup_deferred$&"
12858 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12859 message comes from a remote host and there is an attempt to look up the host's
12860 name from its IP address, and the attempt is not successful, one of these
12861 variables is set to &"1"&.
12862
12863 .ilist
12864 If the lookup receives a definite negative response (for example, a DNS lookup
12865 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12866
12867 .next
12868 If there is any kind of problem during the lookup, such that Exim cannot
12869 tell whether or not the host name is defined (for example, a timeout for a DNS
12870 lookup), &$host_lookup_deferred$& is set to &"1"&.
12871 .endlist ilist
12872
12873 Looking up a host's name from its IP address consists of more than just a
12874 single reverse lookup. Exim checks that a forward lookup of at least one of the
12875 names it receives from a reverse lookup yields the original IP address. If this
12876 is not the case, Exim does not accept the looked up name(s), and
12877 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12878 IP address (for example, the existence of a PTR record in the DNS) is not
12879 sufficient on its own for the success of a host name lookup. If the reverse
12880 lookup succeeds, but there is a lookup problem such as a timeout when checking
12881 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12882 &"1"&. See also &$sender_host_name$&.
12883
12884 .cindex authentication "expansion item"
12885 Performing these checks sets up information used by the
12886 &%authresults%& expansion item.
12887
12888
12889 .vitem &$host_lookup_failed$&
12890 .vindex "&$host_lookup_failed$&"
12891 See &$host_lookup_deferred$&.
12892
12893 .vitem &$host_port$&
12894 .vindex "&$host_port$&"
12895 This variable is set to the remote host's TCP port whenever &$host$& is set
12896 for an outbound connection.
12897
12898 .vitem &$initial_cwd$&
12899 .vindex "&$initial_cwd$&
12900 This variable contains the full path name of the initial working
12901 directory of the current Exim process. This may differ from the current
12902 working directory, as Exim changes this to "/" during early startup, and
12903 to &$spool_directory$& later.
12904
12905 .vitem &$inode$&
12906 .vindex "&$inode$&"
12907 The only time this variable is set is while expanding the &%directory_file%&
12908 option in the &(appendfile)& transport. The variable contains the inode number
12909 of the temporary file which is about to be renamed. It can be used to construct
12910 a unique name for the file.
12911
12912 .vitem &$interface_address$& &&&
12913        &$interface_port$&
12914 .vindex "&$interface_address$&"
12915 .vindex "&$interface_port$&"
12916 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12917
12918 .vitem &$item$&
12919 .vindex "&$item$&"
12920 This variable is used during the expansion of &*forall*& and &*forany*&
12921 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12922 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12923 empty.
12924
12925 .vitem &$ldap_dn$&
12926 .vindex "&$ldap_dn$&"
12927 This variable, which is available only when Exim is compiled with LDAP support,
12928 contains the DN from the last entry in the most recently successful LDAP
12929 lookup.
12930
12931 .vitem &$load_average$&
12932 .vindex "&$load_average$&"
12933 This variable contains the system load average, multiplied by 1000 so that it
12934 is an integer. For example, if the load average is 0.21, the value of the
12935 variable is 210. The value is recomputed every time the variable is referenced.
12936
12937 .tvar &$local_part$&
12938 When an address is being routed, or delivered on its own, this
12939 variable contains the local part. When a number of addresses are being
12940 delivered together (for example, multiple RCPT commands in an SMTP
12941 session), &$local_part$& is not set.
12942
12943 Global address rewriting happens when a message is received, so the value of
12944 &$local_part$& during routing and delivery is the value after rewriting.
12945 &$local_part$& is set during user filtering, but not during system filtering,
12946 because a message may have many recipients and the system filter is called just
12947 once.
12948
12949 .cindex "tainted data"
12950 If the origin of the data is an incoming message,
12951 the result of expanding this variable is tainted and
12952 may not be further expanded or used as a filename.
12953
12954 &*Warning*&: the content of this variable is usually provided by a potential
12955 attacker.
12956 Consider carefully the implications of using it unvalidated as a name
12957 for file access.
12958 This presents issues for users' &_.forward_& and filter files.
12959 For traditional full user accounts, use &%check_local_users%& and the
12960 &$local_part_data$& variable rather than this one.
12961 For virtual users, store a suitable pathname component in the database
12962 which is used for account name validation, and use that retrieved value
12963 rather than this variable.
12964 Often &$local_part_data$& is usable in this role.
12965 If needed, use a router &%address_data%& or &%set%& option for
12966 the retrieved data.
12967
12968 When a message is being delivered to a file, pipe, or autoreply transport as a
12969 result of aliasing or forwarding, &$local_part$& is set to the local part of
12970 the parent address, not to the filename or command (see &$address_file$& and
12971 &$address_pipe$&).
12972
12973 When an ACL is running for a RCPT command, &$local_part$& contains the
12974 local part of the recipient address.
12975
12976 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12977 &$local_part$& contains the local part of the address that is being rewritten;
12978 it can be used in the expansion of the replacement address, for example.
12979
12980 In all cases, all quoting is removed from the local part. For example, for both
12981 the addresses
12982 .code
12983 "abc:xyz"@test.example
12984 abc\:xyz@test.example
12985 .endd
12986 the value of &$local_part$& is
12987 .code
12988 abc:xyz
12989 .endd
12990 If you use &$local_part$& to create another address, you should always wrap it
12991 inside a quoting operator. For example, in a &(redirect)& router you could
12992 have:
12993 .code
12994 data = ${quote_local_part:$local_part}@new.domain.example
12995 .endd
12996 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12997 to process local parts in a case-dependent manner in a router, you can set the
12998 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12999
13000 .vitem &$local_part_data$&
13001 .vindex "&$local_part_data$&"
13002 When the &%local_parts%& condition on a router or ACL
13003 matches a local part list
13004 the match value is copied to &$local_part_data$&.
13005 This is an enhancement over previous versions of Exim, when it only
13006 applied to the data read by a lookup.
13007 For details on match values see section &<<SECTlistresults>>& et. al.
13008
13009 The &%check_local_user%& router option also sets this variable.
13010
13011 .vindex &$local_part_prefix$& &&&
13012         &$local_part_prefix_v$& &&&
13013         &$local_part_suffix$& &&&
13014         &$local_part_suffix_v$&
13015 .cindex affix variables
13016 If a local part prefix or suffix has been recognized, it is not included in the
13017 value of &$local_part$& during routing and subsequent delivery. The values of
13018 any prefix or suffix are in &$local_part_prefix$& and
13019 &$local_part_suffix$&, respectively.
13020 .cindex "tainted data"
13021 If the specification did not include a wildcard then
13022 the affix variable value is not tainted.
13023
13024 If the affix specification included a wildcard then the portion of
13025 the affix matched by the wildcard is in
13026 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
13027 and both the whole and varying values are tainted.
13028
13029 .vitem &$local_scan_data$&
13030 .vindex "&$local_scan_data$&"
13031 This variable contains the text returned by the &[local_scan()]& function when
13032 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
13033
13034 .vitem &$local_user_gid$&
13035 .vindex "&$local_user_gid$&"
13036 See &$local_user_uid$&.
13037
13038 .vitem &$local_user_uid$&
13039 .vindex "&$local_user_uid$&"
13040 This variable and &$local_user_gid$& are set to the uid and gid after the
13041 &%check_local_user%& router precondition succeeds. This means that their values
13042 are available for the remaining preconditions (&%senders%&, &%require_files%&,
13043 and &%condition%&), for the &%address_data%& expansion, and for any
13044 router-specific expansions. At all other times, the values in these variables
13045 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
13046
13047 .vitem &$localhost_number$&
13048 .vindex "&$localhost_number$&"
13049 This contains the expanded value of the
13050 &%localhost_number%& option. The expansion happens after the main options have
13051 been read.
13052
13053 .vitem &$log_inodes$&
13054 .vindex "&$log_inodes$&"
13055 The number of free inodes in the disk partition where Exim's
13056 log files are being written. The value is recalculated whenever the variable is
13057 referenced. If the relevant file system does not have the concept of inodes,
13058 the value of is -1. See also the &%check_log_inodes%& option.
13059
13060 .vitem &$log_space$&
13061 .vindex "&$log_space$&"
13062 The amount of free space (as a number of kilobytes) in the disk
13063 partition where Exim's log files are being written. The value is recalculated
13064 whenever the variable is referenced. If the operating system does not have the
13065 ability to find the amount of free space (only true for experimental systems),
13066 the space value is -1. See also the &%check_log_space%& option.
13067
13068
13069 .vitem &$lookup_dnssec_authenticated$&
13070 .vindex "&$lookup_dnssec_authenticated$&"
13071 This variable is set after a DNS lookup done by
13072 a dnsdb lookup expansion, dnslookup router or smtp transport.
13073 .cindex "DNS" "DNSSEC"
13074 It will be empty if &(DNSSEC)& was not requested,
13075 &"no"& if the result was not labelled as authenticated data
13076 and &"yes"& if it was.
13077 Results that are labelled as authoritative answer that match
13078 the &%dns_trust_aa%& configuration variable count also
13079 as authenticated data.
13080
13081 .vitem &$mailstore_basename$&
13082 .vindex "&$mailstore_basename$&"
13083 This variable is set only when doing deliveries in &"mailstore"& format in the
13084 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
13085 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
13086 contains the basename of the files that are being written, that is, the name
13087 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
13088 variable is empty.
13089
13090 .vitem &$malware_name$&
13091 .vindex "&$malware_name$&"
13092 This variable is available when Exim is compiled with the
13093 content-scanning extension. It is set to the name of the virus that was found
13094 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
13095
13096 .vitem &$max_received_linelength$&
13097 .vindex "&$max_received_linelength$&"
13098 .cindex "maximum" "line length"
13099 .cindex "line length" "maximum"
13100 This variable contains the number of bytes in the longest line that was
13101 received as part of the message, not counting the line termination
13102 character(s).
13103 It is not valid if the &%spool_wireformat%& option is used.
13104
13105 .vitem &$message_age$&
13106 .cindex "message" "age of"
13107 .vindex "&$message_age$&"
13108 This variable is set at the start of a delivery attempt to contain the number
13109 of seconds since the message was received. It does not change during a single
13110 delivery attempt.
13111
13112 .tvar &$message_body$&
13113 .cindex "body of message" "expansion variable"
13114 .cindex "message body" "in expansion"
13115 .cindex "binary zero" "in message body"
13116 .oindex "&%message_body_visible%&"
13117 This variable contains the initial portion of a message's body while it is
13118 being delivered, and is intended mainly for use in filter files. The maximum
13119 number of characters of the body that are put into the variable is set by the
13120 &%message_body_visible%& configuration option; the default is 500.
13121
13122 .oindex "&%message_body_newlines%&"
13123 By default, newlines are converted into spaces in &$message_body$&, to make it
13124 easier to search for phrases that might be split over a line break. However,
13125 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13126 zeros are always converted into spaces.
13127
13128 .tvar &$message_body_end$&
13129 .cindex "body of message" "expansion variable"
13130 .cindex "message body" "in expansion"
13131 This variable contains the final portion of a message's
13132 body while it is being delivered. The format and maximum size are as for
13133 &$message_body$&.
13134
13135 .vitem &$message_body_size$&
13136 .cindex "body of message" "size"
13137 .cindex "message body" "size"
13138 .vindex "&$message_body_size$&"
13139 When a message is being delivered, this variable contains the size of the body
13140 in bytes. The count starts from the character after the blank line that
13141 separates the body from the header. Newlines are included in the count. See
13142 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13143
13144 If the spool file is wireformat
13145 (see the &%spool_wireformat%& main option)
13146 the CRLF line-terminators are included in the count.
13147
13148 .vitem &$message_exim_id$&
13149 .vindex "&$message_exim_id$&"
13150 When a message is being received or delivered, this variable contains the
13151 unique message id that is generated and used by Exim to identify the message.
13152 An id is not created for a message until after its header has been successfully
13153 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13154 line; it is the local id that Exim assigns to the message, for example:
13155 &`1BXTIK-0001yO-VA`&.
13156
13157 .tvar &$message_headers$&
13158 This variable contains a concatenation of all the header lines when a message
13159 is being processed, except for lines added by routers or transports. The header
13160 lines are separated by newline characters. Their contents are decoded in the
13161 same way as a header line that is inserted by &%bheader%&.
13162
13163 .tvar &$message_headers_raw$&
13164 This variable is like &$message_headers$& except that no processing of the
13165 contents of header lines is done.
13166
13167 .vitem &$message_id$&
13168 This is an old name for &$message_exim_id$&. It is now deprecated.
13169
13170 .vitem &$message_linecount$&
13171 .vindex "&$message_linecount$&"
13172 This variable contains the total number of lines in the header and body of the
13173 message. Compare &$body_linecount$&, which is the count for the body only.
13174 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13175 number of lines received. Before delivery happens (that is, before filters,
13176 routers, and transports run) the count is increased to include the
13177 &'Received:'& header line that Exim standardly adds, and also any other header
13178 lines that are added by ACLs. The blank line that separates the message header
13179 from the body is not counted.
13180
13181 As with the special case of &$message_size$&, during the expansion of the
13182 appendfile transport's maildir_tag option in maildir format, the value of
13183 &$message_linecount$& is the precise size of the number of newlines in the
13184 file that has been written (minus one for the blank line between the
13185 header and the body).
13186
13187 Here is an example of the use of this variable in a DATA ACL:
13188 .code
13189 deny condition = \
13190       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13191      message   = Too many lines in message header
13192 .endd
13193 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13194 message has not yet been received.
13195
13196 This variable is not valid if the &%spool_wireformat%& option is used.
13197
13198 .vitem &$message_size$&
13199 .cindex "size" "of message"
13200 .cindex "message" "size"
13201 .vindex "&$message_size$&"
13202 When a message is being processed, this variable contains its size in bytes. In
13203 most cases, the size includes those headers that were received with the
13204 message, but not those (such as &'Envelope-to:'&) that are added to individual
13205 deliveries as they are written. However, there is one special case: during the
13206 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13207 doing a delivery in maildir format, the value of &$message_size$& is the
13208 precise size of the file that has been written. See also
13209 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13210
13211 .cindex "RCPT" "value of &$message_size$&"
13212 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13213 contains the size supplied on the MAIL command, or -1 if no size was given. The
13214 value may not, of course, be truthful.
13215
13216 .vitem &$mime_anomaly_level$& &&&
13217        &$mime_anomaly_text$& &&&
13218        &$mime_boundary$& &&&
13219        &$mime_charset$& &&&
13220        &$mime_content_description$& &&&
13221        &$mime_content_disposition$& &&&
13222        &$mime_content_id$& &&&
13223        &$mime_content_size$& &&&
13224        &$mime_content_transfer_encoding$& &&&
13225        &$mime_content_type$& &&&
13226        &$mime_decoded_filename$& &&&
13227        &$mime_filename$& &&&
13228        &$mime_is_coverletter$& &&&
13229        &$mime_is_multipart$& &&&
13230        &$mime_is_rfc822$& &&&
13231        &$mime_part_count$&
13232 A number of variables whose names start with &$mime$& are
13233 available when Exim is compiled with the content-scanning extension. For
13234 details, see section &<<SECTscanmimepart>>&.
13235
13236 .vitem "&$n0$& &-- &$n9$&"
13237 These variables are counters that can be incremented by means
13238 of the &%add%& command in filter files.
13239
13240 .tvar &$original_domain$&
13241 .vindex "&$domain$&"
13242 When a top-level address is being processed for delivery, this contains the
13243 same value as &$domain$&. However, if a &"child"& address (for example,
13244 generated by an alias, forward, or filter file) is being processed, this
13245 variable contains the domain of the original address (lower cased). This
13246 differs from &$parent_domain$& only when there is more than one level of
13247 aliasing or forwarding. When more than one address is being delivered in a
13248 single transport run, &$original_domain$& is not set.
13249
13250 If a new address is created by means of a &%deliver%& command in a system
13251 filter, it is set up with an artificial &"parent"& address. This has the local
13252 part &'system-filter'& and the default qualify domain.
13253
13254 .tvar &$original_local_part$&
13255 .vindex "&$local_part$&"
13256 When a top-level address is being processed for delivery, this contains the
13257 same value as &$local_part$&, unless a prefix or suffix was removed from the
13258 local part, because &$original_local_part$& always contains the full local
13259 part. When a &"child"& address (for example, generated by an alias, forward, or
13260 filter file) is being processed, this variable contains the full local part of
13261 the original address.
13262
13263 If the router that did the redirection processed the local part
13264 case-insensitively, the value in &$original_local_part$& is in lower case.
13265 This variable differs from &$parent_local_part$& only when there is more than
13266 one level of aliasing or forwarding. When more than one address is being
13267 delivered in a single transport run, &$original_local_part$& is not set.
13268
13269 If a new address is created by means of a &%deliver%& command in a system
13270 filter, it is set up with an artificial &"parent"& address. This has the local
13271 part &'system-filter'& and the default qualify domain.
13272
13273 .vitem &$originator_gid$&
13274 .cindex "gid (group id)" "of originating user"
13275 .cindex "sender" "gid"
13276 .vindex "&$caller_gid$&"
13277 .vindex "&$originator_gid$&"
13278 This variable contains the value of &$caller_gid$& that was set when the
13279 message was received. For messages received via the command line, this is the
13280 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13281 normally the gid of the Exim user.
13282
13283 .vitem &$originator_uid$&
13284 .cindex "uid (user id)" "of originating user"
13285 .cindex "sender" "uid"
13286 .vindex "&$caller_uid$&"
13287 .vindex "&$originator_uid$&"
13288 The value of &$caller_uid$& that was set when the message was received. For
13289 messages received via the command line, this is the uid of the sending user.
13290 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13291 user.
13292
13293 .tvar &$parent_domain$&
13294 This variable is similar to &$original_domain$& (see
13295 above), except that it refers to the immediately preceding parent address.
13296
13297 .tvar &$parent_local_part$&
13298 This variable is similar to &$original_local_part$&
13299 (see above), except that it refers to the immediately preceding parent address.
13300
13301 .vitem &$pid$&
13302 .cindex "pid (process id)" "of current process"
13303 .vindex "&$pid$&"
13304 This variable contains the current process id.
13305
13306 .vitem &$pipe_addresses$&
13307 .cindex "filter" "transport filter"
13308 .cindex "transport" "filter"
13309 .vindex "&$pipe_addresses$&"
13310 This is not an expansion variable, but is mentioned here because the string
13311 &`$pipe_addresses`& is handled specially in the command specification for the
13312 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13313 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13314 It cannot be used in general expansion strings, and provokes an &"unknown
13315 variable"& error if encountered.
13316 &*Note*&: This value permits data supplied by a potential attacker to
13317 be used in the command for a &(pipe)& transport.
13318 Such configurations should be carefully assessed for security vulnerbilities.
13319
13320 .vitem &$primary_hostname$&
13321 .vindex "&$primary_hostname$&"
13322 This variable contains the value set by &%primary_hostname%& in the
13323 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13324 a single-component name, Exim calls &[gethostbyname()]& (or
13325 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13326 qualified host name. See also &$smtp_active_hostname$&.
13327
13328
13329 .vitem &$proxy_external_address$& &&&
13330        &$proxy_external_port$& &&&
13331        &$proxy_local_address$& &&&
13332        &$proxy_local_port$& &&&
13333        &$proxy_session$&
13334 These variables are only available when built with Proxy Protocol
13335 or SOCKS5 support.
13336 For details see chapter &<<SECTproxyInbound>>&.
13337
13338 .vitem &$prdr_requested$&
13339 .cindex "PRDR" "variable for"
13340 This variable is set to &"yes"& if PRDR was requested by the client for the
13341 current message, otherwise &"no"&.
13342
13343 .vitem &$prvscheck_address$& &&&
13344        &$prvscheck_keynum$& &&&
13345        &$prvscheck_result$&
13346 These variables are used in conjunction with the &%prvscheck%& expansion item,
13347 which is described in sections &<<SECTexpansionitems>>& and
13348 &<<SECTverifyPRVS>>&.
13349
13350 .vitem &$qualify_domain$&
13351 .vindex "&$qualify_domain$&"
13352 The value set for the &%qualify_domain%& option in the configuration file.
13353
13354 .vitem &$qualify_recipient$&
13355 .vindex "&$qualify_recipient$&"
13356 The value set for the &%qualify_recipient%& option in the configuration file,
13357 or if not set, the value of &$qualify_domain$&.
13358
13359 .vitem &$queue_name$&
13360 .vindex &$queue_name$&
13361 .cindex "named queues" variable
13362 .cindex queues named
13363 The name of the spool queue in use; empty for the default queue.
13364
13365 .vitem &$queue_size$&
13366 .vindex "&$queue_size$&"
13367 .cindex "queue" "size of"
13368 .cindex "spool" "number of messages"
13369 This variable contains the number of messages queued.
13370 It is evaluated on demand, but no more often than once every minute.
13371 If there is no daemon notifier socket open, the value will be
13372 an empty string.
13373
13374 .vitem &$r_...$&
13375 .vindex &$r_...$&
13376 .cindex router variables
13377 Values can be placed in these variables by the &%set%& option of a router.
13378 They can be given any name that starts with &$r_$&.
13379 The values persist for the address being handled through subsequent routers
13380 and the eventual transport.
13381
13382 .vitem &$rcpt_count$&
13383 .vindex "&$rcpt_count$&"
13384 When a message is being received by SMTP, this variable contains the number of
13385 RCPT commands received for the current message. If this variable is used in a
13386 RCPT ACL, its value includes the current command.
13387
13388 .vitem &$rcpt_defer_count$&
13389 .vindex "&$rcpt_defer_count$&"
13390 .cindex "4&'xx'& responses" "count of"
13391 When a message is being received by SMTP, this variable contains the number of
13392 RCPT commands in the current message that have previously been rejected with a
13393 temporary (4&'xx'&) response.
13394
13395 .vitem &$rcpt_fail_count$&
13396 .vindex "&$rcpt_fail_count$&"
13397 When a message is being received by SMTP, this variable contains the number of
13398 RCPT commands in the current message that have previously been rejected with a
13399 permanent (5&'xx'&) response.
13400
13401 .vitem &$received_count$&
13402 .vindex "&$received_count$&"
13403 This variable contains the number of &'Received:'& header lines in the message,
13404 including the one added by Exim (so its value is always greater than zero). It
13405 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13406 delivering.
13407
13408 .tvar &$received_for$&
13409 If there is only a single recipient address in an incoming message, this
13410 variable contains that address when the &'Received:'& header line is being
13411 built. The value is copied after recipient rewriting has happened, but before
13412 the &[local_scan()]& function is run.
13413
13414 .vitem &$received_ip_address$& &&&
13415        &$received_port$&
13416 .vindex "&$received_ip_address$&"
13417 .vindex "&$received_port$&"
13418 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13419 variables are set to the address and port on the local IP interface.
13420 (The remote IP address and port are in
13421 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13422 the port value is -1 unless it has been set using the &%-oMi%& command line
13423 option.
13424
13425 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13426 could be used, for example, to make the filename for a TLS certificate depend
13427 on which interface and/or port is being used for the incoming connection. The
13428 values of &$received_ip_address$& and &$received_port$& are saved with any
13429 messages that are received, thus making these variables available at delivery
13430 time.
13431 For outbound connections see &$sending_ip_address$&.
13432
13433 .vitem &$received_protocol$&
13434 .vindex "&$received_protocol$&"
13435 When a message is being processed, this variable contains the name of the
13436 protocol by which it was received. Most of the names used by Exim are defined
13437 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13438 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13439 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13440 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13441 connection and the client was successfully authenticated.
13442
13443 Exim uses the protocol name &"smtps"& for the case when encryption is
13444 automatically set up on connection without the use of STARTTLS (see
13445 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13446 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13447 where the client initially uses EHLO, sets up an encrypted connection using
13448 STARTTLS, and then uses HELO afterwards.
13449
13450 The &%-oMr%& option provides a way of specifying a custom protocol name for
13451 messages that are injected locally by trusted callers. This is commonly used to
13452 identify messages that are being re-injected after some kind of scanning.
13453
13454 .vitem &$received_time$&
13455 .vindex "&$received_time$&"
13456 This variable contains the date and time when the current message was received,
13457 as a number of seconds since the start of the Unix epoch.
13458
13459 .vitem &$recipient_data$&
13460 .vindex "&$recipient_data$&"
13461 This variable is set after an indexing lookup success in an ACL &%recipients%&
13462 condition. It contains the data from the lookup, and the value remains set
13463 until the next &%recipients%& test. Thus, you can do things like this:
13464 .display
13465 &`require recipients  = cdb*@;/some/file`&
13466 &`deny    `&&'some further test involving'& &`$recipient_data`&
13467 .endd
13468 &*Warning*&: This variable is set only when a lookup is used as an indexing
13469 method in the address list, using the semicolon syntax as in the example above.
13470 The variable is not set for a lookup that is used as part of the string
13471 expansion that all such lists undergo before being interpreted.
13472
13473 .vitem &$recipient_verify_failure$&
13474 .vindex "&$recipient_verify_failure$&"
13475 In an ACL, when a recipient verification fails, this variable contains
13476 information about the failure. It is set to one of the following words:
13477
13478 .ilist
13479 &"qualify"&: The address was unqualified (no domain), and the message
13480 was neither local nor came from an exempted host.
13481
13482 .next
13483 &"route"&: Routing failed.
13484
13485 .next
13486 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13487 or before the MAIL command (that is, on initial connection, HELO, or
13488 MAIL).
13489
13490 .next
13491 &"recipient"&: The RCPT command in a callout was rejected.
13492 .next
13493
13494 &"postmaster"&: The postmaster check in a callout was rejected.
13495 .endlist
13496
13497 The main use of this variable is expected to be to distinguish between
13498 rejections of MAIL and rejections of RCPT.
13499
13500 .tvar &$recipients$&
13501 .tvar &$recipients_list$&
13502 These variables both contain the envelope recipients for a message.
13503
13504 The first uses a comma and a space separate the addresses in the replacement text.
13505 &*Note*&: an address can legitimately contain a comma;
13506 this variable is not intended for further processing.
13507
13508 The second is a proper Exim list; colon-separated.
13509
13510 However, the variables
13511 are not generally available, to prevent exposure of Bcc recipients in
13512 unprivileged users' filter files. You can use either of them  only in these
13513 cases:
13514
13515 .olist
13516 In a system filter file.
13517 .next
13518 In the ACLs associated with the DATA command and with non-SMTP messages, that
13519 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13520 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13521 &%acl_not_smtp_mime%&.
13522 .next
13523 From within a &[local_scan()]& function.
13524 .endlist
13525
13526
13527 .vitem &$recipients_count$&
13528 .vindex "&$recipients_count$&"
13529 When a message is being processed, this variable contains the number of
13530 envelope recipients that came with the message. Duplicates are not excluded
13531 from the count. While a message is being received over SMTP, the number
13532 increases for each accepted recipient. It can be referenced in an ACL.
13533
13534
13535 .vitem &$regex_match_string$&
13536 .vindex "&$regex_match_string$&"
13537 This variable is set to contain the matching regular expression after a
13538 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13539
13540 .vitem "&$regex1$&, &$regex2$&, etc"
13541 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13542 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13543 these variables contain the
13544 captured substrings identified by the regular expression.
13545 If the subject string was tainted then so will any captured substring.
13546
13547
13548 .tvar &$reply_address$&
13549 When a message is being processed, this variable contains the contents of the
13550 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13551 contents of the &'From:'& header line. Apart from the removal of leading
13552 white space, the value is not processed in any way. In particular, no RFC 2047
13553 decoding or character code translation takes place.
13554
13555 .vitem &$return_path$&
13556 .vindex "&$return_path$&"
13557 When a message is being delivered, this variable contains the return path &--
13558 the sender field that will be sent as part of the envelope. It is not enclosed
13559 in <> characters. At the start of routing an address, &$return_path$& has the
13560 same value as &$sender_address$&, but if, for example, an incoming message to a
13561 mailing list has been expanded by a router which specifies a different address
13562 for bounce messages, &$return_path$& subsequently contains the new bounce
13563 address, whereas &$sender_address$& always contains the original sender address
13564 that was received with the message. In other words, &$sender_address$& contains
13565 the incoming envelope sender, and &$return_path$& contains the outgoing
13566 envelope sender.
13567
13568 .vitem &$return_size_limit$&
13569 .vindex "&$return_size_limit$&"
13570 This is an obsolete name for &$bounce_return_size_limit$&.
13571
13572 .vitem &$router_name$&
13573 .cindex "router" "name"
13574 .cindex "name" "of router"
13575 .vindex "&$router_name$&"
13576 During the running of a router, or a transport called,
13577 this variable contains the router name.
13578
13579 .vitem &$runrc$&
13580 .cindex "return code" "from &%run%& expansion"
13581 .vindex "&$runrc$&"
13582 This variable contains the return code from a command that is run by the
13583 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13584 assume the order in which option values are expanded, except for those
13585 preconditions whose order of testing is documented. Therefore, you cannot
13586 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13587 another.
13588
13589 .vitem &$self_hostname$&
13590 .oindex "&%self%&" "value of host name"
13591 .vindex "&$self_hostname$&"
13592 When an address is routed to a supposedly remote host that turns out to be the
13593 local host, what happens is controlled by the &%self%& generic router option.
13594 One of its values causes the address to be passed to another router. When this
13595 happens, &$self_hostname$& is set to the name of the local host that the
13596 original router encountered. In other circumstances its contents are null.
13597
13598 .tvar &$sender_address$&
13599 When a message is being processed, this variable contains the sender's address
13600 that was received in the message's envelope. The case of letters in the address
13601 is retained, in both the local part and the domain. For bounce messages, the
13602 value of this variable is the empty string. See also &$return_path$&.
13603
13604 .vitem &$sender_address_data$&
13605 .vindex "&$address_data$&"
13606 .vindex "&$sender_address_data$&"
13607 If &$address_data$& is set when the routers are called from an ACL to verify a
13608 sender address, the final value is preserved in &$sender_address_data$&, to
13609 distinguish it from data from a recipient address. The value does not persist
13610 after the end of the current ACL statement. If you want to preserve it for
13611 longer, you can save it in an ACL variable.
13612
13613 .tvar &$sender_address_domain$&
13614 The domain portion of &$sender_address$&.
13615
13616 .tvar &$sender_address_local_part$&
13617 The local part portion of &$sender_address$&.
13618
13619 .vitem &$sender_data$&
13620 .vindex "&$sender_data$&"
13621 This variable is set after a lookup success in an ACL &%senders%& condition or
13622 in a router &%senders%& option. It contains the data from the lookup, and the
13623 value remains set until the next &%senders%& test. Thus, you can do things like
13624 this:
13625 .display
13626 &`require senders      = cdb*@;/some/file`&
13627 &`deny    `&&'some further test involving'& &`$sender_data`&
13628 .endd
13629 &*Warning*&: This variable is set only when a lookup is used as an indexing
13630 method in the address list, using the semicolon syntax as in the example above.
13631 The variable is not set for a lookup that is used as part of the string
13632 expansion that all such lists undergo before being interpreted.
13633
13634 .vitem &$sender_fullhost$&
13635 .vindex "&$sender_fullhost$&"
13636 When a message is received from a remote host, this variable contains the host
13637 name and IP address in a single string. It ends with the IP address in square
13638 brackets, followed by a colon and a port number if the logging of ports is
13639 enabled. The format of the rest of the string depends on whether the host
13640 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13641 looking up its IP address. (Looking up the IP address can be forced by the
13642 &%host_lookup%& option, independent of verification.) A plain host name at the
13643 start of the string is a verified host name; if this is not present,
13644 verification either failed or was not requested. A host name in parentheses is
13645 the argument of a HELO or EHLO command. This is omitted if it is identical to
13646 the verified host name or to the host's IP address in square brackets.
13647
13648 .vitem &$sender_helo_dnssec$&
13649 .vindex "&$sender_helo_dnssec$&"
13650 This boolean variable is true if a successful HELO verification was
13651 .cindex "DNS" "DNSSEC"
13652 done using DNS information the resolver library stated was authenticated data.
13653
13654 .tvar &$sender_helo_name$&
13655 When a message is received from a remote host that has issued a HELO or EHLO
13656 command, the argument of that command is placed in this variable. It is also
13657 set if HELO or EHLO is used when a message is received using SMTP locally via
13658 the &%-bs%& or &%-bS%& options.
13659
13660 .vitem &$sender_host_address$&
13661 .vindex "&$sender_host_address$&"
13662 When a message is received from a remote host using SMTP,
13663 this variable contains that
13664 host's IP address. For locally non-SMTP submitted messages, it is empty.
13665
13666 .vitem &$sender_host_authenticated$&
13667 .vindex "&$sender_host_authenticated$&"
13668 This variable contains the name (not the public name) of the authenticator
13669 driver that successfully authenticated the client from which the message was
13670 received. It is empty if there was no successful authentication. See also
13671 &$authenticated_id$&.
13672
13673 .vitem &$sender_host_dnssec$&
13674 .vindex "&$sender_host_dnssec$&"
13675 If an attempt to populate &$sender_host_name$& has been made
13676 (by reference, &%hosts_lookup%& or
13677 otherwise) then this boolean will have been set true if, and only if, the
13678 resolver library states that both
13679 the reverse and forward DNS were authenticated data.  At all
13680 other times, this variable is false.
13681
13682 .cindex "DNS" "DNSSEC"
13683 It is likely that you will need to coerce DNSSEC support on in the resolver
13684 library, by setting:
13685 .code
13686 dns_dnssec_ok = 1
13687 .endd
13688
13689 In addition, on Linux with glibc 2.31 or newer the resolver library will
13690 default to stripping out a successful validation status.
13691 This will break a previously working Exim installation.
13692 Provided that you do trust the resolver (ie, is on localhost) you can tell
13693 glibc to pass through any successful validation with a new option in
13694 &_/etc/resolv.conf_&:
13695 .code
13696 options trust-ad
13697 .endd
13698
13699 Exim does not perform DNSSEC validation itself, instead leaving that to a
13700 validating resolver (e.g. unbound, or bind with suitable configuration).
13701
13702 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13703 mechanism in the list, then this variable will be false.
13704
13705 This requires that your system resolver library support EDNS0 (and that
13706 DNSSEC flags exist in the system headers).  If the resolver silently drops
13707 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13708 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13709
13710
13711 .tvar &$sender_host_name$&
13712 When a message is received from a remote host, this variable contains the
13713 host's name as obtained by looking up its IP address. For messages received by
13714 other means, this variable is empty.
13715
13716 .vindex "&$host_lookup_failed$&"
13717 If the host name has not previously been looked up, a reference to
13718 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13719 A looked up name is accepted only if it leads back to the original IP address
13720 via a forward lookup. If either the reverse or the forward lookup fails to find
13721 any data, or if the forward lookup does not yield the original IP address,
13722 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13723
13724 .vindex "&$host_lookup_deferred$&"
13725 However, if either of the lookups cannot be completed (for example, there is a
13726 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13727 &$host_lookup_failed$& remains set to &"0"&.
13728
13729 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13730 host name again if there is a subsequent reference to &$sender_host_name$&
13731 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13732 is set to &"1"&.
13733
13734 Exim does not automatically look up every calling host's name. If you want
13735 maximum efficiency, you should arrange your configuration so that it avoids
13736 these lookups altogether. The lookup happens only if one or more of the
13737 following are true:
13738
13739 .ilist
13740 A string containing &$sender_host_name$& is expanded.
13741 .next
13742 The calling host matches the list in &%host_lookup%&. In the default
13743 configuration, this option is set to *, so it must be changed if lookups are
13744 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13745 .next
13746 Exim needs the host name in order to test an item in a host list. The items
13747 that require this are described in sections &<<SECThoslispatnam>>& and
13748 &<<SECThoslispatnamsk>>&.
13749 .next
13750 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13751 In this case, the host name is required to compare with the name quoted in any
13752 EHLO or HELO commands that the client issues.
13753 .next
13754 The remote host issues a EHLO or HELO command that quotes one of the
13755 domains in &%helo_lookup_domains%&. The default value of this option is
13756 . ==== As this is a nested list, any displays it contains must be indented
13757 . ==== as otherwise they are too far to the left.
13758 .code
13759   helo_lookup_domains = @ : @[]
13760 .endd
13761 which causes a lookup if a remote host (incorrectly) gives the server's name or
13762 IP address in an EHLO or HELO command.
13763 .endlist
13764
13765
13766 .vitem &$sender_host_port$&
13767 .vindex "&$sender_host_port$&"
13768 When a message is received from a remote host, this variable contains the port
13769 number that was used on the remote host.
13770
13771 .vitem &$sender_ident$&
13772 .vindex "&$sender_ident$&"
13773 When a message is received from a remote host, this variable contains the
13774 identification received in response to an RFC 1413 request. When a message has
13775 been received locally, this variable contains the login name of the user that
13776 called Exim.
13777
13778 .vitem &$sender_rate_$&&'xxx'&
13779 A number of variables whose names begin &$sender_rate_$& are set as part of the
13780 &%ratelimit%& ACL condition. Details are given in section
13781 &<<SECTratelimiting>>&.
13782
13783 .vitem &$sender_rcvhost$&
13784 .cindex "DNS" "reverse lookup"
13785 .cindex "reverse DNS lookup"
13786 .vindex "&$sender_rcvhost$&"
13787 This is provided specifically for use in &'Received:'& headers. It starts with
13788 either the verified host name (as obtained from a reverse DNS lookup) or, if
13789 there is no verified host name, the IP address in square brackets. After that
13790 there may be text in parentheses. When the first item is a verified host name,
13791 the first thing in the parentheses is the IP address in square brackets,
13792 followed by a colon and a port number if port logging is enabled. When the
13793 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13794 the parentheses.
13795
13796 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13797 was used and its argument was not identical to the real host name or IP
13798 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13799 all three items are present in the parentheses, a newline and tab are inserted
13800 into the string, to improve the formatting of the &'Received:'& header.
13801
13802 .vitem &$sender_verify_failure$&
13803 .vindex "&$sender_verify_failure$&"
13804 In an ACL, when a sender verification fails, this variable contains information
13805 about the failure. The details are the same as for
13806 &$recipient_verify_failure$&.
13807
13808 .vitem &$sending_ip_address$&
13809 .vindex "&$sending_ip_address$&"
13810 This variable is set whenever an outgoing SMTP connection to another host has
13811 been set up. It contains the IP address of the local interface that is being
13812 used. This is useful if a host that has more than one IP address wants to take
13813 on different personalities depending on which one is being used. For incoming
13814 connections, see &$received_ip_address$&.
13815
13816 .vitem &$sending_port$&
13817 .vindex "&$sending_port$&"
13818 This variable is set whenever an outgoing SMTP connection to another host has
13819 been set up. It contains the local port that is being used. For incoming
13820 connections, see &$received_port$&.
13821
13822 .vitem &$smtp_active_hostname$&
13823 .vindex "&$smtp_active_hostname$&"
13824 During an incoming SMTP session, this variable contains the value of the active
13825 host name, as specified by the &%smtp_active_hostname%& option. The value of
13826 &$smtp_active_hostname$& is saved with any message that is received, so its
13827 value can be consulted during routing and delivery.
13828
13829 .tvar &$smtp_command$&
13830 During the processing of an incoming SMTP command, this variable contains the
13831 entire command. This makes it possible to distinguish between HELO and EHLO in
13832 the HELO ACL, and also to distinguish between commands such as these:
13833 .code
13834 MAIL FROM:<>
13835 MAIL FROM: <>
13836 .endd
13837 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13838 command, the address in &$smtp_command$& is the original address before any
13839 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13840 the address after SMTP-time rewriting.
13841
13842 .tvar &$smtp_command_argument$&
13843 .cindex "SMTP" "command, argument for"
13844 While an ACL is running to check an SMTP command, this variable contains the
13845 argument, that is, the text that follows the command name, with leading white
13846 space removed. Following the introduction of &$smtp_command$&, this variable is
13847 somewhat redundant, but is retained for backwards compatibility.
13848
13849 .vitem &$smtp_command_history$&
13850 .cindex SMTP "command history"
13851 .vindex "&$smtp_command_history$&"
13852 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13853 received, in time-order left to right.  Only a limited number of commands
13854 are remembered.
13855
13856 .vitem &$smtp_count_at_connection_start$&
13857 .vindex "&$smtp_count_at_connection_start$&"
13858 This variable is set greater than zero only in processes spawned by the Exim
13859 daemon for handling incoming SMTP connections. The name is deliberately long,
13860 in order to emphasize what the contents are. When the daemon accepts a new
13861 connection, it increments this variable. A copy of the variable is passed to
13862 the child process that handles the connection, but its value is fixed, and
13863 never changes. It is only an approximation of how many incoming connections
13864 there actually are, because many other connections may come and go while a
13865 single connection is being processed. When a child process terminates, the
13866 daemon decrements its copy of the variable.
13867
13868 .vitem &$smtp_notquit_reason$&
13869 .vindex "&$smtp_notquit_reason$&"
13870 When the not-QUIT ACL is running, this variable is set to a string
13871 that indicates the reason for the termination of the SMTP connection.
13872
13873 .vitem "&$sn0$& &-- &$sn9$&"
13874 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13875 that were current at the end of the system filter file. This allows a system
13876 filter file to set values that can be tested in users' filter files. For
13877 example, a system filter could set a value indicating how likely it is that a
13878 message is junk mail.
13879
13880 .vitem &$spam_score$& &&&
13881        &$spam_score_int$& &&&
13882        &$spam_bar$& &&&
13883        &$spam_report$& &&&
13884        &$spam_action$&
13885 A number of variables whose names start with &$spam$& are available when Exim
13886 is compiled with the content-scanning extension. For details, see section
13887 &<<SECTscanspamass>>&.
13888
13889 .vitem &$spf_header_comment$& &&&
13890        &$spf_received$& &&&
13891        &$spf_result$& &&&
13892        &$spf_result_guessed$& &&&
13893        &$spf_smtp_comment$&
13894 These variables are only available if Exim is built with SPF support.
13895 For details see section &<<SECSPF>>&.
13896
13897 .vitem &$spool_directory$&
13898 .vindex "&$spool_directory$&"
13899 The name of Exim's spool directory.
13900
13901 .vitem &$spool_inodes$&
13902 .vindex "&$spool_inodes$&"
13903 The number of free inodes in the disk partition where Exim's spool files are
13904 being written. The value is recalculated whenever the variable is referenced.
13905 If the relevant file system does not have the concept of inodes, the value of
13906 is -1. See also the &%check_spool_inodes%& option.
13907
13908 .vitem &$spool_space$&
13909 .vindex "&$spool_space$&"
13910 The amount of free space (as a number of kilobytes) in the disk partition where
13911 Exim's spool files are being written. The value is recalculated whenever the
13912 variable is referenced. If the operating system does not have the ability to
13913 find the amount of free space (only true for experimental systems), the space
13914 value is -1. For example, to check in an ACL that there is at least 50
13915 megabytes free on the spool, you could write:
13916 .code
13917 condition = ${if > {$spool_space}{50000}}
13918 .endd
13919 See also the &%check_spool_space%& option.
13920
13921
13922 .vitem &$thisaddress$&
13923 .vindex "&$thisaddress$&"
13924 This variable is set only during the processing of the &%foranyaddress%&
13925 command in a filter file. Its use is explained in the description of that
13926 command, which can be found in the separate document entitled &'Exim's
13927 interfaces to mail filtering'&.
13928
13929 .vitem &$tls_in_bits$&
13930 .vindex "&$tls_in_bits$&"
13931 Contains an approximation of the TLS cipher's bit-strength
13932 on the inbound connection; the meaning of
13933 this depends upon the TLS implementation used.
13934 If TLS has not been negotiated, the value will be 0.
13935 The value of this is automatically fed into the Cyrus SASL authenticator
13936 when acting as a server, to specify the "external SSF" (a SASL term).
13937
13938 The deprecated &$tls_bits$& variable refers to the inbound side
13939 except when used in the context of an outbound SMTP delivery, when it refers to
13940 the outbound.
13941
13942 .vitem &$tls_out_bits$&
13943 .vindex "&$tls_out_bits$&"
13944 Contains an approximation of the TLS cipher's bit-strength
13945 on an outbound SMTP connection; the meaning of
13946 this depends upon the TLS implementation used.
13947 If TLS has not been negotiated, the value will be 0.
13948
13949 .vitem &$tls_in_ourcert$&
13950 .vindex "&$tls_in_ourcert$&"
13951 .cindex certificate variables
13952 This variable refers to the certificate presented to the peer of an
13953 inbound connection when the message was received.
13954 It is only useful as the argument of a
13955 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13956 or a &%def%& condition.
13957
13958 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13959 when a list of more than one
13960 file is used for &%tls_certificate%&, this variable is not reliable.
13961 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13962
13963 .vitem &$tls_in_peercert$&
13964 .vindex "&$tls_in_peercert$&"
13965 This variable refers to the certificate presented by the peer of an
13966 inbound connection when the message was received.
13967 It is only useful as the argument of a
13968 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13969 or a &%def%& condition.
13970 If certificate verification fails it may refer to a failing chain element
13971 which is not the leaf.
13972
13973 .vitem &$tls_out_ourcert$&
13974 .vindex "&$tls_out_ourcert$&"
13975 This variable refers to the certificate presented to the peer of an
13976 outbound connection.  It is only useful as the argument of a
13977 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13978 or a &%def%& condition.
13979
13980 .vitem &$tls_out_peercert$&
13981 .vindex "&$tls_out_peercert$&"
13982 This variable refers to the certificate presented by the peer of an
13983 outbound connection.  It is only useful as the argument of a
13984 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13985 or a &%def%& condition.
13986 If certificate verification fails it may refer to a failing chain element
13987 which is not the leaf.
13988
13989 .vitem &$tls_in_certificate_verified$&
13990 .vindex "&$tls_in_certificate_verified$&"
13991 This variable is set to &"1"& if a TLS certificate was verified when the
13992 message was received, and &"0"& otherwise.
13993
13994 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13995 except when used in the context of an outbound SMTP delivery, when it refers to
13996 the outbound.
13997
13998 .vitem &$tls_out_certificate_verified$&
13999 .vindex "&$tls_out_certificate_verified$&"
14000 This variable is set to &"1"& if a TLS certificate was verified when an
14001 outbound SMTP connection was made,
14002 and &"0"& otherwise.
14003
14004 .vitem &$tls_in_cipher$&
14005 .vindex "&$tls_in_cipher$&"
14006 .vindex "&$tls_cipher$&"
14007 When a message is received from a remote host over an encrypted SMTP
14008 connection, this variable is set to the cipher suite that was negotiated, for
14009 example DES-CBC3-SHA. In other circumstances, in particular, for message
14010 received over unencrypted connections, the variable is empty. Testing
14011 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
14012 non-encrypted connections during ACL processing.
14013
14014 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
14015 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
14016 becomes the same as &$tls_out_cipher$&.
14017
14018 .vitem &$tls_in_cipher_std$&
14019 .vindex "&$tls_in_cipher_std$&"
14020 As above, but returning the RFC standard name for the cipher suite.
14021
14022 .vitem &$tls_out_cipher$&
14023 .vindex "&$tls_out_cipher$&"
14024 This variable is
14025 cleared before any outgoing SMTP connection is made,
14026 and then set to the outgoing cipher suite if one is negotiated. See chapter
14027 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
14028 details of the &(smtp)& transport.
14029
14030 .vitem &$tls_out_cipher_std$&
14031 .vindex "&$tls_out_cipher_std$&"
14032 As above, but returning the RFC standard name for the cipher suite.
14033
14034 .vitem &$tls_out_dane$&
14035 .vindex &$tls_out_dane$&
14036 DANE active status.  See section &<<SECDANE>>&.
14037
14038 .vitem &$tls_in_ocsp$&
14039 .vindex "&$tls_in_ocsp$&"
14040 When a message is received from a remote client connection
14041 the result of any OCSP request from the client is encoded in this variable:
14042 .code
14043 0 OCSP proof was not requested (default value)
14044 1 No response to request
14045 2 Response not verified
14046 3 Verification failed
14047 4 Verification succeeded
14048 .endd
14049
14050 .vitem &$tls_out_ocsp$&
14051 .vindex "&$tls_out_ocsp$&"
14052 When a message is sent to a remote host connection
14053 the result of any OCSP request made is encoded in this variable.
14054 See &$tls_in_ocsp$& for values.
14055
14056 .vitem &$tls_in_peerdn$&
14057 .vindex "&$tls_in_peerdn$&"
14058 .vindex "&$tls_peerdn$&"
14059 .cindex certificate "extracting fields"
14060 When a message is received from a remote host over an encrypted SMTP
14061 connection, and Exim is configured to request a certificate from the client,
14062 the value of the Distinguished Name of the certificate is made available in the
14063 &$tls_in_peerdn$& during subsequent processing.
14064 If certificate verification fails it may refer to a failing chain element
14065 which is not the leaf.
14066
14067 The deprecated &$tls_peerdn$& variable refers to the inbound side
14068 except when used in the context of an outbound SMTP delivery, when it refers to
14069 the outbound.
14070
14071 .vitem &$tls_out_peerdn$&
14072 .vindex "&$tls_out_peerdn$&"
14073 When a message is being delivered to a remote host over an encrypted SMTP
14074 connection, and Exim is configured to request a certificate from the server,
14075 the value of the Distinguished Name of the certificate is made available in the
14076 &$tls_out_peerdn$& during subsequent processing.
14077 If certificate verification fails it may refer to a failing chain element
14078 which is not the leaf.
14079
14080
14081 .vitem &$tls_in_resumption$& &&&
14082        &$tls_out_resumption$&
14083 .vindex &$tls_in_resumption$&
14084 .vindex &$tls_out_resumption$&
14085 .cindex TLS resumption
14086 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
14087
14088
14089 .tvar &$tls_in_sni$&
14090 .vindex "&$tls_sni$&"
14091 .cindex "TLS" "Server Name Indication"
14092 .cindex "TLS" SNI
14093 .cindex SNI "observability on server"
14094 When a TLS session is being established, if the client sends the Server
14095 Name Indication extension, the value will be placed in this variable.
14096 If the variable appears in &%tls_certificate%& then this option and
14097 some others, described in &<<SECTtlssni>>&,
14098 will be re-expanded early in the TLS session, to permit
14099 a different certificate to be presented (and optionally a different key to be
14100 used) to the client, based upon the value of the SNI extension.
14101
14102 The deprecated &$tls_sni$& variable refers to the inbound side
14103 except when used in the context of an outbound SMTP delivery, when it refers to
14104 the outbound.
14105
14106 .vitem &$tls_out_sni$&
14107 .vindex "&$tls_out_sni$&"
14108 .cindex "TLS" "Server Name Indication"
14109 .cindex "TLS" SNI
14110 .cindex SNI "observability in client"
14111 During outbound
14112 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14113 the transport.
14114
14115 .vitem &$tls_out_tlsa_usage$&
14116 .vindex &$tls_out_tlsa_usage$&
14117 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14118
14119 .vitem &$tls_in_ver$&
14120 .vindex "&$tls_in_ver$&"
14121 When a message is received from a remote host over an encrypted SMTP connection
14122 this variable is set to the protocol version, eg &'TLS1.2'&.
14123
14124 .vitem &$tls_out_ver$&
14125 .vindex "&$tls_out_ver$&"
14126 When a message is being delivered to a remote host over an encrypted SMTP connection
14127 this variable is set to the protocol version.
14128
14129
14130 .vitem &$tod_bsdinbox$&
14131 .vindex "&$tod_bsdinbox$&"
14132 The time of day and the date, in the format required for BSD-style mailbox
14133 files, for example: Thu Oct 17 17:14:09 1995.
14134
14135 .vitem &$tod_epoch$&
14136 .vindex "&$tod_epoch$&"
14137 The time and date as a number of seconds since the start of the Unix epoch.
14138
14139 .vitem &$tod_epoch_l$&
14140 .vindex "&$tod_epoch_l$&"
14141 The time and date as a number of microseconds since the start of the Unix epoch.
14142
14143 .vitem &$tod_full$&
14144 .vindex "&$tod_full$&"
14145 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14146 +0100. The timezone is always given as a numerical offset from UTC, with
14147 positive values used for timezones that are ahead (east) of UTC, and negative
14148 values for those that are behind (west).
14149
14150 .vitem &$tod_log$&
14151 .vindex "&$tod_log$&"
14152 The time and date in the format used for writing Exim's log files, for example:
14153 1995-10-12 15:32:29, but without a timezone.
14154
14155 .vitem &$tod_logfile$&
14156 .vindex "&$tod_logfile$&"
14157 This variable contains the date in the format yyyymmdd. This is the format that
14158 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14159 flag.
14160
14161 .vitem &$tod_zone$&
14162 .vindex "&$tod_zone$&"
14163 This variable contains the numerical value of the local timezone, for example:
14164 -0500.
14165
14166 .vitem &$tod_zulu$&
14167 .vindex "&$tod_zulu$&"
14168 This variable contains the UTC date and time in &"Zulu"& format, as specified
14169 by ISO 8601, for example: 20030221154023Z.
14170
14171 .vitem &$transport_name$&
14172 .cindex "transport" "name"
14173 .cindex "name" "of transport"
14174 .vindex "&$transport_name$&"
14175 During the running of a transport, this variable contains its name.
14176
14177 .vitem &$value$&
14178 .vindex "&$value$&"
14179 This variable contains the result of an expansion lookup, extraction operation,
14180 or external command, as described above. It is also used during a
14181 &*reduce*& expansion.
14182
14183 .vitem &$verify_mode$&
14184 .vindex "&$verify_mode$&"
14185 While a router or transport is being run in verify mode or for cutthrough delivery,
14186 contains "S" for sender-verification or "R" for recipient-verification.
14187 Otherwise, empty.
14188
14189 .vitem &$version_number$&
14190 .vindex "&$version_number$&"
14191 The version number of Exim. Same as &$exim_version$&, may be overridden
14192 by the &%exim_version%& main config option.
14193
14194 .vitem &$warn_message_delay$&
14195 .vindex "&$warn_message_delay$&"
14196 This variable is set only during the creation of a message warning about a
14197 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14198
14199 .vitem &$warn_message_recipients$&
14200 .vindex "&$warn_message_recipients$&"
14201 This variable is set only during the creation of a message warning about a
14202 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14203 .endlist
14204 .ecindex IIDstrexp
14205
14206
14207
14208 . ////////////////////////////////////////////////////////////////////////////
14209 . ////////////////////////////////////////////////////////////////////////////
14210
14211 .chapter "Embedded Perl" "CHAPperl"
14212 .scindex IIDperl "Perl" "calling from Exim"
14213 Exim can be built to include an embedded Perl interpreter. When this is done,
14214 Perl subroutines can be called as part of the string expansion process. To make
14215 use of the Perl support, you need version 5.004 or later of Perl installed on
14216 your system. To include the embedded interpreter in the Exim binary, include
14217 the line
14218 .code
14219 EXIM_PERL = perl.o
14220 .endd
14221 in your &_Local/Makefile_& and then build Exim in the normal way.
14222
14223
14224 .section "Setting up so Perl can be used" "SECID85"
14225 .oindex "&%perl_startup%&"
14226 Access to Perl subroutines is via a global configuration option called
14227 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14228 no &%perl_startup%& option in the Exim configuration file then no Perl
14229 interpreter is started and there is almost no overhead for Exim (since none of
14230 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14231 option then the associated value is taken to be Perl code which is executed in
14232 a newly created Perl interpreter.
14233
14234 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14235 need backslashes before any characters to escape special meanings. The option
14236 should usually be something like
14237 .code
14238 perl_startup = do '/etc/exim.pl'
14239 .endd
14240 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14241 use from Exim. Exim can be configured either to start up a Perl interpreter as
14242 soon as it is entered, or to wait until the first time it is needed. Starting
14243 the interpreter at the beginning ensures that it is done while Exim still has
14244 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14245 fact used in a particular run. Also, note that this does not mean that Exim is
14246 necessarily running as root when Perl is called at a later time. By default,
14247 the interpreter is started only when it is needed, but this can be changed in
14248 two ways:
14249
14250 .ilist
14251 .oindex "&%perl_at_start%&"
14252 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14253 a startup when Exim is entered.
14254 .next
14255 The command line option &%-ps%& also requests a startup when Exim is entered,
14256 overriding the setting of &%perl_at_start%&.
14257 .endlist
14258
14259 There is also a command line option &%-pd%& (for delay) which suppresses the
14260 initial startup, even if &%perl_at_start%& is set.
14261
14262 .ilist
14263 .oindex "&%perl_taintmode%&"
14264 .cindex "Perl" "taintmode"
14265 To provide more security executing Perl code via the embedded Perl
14266 interpreter, the &%perl_taintmode%& option can be set. This enables the
14267 taint mode of the Perl interpreter. You are encouraged to set this
14268 option to a true value. To avoid breaking existing installations, it
14269 defaults to false.
14270
14271 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14272
14273
14274 .section "Calling Perl subroutines" "SECID86"
14275 When the configuration file includes a &%perl_startup%& option you can make use
14276 of the string expansion item to call the Perl subroutines that are defined
14277 by the &%perl_startup%& code. The operator is used in any of the following
14278 forms:
14279 .code
14280 ${perl{foo}}
14281 ${perl{foo}{argument}}
14282 ${perl{foo}{argument1}{argument2} ... }
14283 .endd
14284 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14285 arguments may be passed. Passing more than this results in an expansion failure
14286 with an error message of the form
14287 .code
14288 Too many arguments passed to Perl subroutine "foo" (max is 8)
14289 .endd
14290 The return value of the Perl subroutine is evaluated in a scalar context before
14291 it is passed back to Exim to be inserted into the expanded string. If the
14292 return value is &'undef'&, the expansion is forced to fail in the same way as
14293 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14294 by obeying Perl's &%die%& function, the expansion fails with the error message
14295 that was passed to &%die%&.
14296
14297
14298 .section "Calling Exim functions from Perl" "SECID87"
14299 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14300 is available to call back into Exim's string expansion function. For example,
14301 the Perl code
14302 .code
14303 my $lp = Exim::expand_string('$local_part');
14304 .endd
14305 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14306 Note those are single quotes and not double quotes to protect against
14307 &$local_part$& being interpolated as a Perl variable.
14308
14309 If the string expansion is forced to fail by a &"fail"& item, the result of
14310 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14311 expansion string, the Perl call from the original expansion string fails with
14312 an appropriate error message, in the same way as if &%die%& were used.
14313
14314 .cindex "debugging" "from embedded Perl"
14315 .cindex "log" "writing from embedded Perl"
14316 Two other Exim functions are available for use from within Perl code.
14317 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14318 debugging is enabled. If you want a newline at the end, you must supply it.
14319 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14320 timestamp. In this case, you should not supply a terminating newline.
14321
14322
14323 .section "Use of standard output and error by Perl" "SECID88"
14324 .cindex "Perl" "standard output and error"
14325 You should not write to the standard error or output streams from within your
14326 Perl code, as it is not defined how these are set up. In versions of Exim
14327 before 4.50, it is possible for the standard output or error to refer to the
14328 SMTP connection during message reception via the daemon. Writing to this stream
14329 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14330 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14331 avoided, but the output is lost.
14332
14333 .cindex "Perl" "use of &%warn%&"
14334 The Perl &%warn%& statement writes to the standard error stream by default.
14335 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14336 you have no control. When Exim starts up the Perl interpreter, it arranges for
14337 output from the &%warn%& statement to be written to the Exim main log. You can
14338 change this by including appropriate Perl magic somewhere in your Perl code.
14339 For example, to discard &%warn%& output completely, you need this:
14340 .code
14341 $SIG{__WARN__} = sub { };
14342 .endd
14343 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14344 example, the code for the subroutine is empty, so it does nothing, but you can
14345 include any Perl code that you like. The text of the &%warn%& message is passed
14346 as the first subroutine argument.
14347 .ecindex IIDperl
14348
14349
14350 . ////////////////////////////////////////////////////////////////////////////
14351 . ////////////////////////////////////////////////////////////////////////////
14352
14353 .chapter "Starting the daemon and the use of network interfaces" &&&
14354          "CHAPinterfaces" &&&
14355          "Starting the daemon"
14356 .cindex "daemon" "starting"
14357 .cindex "interface" "listening"
14358 .cindex "network interface"
14359 .cindex "interface" "network"
14360 .cindex "IP address" "for listening"
14361 .cindex "daemon" "listening IP addresses"
14362 .cindex "TCP/IP" "setting listening interfaces"
14363 .cindex "TCP/IP" "setting listening ports"
14364 A host that is connected to a TCP/IP network may have one or more physical
14365 hardware network interfaces. Each of these interfaces may be configured as one
14366 or more &"logical"& interfaces, which are the entities that a program actually
14367 works with. Each of these logical interfaces is associated with an IP address.
14368 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14369 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14370 knowledge about the host's interfaces for use in three different circumstances:
14371
14372 .olist
14373 When a listening daemon is started, Exim needs to know which interfaces
14374 and ports to listen on.
14375 .next
14376 When Exim is routing an address, it needs to know which IP addresses
14377 are associated with local interfaces. This is required for the correct
14378 processing of MX lists by removing the local host and others with the
14379 same or higher priority values. Also, Exim needs to detect cases
14380 when an address is routed to an IP address that in fact belongs to the
14381 local host. Unless the &%self%& router option or the &%allow_localhost%&
14382 option of the smtp transport is set (as appropriate), this is treated
14383 as an error situation.
14384 .next
14385 When Exim connects to a remote host, it may need to know which interface to use
14386 for the outgoing connection.
14387 .endlist
14388
14389
14390 Exim's default behaviour is likely to be appropriate in the vast majority
14391 of cases. If your host has only one interface, and you want all its IP
14392 addresses to be treated in the same way, and you are using only the
14393 standard SMTP port, you should not need to take any special action. The
14394 rest of this chapter does not apply to you.
14395
14396 In a more complicated situation you may want to listen only on certain
14397 interfaces, or on different ports, and for this reason there are a number of
14398 options that can be used to influence Exim's behaviour. The rest of this
14399 chapter describes how they operate.
14400
14401 When a message is received over TCP/IP, the interface and port that were
14402 actually used are set in &$received_ip_address$& and &$received_port$&.
14403
14404
14405
14406 .section "Starting a listening daemon" "SECID89"
14407 When a listening daemon is started (by means of the &%-bd%& command line
14408 option), the interfaces and ports on which it listens are controlled by the
14409 following options:
14410
14411 .ilist
14412 &%daemon_smtp_ports%& contains a list of default ports
14413 or service names.
14414 (For backward compatibility, this option can also be specified in the singular.)
14415 .next
14416 &%local_interfaces%& contains list of interface IP addresses on which to
14417 listen. Each item may optionally also specify a port.
14418 .endlist
14419
14420 The default list separator in both cases is a colon, but this can be changed as
14421 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14422 it is usually best to change the separator to avoid having to double all the
14423 colons. For example:
14424 .code
14425 local_interfaces = <; 127.0.0.1 ; \
14426                       192.168.23.65 ; \
14427                       ::1 ; \
14428                       3ffe:ffff:836f::fe86:a061
14429 .endd
14430 There are two different formats for specifying a port along with an IP address
14431 in &%local_interfaces%&:
14432
14433 .olist
14434 The port is added onto the address with a dot separator. For example, to listen
14435 on port 1234 on two different IP addresses:
14436 .code
14437 local_interfaces = <; 192.168.23.65.1234 ; \
14438                       3ffe:ffff:836f::fe86:a061.1234
14439 .endd
14440 .next
14441 The IP address is enclosed in square brackets, and the port is added
14442 with a colon separator, for example:
14443 .code
14444 local_interfaces = <; [192.168.23.65]:1234 ; \
14445                       [3ffe:ffff:836f::fe86:a061]:1234
14446 .endd
14447 .endlist
14448
14449 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14450 default setting contains just one port:
14451 .code
14452 daemon_smtp_ports = smtp
14453 .endd
14454 If more than one port is listed, each interface that does not have its own port
14455 specified listens on all of them. Ports that are listed in
14456 &%daemon_smtp_ports%& can be identified either by name (defined in
14457 &_/etc/services_&) or by number. However, when ports are given with individual
14458 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14459
14460
14461
14462 .section "Special IP listening addresses" "SECID90"
14463 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14464 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14465 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14466 instead of setting up separate listening sockets for each interface. The
14467 default value of &%local_interfaces%& is
14468 .code
14469 local_interfaces = 0.0.0.0
14470 .endd
14471 when Exim is built without IPv6 support; otherwise it is:
14472 .code
14473 local_interfaces = <; ::0 ; 0.0.0.0
14474 .endd
14475 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14476
14477
14478
14479 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14480 The &%-oX%& command line option can be used to override the values of
14481 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14482 instance. Another way of doing this would be to use macros and the &%-D%&
14483 option. However, &%-oX%& can be used by any admin user, whereas modification of
14484 the runtime configuration by &%-D%& is allowed only when the caller is root or
14485 exim.
14486
14487 The value of &%-oX%& is a list of items. The default colon separator can be
14488 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14489 If there are any items that do not
14490 contain dots or colons (that is, are not IP addresses), the value of
14491 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14492 items that do contain dots or colons, the value of &%local_interfaces%& is
14493 replaced by those items. Thus, for example,
14494 .code
14495 -oX 1225
14496 .endd
14497 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14498 whereas
14499 .code
14500 -oX 192.168.34.5.1125
14501 .endd
14502 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14503 (However, since &%local_interfaces%& now contains no items without ports, the
14504 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14505
14506
14507
14508 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14509 .cindex "submissions protocol"
14510 .cindex "ssmtp protocol"
14511 .cindex "smtps protocol"
14512 .cindex "SMTP" "ssmtp protocol"
14513 .cindex "SMTP" "smtps protocol"
14514 Exim supports the use of TLS-on-connect, used by mail clients in the
14515 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14516 For some years, IETF Standards Track documents only blessed the
14517 STARTTLS-based Submission service (port 587) while common practice was to support
14518 the same feature set on port 465, but using TLS-on-connect.
14519 If your installation needs to provide service to mail clients
14520 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14521 the 465 TCP ports.
14522
14523 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14524 service names, connections to those ports must first establish TLS, before
14525 proceeding to the application layer use of the SMTP protocol.
14526
14527 The common use of this option is expected to be
14528 .code
14529 tls_on_connect_ports = 465
14530 .endd
14531 per RFC 8314.
14532 There is also a command line option &%-tls-on-connect%&, which forces all ports
14533 to behave in this way when a daemon is started.
14534
14535 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14536 daemon to listen on those ports. You must still specify them in
14537 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14538 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14539 connections via the daemon.)
14540
14541
14542
14543
14544 .section "IPv6 address scopes" "SECID92"
14545 .cindex "IPv6" "address scopes"
14546 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14547 can, in principle, have the same link-local IPv6 address on different
14548 interfaces. Thus, additional information is needed, over and above the IP
14549 address, to distinguish individual interfaces. A convention of using a
14550 percent sign followed by something (often the interface name) has been
14551 adopted in some cases, leading to addresses like this:
14552 .code
14553 fe80::202:b3ff:fe03:45c1%eth0
14554 .endd
14555 To accommodate this usage, a percent sign followed by an arbitrary string is
14556 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14557 to convert a textual IPv6 address for actual use. This function recognizes the
14558 percent convention in operating systems that support it, and it processes the
14559 address appropriately. Unfortunately, some older libraries have problems with
14560 &[getaddrinfo()]&. If
14561 .code
14562 IPV6_USE_INET_PTON=yes
14563 .endd
14564 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14565 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14566 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14567 function.) Of course, this means that the additional functionality of
14568 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14569
14570 .section "Disabling IPv6" "SECID93"
14571 .cindex "IPv6" "disabling"
14572 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14573 run on a host whose kernel does not support IPv6. The binary will fall back to
14574 using IPv4, but it may waste resources looking up AAAA records, and trying to
14575 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14576 .oindex "&%disable_ipv6%&"
14577 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14578 activities take place. AAAA records are never looked up, and any IPv6 addresses
14579 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14580 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14581 to handle IPv6 literal addresses.
14582
14583 On the other hand, when IPv6 is in use, there may be times when you want to
14584 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14585 option to globally suppress the lookup of AAAA records for specified domains,
14586 and you can use the &%ignore_target_hosts%& generic router option to ignore
14587 IPv6 addresses in an individual router.
14588
14589
14590
14591 .section "Examples of starting a listening daemon" "SECID94"
14592 The default case in an IPv6 environment is
14593 .code
14594 daemon_smtp_ports = smtp
14595 local_interfaces = <; ::0 ; 0.0.0.0
14596 .endd
14597 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14598 Either one or two sockets may be used, depending on the characteristics of
14599 the TCP/IP stack. (This is complicated and messy; for more information,
14600 read the comments in the &_daemon.c_& source file.)
14601
14602 To specify listening on ports 25 and 26 on all interfaces:
14603 .code
14604 daemon_smtp_ports = 25 : 26
14605 .endd
14606 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14607 .code
14608 local_interfaces = <; ::0.25     ; ::0.26 \
14609                       0.0.0.0.25 ; 0.0.0.0.26
14610 .endd
14611 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14612 IPv4 loopback address only:
14613 .code
14614 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14615 .endd
14616 To specify listening on the default port on specific interfaces only:
14617 .code
14618 local_interfaces = 10.0.0.67 : 192.168.34.67
14619 .endd
14620 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14621
14622
14623
14624 .section "Recognizing the local host" "SECTreclocipadd"
14625 The &%local_interfaces%& option is also used when Exim needs to determine
14626 whether or not an IP address refers to the local host. That is, the IP
14627 addresses of all the interfaces on which a daemon is listening are always
14628 treated as local.
14629
14630 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14631 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14632 available interfaces from the operating system, and extracts the relevant
14633 (that is, IPv4 or IPv6) addresses to use for checking.
14634
14635 Some systems set up large numbers of virtual interfaces in order to provide
14636 many virtual web servers. In this situation, you may want to listen for
14637 email on only a few of the available interfaces, but nevertheless treat all
14638 interfaces as local when routing. You can do this by setting
14639 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14640 &"all"& wildcard values. These addresses are recognized as local, but are not
14641 used for listening. Consider this example:
14642 .code
14643 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14644                       192.168.53.235 ; \
14645                       3ffe:2101:12:1:a00:20ff:fe86:a061
14646
14647 extra_local_interfaces = <; ::0 ; 0.0.0.0
14648 .endd
14649 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14650 address, but all available interface addresses are treated as local when
14651 Exim is routing.
14652
14653 In some environments the local host name may be in an MX list, but with an IP
14654 address that is not assigned to any local interface. In other cases it may be
14655 desirable to treat other host names as if they referred to the local host. Both
14656 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14657 This contains host names rather than IP addresses. When a host is referenced
14658 during routing, either via an MX record or directly, it is treated as the local
14659 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14660 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14661
14662
14663
14664 .section "Delivering to a remote host" "SECID95"
14665 Delivery to a remote host is handled by the smtp transport. By default, it
14666 allows the system's TCP/IP functions to choose which interface to use (if
14667 there is more than one) when connecting to a remote host. However, the
14668 &%interface%& option can be set to specify which interface is used. See the
14669 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14670 details.
14671
14672
14673
14674
14675 . ////////////////////////////////////////////////////////////////////////////
14676 . ////////////////////////////////////////////////////////////////////////////
14677
14678 .chapter "Main configuration" "CHAPmainconfig"
14679 .scindex IIDconfima "configuration file" "main section"
14680 .scindex IIDmaiconf "main configuration"
14681 The first part of the runtime configuration file contains three types of item:
14682
14683 .ilist
14684 Macro definitions: These lines start with an upper case letter. See section
14685 &<<SECTmacrodefs>>& for details of macro processing.
14686 .next
14687 Named list definitions: These lines start with one of the words &"domainlist"&,
14688 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14689 section &<<SECTnamedlists>>&.
14690 .next
14691 Main configuration settings: Each setting occupies one line of the file
14692 (with possible continuations). If any setting is preceded by the word
14693 &"hide"&, the &%-bP%& command line option displays its value to admin users
14694 only. See section &<<SECTcos>>& for a description of the syntax of these option
14695 settings.
14696 .endlist
14697
14698 This chapter specifies all the main configuration options, along with their
14699 types and default values. For ease of finding a particular option, they appear
14700 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14701 are now so many options, they are first listed briefly in functional groups, as
14702 an aid to finding the name of the option you are looking for. Some options are
14703 listed in more than one group.
14704
14705 .section "Miscellaneous" "SECID96"
14706 .table2
14707 .row &%add_environment%&             "environment variables"
14708 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14709 .row &%debug_store%&                 "do extra internal checks"
14710 .row &%disable_ipv6%&                "do no IPv6 processing"
14711 .row &%keep_environment%&            "environment variables"
14712 .row &%keep_malformed%&              "for broken files &-- should not happen"
14713 .row &%localhost_number%&            "for unique message ids in clusters"
14714 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14715 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14716 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14717 .row &%print_topbitchars%&           "top-bit characters are printing"
14718 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14719 .row &%timezone%&                    "force time zone"
14720 .endtable
14721
14722
14723 .section "Exim parameters" "SECID97"
14724 .table2
14725 .row &%exim_group%&                  "override compiled-in value"
14726 .row &%exim_path%&                   "override compiled-in value"
14727 .row &%exim_user%&                   "override compiled-in value"
14728 .row &%primary_hostname%&            "default from &[uname()]&"
14729 .row &%split_spool_directory%&       "use multiple directories"
14730 .row &%spool_directory%&             "override compiled-in value"
14731 .endtable
14732
14733
14734
14735 .section "Privilege controls" "SECID98"
14736 .table2
14737 .row &%admin_groups%&                "groups that are Exim admin users"
14738 .row &%commandline_checks_require_admin%& "require admin for various checks"
14739 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14740 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14741 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14742 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14743 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14744 .row &%never_users%&                 "do not run deliveries as these"
14745 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14746 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14747 .row &%trusted_groups%&              "groups that are trusted"
14748 .row &%trusted_users%&               "users that are trusted"
14749 .endtable
14750
14751
14752
14753 .section "Logging" "SECID99"
14754 .table2
14755 .row &%event_action%&                "custom logging"
14756 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14757 .row &%log_file_path%&               "override compiled-in value"
14758 .row &%log_selector%&                "set/unset optional logging"
14759 .row &%log_timezone%&                "add timezone to log lines"
14760 .row &%message_logs%&                "create per-message logs"
14761 .row &%preserve_message_logs%&       "after message completion"
14762 .row &%panic_coredump%&              "request coredump on fatal errors"
14763 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14764 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14765 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14766 .row &%syslog_facility%&             "set syslog &""facility""& field"
14767 .row &%syslog_pid%&                  "pid in syslog lines"
14768 .row &%syslog_processname%&          "set syslog &""ident""& field"
14769 .row &%syslog_timestamp%&            "timestamp syslog lines"
14770 .row &%write_rejectlog%&             "control use of message log"
14771 .endtable
14772
14773
14774
14775 .section "Frozen messages" "SECID100"
14776 .table2
14777 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14778 .row &%freeze_tell%&                 "send message when freezing"
14779 .row &%move_frozen_messages%&        "to another directory"
14780 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14781 .endtable
14782
14783
14784
14785 .section "Data lookups" "SECID101"
14786 .table2
14787 .row &%ibase_servers%&               "InterBase servers"
14788 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14789 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14790 .row &%ldap_cert_file%&              "client cert file for LDAP"
14791 .row &%ldap_cert_key%&               "client key file for LDAP"
14792 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14793 .row &%ldap_default_servers%&        "used if no server in query"
14794 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14795 .row &%ldap_start_tls%&              "require TLS within LDAP"
14796 .row &%ldap_version%&                "set protocol version"
14797 .row &%lookup_open_max%&             "lookup files held open"
14798 .row &%mysql_servers%&               "default MySQL servers"
14799 .row &%oracle_servers%&              "Oracle servers"
14800 .row &%pgsql_servers%&               "default PostgreSQL servers"
14801 .row &%sqlite_lock_timeout%&         "as it says"
14802 .endtable
14803
14804
14805
14806 .section "Message ids" "SECID102"
14807 .table2
14808 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14809 .row &%message_id_header_text%&      "ditto"
14810 .endtable
14811
14812
14813
14814 .section "Embedded Perl Startup" "SECID103"
14815 .table2
14816 .row &%perl_at_start%&               "always start the interpreter"
14817 .row &%perl_startup%&                "code to obey when starting Perl"
14818 .row &%perl_taintmode%&              "enable taint mode in Perl"
14819 .endtable
14820
14821
14822
14823 .section "Daemon" "SECID104"
14824 .table2
14825 .row &%daemon_smtp_ports%&           "default ports"
14826 .row &%daemon_startup_retries%&      "number of times to retry"
14827 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14828 .row &%extra_local_interfaces%&      "not necessarily listened on"
14829 .row &%local_interfaces%&            "on which to listen, with optional ports"
14830 .row &%notifier_socket%&             "override compiled-in value"
14831 .row &%pid_file_path%&               "override compiled-in value"
14832 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14833 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14834 .endtable
14835
14836
14837
14838 .section "Resource control" "SECID105"
14839 .table2
14840 .row &%check_log_inodes%&            "before accepting a message"
14841 .row &%check_log_space%&             "before accepting a message"
14842 .row &%check_spool_inodes%&          "before accepting a message"
14843 .row &%check_spool_space%&           "before accepting a message"
14844 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14845 .row &%queue_only_load%&             "queue incoming if load high"
14846 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14847 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14848 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14849 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14850 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14851 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14852 .row &%smtp_accept_max_per_connection%& "messages per connection"
14853 .row &%smtp_accept_max_per_host%&    "connections from one host"
14854 .row &%smtp_accept_queue%&           "queue mail if more connections"
14855 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14856                                            connection"
14857 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14858 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14859 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14860 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14861 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14862 .endtable
14863
14864
14865
14866 .section "Policy controls" "SECID106"
14867 .table2
14868 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14869 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14870 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14871 .row &%acl_smtp_auth%&               "ACL for AUTH"
14872 .row &%acl_smtp_connect%&            "ACL for connection"
14873 .row &%acl_smtp_data%&               "ACL for DATA"
14874 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14875 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14876 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14877 .row &%acl_smtp_expn%&               "ACL for EXPN"
14878 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14879 .row &%acl_smtp_mail%&               "ACL for MAIL"
14880 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14881 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14882 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14883 .row &%acl_smtp_predata%&            "ACL for start of data"
14884 .row &%acl_smtp_quit%&               "ACL for QUIT"
14885 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14886 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14887 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14888 .row &%acl_smtp_wellknown%&          "ACL for WELLKNOWN"
14889 .row &%av_scanner%&                  "specify virus scanner"
14890 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14891                                       words""&"
14892 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14893 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14894 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14895 .row &%header_maxsize%&              "total size of message header"
14896 .row &%header_line_maxsize%&         "individual header line limit"
14897 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14898 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14899 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14900 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14901 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14902 .row &%host_lookup%&                 "host name looked up for these hosts"
14903 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14904 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14905 .row &%host_reject_connection%&      "reject connection from these hosts"
14906 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14907 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14908 .row &%message_size_limit%&          "for all messages"
14909 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14910 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14911 .row &%spamd_address%&               "set interface to SpamAssassin"
14912 .row &%strict_acl_vars%&             "object to unset ACL variables"
14913 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14914 .endtable
14915
14916
14917
14918 .section "Callout cache" "SECID107"
14919 .table2
14920 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14921                                          item"
14922 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14923                                          item"
14924 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14925 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14926 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14927 .endtable
14928
14929
14930
14931 .section "TLS" "SECID108"
14932 .table2
14933 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14934 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14935 .row &%hosts_require_alpn%&          "mandatory ALPN"
14936 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14937 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14938 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14939 .row &%tls_alpn%&                    "acceptable protocol names"
14940 .row &%tls_certificate%&             "location of server certificate"
14941 .row &%tls_crl%&                     "certificate revocation list"
14942 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14943 .row &%tls_dhparam%&                 "DH parameters for server"
14944 .row &%tls_eccurve%&                 "EC curve selection for server"
14945 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14946 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14947 .row &%tls_privatekey%&              "location of server private key"
14948 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14949 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14950 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14951 .row &%tls_verify_certificates%&     "expected client certificates"
14952 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14953 .endtable
14954
14955
14956
14957 .section "Local user handling" "SECID109"
14958 .table2
14959 .row &%finduser_retries%&            "useful in NIS environments"
14960 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14961 .row &%gecos_pattern%&               "ditto"
14962 .row &%max_username_length%&         "for systems that truncate"
14963 .row &%unknown_login%&               "used when no login name found"
14964 .row &%unknown_username%&            "ditto"
14965 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14966 .row &%uucp_from_sender%&            "ditto"
14967 .endtable
14968
14969
14970
14971 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14972 .table2
14973 .row &%header_maxsize%&              "total size of message header"
14974 .row &%header_line_maxsize%&         "individual header line limit"
14975 .row &%message_size_limit%&          "applies to all messages"
14976 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14977 .row &%received_header_text%&        "expanded to make &'Received:'&"
14978 .row &%received_headers_max%&        "for mail loop detection"
14979 .row &%recipients_max%&              "limit per message"
14980 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14981 .endtable
14982
14983
14984
14985
14986 .section "Non-SMTP incoming messages" "SECID111"
14987 .table2
14988 .row &%receive_timeout%&             "for non-SMTP messages"
14989 .endtable
14990
14991
14992
14993
14994
14995 .section "Incoming SMTP messages" "SECID112"
14996 See also the &'Policy controls'& section above.
14997
14998 .table2
14999 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
15000 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
15001 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
15002 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
15003 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
15004 .row &%dmarc_history_file%&          "DMARC results log"
15005 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
15006 .row &%host_lookup%&                 "host name looked up for these hosts"
15007 .row &%host_lookup_order%&           "order of DNS and local name lookups"
15008 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
15009 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
15010 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
15011 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
15012 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
15013 .row &%smtp_accept_max%&             "simultaneous incoming connections"
15014 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
15015 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
15016 .row &%smtp_accept_max_per_connection%& "messages per connection"
15017 .row &%smtp_accept_max_per_host%&    "connections from one host"
15018 .row &%smtp_accept_queue%&           "queue mail if more connections"
15019 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
15020                                            connection"
15021 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
15022 .row &%smtp_active_hostname%&        "host name to use in messages"
15023 .row &%smtp_banner%&                 "text for welcome banner"
15024 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
15025 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
15026 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
15027 .row &%smtp_etrn_command%&           "what to run for ETRN"
15028 .row &%smtp_etrn_serialize%&         "only one at once"
15029 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
15030 .row &%smtp_max_unknown_commands%&   "before dropping connection"
15031 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
15032 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
15033 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
15034 .row &%smtp_receive_timeout%&        "per command or data line"
15035 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
15036 .row &%smtp_return_error_details%&   "give detail on rejections"
15037 .endtable
15038
15039
15040
15041 .section "SMTP extensions" "SECID113"
15042 .table2
15043 .row &%accept_8bitmime%&             "advertise 8BITMIME"
15044 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
15045 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
15046 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
15047 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
15048 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
15049 .row &%limits_advertise_hosts%&      "advertise LIMITS to these hosts"
15050 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
15051 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
15052 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
15053 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
15054 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
15055 .row &%wellknown_advertise_hosts%&   "advertise WELLKNOWN to these hosts"
15056 .endtable
15057
15058
15059
15060 .section "Processing messages" "SECID114"
15061 .table2
15062 .row &%allow_domain_literals%&       "recognize domain literal syntax"
15063 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
15064 .row &%allow_utf8_domains%&          "in addresses"
15065 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
15066                                       words""&"
15067 .row &%delivery_date_remove%&        "from incoming messages"
15068 .row &%envelope_to_remove%&          "from incoming messages"
15069 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
15070 .row &%headers_charset%&             "default for translations"
15071 .row &%qualify_domain%&              "default for senders"
15072 .row &%qualify_recipient%&           "default for recipients"
15073 .row &%return_path_remove%&          "from incoming messages"
15074 .row &%strip_excess_angle_brackets%& "in addresses"
15075 .row &%strip_trailing_dot%&          "at end of addresses"
15076 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
15077 .endtable
15078
15079
15080
15081 .section "System filter" "SECID115"
15082 .table2
15083 .row &%system_filter%&               "locate system filter"
15084 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
15085                                             directory"
15086 .row &%system_filter_file_transport%& "transport for delivery to a file"
15087 .row &%system_filter_group%&         "group for filter running"
15088 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
15089 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
15090 .row &%system_filter_user%&          "user for filter running"
15091 .endtable
15092
15093
15094
15095 .section "Routing and delivery" "SECID116"
15096 .table2
15097 .row &%disable_ipv6%&                "do no IPv6 processing"
15098 .row &%dns_again_means_nonexist%&    "for broken domains"
15099 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
15100 .row &%dns_dnssec_ok%&               "parameter for resolver"
15101 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
15102 .row &%dns_retrans%&                 "parameter for resolver"
15103 .row &%dns_retry%&                   "parameter for resolver"
15104 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
15105 .row &%dns_use_edns0%&               "parameter for resolver"
15106 .row &%hold_domains%&                "hold delivery for these domains"
15107 .row &%local_interfaces%&            "for routing checks"
15108 .row &%queue_domains%&               "no immediate delivery for these"
15109 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15110 .row &%queue_only%&                  "no immediate delivery at all"
15111 .row &%queue_only_file%&             "no immediate delivery if file exists"
15112 .row &%queue_only_load%&             "no immediate delivery if load is high"
15113 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15114 .row &%queue_only_override%&         "allow command line to override"
15115 .row &%queue_run_in_order%&          "order of arrival"
15116 .row &%queue_run_max%&               "of simultaneous queue runners"
15117 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15118 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15119 .row &%remote_sort_domains%&         "order of remote deliveries"
15120 .row &%retry_data_expire%&           "timeout for retry data"
15121 .row &%retry_interval_max%&          "safety net for retry rules"
15122 .endtable
15123
15124
15125
15126 .section "Bounce and warning messages" "SECID117"
15127 .table2
15128 .row &%bounce_message_file%&         "content of bounce"
15129 .row &%bounce_message_text%&         "content of bounce"
15130 .row &%bounce_return_body%&          "include body if returning message"
15131 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15132 .row &%bounce_return_message%&       "include original message in bounce"
15133 .row &%bounce_return_size_limit%&    "limit on returned message"
15134 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15135 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15136 .row &%errors_copy%&                 "copy bounce messages"
15137 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15138 .row &%delay_warning%&               "time schedule"
15139 .row &%delay_warning_condition%&     "condition for warning messages"
15140 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15141 .row &%smtp_return_error_details%&   "give detail on rejections"
15142 .row &%warn_message_file%&           "content of warning message"
15143 .endtable
15144
15145
15146
15147 .section "Alphabetical list of main options" "SECTalomo"
15148 Those options that undergo string expansion before use are marked with
15149 &dagger;.
15150
15151 .option accept_8bitmime main boolean true
15152 .cindex "8BITMIME"
15153 .cindex "8-bit characters"
15154 .cindex "log" "selectors"
15155 .cindex "log" "8BITMIME"
15156 .cindex "ESMTP extensions" 8BITMIME
15157 This option causes Exim to send 8BITMIME in its response to an SMTP
15158 EHLO command, and to accept the BODY= parameter on MAIL commands.
15159 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15160 takes no steps to do anything special with messages received by this route.
15161
15162 Historically Exim kept this option off by default, but the maintainers
15163 feel that in today's Internet, this causes more problems than it solves.
15164 It now defaults to true.
15165 A more detailed analysis of the issues is provided by Dan Bernstein:
15166 .display
15167 &url(https://cr.yp.to/smtp/8bitmime.html)
15168 .endd
15169
15170 To log received 8BITMIME status use
15171 .code
15172 log_selector = +8bitmime
15173 .endd
15174
15175 .option acl_not_smtp main string&!! unset
15176 .cindex "&ACL;" "for non-SMTP messages"
15177 .cindex "non-SMTP messages" "ACLs for"
15178 This option defines the ACL that is run when a non-SMTP message has been
15179 read and is on the point of being accepted. See section &<<SECnonSMTP>>& for
15180 further details.
15181
15182 .option acl_not_smtp_mime main string&!! unset
15183 This option defines the ACL that is run for individual MIME parts of non-SMTP
15184 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15185 SMTP messages.
15186
15187 .option acl_not_smtp_start main string&!! unset
15188 .cindex "&ACL;" "at start of non-SMTP message"
15189 .cindex "non-SMTP messages" "ACLs for"
15190 This option defines the ACL that is run before Exim starts reading a
15191 non-SMTP message. See section &<<SECnonSMTP>>& for further details.
15192
15193 .option acl_smtp_auth main string&!! unset
15194 .cindex "&ACL;" "setting up for SMTP commands"
15195 .cindex "AUTH" "ACL for"
15196 This option defines the ACL that is run when an SMTP AUTH command is
15197 received.
15198 See chapter &<<CHAPACL>>& for general information on ACLs, and chapter
15199 &<<CHAPSMTPAUTH>>& for details of authentication.
15200
15201 .option acl_smtp_connect main string&!! unset
15202 .cindex "&ACL;" "on SMTP connection"
15203 This option defines the ACL that is run when an SMTP connection is received.
15204 See section &<<SECconnectACL>>& for further details.
15205
15206 .option acl_smtp_data main string&!! unset
15207 .cindex "DATA" "ACL for"
15208 This option defines the ACL that is run after an SMTP DATA command has been
15209 processed and the message itself has been received, but before the final
15210 acknowledgment is sent. See section &<<SECdataACLS>>& for further details.
15211
15212 .option acl_smtp_data_prdr main string&!! accept
15213 .cindex "PRDR" "ACL for"
15214 .cindex "DATA" "PRDR ACL for"
15215 .cindex "&ACL;" "PRDR-related"
15216 .cindex "&ACL;" "per-user data processing"
15217 This option defines the ACL that,
15218 if the PRDR feature has been negotiated,
15219 is run for each recipient after an SMTP DATA command has been
15220 processed and the message itself has been received, but before the
15221 acknowledgment is sent. See section &<<SECTPRDRACL>>& for further details.
15222
15223 .option acl_smtp_dkim main string&!! unset
15224 .cindex DKIM "ACL for"
15225 This option defines the ACL that is run for each DKIM signature
15226 (by default, or as specified in the dkim_verify_signers option)
15227 of a received message.
15228 See section &<<SECDKIMVFY>>& for further details.
15229
15230 .option acl_smtp_etrn main string&!! unset
15231 .cindex "ETRN" "ACL for"
15232 .cindex "ETRN" advertisement
15233 This option defines the ACL that is run when an SMTP ETRN command is
15234 received.
15235 If no value is set then the ETRN facility is not advertised.
15236 See chapter &<<CHAPACL>>& for further details.
15237
15238 .option acl_smtp_expn main string&!! unset
15239 .cindex "EXPN" "ACL for"
15240 This option defines the ACL that is run when an SMTP EXPN command is
15241 received. See chapter &<<CHAPACL>>& for further details.
15242
15243 .option acl_smtp_helo main string&!! unset
15244 .cindex "EHLO" "ACL for"
15245 .cindex "HELO" "ACL for"
15246 This option defines the ACL that is run when an SMTP EHLO or HELO
15247 command is received. See section &<<SECheloACL>>& for further details.
15248
15249
15250 .option acl_smtp_mail main string&!! unset
15251 .cindex "MAIL" "ACL for"
15252 This option defines the ACL that is run when an SMTP MAIL command is
15253 received. See chapter &<<CHAPACL>>& for further details.
15254
15255 .option acl_smtp_mailauth main string&!! unset
15256 .cindex "AUTH" "on MAIL command"
15257 This option defines the ACL that is run when there is an AUTH parameter on
15258 a MAIL command.
15259 See chapter &<<CHAPACL>>& for general information on ACLs, and chapter
15260 &<<CHAPSMTPAUTH>>& for details of authentication.
15261
15262 .option acl_smtp_mime main string&!! unset
15263 .cindex "MIME content scanning" "ACL for"
15264 This option is available when Exim is built with the content-scanning
15265 extension. It defines the ACL that is run for each MIME part in a message. See
15266 section &<<SECTscanmimepart>>& for details.
15267
15268 .option acl_smtp_notquit main string&!! unset
15269 .cindex "not-QUIT, ACL for"
15270 This option defines the ACL that is run when an SMTP session
15271 ends without a QUIT command being received.
15272 See section &<<SECTNOTQUITACL>>& for further details.
15273
15274 .option acl_smtp_predata main string&!! unset
15275 This option defines the ACL that is run when an SMTP DATA command is
15276 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15277 further details.
15278
15279 .option acl_smtp_quit main string&!! unset
15280 .cindex "QUIT, ACL for"
15281 This option defines the ACL that is run when an SMTP QUIT command is
15282 received. See chapter &<<CHAPACL>>& for further details.
15283
15284 .option acl_smtp_rcpt main string&!! unset
15285 .cindex "RCPT" "ACL for"
15286 This option defines the ACL that is run when an SMTP RCPT command is
15287 received. See section &<<SECTQUITACL>>& for further details.
15288
15289 .option acl_smtp_starttls main string&!! unset
15290 .cindex "STARTTLS, ACL for"
15291 This option defines the ACL that is run when an SMTP STARTTLS command is
15292 received. See chapter &<<CHAPACL>>& for further details.
15293
15294 .option acl_smtp_vrfy main string&!! unset
15295 .cindex "VRFY" "ACL for"
15296 This option defines the ACL that is run when an SMTP VRFY command is
15297 received. See chapter &<<CHAPACL>>& for further details.
15298
15299 .option acl_smtp_wellknown main string&!! unset
15300 .cindex "WELLKNOWN, ACL for"
15301 This option defines the ACL that is run when an SMTP WELLKNOWN command is
15302 received. See section &<<SECTWELLKNOWNACL>>& for further details.
15303
15304 .option add_environment main "string list" empty
15305 .cindex "environment" "set values"
15306 This option adds individual environment variables that the
15307 currently linked libraries and programs in child processes may use.
15308 Each list element should be of the form &"name=value"&.
15309
15310 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15311
15312 .option admin_groups main "string list&!!" unset
15313 .cindex "admin user"
15314 This option is expanded just once, at the start of Exim's processing. If the
15315 current group or any of the supplementary groups of an Exim caller is in this
15316 colon-separated list, the caller has admin privileges. If all your system
15317 programmers are in a specific group, for example, you can give them all Exim
15318 admin privileges by putting that group in &%admin_groups%&. However, this does
15319 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15320 To permit this, you have to add individuals to the Exim group.
15321
15322 .option allow_domain_literals main boolean false
15323 .cindex "domain literal"
15324 If this option is set, the RFC 2822 domain literal format is permitted in
15325 email addresses. The option is not set by default, because the domain literal
15326 format is not normally required these days, and few people know about it. It
15327 has, however, been exploited by mail abusers.
15328
15329 Unfortunately, it seems that some DNS black list maintainers are using this
15330 format to report black listing to postmasters. If you want to accept messages
15331 addressed to your hosts by IP address, you need to set
15332 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15333 domains (defined in the named domain list &%local_domains%& in the default
15334 configuration). This &"magic string"& matches the domain literal form of all
15335 the local host's IP addresses.
15336
15337 .option allow_mx_to_ip main boolean false
15338 .cindex "MX record" "pointing to IP address"
15339 It appears that more and more DNS zone administrators are breaking the rules
15340 and putting domain names that look like IP addresses on the right hand side of
15341 MX records. Exim follows the rules and rejects this, giving an error message
15342 that explains the misconfiguration. However, some other MTAs support this
15343 practice, so to avoid &"Why can't Exim do this?"& complaints,
15344 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15345 recommended, except when you have no other choice.
15346
15347 .option allow_utf8_domains main boolean false
15348 .cindex "domain" "UTF-8 characters in"
15349 .cindex "UTF-8" "in domain name"
15350 Lots of discussion is going on about internationalized domain names. One
15351 camp is strongly in favour of just using UTF-8 characters, and it seems
15352 that at least two other MTAs permit this.
15353 This option allows Exim users to experiment if they wish.
15354
15355 If it is set true, Exim's domain parsing function allows valid
15356 UTF-8 multicharacters to appear in domain name components, in addition to
15357 letters, digits, and hyphens.
15358
15359 If Exim is built with internationalization support
15360 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15361 this option can be left as default.
15362 Without that,
15363 if you want to look up such domain names in the DNS, you must also
15364 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15365 suitable setting is:
15366 .code
15367 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15368   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15369 .endd
15370 Alternatively, you can just disable this feature by setting
15371 .code
15372 dns_check_names_pattern =
15373 .endd
15374 That is, set the option to an empty string so that no check is done.
15375
15376
15377 .option auth_advertise_hosts main "host list&!!" *
15378 .cindex "authentication" "advertising"
15379 .cindex "AUTH" "advertising"
15380 .cindex "ESMTP extensions" AUTH
15381 If any server authentication mechanisms are configured, Exim advertises them in
15382 response to an EHLO command only if the calling host matches this list.
15383 Otherwise, Exim does not advertise AUTH.
15384 Exim does not accept AUTH commands from clients to which it has not
15385 advertised the availability of AUTH. The advertising of individual
15386 authentication mechanisms can be controlled by the use of the
15387 &%server_advertise_condition%& generic authenticator option on the individual
15388 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15389
15390 Certain mail clients (for example, Netscape) require the user to provide a name
15391 and password for authentication if AUTH is advertised, even though it may
15392 not be needed (the host may accept messages from hosts on its local LAN without
15393 authentication, for example). The &%auth_advertise_hosts%& option can be used
15394 to make these clients more friendly by excluding them from the set of hosts to
15395 which Exim advertises AUTH.
15396
15397 .cindex "AUTH" "advertising when encrypted"
15398 If you want to advertise the availability of AUTH only when the connection
15399 is encrypted using TLS, you can make use of the fact that the value of this
15400 option is expanded, with a setting like this:
15401 .code
15402 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15403 .endd
15404 .vindex "&$tls_in_cipher$&"
15405 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15406 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15407 expansion is *, which matches all hosts.
15408
15409
15410 .option auto_thaw main time 0s
15411 .cindex "thawing messages"
15412 .cindex "unfreezing messages"
15413 If this option is set to a time greater than zero, a queue runner will try a
15414 new delivery attempt on any frozen message, other than a bounce message, if
15415 this much time has passed since it was frozen. This may result in the message
15416 being re-frozen if nothing has changed since the last attempt. It is a way of
15417 saying &"keep on trying, even though there are big problems"&.
15418
15419 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15420 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15421 thought to be very useful any more, and its use should probably be avoided.
15422
15423
15424 .option av_scanner main string "see below"
15425 This option is available if Exim is built with the content-scanning extension.
15426 It specifies which anti-virus scanner to use. The default value is:
15427 .code
15428 sophie:/var/run/sophie
15429 .endd
15430 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15431 before use. See section &<<SECTscanvirus>>& for further details.
15432
15433
15434 .option bi_command main string unset
15435 .oindex "&%-bi%&"
15436 This option supplies the name of a command that is run when Exim is called with
15437 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15438 just the command name, it is not a complete command line. If an argument is
15439 required, it must come from the &%-oA%& command line option.
15440
15441
15442 .option bounce_message_file main string&!! unset
15443 .cindex "bounce message" "customizing"
15444 .cindex "customizing" "bounce message"
15445 This option defines a template file containing paragraphs of text to be used
15446 for constructing bounce messages.  Details of the file's contents are given in
15447 chapter &<<CHAPemsgcust>>&.
15448 .cindex bounce_message_file "tainted data"
15449 The option is expanded to give the file path, which must be
15450 absolute and untainted.
15451 See also &%warn_message_file%&.
15452
15453
15454 .option bounce_message_text main string unset
15455 When this option is set, its contents are included in the default bounce
15456 message immediately after &"This message was created automatically by mail
15457 delivery software."& It is not used if &%bounce_message_file%& is set.
15458
15459 .option bounce_return_body main boolean true
15460 .cindex "bounce message" "including body"
15461 This option controls whether the body of an incoming message is included in a
15462 bounce message when &%bounce_return_message%& is true. The default setting
15463 causes the entire message, both header and body, to be returned (subject to the
15464 value of &%bounce_return_size_limit%&). If this option is false, only the
15465 message header is included. In the case of a non-SMTP message containing an
15466 error that is detected during reception, only those header lines preceding the
15467 point at which the error was detected are returned.
15468 .cindex "bounce message" "including original"
15469
15470 .option bounce_return_linesize_limit main integer 998
15471 .cindex "size" "of bounce lines, limit"
15472 .cindex "bounce message" "line length limit"
15473 .cindex "limit" "bounce message line length"
15474 This option sets a limit in bytes on the line length of messages
15475 that are returned to senders due to delivery problems,
15476 when &%bounce_return_message%& is true.
15477 The default value corresponds to RFC limits.
15478 If the message being returned has lines longer than this value it is
15479 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15480
15481 The option also applies to bounces returned when an error is detected
15482 during reception of a message.
15483 In this case lines from the original are truncated.
15484
15485 The option does not apply to messages generated by an &(autoreply)& transport.
15486
15487
15488 .option bounce_return_message main boolean true
15489 If this option is set false, none of the original message is included in
15490 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15491 &%bounce_return_body%&.
15492
15493
15494 .option bounce_return_size_limit main integer 100K
15495 .cindex "size" "of bounce, limit"
15496 .cindex "bounce message" "size limit"
15497 .cindex "limit" "bounce message size"
15498 This option sets a limit in bytes on the size of messages that are returned to
15499 senders as part of bounce messages when &%bounce_return_message%& is true. The
15500 limit should be less than the value of the global &%message_size_limit%& and of
15501 any &%message_size_limit%& settings on transports, to allow for the bounce text
15502 that Exim generates. If this option is set to zero there is no limit.
15503
15504 When the body of any message that is to be included in a bounce message is
15505 greater than the limit, it is truncated, and a comment pointing this out is
15506 added at the top. The actual cutoff may be greater than the value given, owing
15507 to the use of buffering for transferring the message in chunks (typically 8K in
15508 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15509 messages.
15510
15511 .option bounce_sender_authentication main string unset
15512 .cindex "bounce message" "sender authentication"
15513 .cindex "authentication" "bounce message"
15514 .cindex "AUTH" "on bounce message"
15515 This option provides an authenticated sender address that is sent with any
15516 bounce messages generated by Exim that are sent over an authenticated SMTP
15517 connection. A typical setting might be:
15518 .code
15519 bounce_sender_authentication = mailer-daemon@my.domain.example
15520 .endd
15521 which would cause bounce messages to be sent using the SMTP command:
15522 .code
15523 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15524 .endd
15525 The value of &%bounce_sender_authentication%& must always be a complete email
15526 address.
15527
15528 .option callout_domain_negative_expire main time 3h
15529 .cindex "caching" "callout timeouts"
15530 .cindex "callout" "caching timeouts"
15531 This option specifies the expiry time for negative callout cache data for a
15532 domain. See section &<<SECTcallver>>& for details of callout verification, and
15533 section &<<SECTcallvercache>>& for details of the caching.
15534
15535
15536 .option callout_domain_positive_expire main time 7d
15537 This option specifies the expiry time for positive callout cache data for a
15538 domain. See section &<<SECTcallver>>& for details of callout verification, and
15539 section &<<SECTcallvercache>>& for details of the caching.
15540
15541
15542 .option callout_negative_expire main time 2h
15543 This option specifies the expiry time for negative callout cache data for an
15544 address. See section &<<SECTcallver>>& for details of callout verification, and
15545 section &<<SECTcallvercache>>& for details of the caching.
15546
15547
15548 .option callout_positive_expire main time 24h
15549 This option specifies the expiry time for positive callout cache data for an
15550 address. See section &<<SECTcallver>>& for details of callout verification, and
15551 section &<<SECTcallvercache>>& for details of the caching.
15552
15553
15554 .option callout_random_local_part main string&!! "see below"
15555 This option defines the &"random"& local part that can be used as part of
15556 callout verification. The default value is
15557 .code
15558 $primary_hostname-$tod_epoch-testing
15559 .endd
15560 See section &<<CALLaddparcall>>& for details of how this value is used.
15561
15562
15563 .options check_log_inodes main integer 100 &&&
15564          check_log_space main integer 10M
15565 See &%check_spool_space%& below.
15566
15567 .oindex "&%check_rfc2047_length%&"
15568 .cindex "RFC 2047" "disabling length check"
15569 .option check_rfc2047_length main boolean true
15570 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15571 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15572 word; strings to be encoded that exceed this length are supposed to use
15573 multiple encoded words. By default, Exim does not recognize encoded words that
15574 exceed the maximum length. However, it seems that some software, in violation
15575 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15576 set false, Exim recognizes encoded words of any length.
15577
15578
15579 .options check_spool_inodes main integer 100 &&&
15580          check_spool_space main integer 10M
15581 .cindex "checking disk space"
15582 .cindex "disk space, checking"
15583 .cindex "spool directory" "checking space"
15584 The four &%check_...%& options allow for checking of disk resources before a
15585 message is accepted.
15586
15587 .vindex "&$log_inodes$&"
15588 .vindex "&$log_space$&"
15589 .vindex "&$spool_inodes$&"
15590 .vindex "&$spool_space$&"
15591 When any of these options are nonzero, they apply to all incoming messages. If you
15592 want to apply different checks to different kinds of message, you can do so by
15593 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15594 &$spool_space$& in an ACL with appropriate additional conditions.
15595
15596
15597 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15598 either value is greater than zero, for example:
15599 .code
15600 check_spool_space = 100M
15601 check_spool_inodes = 100
15602 .endd
15603 The spool partition is the one that contains the directory defined by
15604 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15605 transit.
15606
15607 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15608 files are written if either is greater than zero. These should be set only if
15609 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15610
15611 If there is less space or fewer inodes than requested, Exim refuses to accept
15612 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15613 error response to the MAIL command. If ESMTP is in use and there was a
15614 SIZE parameter on the MAIL command, its value is added to the
15615 &%check_spool_space%& value, and the check is performed even if
15616 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15617
15618 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15619 number of kilobytes (though specified in bytes).
15620 If a non-multiple of 1024 is specified, it is rounded up.
15621
15622 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15623 failure a message is written to stderr and Exim exits with a non-zero code, as
15624 it obviously cannot send an error message of any kind.
15625
15626 There is a slight performance penalty for these checks.
15627 Versions of Exim preceding 4.88 had these disabled by default;
15628 high-rate installations confident they will never run out of resources
15629 may wish to deliberately disable them.
15630
15631 .option chunking_advertise_hosts main "host list&!!" *
15632 .cindex CHUNKING advertisement
15633 .cindex "RFC 3030" "CHUNKING"
15634 .cindex "ESMTP extensions" CHUNKING
15635 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15636 these hosts.
15637 Hosts may use the BDAT command as an alternate to DATA.
15638
15639 .option commandline_checks_require_admin main boolean &`false`&
15640 .cindex "restricting access to features"
15641 This option restricts various basic checking features to require an
15642 administrative user.
15643 This affects most of the &%-b*%& options, such as &%-be%&.
15644
15645 .option debug_store main boolean &`false`&
15646 .cindex debugging "memory corruption"
15647 .cindex memory debugging
15648 This option, when true, enables extra checking in Exim's internal memory
15649 management.  For use when a memory corruption issue is being investigated,
15650 it should normally be left as default.
15651
15652 .option daemon_smtp_ports main string &`smtp`&
15653 .cindex "port" "for daemon"
15654 .cindex "TCP/IP" "setting listening ports"
15655 This option specifies one or more default SMTP ports on which the Exim daemon
15656 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15657 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15658
15659 .options daemon_startup_retries main integer 9 &&&
15660          daemon_startup_sleep main time 30s
15661 .cindex "daemon startup, retrying"
15662 These options control the retrying done by
15663 the daemon at startup when it cannot immediately bind a listening socket
15664 (typically because the socket is already in use): &%daemon_startup_retries%&
15665 defines the number of retries after the first failure, and
15666 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15667
15668 .option delay_warning main "time list" 24h
15669 .cindex "warning of delay"
15670 .cindex "delay warning, specifying"
15671 .cindex "queue" "delay warning"
15672 When a message is delayed, Exim sends a warning message to the sender at
15673 intervals specified by this option. The data is a colon-separated list of times
15674 after which to send warning messages. If the value of the option is an empty
15675 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15676 message has been in the queue for longer than the last time, the last interval
15677 between the times is used to compute subsequent warning times. For example,
15678 with
15679 .code
15680 delay_warning = 4h:8h:24h
15681 .endd
15682 the first message is sent after 4 hours, the second after 8 hours, and
15683 the third one after 24 hours. After that, messages are sent every 16 hours,
15684 because that is the interval between the last two times on the list. If you set
15685 just one time, it specifies the repeat interval. For example, with:
15686 .code
15687 delay_warning = 6h
15688 .endd
15689 messages are repeated every six hours. To stop warnings after a given time, set
15690 a very large time at the end of the list. For example:
15691 .code
15692 delay_warning = 2h:12h:99d
15693 .endd
15694 Note that the option is only evaluated at the time a delivery attempt fails,
15695 which depends on retry and queue-runner configuration.
15696 Typically retries will be configured more frequently than warning messages.
15697
15698 .option delay_warning_condition main string&!! "see below"
15699 .vindex "&$domain$&"
15700 The string is expanded at the time a warning message might be sent. If all the
15701 deferred addresses have the same domain, it is set in &$domain$& during the
15702 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15703 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15704 &"false"& (the comparison being done caselessly) then the warning message is
15705 not sent. The default is:
15706 .code
15707 delay_warning_condition = ${if or {\
15708   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15709   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15710   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15711   } {no}{yes}}
15712 .endd
15713 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15714 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15715 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15716 &"auto-replied"& in an &'Auto-Submitted:'& header.
15717
15718 .option deliver_drop_privilege main boolean false
15719 .cindex "unprivileged delivery"
15720 .cindex "delivery" "unprivileged"
15721 If this option is set true, Exim drops its root privilege at the start of a
15722 delivery process, and runs as the Exim user throughout. This severely restricts
15723 the kinds of local delivery that are possible, but is viable in certain types
15724 of configuration. There is a discussion about the use of root privilege in
15725 chapter &<<CHAPsecurity>>&.
15726
15727 .option deliver_queue_load_max main fixed-point unset
15728 .cindex "load average"
15729 .cindex "queue runner" "abandoning"
15730 When this option is set, a queue run is abandoned if the system load average
15731 becomes greater than the value of the option. The option has no effect on
15732 ancient operating systems on which Exim cannot determine the load average.
15733 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15734
15735
15736 .option delivery_date_remove main boolean true
15737 .cindex "&'Delivery-date:'& header line"
15738 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15739 message when it is delivered, in exactly the same way as &'Return-path:'& is
15740 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15741 should not be present in incoming messages, and this option causes them to be
15742 removed at the time the message is received, to avoid any problems that might
15743 occur when a delivered message is subsequently sent on to some other recipient.
15744
15745 .option disable_fsync main boolean false
15746 .cindex "&[fsync()]&, disabling"
15747 This option is available only if Exim was built with the compile-time option
15748 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15749 a runtime configuration generates an &"unknown option"& error. You should not
15750 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15751 really, really, really understand what you are doing. &'No pre-compiled
15752 distributions of Exim should ever make this option available.'&
15753
15754 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15755 updated files' data to be written to disc before continuing. Unexpected events
15756 such as crashes and power outages may cause data to be lost or scrambled.
15757 Here be Dragons. &*Beware.*&
15758
15759
15760 .option disable_ipv6 main boolean false
15761 .cindex "IPv6" "disabling"
15762 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15763 activities take place. AAAA records are never looked up, and any IPv6 addresses
15764 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15765 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15766 to handle IPv6 literal addresses.
15767
15768
15769 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15770 .cindex DKIM "selecting signature algorithms"
15771 This option gives a list of hash types which are acceptable in signatures,
15772 and an order of processing.
15773 Signatures with algorithms not in the list will be ignored.
15774
15775 Acceptable values include:
15776 .code
15777 sha1
15778 sha256
15779 sha512
15780 .endd
15781
15782 Note that the acceptance of sha1 violates RFC 8301.
15783
15784 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15785 This option gives a list of key types which are acceptable in signatures,
15786 and an order of processing.
15787 Signatures with algorithms not in the list will be ignored.
15788
15789
15790 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15791 This option gives a list of key sizes which are acceptable in signatures.
15792 The list is keyed by the algorithm type for the key; the values are in bits.
15793 Signatures with keys smaller than given by this option will fail verification.
15794
15795 The default enforces the RFC 8301 minimum key size for RSA signatures.
15796
15797 .option dkim_verify_minimal main boolean false
15798 If set to true, verification of signatures will terminate after the
15799 first success.
15800
15801 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15802 .cindex DKIM "controlling calls to the ACL"
15803 This option gives a list of DKIM domains for which the DKIM ACL is run.
15804 It is expanded after the message is received; by default it runs
15805 the ACL once for each signature in the message.
15806 See section &<<SECDKIMVFY>>&.
15807
15808
15809 .options dmarc_forensic_sender main string&!! unset &&&
15810          dmarc_history_file main string unset &&&
15811          dmarc_tld_file main string unset
15812 .cindex DMARC "main section options"
15813 These options control DMARC processing.
15814 See section &<<SECDMARC>>& for details.
15815
15816
15817 .option dns_again_means_nonexist main "domain list&!!" unset
15818 .cindex "DNS" "&""try again""& response; overriding"
15819 DNS lookups give a &"try again"& response for the DNS errors
15820 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15821 keep trying to deliver a message, or to give repeated temporary errors to
15822 incoming mail. Sometimes the effect is caused by a badly set up name server and
15823 may persist for a long time. If a domain which exhibits this problem matches
15824 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15825 This option should be used with care. You can make it apply to reverse lookups
15826 by a setting such as this:
15827 .code
15828 dns_again_means_nonexist = *.in-addr.arpa
15829 .endd
15830 This option applies to all DNS lookups that Exim does,
15831 except for TLSA lookups (where knowing about such failures
15832 is security-relevant).
15833 It also applies when the
15834 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15835 since these are most likely to be caused by DNS lookup problems. The
15836 &(dnslookup)& router has some options of its own for controlling what happens
15837 when lookups for MX or SRV records give temporary errors. These more specific
15838 options are applied after this global option.
15839
15840 .option dns_check_names_pattern main string "see below"
15841 .cindex "DNS" "pre-check of name syntax"
15842 When this option is set to a non-empty string, it causes Exim to check domain
15843 names for characters that are not allowed in host names before handing them to
15844 the DNS resolver, because some resolvers give temporary errors for names that
15845 contain unusual characters. If a domain name contains any unwanted characters,
15846 a &"not found"& result is forced, and the resolver is not called. The check is
15847 done by matching the domain name against a regular expression, which is the
15848 value of this option. The default pattern is
15849 .code
15850 dns_check_names_pattern = \
15851   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15852 .endd
15853 which permits only letters, digits, slashes, and hyphens in components, but
15854 they must start and end with a letter or digit. Slashes are not, in fact,
15855 permitted in host names, but they are found in certain NS records (which can be
15856 accessed in Exim by using a &%dnsdb%& lookup). If you set
15857 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15858 empty string.
15859
15860 .option dns_csa_search_limit main integer 5
15861 This option controls the depth of parental searching for CSA SRV records in the
15862 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15863
15864 .option dns_csa_use_reverse main boolean true
15865 This option controls whether or not an IP address, given as a CSA domain, is
15866 reversed and looked up in the reverse DNS, as described in more detail in
15867 section &<<SECTverifyCSA>>&.
15868
15869 .option dns_cname_loops main integer 1
15870 .cindex DNS "CNAME following"
15871 This option controls the following of CNAME chains, needed if the resolver does
15872 not do it internally.
15873 As of 2018 most should, and the default can be left.
15874 If you have an ancient one, a value of 10 is likely needed.
15875
15876 The default value of one CNAME-follow is needed
15877 thanks to the observed return for an MX request,
15878 given no MX presence but a CNAME to an A, of the CNAME.
15879
15880
15881 .option dns_dnssec_ok main integer -1
15882 .cindex "DNS" "resolver options"
15883 .cindex "DNS" "DNSSEC"
15884 If this option is set to a non-negative number then Exim will initialise the
15885 DNS resolver library to either use or not use DNSSEC, overriding the system
15886 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15887
15888 If the resolver library does not support DNSSEC then this option has no effect.
15889
15890 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15891 will default to stripping out a successful validation status.
15892 This will break a previously working Exim installation.
15893 Provided that you do trust the resolver (ie, is on localhost) you can tell
15894 glibc to pass through any successful validation with a new option in
15895 &_/etc/resolv.conf_&:
15896 .code
15897 options trust-ad
15898 .endd
15899
15900
15901 .option dns_ipv4_lookup main "domain list&!!" unset
15902 .cindex "IPv6" "DNS lookup for AAAA records"
15903 .cindex "DNS" "IPv6 lookup for AAAA records"
15904 .cindex DNS "IPv6 disabling"
15905 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15906 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15907 (A records) when trying to find IP addresses for hosts, unless the host's
15908 domain matches this list.
15909
15910 This is a fudge to help with name servers that give big delays or otherwise do
15911 not work for the AAAA record type. In due course, when the world's name
15912 servers have all been upgraded, there should be no need for this option.
15913 Note that all lookups, including those done for verification, are affected;
15914 this will result in verify failure for IPv6 connections or ones using names
15915 only valid for IPv6 addresses.
15916
15917
15918 .option dns_retrans main time 0s
15919 .cindex "DNS" "resolver options"
15920 .cindex timeout "dns lookup"
15921 .cindex "DNS" timeout
15922 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15923 retransmission and retry parameters for DNS lookups. Values of zero (the
15924 defaults) leave the system default settings unchanged. The first value is the
15925 time between retries, and the second is the number of retries. It isn't
15926 totally clear exactly how these settings affect the total time a DNS lookup may
15927 take. I haven't found any documentation about timeouts on DNS lookups; these
15928 parameter values are available in the external resolver interface structure,
15929 but nowhere does it seem to describe how they are used or what you might want
15930 to set in them.
15931 See also the &%slow_lookup_log%& option.
15932
15933
15934 .option dns_retry main integer 0
15935 See &%dns_retrans%& above.
15936
15937
15938 .option dns_trust_aa main "domain list&!!" unset
15939 .cindex "DNS" "resolver options"
15940 .cindex "DNS" "DNSSEC"
15941 If this option is set then lookup results marked with the AA bit
15942 (Authoritative Answer) are trusted the same way as if they were
15943 DNSSEC-verified. The authority section's name of the answer must
15944 match with this expanded domain list.
15945
15946 Use this option only if you talk directly to a resolver that is
15947 authoritative for some zones and does not set the AD (Authentic Data)
15948 bit in the answer. Some DNS servers may have an configuration option to
15949 mark the answers from their own zones as verified (they set the AD bit).
15950 Others do not have this option. It is considered as poor practice using
15951 a resolver that is an authoritative server for some zones.
15952
15953 Use this option only if you really have to (e.g. if you want
15954 to use DANE for remote delivery to a server that is listed in the DNS
15955 zones that your resolver is authoritative for).
15956
15957 If the DNS answer packet has the AA bit set and contains resource record
15958 in the answer section, the name of the first NS record appearing in the
15959 authority section is compared against the list. If the answer packet is
15960 authoritative but the answer section is empty, the name of the first SOA
15961 record in the authoritative section is used instead.
15962
15963 .cindex "DNS" "resolver options"
15964 .option dns_use_edns0 main integer -1
15965 .cindex "DNS" "resolver options"
15966 .cindex "DNS" "EDNS0"
15967 .cindex "DNS" "OpenBSD
15968 If this option is set to a non-negative number then Exim will initialise the
15969 DNS resolver library to either use or not use EDNS0 extensions, overriding
15970 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15971 on.
15972
15973 If the resolver library does not support EDNS0 then this option has no effect.
15974
15975 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15976 means that DNSSEC will not work with Exim on that platform either, unless Exim
15977 is linked against an alternative DNS client library.
15978
15979
15980 .option drop_cr main boolean false
15981 This is an obsolete option that is now a no-op. It used to affect the way Exim
15982 handled CR and LF characters in incoming messages. What happens now is
15983 described in section &<<SECTlineendings>>&.
15984
15985 .option dsn_advertise_hosts main "host list&!!" unset
15986 .cindex "bounce messages" "success"
15987 .cindex "DSN" "success"
15988 .cindex "Delivery Status Notification" "success"
15989 .cindex "ESMTP extensions" DSN
15990 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15991 and accepted from, these hosts.
15992 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15993 and RET and ENVID options on MAIL FROM commands.
15994 A NOTIFY=SUCCESS option requests success-DSN messages.
15995 A NOTIFY= option with no argument requests that no delay or failure DSNs
15996 are sent.
15997 &*Note*&: Supplying success-DSN messages has been criticised
15998 on privacy grounds; it can leak details of internal forwarding.
15999
16000 .option dsn_from main "string&!!" "see below"
16001 .cindex "&'From:'& header line" "in bounces"
16002 .cindex "bounce messages" "&'From:'& line, specifying"
16003 This option can be used to vary the contents of &'From:'& header lines in
16004 bounces and other automatically generated messages (&"Delivery Status
16005 Notifications"& &-- hence the name of the option). The default setting is:
16006 .code
16007 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
16008 .endd
16009 The value is expanded every time it is needed. If the expansion fails, a
16010 panic is logged, and the default value is used.
16011
16012 .option envelope_to_remove main boolean true
16013 .cindex "&'Envelope-to:'& header line"
16014 Exim's transports have an option for adding an &'Envelope-to:'& header to a
16015 message when it is delivered, in exactly the same way as &'Return-path:'& is
16016 handled. &'Envelope-to:'& records the original recipient address from the
16017 message's envelope that caused the delivery to happen. Such headers should not
16018 be present in incoming messages, and this option causes them to be removed at
16019 the time the message is received, to avoid any problems that might occur when a
16020 delivered message is subsequently sent on to some other recipient.
16021
16022
16023 .option errors_copy main "string list&!!" unset
16024 .cindex "bounce message" "copy to other address"
16025 .cindex "copy of bounce message"
16026 Setting this option causes Exim to send bcc copies of bounce messages that it
16027 generates to other addresses. &*Note*&: This does not apply to bounce messages
16028 coming from elsewhere. The value of the option is a colon-separated list of
16029 items. Each item consists of a pattern, terminated by white space, followed by
16030 a comma-separated list of email addresses. If a pattern contains spaces, it
16031 must be enclosed in double quotes.
16032
16033 Each pattern is processed in the same way as a single item in an address list
16034 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
16035 the bounce message, the message is copied to the addresses on the list. The
16036 items are scanned in order, and once a matching one is found, no further items
16037 are examined. For example:
16038 .code
16039 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
16040               rqps@mydomain   hostmaster@mydomain.example,\
16041                               postmaster@mydomain.example
16042 .endd
16043 .vindex "&$domain$&"
16044 .vindex "&$local_part$&"
16045 The address list is expanded before use. The expansion variables &$local_part$&
16046 and &$domain$& are set from the original recipient of the error message, and if
16047 there was any wildcard matching in the pattern, the expansion
16048 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
16049 variables &$0$&, &$1$&, etc. are set in the normal way.
16050
16051
16052 .option errors_reply_to main string unset
16053 .cindex "bounce message" "&'Reply-to:'& in"
16054 By default, Exim's bounce and delivery warning messages contain the header line
16055 .display
16056 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
16057 .endd
16058 .oindex &%quota_warn_message%&
16059 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
16060 A warning message that is generated by the &%quota_warn_message%& option in an
16061 &(appendfile)& transport may contain its own &'From:'& header line that
16062 overrides the default.
16063
16064 Experience shows that people reply to bounce messages. If the
16065 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
16066 and warning messages. For example:
16067 .code
16068 errors_reply_to = postmaster@my.domain.example
16069 .endd
16070 The value of the option is not expanded. It must specify a valid RFC 2822
16071 address. However, if a warning message that is generated by the
16072 &%quota_warn_message%& option in an &(appendfile)& transport contain its
16073 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
16074 not used.
16075
16076
16077 .option event_action main string&!! unset
16078 .cindex events
16079 This option declares a string to be expanded for Exim's events mechanism.
16080 For details see chapter &<<CHAPevents>>&.
16081
16082
16083 .option exim_group main string "compile-time configured"
16084 .cindex "gid (group id)" "Exim's own"
16085 .cindex "Exim group"
16086 This option changes the gid under which Exim runs when it gives up root
16087 privilege. The default value is compiled into the binary. The value of this
16088 option is used only when &%exim_user%& is also set. Unless it consists entirely
16089 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
16090 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
16091 security issues.
16092
16093
16094 .option exim_path main string "see below"
16095 .cindex "Exim binary, path name"
16096 This option specifies the path name of the Exim binary, which is used when Exim
16097 needs to re-exec itself. The default is set up to point to the file &'exim'& in
16098 the directory configured at compile time by the BIN_DIRECTORY setting. It
16099 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
16100 other place.
16101 &*Warning*&: Do not use a macro to define the value of this option, because
16102 you will break those Exim utilities that scan the configuration file to find
16103 where the binary is. (They then use the &%-bP%& option to extract option
16104 settings such as the value of &%spool_directory%&.)
16105
16106
16107 .option exim_user main string "compile-time configured"
16108 .cindex "uid (user id)" "Exim's own"
16109 .cindex "Exim user"
16110 This option changes the uid under which Exim runs when it gives up root
16111 privilege. The default value is compiled into the binary. Ownership of the run
16112 time configuration file and the use of the &%-C%& and &%-D%& command line
16113 options is checked against the values in the binary, not what is set here.
16114
16115 Unless it consists entirely of digits, the string is looked up using
16116 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16117 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16118 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16119
16120
16121 .option exim_version main string "current version"
16122 .cindex "Exim version"
16123 .cindex customizing "version number"
16124 .cindex "version number of Exim" override
16125 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16126 various places.  Use with care; this may fool stupid security scanners.
16127
16128
16129 .option extra_local_interfaces main "string list" unset
16130 This option defines network interfaces that are to be considered local when
16131 routing, but which are not used for listening by the daemon. See section
16132 &<<SECTreclocipadd>>& for details.
16133
16134
16135 . Allow this long option name to split; give it unsplit as a fifth argument
16136 . for the automatic .oindex that is generated by .option.
16137 . WAS:
16138 . .option "extract_addresses_remove_ &~&~arguments"
16139 . but apparently this results in searchability problems; bug 1197
16140
16141 .option extract_addresses_remove_arguments main boolean true
16142 .oindex "&%-t%&"
16143 .cindex "command line" "addresses with &%-t%&"
16144 .cindex "Sendmail compatibility" "&%-t%& option"
16145 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16146 are present on the command line when the &%-t%& option is used to build an
16147 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16148 line addresses are removed from the recipients list. This is also how Smail
16149 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16150 command line addresses are added to those obtained from the header lines. When
16151 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16152 argument headers. If it is set false, Exim adds rather than removes argument
16153 addresses.
16154
16155
16156 .option finduser_retries main integer 0
16157 .cindex "NIS, retrying user lookups"
16158 On systems running NIS or other schemes in which user and group information is
16159 distributed from a remote system, there can be times when &[getpwnam()]& and
16160 related functions fail, even when given valid data, because things time out.
16161 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16162 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16163 many extra times to find a user or a group, waiting for one second between
16164 retries.
16165
16166 .cindex "&_/etc/passwd_&" "multiple reading of"
16167 You should not set this option greater than zero if your user information is in
16168 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16169 search the file multiple times for non-existent users, and also cause delay.
16170
16171
16172
16173 .option freeze_tell main "string list, comma separated" unset
16174 .cindex "freezing messages" "sending a message when freezing"
16175 .cindex "frozen messages" "sending a message when freezing"
16176 On encountering certain errors, or when configured to do so in a system filter,
16177 ACL, or special router, Exim freezes a message. This means that no further
16178 delivery attempts take place until an administrator thaws the message, or the
16179 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16180 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16181 warning message whenever it freezes something, unless the message it is
16182 freezing is a locally-generated bounce message. (Without this exception there
16183 is the possibility of looping.) The warning message is sent to the addresses
16184 supplied as the comma-separated value of this option. If several of the
16185 message's addresses cause freezing, only a single message is sent. If the
16186 freezing was automatic, the reason(s) for freezing can be found in the message
16187 log. If you configure freezing in a filter or ACL, you must arrange for any
16188 logging that you require.
16189
16190
16191 .options gecos_name main string&!! unset &&&
16192          gecos_pattern main string unset
16193 .cindex "HP-UX"
16194 .cindex "&""gecos""& field, parsing"
16195 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16196 password file to hold other information in addition to users' real names. Exim
16197 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16198 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16199 of the field are used unchanged, except that, if an ampersand is encountered,
16200 it is replaced by the user's login name with the first character forced to
16201 upper case, since this is a convention that is observed on many systems.
16202
16203 When these options are set, &%gecos_pattern%& is treated as a regular
16204 expression that is to be applied to the field (again with && replaced by the
16205 login name), and if it matches, &%gecos_name%& is expanded and used as the
16206 user's name.
16207
16208 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16209 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16210 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16211 name terminates at the first comma, the following can be used:
16212 .code
16213 gecos_pattern = ([^,]*)
16214 gecos_name = $1
16215 .endd
16216
16217
16218 .option gnutls_compat_mode main boolean unset
16219 This option controls whether GnuTLS is used in compatibility mode in an Exim
16220 server. This reduces security slightly, but improves interworking with older
16221 implementations of TLS.
16222
16223
16224 .option gnutls_allow_auto_pkcs11 main boolean unset
16225 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16226 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16227
16228 See
16229 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16230 for documentation.
16231
16232
16233
16234 .option headers_charset main string "see below"
16235 This option sets a default character set for translating from encoded MIME
16236 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16237 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16238 ultimate default is ISO-8859-1. For more details see the description of header
16239 insertions in section &<<SECTexpansionitems>>&.
16240
16241
16242
16243 .option header_maxsize main integer "see below"
16244 .cindex "header section" "maximum size of"
16245 .cindex "limit" "size of message header section"
16246 This option controls the overall maximum size of a message's header
16247 section. The default is the value of HEADER_MAXSIZE in
16248 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16249 sections are rejected.
16250
16251
16252 .option header_line_maxsize main integer 0
16253 .cindex "header lines" "maximum size of"
16254 .cindex "limit" "size of one header line"
16255 This option limits the length of any individual header line in a message, after
16256 all the continuations have been joined together. Messages with individual
16257 header lines that are longer than the limit are rejected. The default value of
16258 zero means &"no limit"&.
16259
16260
16261
16262
16263 .option helo_accept_junk_hosts main "host list&!!" unset
16264 .cindex "HELO" "accepting junk data"
16265 .cindex "EHLO" "accepting junk data"
16266 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16267 mail, and gives an error response for invalid data. Unfortunately, there are
16268 some SMTP clients that send syntactic junk. They can be accommodated by setting
16269 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16270 if you want to do semantic checking.
16271 See also &%helo_allow_chars%& for a way of extending the permitted character
16272 set.
16273
16274
16275 .option helo_allow_chars main string unset
16276 .cindex "HELO" "underscores in"
16277 .cindex "EHLO" "underscores in"
16278 .cindex "underscore in EHLO/HELO"
16279 This option can be set to a string of rogue characters that are permitted in
16280 non-ip-literal EHLO and HELO names in addition to the standard letters, digits,
16281 hyphens, and dots. For examplem if you really must allow underscores,
16282 you can set
16283 .code
16284 helo_allow_chars = _
16285 .endd
16286 This option does not apply to names that look like ip-literals.
16287 Note that the value is one string, not a list.
16288
16289
16290 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16291 .cindex "HELO" "forcing reverse lookup"
16292 .cindex "EHLO" "forcing reverse lookup"
16293 If the domain given by a client in a HELO or EHLO command matches this
16294 list, a reverse lookup is done in order to establish the host's true name. The
16295 default forces a lookup if the client host gives the server's name or any of
16296 its IP addresses (in brackets), something that broken clients have been seen to
16297 do.
16298
16299
16300 .option helo_try_verify_hosts main "host list&!!" unset
16301 .cindex "HELO verifying" "optional"
16302 .cindex "EHLO" "verifying, optional"
16303 By default, Exim just checks the syntax of HELO and EHLO commands (see
16304 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16305 to do more extensive checking of the data supplied by these commands. The ACL
16306 condition &`verify = helo`& is provided to make this possible.
16307 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16308 to force the check to occur. From release 4.53 onwards, this is no longer
16309 necessary. If the check has not been done before &`verify = helo`& is
16310 encountered, it is done at that time. Consequently, this option is obsolete.
16311 Its specification is retained here for backwards compatibility.
16312
16313 When an EHLO or HELO command is received, if the calling host matches
16314 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16315 EHLO command either:
16316
16317 .ilist
16318 is an IP literal matching the calling address of the host, or
16319 .next
16320 .cindex "DNS" "reverse lookup"
16321 .cindex "reverse DNS lookup"
16322 matches the host name that Exim obtains by doing a reverse lookup of the
16323 calling host address, or
16324 .next
16325 when looked up in DNS yields the calling host address.
16326 .endlist
16327
16328 However, the EHLO or HELO command is not rejected if any of the checks
16329 fail. Processing continues, but the result of the check is remembered, and can
16330 be detected later in an ACL by the &`verify = helo`& condition.
16331
16332 If DNS was used for successful verification, the variable
16333 .cindex "DNS" "DNSSEC"
16334 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16335
16336 .option helo_verify_hosts main "host list&!!" unset
16337 .cindex "HELO verifying" "mandatory"
16338 .cindex "EHLO" "verifying, mandatory"
16339 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16340 backwards compatibility. For hosts that match this option, Exim checks the host
16341 name given in the HELO or EHLO in the same way as for
16342 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16343 rejected with a 550 error, and entries are written to the main and reject logs.
16344 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16345 error.
16346
16347 .option hold_domains main "domain list&!!" unset
16348 .cindex "domain" "delaying delivery"
16349 .cindex "delivery" "delaying certain domains"
16350 This option allows mail for particular domains to be held in the queue
16351 manually. The option is overridden if a message delivery is forced with the
16352 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16353 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16354 item in &%hold_domains%&, no routing or delivery for that address is done, and
16355 it is deferred every time the message is looked at.
16356
16357 This option is intended as a temporary operational measure for delaying the
16358 delivery of mail while some problem is being sorted out, or some new
16359 configuration tested. If you just want to delay the processing of some
16360 domains until a queue run occurs, you should use &%queue_domains%& or
16361 &%queue_smtp_domains%&, not &%hold_domains%&.
16362
16363 A setting of &%hold_domains%& does not override Exim's code for removing
16364 messages from the queue if they have been there longer than the longest retry
16365 time in any retry rule. If you want to hold messages for longer than the normal
16366 retry times, insert a dummy retry rule with a long retry time.
16367
16368
16369 .option host_lookup main "host list&!!" unset
16370 .cindex "host name" "lookup, forcing"
16371 Exim does not look up the name of a calling host from its IP address unless it
16372 is required to compare against some host list, or the host matches
16373 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16374 option (which normally contains IP addresses rather than host names). The
16375 default configuration file contains
16376 .code
16377 host_lookup = *
16378 .endd
16379 which causes a lookup to happen for all hosts. If the expense of these lookups
16380 is felt to be too great, the setting can be changed or removed.
16381
16382 After a successful reverse lookup, Exim does a forward lookup on the name it
16383 has obtained, to verify that it yields the IP address that it started with. If
16384 this check fails, Exim behaves as if the name lookup failed.
16385
16386 .vindex "&$host_lookup_failed$&"
16387 .vindex "&$sender_host_name$&"
16388 After any kind of failure, the host name (in &$sender_host_name$&) remains
16389 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16390 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16391 &`verify = reverse_host_lookup`& in ACLs.
16392
16393
16394 .option host_lookup_order main "string list" &`bydns:byaddr`&
16395 This option specifies the order of different lookup methods when Exim is trying
16396 to find a host name from an IP address. The default is to do a DNS lookup
16397 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16398 if that fails. You can change the order of these lookups, or omit one entirely,
16399 if you want.
16400
16401 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16402 multiple PTR records in the DNS and the IP address is not listed in
16403 &_/etc/hosts_&. Different operating systems give different results in this
16404 case. That is why the default tries a DNS lookup first.
16405
16406
16407
16408 .option host_reject_connection main "host list&!!" unset
16409 .cindex "host" "rejecting connections from"
16410 If this option is set, incoming SMTP calls from the hosts listed are rejected
16411 as soon as the connection is made.
16412 This option is obsolete, and retained only for backward compatibility, because
16413 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16414 connections immediately.
16415
16416 If the connection is on a TLS-on-connect port then the TCP connection is
16417 just dropped.  Otherwise, an SMTP error is sent first.
16418
16419 The ability to give an immediate rejection (either by this option or using an
16420 ACL) is provided for use in unusual cases. Many hosts will just try again,
16421 sometimes without much delay. Normally, it is better to use an ACL to reject
16422 incoming messages at a later stage, such as after RCPT commands. See
16423 chapter &<<CHAPACL>>&.
16424
16425
16426 .option hosts_connection_nolog main "host list&!!" unset
16427 .cindex "host" "not logging connections from"
16428 This option defines a list of hosts for which connection logging does not
16429 happen, even though the &%smtp_connection%& log selector is set. For example,
16430 you might want not to log SMTP connections from local processes, or from
16431 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16432 the daemon; you should therefore strive to restrict its value to a short inline
16433 list of IP addresses and networks. To disable logging SMTP connections from
16434 local processes, you must create a host list with an empty item. For example:
16435 .code
16436 hosts_connection_nolog = :
16437 .endd
16438 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16439 lines, as may commonly be produced by a monitoring system.
16440
16441
16442 .option hosts_require_alpn main "host list&!!" unset
16443 .cindex ALPN "require negotiation in server"
16444 .cindex TLS ALPN
16445 .cindex TLS "Application Layer Protocol Names"
16446 If the TLS library supports ALPN
16447 then a successful negotiation of ALPN will be required for any client
16448 matching the list, for TLS to be used.
16449 See also the &%tls_alpn%& option.
16450
16451 &*Note*&: prevention of fallback to in-clear connection is not
16452 managed by this option, and should be done separately.
16453
16454
16455 .option hosts_require_helo main "host list&!!" *
16456 .cindex "HELO/EHLO" requiring
16457 Exim will require an accepted HELO or EHLO command from a host matching
16458 this list, before accepting a MAIL command.
16459
16460
16461 .option hosts_proxy main "host list&!!" unset
16462 .cindex proxy "proxy protocol"
16463 This option enables use of Proxy Protocol proxies for incoming
16464 connections.  For details see section &<<SECTproxyInbound>>&.
16465
16466
16467 .option hosts_treat_as_local main "domain list&!!" unset
16468 .cindex "local host" "domains treated as"
16469 .cindex "host" "treated as local"
16470 If this option is set, any host names that match the domain list are treated as
16471 if they were the local host when Exim is scanning host lists obtained from MX
16472 records
16473 or other sources. Note that the value of this option is a domain list, not a
16474 host list, because it is always used to check host names, not IP addresses.
16475
16476 This option also applies when Exim is matching the special items
16477 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16478 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16479 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16480 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16481 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16482 interfaces and recognizing the local host.
16483
16484
16485 .option ibase_servers main "string list" unset
16486 .cindex "InterBase" "server list"
16487 This option provides a list of InterBase servers and associated connection data,
16488 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16489 The option is available only if Exim has been built with InterBase support.
16490
16491
16492
16493 .option ignore_bounce_errors_after main time 10w
16494 .cindex "bounce message" "discarding"
16495 .cindex "discarding bounce message"
16496 This option affects the processing of bounce messages that cannot be delivered,
16497 that is, those that suffer a permanent delivery failure. (Bounce messages that
16498 suffer temporary delivery failures are of course retried in the usual way.)
16499
16500 After a permanent delivery failure, bounce messages are frozen,
16501 because there is no sender to whom they can be returned. When a frozen bounce
16502 message has been in the queue for more than the given time, it is unfrozen at
16503 the next queue run, and a further delivery is attempted. If delivery fails
16504 again, the bounce message is discarded. This makes it possible to keep failed
16505 bounce messages around for a shorter time than the normal maximum retry time
16506 for frozen messages. For example,
16507 .code
16508 ignore_bounce_errors_after = 12h
16509 .endd
16510 retries failed bounce message deliveries after 12 hours, discarding any further
16511 failures. If the value of this option is set to a zero time period, bounce
16512 failures are discarded immediately. Setting a very long time (as in the default
16513 value) has the effect of disabling this option. For ways of automatically
16514 dealing with other kinds of frozen message, see &%auto_thaw%& and
16515 &%timeout_frozen_after%&.
16516
16517
16518 .options ignore_fromline_hosts main "host list&!!" unset &&&
16519          ignore_fromline_local main boolean false
16520 .cindex "&""From""& line"
16521 .cindex "UUCP" "&""From""& line"
16522 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16523 the headers of a message. By default this is treated as the start of the
16524 message's body, which means that any following headers are not recognized as
16525 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16526 match those hosts that insist on sending it. If the sender is actually a local
16527 process rather than a remote host, and is using &%-bs%& to inject the messages,
16528 &%ignore_fromline_local%& must be set to achieve this effect.
16529
16530
16531
16532 .option keep_environment main "string list" unset
16533 .cindex "environment" "values from"
16534 This option contains a string list of environment variables to keep.
16535 You have to trust these variables or you have to be sure that
16536 these variables do not impose any security risk. Keep in mind that
16537 during the startup phase Exim is running with an effective UID 0 in most
16538 installations. As the default value is an empty list, the default
16539 environment for using libraries, running embedded Perl code, or running
16540 external binaries is empty, and does not not even contain PATH or HOME.
16541
16542 Actually the list is interpreted as a list of patterns
16543 (&<<SECTlistexpand>>&), except that it is not expanded first.
16544
16545 WARNING: Macro substitution is still done first, so having a macro
16546 FOO and having FOO_HOME in your &%keep_environment%& option may have
16547 unexpected results. You may work around this using a regular expression
16548 that does not match the macro name: ^[F]OO_HOME$.
16549
16550 Current versions of Exim issue a warning during startup if you do not mention
16551 &%keep_environment%& in your runtime configuration file and if your
16552 current environment is not empty. Future versions may not issue that warning
16553 anymore.
16554
16555 See the &%add_environment%& main config option for a way to set
16556 environment variables to a fixed value.  The environment for &(pipe)&
16557 transports is handled separately, see section &<<SECTpipeenv>>& for
16558 details.
16559
16560
16561 .option keep_malformed main time 4d
16562 This option specifies the length of time to keep messages whose spool files
16563 have been corrupted in some way. This should, of course, never happen. At the
16564 next attempt to deliver such a message, it gets removed. The incident is
16565 logged.
16566
16567
16568 .option ldap_ca_cert_dir main string unset
16569 .cindex "LDAP", "TLS CA certificate directory"
16570 .cindex certificate "directory for LDAP"
16571 This option indicates which directory contains CA certificates for verifying
16572 a TLS certificate presented by an LDAP server.
16573 While Exim does not provide a default value, your SSL library may.
16574 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16575 and constrained to be a directory.
16576
16577
16578 .option ldap_ca_cert_file main string unset
16579 .cindex "LDAP", "TLS CA certificate file"
16580 .cindex certificate "file for LDAP"
16581 This option indicates which file contains CA certificates for verifying
16582 a TLS certificate presented by an LDAP server.
16583 While Exim does not provide a default value, your SSL library may.
16584 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16585 and constrained to be a file.
16586
16587
16588 .option ldap_cert_file main string unset
16589 .cindex "LDAP" "TLS client certificate file"
16590 .cindex certificate "file for LDAP"
16591 This option indicates which file contains an TLS client certificate which
16592 Exim should present to the LDAP server during TLS negotiation.
16593 Should be used together with &%ldap_cert_key%&.
16594
16595
16596 .option ldap_cert_key main string unset
16597 .cindex "LDAP" "TLS client key file"
16598 .cindex certificate "key for LDAP"
16599 This option indicates which file contains the secret/private key to use
16600 to prove identity to the LDAP server during TLS negotiation.
16601 Should be used together with &%ldap_cert_file%&, which contains the
16602 identity to be proven.
16603
16604
16605 .option ldap_cipher_suite main string unset
16606 .cindex "LDAP" "TLS cipher suite"
16607 This controls the TLS cipher-suite negotiation during TLS negotiation with
16608 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16609 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16610
16611
16612 .option ldap_default_servers main "string list" unset
16613 .cindex "LDAP" "default servers"
16614 This option provides a list of LDAP servers which are tried in turn when an
16615 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16616 details of LDAP queries. This option is available only when Exim has been built
16617 with LDAP support.
16618
16619
16620 .option ldap_require_cert main string unset.
16621 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16622 This should be one of the values "hard", "demand", "allow", "try" or "never".
16623 A value other than one of these is interpreted as "never".
16624 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16625 Although Exim does not set a default, the LDAP library probably defaults
16626 to hard/demand.
16627
16628
16629 .option ldap_start_tls main boolean false
16630 .cindex "LDAP" "whether or not to negotiate TLS"
16631 If set, Exim will attempt to negotiate TLS with the LDAP server when
16632 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16633 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16634 of SSL-on-connect.
16635 In the event of failure to negotiate TLS, the action taken is controlled
16636 by &%ldap_require_cert%&.
16637 This option is ignored for &`ldapi`& connections.
16638
16639
16640 .option ldap_version main integer unset
16641 .cindex "LDAP" "protocol version, forcing"
16642 This option can be used to force Exim to set a specific protocol version for
16643 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16644 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16645 the LDAP headers; otherwise it is 2. This option is available only when Exim
16646 has been built with LDAP support.
16647
16648
16649
16650 .option limits_advertise_hosts main "host list&!!" *
16651 .cindex LIMITS "suppressing advertising"
16652 .cindex "ESMTP extensions" LIMITS
16653 This option can be used to suppress the advertisement of the SMTP
16654 LIMITS extension (RFC 9422) to specific hosts.
16655 If permitted, Exim as a server will advertise in the EHLO response
16656 the limit for RCPT commands set by the &%recipients_max%& option (if it is set)
16657 and the limit for MAIL commands set by the &%smtp_accept_max_per_connection%&
16658 option.
16659
16660 .option local_from_check main boolean true
16661 .cindex "&'Sender:'& header line" "disabling addition of"
16662 .cindex "&'From:'& header line" "disabling checking of"
16663 When a message is submitted locally (that is, not over a TCP/IP connection) by
16664 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16665 checks that the &'From:'& header line matches the login of the calling user and
16666 the domain specified by &%qualify_domain%&.
16667
16668 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16669 locally submitted message is automatically qualified by Exim, unless the
16670 &%-bnq%& command line option is used.
16671
16672 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16673 on the local part. If the &'From:'& header line does not match, Exim adds a
16674 &'Sender:'& header with an address constructed from the calling user's login
16675 and the default qualify domain.
16676
16677 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16678 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16679 &'Sender:'& header lines supplied by untrusted users, you must also set
16680 &%local_sender_retain%& to be true.
16681
16682 .cindex "envelope from"
16683 .cindex "envelope sender"
16684 These options affect only the header lines in the message. The envelope sender
16685 is still forced to be the login id at the qualify domain unless
16686 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16687
16688 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16689 request similar header line checking. See section &<<SECTthesenhea>>&, which
16690 has more details about &'Sender:'& processing.
16691
16692
16693
16694
16695 .options local_from_prefix main string unset &&&
16696          local_from_suffix main string unset
16697 When Exim checks the &'From:'& header line of locally submitted messages for
16698 matching the login id (see &%local_from_check%& above), it can be configured to
16699 ignore certain prefixes and suffixes in the local part of the address. This is
16700 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16701 appropriate lists, in the same form as the &%local_part_prefix%& and
16702 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16703 example, if
16704 .code
16705 local_from_prefix = *-
16706 .endd
16707 is set, a &'From:'& line containing
16708 .code
16709 From: anything-user@your.domain.example
16710 .endd
16711 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16712 matches the actual sender address that is constructed from the login name and
16713 qualify domain.
16714
16715
16716 .option local_interfaces main "string list" "see below"
16717 This option controls which network interfaces are used by the daemon for
16718 listening; they are also used to identify the local host when routing. Chapter
16719 &<<CHAPinterfaces>>& contains a full description of this option and the related
16720 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16721 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16722 &%local_interfaces%& is
16723 .code
16724 local_interfaces = 0.0.0.0
16725 .endd
16726 when Exim is built without IPv6 support; otherwise it is
16727 .code
16728 local_interfaces = <; ::0 ; 0.0.0.0
16729 .endd
16730
16731 .option local_scan_timeout main time 5m
16732 .cindex "timeout" "for &[local_scan()]& function"
16733 .cindex "&[local_scan()]& function" "timeout"
16734 This timeout applies to the &[local_scan()]& function (see chapter
16735 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16736 the incoming message is rejected with a temporary error if it is an SMTP
16737 message. For a non-SMTP message, the message is dropped and Exim ends with a
16738 non-zero code. The incident is logged on the main and reject logs.
16739
16740
16741
16742 .option local_sender_retain main boolean false
16743 .cindex "&'Sender:'& header line" "retaining from local submission"
16744 When a message is submitted locally (that is, not over a TCP/IP connection) by
16745 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16746 do not want this to happen, you must set &%local_sender_retain%&, and you must
16747 also set &%local_from_check%& to be false (Exim will complain if you do not).
16748 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16749 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16750
16751
16752
16753
16754 .option localhost_number main string&!! unset
16755 .cindex "host" "locally unique number for"
16756 .cindex "message ids" "with multiple hosts"
16757 .cindex multiple "systems sharing a spool"
16758 .cindex "multiple hosts" "sharing a spool"
16759 .cindex "shared spool directory"
16760 .cindex "spool directory" sharing
16761 .vindex "&$localhost_number$&"
16762 Exim's message ids are normally unique only within the local host. If
16763 uniqueness among a set of hosts is required
16764 (eg. because they share a spool directory),
16765 each host must set a different
16766 value for the &%localhost_number%& option. The string is expanded immediately
16767 after reading the configuration file (so that a number can be computed from the
16768 host name, for example) and the result of the expansion must be a number in the
16769 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16770 systems). This is available in subsequent string expansions via the variable
16771 &$localhost_number$&. When &%localhost_number%& is set, the final four
16772 characters of the message id, instead of just being a fractional part of the
16773 time, are computed from the time and the local host number as described in
16774 section &<<SECTmessiden>>&.
16775
16776
16777
16778 .option log_file_path main "string list&!!" "set at compile time"
16779 .cindex "log" "file path for"
16780 This option sets the path which is used to determine the names of Exim's log
16781 files, or indicates that logging is to be to syslog, or both. It is expanded
16782 when Exim is entered, so it can, for example, contain a reference to the host
16783 name. If no specific path is set for the log files at compile or runtime,
16784 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16785 they are written in a sub-directory called &_log_& in Exim's spool directory.
16786 A path must start with a slash.
16787 To send to syslog, use the word &"syslog"&.
16788 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16789 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16790 used. If this string is fixed at your installation (contains no expansion
16791 variables) it is recommended that you do not set this option in the
16792 configuration file, but instead supply the path using LOG_FILE_PATH in
16793 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16794 early on &-- in particular, failure to read the configuration file.
16795
16796
16797 .option log_selector main string unset
16798 .cindex "log" "selectors"
16799 This option can be used to reduce or increase the number of things that Exim
16800 writes to its log files. Its argument is made up of names preceded by plus or
16801 minus characters. For example:
16802 .code
16803 log_selector = +arguments -retry_defer
16804 .endd
16805 A list of possible names and what they control is given in the chapter on
16806 logging, in section &<<SECTlogselector>>&.
16807
16808
16809 .option log_timezone main boolean false
16810 .cindex "log" "timezone for entries"
16811 .vindex "&$tod_log$&"
16812 .vindex "&$tod_zone$&"
16813 By default, the timestamps on log lines are in local time without the
16814 timezone. This means that if your timezone changes twice a year, the timestamps
16815 in log lines are ambiguous for an hour when the clocks go back. One way of
16816 avoiding this problem is to set the timezone to UTC. An alternative is to set
16817 &%log_timezone%& true. This turns on the addition of the timezone offset to
16818 timestamps in log lines. Turning on this option can add quite a lot to the size
16819 of log files because each line is extended by 6 characters. Note that the
16820 &$tod_log$& variable contains the log timestamp without the zone, but there is
16821 another variable called &$tod_zone$& that contains just the timezone offset.
16822
16823
16824 .option lookup_open_max main integer 25
16825 .cindex "too many open files"
16826 .cindex "open files, too many"
16827 .cindex "file" "too many open"
16828 .cindex "lookup" "maximum open files"
16829 .cindex "limit" "open files for lookups"
16830 This option limits the number of simultaneously open files for single-key
16831 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16832 Exim normally keeps these files open during routing, because often the same
16833 file is required several times. If the limit is reached, Exim closes the least
16834 recently used file. Note that if you are using the &'ndbm'& library, it
16835 actually opens two files for each logical DBM database, though it still counts
16836 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16837 open files"& errors with NDBM, you need to reduce the value of
16838 &%lookup_open_max%&.
16839
16840
16841 .option max_username_length main integer 0
16842 .cindex "length of login name"
16843 .cindex "user name" "maximum length"
16844 .cindex "limit" "user name length"
16845 Some operating systems are broken in that they truncate long arguments to
16846 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16847 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16848 an argument that is longer behaves as if &[getpwnam()]& failed.
16849
16850
16851 .option message_body_newlines main bool false
16852 .cindex "message body" "newlines in variables"
16853 .cindex "newline" "in message body variables"
16854 .vindex "&$message_body$&"
16855 .vindex "&$message_body_end$&"
16856 By default, newlines in the message body are replaced by spaces when setting
16857 the &$message_body$& and &$message_body_end$& expansion variables. If this
16858 option is set true, this no longer happens.
16859
16860
16861 .option message_body_visible main integer 500
16862 .cindex "body of message" "visible size"
16863 .cindex "message body" "visible size"
16864 .vindex "&$message_body$&"
16865 .vindex "&$message_body_end$&"
16866 This option specifies how much of a message's body is to be included in the
16867 &$message_body$& and &$message_body_end$& expansion variables.
16868
16869
16870 .option message_id_header_domain main string&!! unset
16871 .cindex "&'Message-ID:'& header line"
16872 If this option is set, the string is expanded and used as the right hand side
16873 (domain) of the &'Message-ID:'& header that Exim creates if a
16874 locally-originated incoming message does not have one. &"Locally-originated"&
16875 means &"not received over TCP/IP."&
16876 Otherwise, the primary host name is used.
16877 Only letters, digits, dot and hyphen are accepted; any other characters are
16878 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16879 empty string, the option is ignored.
16880
16881
16882 .option message_id_header_text main string&!! unset
16883 If this variable is set, the string is expanded and used to augment the text of
16884 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16885 message does not have one. The text of this header is required by RFC 2822 to
16886 take the form of an address. By default, Exim uses its internal message id as
16887 the local part, and the primary host name as the domain. If this option is set,
16888 it is expanded, and provided the expansion is not forced to fail, and does not
16889 yield an empty string, the result is inserted into the header immediately
16890 before the @, separated from the internal message id by a dot. Any characters
16891 that are illegal in an address are automatically converted into hyphens. This
16892 means that variables such as &$tod_log$& can be used, because the spaces and
16893 colons will become hyphens.
16894
16895
16896 .option message_logs main boolean true
16897 .cindex "message logs" "disabling"
16898 .cindex "log" "message log; disabling"
16899 If this option is turned off, per-message log files are not created in the
16900 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16901 Exim, by reducing the number of files involved in handling a message from a
16902 minimum of four (header spool file, body spool file, delivery journal, and
16903 per-message log) to three. The other major I/O activity is Exim's main log,
16904 which is not affected by this option.
16905
16906
16907 .option message_size_limit main string&!! 50M
16908 .cindex "message" "size limit"
16909 .cindex "limit" "message size"
16910 .cindex "size" "of message, limit"
16911 This option limits the maximum size of message that Exim will process. The
16912 value is expanded for each incoming connection so, for example, it can be made
16913 to depend on the IP address of the remote host for messages arriving via
16914 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16915 optionally followed by K or M.
16916
16917 .cindex "SIZE" "ESMTP extension, advertising"
16918 .cindex "ESMTP extensions" SIZE
16919 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16920 service extension keyword.
16921
16922 &*Note*&: This limit cannot be made to depend on a message's sender or any
16923 other properties of an individual message, because it has to be advertised in
16924 the server's response to EHLO. String expansion failure causes a temporary
16925 error. A value of zero means no limit, but its use is not recommended. See also
16926 &%bounce_return_size_limit%&.
16927
16928 Incoming SMTP messages are failed with a 552 error if the limit is
16929 exceeded; locally-generated messages either get a stderr message or a delivery
16930 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16931 an oversized message is logged in both the main and the reject logs. See also
16932 the generic transport option &%message_size_limit%&, which limits the size of
16933 message that an individual transport can process.
16934
16935 If you use a virus-scanner and set this option to to a value larger than the
16936 maximum size that your virus-scanner is configured to support, you may get
16937 failures triggered by large mails.  The right size to configure for the
16938 virus-scanner depends upon what data is passed and the options in use but it's
16939 probably safest to just set it to a little larger than this value.  E.g., with a
16940 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16941 some problems may result.
16942
16943 A value of 0 will disable size limit checking; Exim will still advertise the
16944 SIZE extension in an EHLO response, but without a limit, so as to permit
16945 SMTP clients to still indicate the message size along with the MAIL verb.
16946
16947
16948 .option move_frozen_messages main boolean false
16949 .cindex "frozen messages" "moving"
16950 This option, which is available only if Exim has been built with the setting
16951 .code
16952 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16953 .endd
16954 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16955 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16956 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16957 standard utilities for handling such moved messages, and they do not show up in
16958 lists generated by &%-bp%& or by the Exim monitor.
16959
16960
16961 .option mua_wrapper main boolean false
16962 Setting this option true causes Exim to run in a very restrictive mode in which
16963 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16964 contains a full description of this facility.
16965
16966
16967
16968 .option mysql_servers main "string list" unset
16969 .cindex "MySQL" "server list"
16970 This option provides a list of MySQL servers and associated connection data, to
16971 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16972 option is available only if Exim has been built with MySQL support.
16973
16974
16975 .option never_users main "string list&!!" unset
16976 This option is expanded just once, at the start of Exim's processing. Local
16977 message deliveries are normally run in processes that are setuid to the
16978 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16979 It is usually desirable to prevent any deliveries from running as root, as a
16980 safety precaution.
16981
16982 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16983 list of users that must not be used for local deliveries. This list is fixed in
16984 the binary and cannot be overridden by the configuration file. By default, it
16985 contains just the single user name &"root"&. The &%never_users%& runtime option
16986 can be used to add more users to the fixed list.
16987
16988 If a message is to be delivered as one of the users on the fixed list or the
16989 &%never_users%& list, an error occurs, and delivery is deferred. A common
16990 example is
16991 .code
16992 never_users = root:daemon:bin
16993 .endd
16994 Including root is redundant if it is also on the fixed list, but it does no
16995 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16996 transport driver.
16997
16998
16999 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
17000 This option gives the name for a unix-domain socket on which the daemon
17001 listens for work and information-requests.
17002 Only installations running multiple daemons sharing a spool directory
17003 should need to modify the default.
17004
17005 The option is expanded before use.
17006 If the platform supports Linux-style abstract socket names, the result
17007 is used with a nul byte prefixed.
17008 Otherwise,
17009 it should be a full path name and use a directory accessible
17010 to Exim.
17011
17012 If this option is set as empty,
17013 or the command line &%-oY%& option is used, or
17014 the command line uses a &%-oX%& option and does not use &%-oP%&,
17015 then a notifier socket is not created.
17016
17017
17018 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
17019 .cindex "OpenSSL "compatibility options"
17020 This option allows an administrator to adjust the SSL options applied
17021 by OpenSSL to connections.  It is given as a space-separated list of items,
17022 each one to be +added or -subtracted from the current value.
17023
17024 This option is only available if Exim is built against OpenSSL.  The values
17025 available for this option vary according to the age of your OpenSSL install.
17026 The &"all"& value controls a subset of flags which are available, typically
17027 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
17028 list the values known on your system and Exim should support all the
17029 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
17030 names lose the leading &"SSL_OP_"& and are lower-cased.
17031
17032 Note that adjusting the options can have severe impact upon the security of
17033 SSL as used by Exim.  It is possible to disable safety checks and shoot
17034 yourself in the foot in various unpleasant ways.  This option should not be
17035 adjusted lightly.  An unrecognised item will be detected at startup, by
17036 invoking Exim with the &%-bV%& flag.
17037
17038 The option affects Exim operating both as a server and as a client.
17039
17040 Historical note: prior to release 4.80, Exim defaulted this value to
17041 "+dont_insert_empty_fragments", which may still be needed for compatibility
17042 with some clients, but which lowers security by increasing exposure to
17043 some now infamous attacks.
17044
17045 Examples:
17046 .code
17047 # Make both old MS and old Eudora happy:
17048 openssl_options = -all +microsoft_big_sslv3_buffer \
17049                        +dont_insert_empty_fragments
17050
17051 # Disable older protocol versions:
17052 openssl_options = +no_sslv2 +no_sslv3
17053 .endd
17054
17055 Possible options may include:
17056 .ilist
17057 &`all`&
17058 .next
17059 &`allow_unsafe_legacy_renegotiation`&
17060 .next
17061 &`cipher_server_preference`&
17062 .next
17063 &`dont_insert_empty_fragments`&
17064 .next
17065 &`ephemeral_rsa`&
17066 .next
17067 &`legacy_server_connect`&
17068 .next
17069 &`microsoft_big_sslv3_buffer`&
17070 .next
17071 &`microsoft_sess_id_bug`&
17072 .next
17073 &`msie_sslv2_rsa_padding`&
17074 .next
17075 &`netscape_challenge_bug`&
17076 .next
17077 &`netscape_reuse_cipher_change_bug`&
17078 .next
17079 &`no_compression`&
17080 .next
17081 &`no_session_resumption_on_renegotiation`&
17082 .next
17083 &`no_sslv2`&
17084 .next
17085 &`no_sslv3`&
17086 .next
17087 &`no_ticket`&
17088 .next
17089 &`no_tlsv1`&
17090 .next
17091 &`no_tlsv1_1`&
17092 .next
17093 &`no_tlsv1_2`&
17094 .next
17095 &`safari_ecdhe_ecdsa_bug`&
17096 .next
17097 &`single_dh_use`&
17098 .next
17099 &`single_ecdh_use`&
17100 .next
17101 &`ssleay_080_client_dh_bug`&
17102 .next
17103 &`sslref2_reuse_cert_type_bug`&
17104 .next
17105 &`tls_block_padding_bug`&
17106 .next
17107 &`tls_d5_bug`&
17108 .next
17109 &`tls_rollback_bug`&
17110 .endlist
17111
17112 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
17113 all clients connecting using the MacOS SecureTransport TLS facility prior
17114 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
17115 to negotiate TLS then this option value might help, provided that your OpenSSL
17116 release is new enough to contain this work-around.  This may be a situation
17117 where you have to upgrade OpenSSL to get buggy clients working.
17118
17119
17120 .option oracle_servers main "string list" unset
17121 .cindex "Oracle" "server list"
17122 This option provides a list of Oracle servers and associated connection data,
17123 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17124 The option is available only if Exim has been built with Oracle support.
17125
17126
17127 .option panic_coredump main boolean false
17128 This option is rarely needed but can help for some debugging investigations.
17129 If set, when an internal error is detected by Exim which is sufficient
17130 to terminate the process
17131 (all such are logged in the paniclog)
17132 then a coredump is requested.
17133
17134 Note that most systems require additional administrative configuration
17135 to permit write a core file for a setuid program, which is Exim's
17136 common installed configuration.
17137
17138 .option percent_hack_domains main "domain list&!!" unset
17139 .cindex "&""percent hack""&"
17140 .cindex "source routing" "in email address"
17141 .cindex "address" "source-routed"
17142 The &"percent hack"& is the convention whereby a local part containing a
17143 percent sign is re-interpreted as a new email address, with the percent
17144 replaced by @. This is sometimes called &"source routing"&, though that term is
17145 also applied to RFC 2822 addresses that begin with an @ character. If this
17146 option is set, Exim implements the percent facility for those domains listed,
17147 but no others. This happens before an incoming SMTP address is tested against
17148 an ACL.
17149
17150 &*Warning*&: The &"percent hack"& has often been abused by people who are
17151 trying to get round relaying restrictions. For this reason, it is best avoided
17152 if at all possible. Unfortunately, a number of less security-conscious MTAs
17153 implement it unconditionally. If you are running Exim on a gateway host, and
17154 routing mail through to internal MTAs without processing the local parts, it is
17155 a good idea to reject recipient addresses with percent characters in their
17156 local parts. Exim's default configuration does this.
17157
17158
17159 .options perl_at_start main boolean false &&&
17160          perl_startup main string unset
17161 .cindex "Perl"
17162 These options are available only when Exim is built with an embedded Perl
17163 interpreter. See chapter &<<CHAPperl>>& for details of their use.
17164
17165 .option perl_taintmode main boolean false
17166 .cindex "Perl"
17167 This option enables the taint mode of the embedded Perl interpreter.
17168
17169
17170 .option pgsql_servers main "string list" unset
17171 .cindex "PostgreSQL lookup type" "server list"
17172 This option provides a list of PostgreSQL servers and associated connection
17173 data, to be used in conjunction with &(pgsql)& lookups (see section
17174 &<<SECID72>>&). The option is available only if Exim has been built with
17175 PostgreSQL support.
17176
17177
17178 .option pid_file_path main string&!! "set at compile time"
17179 .cindex "daemon" "pid file path"
17180 .cindex "pid file, path for"
17181 This option sets the name of the file to which the Exim daemon writes its
17182 process id. The string is expanded, so it can contain, for example, references
17183 to the host name:
17184 .code
17185 pid_file_path = /var/log/$primary_hostname/exim.pid
17186 .endd
17187 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17188 spool directory.
17189 The value set by the option can be overridden by the &%-oP%& command line
17190 option. A pid file is not written if a &"non-standard"& daemon is run by means
17191 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17192
17193
17194 .option pipelining_advertise_hosts main "host list&!!" *
17195 .cindex "PIPELINING" "suppressing advertising"
17196 .cindex "ESMTP extensions" PIPELINING
17197 This option can be used to suppress the advertisement of the SMTP
17198 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17199 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17200 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17201 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17202 that clients will use it; &"out of order"& commands that are &"expected"& do
17203 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17204
17205 .option pipelining_connect_advertise_hosts main "host list&!!" *
17206 .cindex "pipelining" "early connection"
17207 .cindex "pipelining" PIPECONNECT
17208 .cindex "ESMTP extensions" PIPECONNECT
17209 If Exim is built without the DISABLE_PIPE_CONNECT build option
17210 this option controls which hosts the facility is advertised to
17211 and from which pipeline early-connection (before MAIL) SMTP
17212 commands are acceptable.
17213 When used, the pipelining saves on roundtrip times.
17214
17215 See also the &%hosts_pipe_connect%& smtp transport option.
17216
17217 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17218 it permits the client to pipeline
17219 TCP connection and hello command (cleatext phase),
17220 or TLS-establishment and hello command (encrypted phase),
17221 on later connections to the same host.
17222
17223
17224 .option prdr_enable main boolean false
17225 .cindex "PRDR" "enabling on server"
17226 .cindex "ESMTP extensions" PRDR
17227 This option can be used to enable the Per-Recipient Data Response extension
17228 to SMTP, defined by Eric Hall.
17229 If the option is set, PRDR is advertised by Exim when operating as a server.
17230 If the client requests PRDR, and more than one recipient, for a message
17231 an additional ACL is called for each recipient after the message content
17232 is received.  See section &<<SECTPRDRACL>>&.
17233
17234 .option preserve_message_logs main boolean false
17235 .cindex "message logs" "preserving"
17236 If this option is set, message log files are not deleted when messages are
17237 completed. Instead, they are moved to a sub-directory of the spool directory
17238 called &_msglog.OLD_&, where they remain available for statistical or debugging
17239 purposes. This is a dangerous option to set on systems with any appreciable
17240 volume of mail. Use with care!
17241
17242
17243 .option primary_hostname main string "see below"
17244 .cindex "name" "of local host"
17245 .cindex "host" "name of local"
17246 .cindex "local host" "name of"
17247 .vindex "&$primary_hostname$&"
17248 This specifies the name of the current host. It is used in the default EHLO or
17249 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17250 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17251 The value is also used by default in some SMTP response messages from an Exim
17252 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17253
17254 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17255 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17256 contains only one component, Exim passes it to &[gethostbyname()]& (or
17257 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17258 version. The variable &$primary_hostname$& contains the host name, whether set
17259 explicitly by this option, or defaulted.
17260
17261
17262 .option print_topbitchars main boolean false
17263 .cindex "printing characters"
17264 .cindex "8-bit characters"
17265 By default, Exim considers only those characters whose codes lie in the range
17266 32&--126 to be printing characters. In a number of circumstances (for example,
17267 when writing log entries) non-printing characters are converted into escape
17268 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17269 is set, code values of 128 and above are also considered to be printing
17270 characters.
17271
17272 This option also affects the header syntax checks performed by the
17273 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17274 the user's full name when constructing From: and Sender: addresses (as
17275 described in section &<<SECTconstr>>&). Setting this option can cause
17276 Exim to generate eight bit message headers that do not conform to the
17277 standards.
17278
17279
17280 .option process_log_path main string unset
17281 .cindex "process log path"
17282 .cindex "log" "process log"
17283 .cindex "&'exiwhat'&"
17284 This option sets the name of the file to which an Exim process writes its
17285 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17286 utility script. If this option is unset, the file called &_exim-process.info_&
17287 in Exim's spool directory is used. The ability to specify the name explicitly
17288 can be useful in environments where two different Exims are running, using
17289 different spool directories.
17290
17291
17292 .option prod_requires_admin main boolean true
17293 .cindex "restricting access to features"
17294 .oindex "&%-M%&"
17295 .oindex "&%-R%&"
17296 .oindex "&%-q%&"
17297 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17298 admin user unless &%prod_requires_admin%& is set false. See also
17299 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17300
17301
17302 .option proxy_protocol_timeout main time 3s
17303 .cindex proxy "proxy protocol"
17304 This option sets the timeout for proxy protocol negotiation.
17305 For details see section &<<SECTproxyInbound>>&.
17306
17307
17308 .option qualify_domain main string "see below"
17309 .cindex "domain" "for qualifying addresses"
17310 .cindex "address" "qualification"
17311 This option specifies the domain name that is added to any envelope sender
17312 addresses that do not have a domain qualification. It also applies to
17313 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17314 are accepted by default only for locally-generated messages. Qualification is
17315 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17316 locally-generated messages, unless the &%-bnq%& command line option is used.
17317
17318 Messages from external sources must always contain fully qualified addresses,
17319 unless the sending host matches &%sender_unqualified_hosts%& or
17320 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17321 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17322 necessary. Internally, Exim always works with fully qualified envelope
17323 addresses. If &%qualify_domain%& is not set, it defaults to the
17324 &%primary_hostname%& value.
17325
17326
17327 .option qualify_recipient main string "see below"
17328 This option allows you to specify a different domain for qualifying recipient
17329 addresses to the one that is used for senders. See &%qualify_domain%& above.
17330
17331
17332
17333 .option queue_domains main "domain list&!!" unset
17334 .cindex "domain" "specifying non-immediate delivery"
17335 .cindex "queueing incoming messages"
17336 .cindex "message" "queueing certain domains"
17337 This option lists domains for which immediate delivery is not required.
17338 A delivery process is started whenever a message is received, but only those
17339 domains that do not match are processed. All other deliveries wait until the
17340 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17341
17342
17343 .option queue_fast_ramp main boolean true
17344 .cindex "queue runner" "two phase"
17345 .cindex "queue" "double scanning"
17346 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17347 command line, may start parallel delivery processes during their first
17348 phase.  This will be done when a threshold number of messages have been
17349 routed for a single host.
17350
17351
17352 .option queue_list_requires_admin main boolean true
17353 .cindex "restricting access to features"
17354 .oindex "&%-bp%&"
17355 The &%-bp%& command-line option, which lists the messages that are on the
17356 queue, requires the caller to be an admin user unless
17357 &%queue_list_requires_admin%& is set false.
17358 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17359
17360
17361 .option queue_only main boolean false
17362 .cindex "queueing incoming messages"
17363 .cindex "message" "queueing unconditionally"
17364 If &%queue_only%& is set, a delivery process is not automatically started
17365 whenever a message is received. Instead, the message waits in the queue for the
17366 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17367 delivered immediately when certain conditions (such as heavy load) occur.
17368
17369 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17370 and &%-odi%& command line options override &%queue_only%& unless
17371 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17372 &%queue_only_load%&, and &%smtp_accept_queue%&.
17373
17374
17375 .option queue_only_file main "string list" unset
17376 .cindex "queueing incoming messages"
17377 .cindex "message" "queueing by file existence"
17378 This option can be set to a colon-separated list of absolute path names, each
17379 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17380 it tests for the existence of each listed path using a call to &[stat()]&. For
17381 each path that exists, the corresponding queueing option is set.
17382 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17383 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17384 .code
17385 queue_only_file = smtp/some/file
17386 .endd
17387 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17388 &_/some/file_& exists.
17389
17390
17391 .option queue_only_load main fixed-point unset
17392 .cindex "load average"
17393 .cindex "queueing incoming messages"
17394 .cindex "message" "queueing by load"
17395 If the system load average is higher than this value, incoming messages from
17396 all sources are queued, and no automatic deliveries are started. If this
17397 happens during local or remote SMTP input, all subsequent messages received on
17398 the same SMTP connection are queued by default, whatever happens to the load in
17399 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17400 false.
17401
17402 Deliveries will subsequently be performed by queue runner processes. This
17403 option has no effect on ancient operating systems on which Exim cannot
17404 determine the load average. See also &%deliver_queue_load_max%& and
17405 &%smtp_load_reserve%&.
17406
17407
17408 .option queue_only_load_latch main boolean true
17409 .cindex "load average" "re-evaluating per message"
17410 When this option is true (the default), once one message has been queued
17411 because the load average is higher than the value set by &%queue_only_load%&,
17412 all subsequent messages received on the same SMTP connection are also queued.
17413 This is a deliberate choice; even though the load average may fall below the
17414 threshold, it doesn't seem right to deliver later messages on the same
17415 connection when not delivering earlier ones. However, there are special
17416 circumstances such as very long-lived connections from scanning appliances
17417 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17418 should be set false. This causes the value of the load average to be
17419 re-evaluated for each message.
17420
17421
17422 .option queue_only_override main boolean true
17423 .cindex "queueing incoming messages"
17424 When this option is true, the &%-od%&&'x'& command line options override the
17425 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17426 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17427 to override; they are accepted, but ignored.
17428
17429
17430 .option queue_run_in_order main boolean false
17431 .cindex "queue runner" "processing messages in order"
17432 If this option is set, queue runs happen in order of message arrival instead of
17433 in an arbitrary order. For this to happen, a complete list of the entire queue
17434 must be set up before the deliveries start. When the queue is all held in a
17435 single directory (the default), a single list is created for both the ordered
17436 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17437 single list is not created when &%queue_run_in_order%& is false. In this case,
17438 the sub-directories are processed one at a time (in a random order), and this
17439 avoids setting up one huge list for the whole queue. Thus, setting
17440 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17441 when the queue is large, because of the extra work in setting up the single,
17442 large list. In most situations, &%queue_run_in_order%& should not be set.
17443
17444
17445
17446 .option queue_run_max main integer&!! 5
17447 .cindex "queue runner" "maximum number of"
17448 This controls the maximum number of queue runner processes that an Exim daemon
17449 can run simultaneously. This does not mean that it starts them all at once,
17450 but rather that if the maximum number are still running when the time comes to
17451 start another one, it refrains from starting another one. This can happen with
17452 very large queues and/or very sluggish deliveries. This option does not,
17453 however, interlock with other processes, so additional queue runners can be
17454 started by other means, or by killing and restarting the daemon.
17455
17456 Setting this option to zero does not suppress queue runs; rather, it disables
17457 the limit, allowing any number of simultaneous queue runner processes to be
17458 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17459 the daemon's command line.
17460
17461 .cindex queues named
17462 .cindex "named queues" "resource limit"
17463 To set limits for different named queues use
17464 an expansion depending on the &$queue_name$& variable.
17465
17466 .option queue_smtp_domains main "domain list&!!" unset
17467 .cindex "queueing incoming messages"
17468 .cindex "message" "queueing remote deliveries"
17469 .cindex "first pass routing"
17470 When this option is set, a delivery process is started whenever a message is
17471 received, routing is performed, and local deliveries take place.
17472 However, if any SMTP deliveries are required for domains that match
17473 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17474 message waits in the queue for the next queue run. Since routing of the message
17475 has taken place, Exim knows to which remote hosts it must be delivered, and so
17476 when the queue run happens, multiple messages for the same host are delivered
17477 over a single SMTP connection. The &%-odqs%& command line option causes all
17478 SMTP deliveries to be queued in this way, and is equivalent to setting
17479 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17480 &%queue_domains%&.
17481
17482
17483 .option receive_timeout main time 0s
17484 .cindex "timeout" "for non-SMTP input"
17485 This option sets the timeout for accepting a non-SMTP message, that is, the
17486 maximum time that Exim waits when reading a message on the standard input. If
17487 the value is zero, it will wait forever. This setting is overridden by the
17488 &%-or%& command line option. The timeout for incoming SMTP messages is
17489 controlled by &%smtp_receive_timeout%&.
17490
17491 .option received_header_text main string&!! "see below"
17492 .cindex "customizing" "&'Received:'& header"
17493 .cindex "&'Received:'& header line" "customizing"
17494 This string defines the contents of the &'Received:'& message header that is
17495 added to each message, except for the timestamp, which is automatically added
17496 on at the end (preceded by a semicolon). The string is expanded each time it is
17497 used. If the expansion yields an empty string, no &'Received:'& header line is
17498 added to the message. Otherwise, the string should start with the text
17499 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17500 header lines.
17501 The default setting is:
17502
17503 .code
17504 received_header_text = Received: \
17505   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17506     {${if def:sender_ident \
17507       {from ${quote_local_part:$sender_ident} }}\
17508         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17509   by $primary_hostname \
17510   ${if def:received_protocol {with $received_protocol }}\
17511   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17512   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17513   (Exim $version_number)\n\t\
17514   ${if def:sender_address \
17515   {(envelope-from <$sender_address>)\n\t}}\
17516   id $message_exim_id\
17517   ${if def:received_for {\n\tfor $received_for}}
17518 .endd
17519
17520 The references to the TLS version and cipher are
17521 omitted when Exim is built without TLS
17522 support. The use of conditional expansions ensures that this works for both
17523 locally generated messages and messages received from remote hosts, giving
17524 header lines such as the following:
17525 .code
17526 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17527 by marley.carol.example with esmtp (Exim 4.00)
17528 (envelope-from <bob@carol.example>)
17529 id 16IOWa-00019l-00
17530 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17531 Received: by scrooge.carol.example with local (Exim 4.00)
17532 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17533 .endd
17534 Until the body of the message has been received, the timestamp is the time when
17535 the message started to be received. Once the body has arrived, and all policy
17536 checks have taken place, the timestamp is updated to the time at which the
17537 message was accepted.
17538
17539
17540 .option received_headers_max main integer 30
17541 .cindex "loop" "prevention"
17542 .cindex "mail loop prevention"
17543 .cindex "&'Received:'& header line" "counting"
17544 When a message is to be delivered, the number of &'Received:'& headers is
17545 counted, and if it is greater than this parameter, a mail loop is assumed to
17546 have occurred, the delivery is abandoned, and an error message is generated.
17547 This applies to both local and remote deliveries.
17548
17549
17550 .option recipient_unqualified_hosts main "host list&!!" unset
17551 .cindex "unqualified addresses"
17552 .cindex "host" "unqualified addresses from"
17553 This option lists those hosts from which Exim is prepared to accept unqualified
17554 recipient addresses in message envelopes. The addresses are made fully
17555 qualified by the addition of the &%qualify_recipient%& value. This option also
17556 affects message header lines. Exim does not reject unqualified recipient
17557 addresses in headers, but it qualifies them only if the message came from a
17558 host that matches &%recipient_unqualified_hosts%&,
17559 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17560 option was not set.
17561
17562
17563 .option recipients_max main integer&!! 50000
17564 .cindex "limit" "number of recipients"
17565 .cindex "recipient" "maximum number"
17566 If the value resulting from expanding this option
17567 is set greater than zero, it specifies the maximum number of
17568 original recipients for any message. Additional recipients that are generated
17569 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17570 all recipients over the limit; earlier recipients are delivered as normal.
17571 Non-SMTP messages with too many recipients are failed, and no deliveries are
17572 done.
17573
17574 For SMTP message the expansion is done after the connection is
17575 accepted (but before any SMTP conversation) and may depend on
17576 the IP addresses and port numbers of the connection.
17577 &*Note*&: If an expansion is used for the option,
17578 care should be taken that a resonable value results for
17579 non-SMTP messages.
17580
17581 .cindex "RCPT" "maximum number of incoming"
17582 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17583 RCPT commands in a single message.
17584
17585
17586 .option recipients_max_reject main boolean false
17587 If this option is set true, Exim rejects SMTP messages containing too many
17588 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17589 error to the eventual DATA command. Otherwise (the default) it gives a 452
17590 error to the surplus RCPT commands and accepts the message on behalf of the
17591 initial set of recipients. The remote server should then re-send the message
17592 for the remaining recipients at a later time.
17593
17594
17595 .option remote_max_parallel main integer 4
17596 .cindex "delivery" "parallelism for remote"
17597 This option controls parallel delivery of one message to a number of remote
17598 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17599 does all the remote deliveries for a message one by one. Otherwise, if a single
17600 message has to be delivered to more than one remote host, or if several copies
17601 have to be sent to the same remote host, up to &%remote_max_parallel%&
17602 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17603 deliveries are required, the maximum number of processes are started, and as
17604 each one finishes, another is begun. The order of starting processes is the
17605 same as if sequential delivery were being done, and can be controlled by the
17606 &%remote_sort_domains%& option. If parallel delivery takes place while running
17607 with debugging turned on, the debugging output from each delivery process is
17608 tagged with its process id.
17609
17610 This option controls only the maximum number of parallel deliveries for one
17611 message in one Exim delivery process. Because Exim has no central queue
17612 manager, there is no way of controlling the total number of simultaneous
17613 deliveries if the configuration allows a delivery attempt as soon as a message
17614 is received.
17615
17616 See also the &%max_parallel%& generic transport option,
17617 and the &%serialize_hosts%& smtp transport option.
17618
17619 .cindex "number of deliveries"
17620 .cindex "delivery" "maximum number of"
17621 If you want to control the total number of deliveries on the system, you
17622 need to set the &%queue_only%& option. This ensures that all incoming messages
17623 are added to the queue without starting a delivery process. Then set up an Exim
17624 daemon to start queue runner processes at appropriate intervals (probably
17625 fairly often, for example, every minute), and limit the total number of queue
17626 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17627 delivers only one message at a time, the maximum number of deliveries that can
17628 then take place at once is &%queue_run_max%& multiplied by
17629 &%remote_max_parallel%&.
17630
17631 If it is purely remote deliveries you want to control, use
17632 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17633 doing the SMTP routing before queueing, so that several messages for the same
17634 host will eventually get delivered down the same connection.
17635
17636
17637 .option remote_sort_domains main "domain list&!!" unset
17638 .cindex "sorting remote deliveries"
17639 .cindex "delivery" "sorting remote"
17640 When there are a number of remote deliveries for a message, they are sorted by
17641 domain into the order given by this list. For example,
17642 .code
17643 remote_sort_domains = *.cam.ac.uk:*.uk
17644 .endd
17645 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17646 then to those in the &%uk%& domain, then to any others.
17647
17648
17649 .option retry_data_expire main time 7d
17650 .cindex "hints database" "data expiry"
17651 This option sets a &"use before"& time on retry information in Exim's hints
17652 database. Any older retry data is ignored. This means that, for example, once a
17653 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17654 past failures.
17655
17656
17657 .option retry_interval_max main time 24h
17658 .cindex "retry" "limit on interval"
17659 .cindex "limit" "on retry interval"
17660 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17661 intervals between delivery attempts for messages that cannot be delivered
17662 straight away. This option sets an overall limit to the length of time between
17663 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17664 the default value.
17665
17666
17667 .option return_path_remove main boolean true
17668 .cindex "&'Return-path:'& header line" "removing"
17669 RFC 2821, section 4.4, states that an SMTP server must insert a
17670 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17671 The &'Return-path:'& header preserves the sender address as received in the
17672 MAIL command. This description implies that this header should not be present
17673 in an incoming message. If &%return_path_remove%& is true, any existing
17674 &'Return-path:'& headers are removed from messages at the time they are
17675 received. Exim's transports have options for adding &'Return-path:'& headers at
17676 the time of delivery. They are normally used only for final local deliveries.
17677
17678
17679 .option return_size_limit main integer 100K
17680 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17681
17682
17683 .option rfc1413_hosts main "host list&!!" @[]
17684 .cindex "RFC 1413"
17685 .cindex "host" "for RFC 1413 calls"
17686 RFC 1413 identification calls are made to any client host which matches
17687 an item in the list.
17688 The default value specifies just this host, being any local interface
17689 for the system.
17690
17691 .option rfc1413_query_timeout main time 0s
17692 .cindex "RFC 1413" "query timeout"
17693 .cindex "timeout" "for RFC 1413 call"
17694 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17695 no RFC 1413 calls are ever made.
17696
17697
17698 .option sender_unqualified_hosts main "host list&!!" unset
17699 .cindex "unqualified addresses"
17700 .cindex "host" "unqualified addresses from"
17701 This option lists those hosts from which Exim is prepared to accept unqualified
17702 sender addresses. The addresses are made fully qualified by the addition of
17703 &%qualify_domain%&. This option also affects message header lines. Exim does
17704 not reject unqualified addresses in headers that contain sender addresses, but
17705 it qualifies them only if the message came from a host that matches
17706 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17707 using TCP/IP), and the &%-bnq%& option was not set.
17708
17709
17710 .option slow_lookup_log main integer 0
17711 .cindex "logging" "slow lookups"
17712 .cindex "dns" "logging slow lookups"
17713 This option controls logging of slow lookups.
17714 If the value is nonzero it is taken as a number of milliseconds
17715 and lookups taking longer than this are logged.
17716 Currently this applies only to DNS lookups.
17717
17718
17719
17720 .option smtp_accept_keepalive main boolean true
17721 .cindex "keepalive" "on incoming connection"
17722 This option controls the setting of the SO_KEEPALIVE option on incoming
17723 TCP/IP socket connections. When set, it causes the kernel to probe idle
17724 connections periodically, by sending packets with &"old"& sequence numbers. The
17725 other end of the connection should send an acknowledgment if the connection is
17726 still okay or a reset if the connection has been aborted. The reason for doing
17727 this is that it has the beneficial effect of freeing up certain types of
17728 connection that can get stuck when the remote host is disconnected without
17729 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17730 hours to detect unreachable hosts.
17731
17732
17733
17734 .option smtp_accept_max main integer 20
17735 .cindex "limit" "incoming SMTP connections"
17736 .cindex "SMTP" "incoming connection count"
17737 .cindex "inetd"
17738 This option specifies the maximum number of simultaneous incoming SMTP calls
17739 that Exim will accept. It applies only to the listening daemon; there is no
17740 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17741 value is set to zero, no limit is applied. However, it is required to be
17742 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17743 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17744
17745 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17746 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17747 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17748 and &%smtp_load_reserve%& are then checked before accepting the connection.
17749
17750
17751 .option smtp_accept_max_nonmail main integer 10
17752 .cindex "limit" "non-mail SMTP commands"
17753 .cindex "SMTP" "limiting non-mail commands"
17754 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17755 the connection if there are too many. This option defines &"too many"&. The
17756 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17757 client looping sending EHLO, for example. The check is applied only if the
17758 client host matches &%smtp_accept_max_nonmail_hosts%&.
17759
17760 When a new message is expected, one occurrence of RSET is not counted. This
17761 allows a client to send one RSET between messages (this is not necessary,
17762 but some clients do it). Exim also allows one uncounted occurrence of HELO
17763 or EHLO, and one occurrence of STARTTLS between messages. After
17764 starting up a TLS session, another EHLO is expected, and so it too is not
17765 counted. The first occurrence of AUTH in a connection, or immediately
17766 following STARTTLS is not counted. Otherwise, all commands other than
17767 MAIL, RCPT, DATA, and QUIT are counted.
17768
17769
17770 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17771 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17772 check by setting this option. The default value makes it apply to all hosts. By
17773 changing the value, you can exclude any badly-behaved hosts that you have to
17774 live with.
17775
17776
17777 . Allow this long option name to split; give it unsplit as a fifth argument
17778 . for the automatic .oindex that is generated by .option.
17779 . We insert " &~&~" which is both pretty nasty visually and results in
17780 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17781 . zero-width-space, which would be nicer visually and results in (at least)
17782 . html that Firefox will split on when it's forced to reflow (rather than
17783 . inserting a horizontal scrollbar).  However, the text is still not
17784 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17785 . the option name to split.
17786
17787 .option smtp_accept_max_per_connection main integer&!! 1000
17788 .cindex "SMTP" "limiting incoming message count"
17789 .cindex "limit" "messages per SMTP connection"
17790 The value of this option limits the number of MAIL commands that Exim is
17791 prepared to accept over a single SMTP connection, whether or not each command
17792 results in the transfer of a message. After the limit is reached, a 421
17793 response is given to subsequent MAIL commands. This limit is a safety
17794 precaution against a client that goes mad (incidents of this type have been
17795 seen).
17796 The option is expanded after the HELO or EHLO is received
17797 and may depend on values available at that time.
17798 An empty or zero value after expansion removes the limit.
17799
17800
17801 .option smtp_accept_max_per_host main string&!! unset
17802 .cindex "limit" "SMTP connections from one host"
17803 .cindex "host" "limiting SMTP connections from"
17804 This option restricts the number of simultaneous IP connections from a single
17805 host (strictly, from a single IP address) to the Exim daemon. The option is
17806 expanded, to enable different limits to be applied to different hosts by
17807 reference to &$sender_host_address$&. Once the limit is reached, additional
17808 connection attempts from the same host are rejected with error code 421. This
17809 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17810 of zero imposes no limit. If this option is set greater than zero, it is
17811 required that &%smtp_accept_max%& be non-zero.
17812
17813 &*Warning*&: When setting this option you should not use any expansion
17814 constructions that take an appreciable amount of time. The expansion and test
17815 happen in the main daemon loop, in order to reject additional connections
17816 without forking additional processes (otherwise a denial-of-service attack
17817 could cause a vast number or processes to be created). While the daemon is
17818 doing this processing, it cannot accept any other incoming connections.
17819
17820
17821
17822 .option smtp_accept_queue main integer 0
17823 .cindex "SMTP" "incoming connection count"
17824 .cindex "queueing incoming messages"
17825 .cindex "message" "queueing by SMTP connection count"
17826 If the number of simultaneous incoming SMTP connections being handled via the
17827 listening daemon exceeds this value, messages received by SMTP are just placed
17828 in the queue; no delivery processes are started automatically. The count is
17829 fixed at the start of an SMTP connection. It cannot be updated in the
17830 subprocess that receives messages, and so the queueing or not queueing applies
17831 to all messages received in the same connection.
17832
17833 A value of zero implies no limit, and clearly any non-zero value is useful only
17834 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17835 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17836 various &%-od%&&'x'& command line options.
17837
17838
17839 . See the comment on smtp_accept_max_per_connection
17840
17841 .option smtp_accept_queue_per_connection main integer 10
17842 .cindex "queueing incoming messages"
17843 .cindex "message" "queueing by message count"
17844 This option limits the number of delivery processes that Exim starts
17845 automatically when receiving messages via SMTP, whether via the daemon or by
17846 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17847 and the number of messages received in a single SMTP session exceeds this
17848 number, subsequent messages are placed in the queue, but no delivery processes
17849 are started. This helps to limit the number of Exim processes when a server
17850 restarts after downtime and there is a lot of mail waiting for it on other
17851 systems. On large systems, the default should probably be increased, and on
17852 dial-in client systems it should probably be set to zero (that is, disabled).
17853
17854
17855 .option smtp_accept_reserve main integer 0
17856 .cindex "SMTP" "incoming call count"
17857 .cindex "host" "reserved"
17858 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17859 number of SMTP connections that are reserved for connections from the hosts
17860 that are specified in &%smtp_reserve_hosts%&. The value set in
17861 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17862 restricted to this number of connections; the option specifies a minimum number
17863 of connection slots for them, not a maximum. It is a guarantee that this group
17864 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17865 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17866 individual host.
17867
17868 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17869 set to 5, once there are 45 active connections (from any hosts), new
17870 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17871 provided the other criteria for acceptance are met.
17872
17873
17874 .option smtp_active_hostname main string&!! unset
17875 .cindex "host" "name in SMTP responses"
17876 .cindex "SMTP" "host name in responses"
17877 .vindex "&$primary_hostname$&"
17878 This option is provided for multi-homed servers that want to masquerade as
17879 several different hosts. At the start of an incoming SMTP connection, its value
17880 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17881 responses. For example, it is used as domain name in the response to an
17882 incoming HELO or EHLO command.
17883
17884 .vindex "&$smtp_active_hostname$&"
17885 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17886 is saved with any messages that are received. It is therefore available for use
17887 in routers and transports when the message is later delivered.
17888
17889 If this option is unset, or if its expansion is forced to fail, or if the
17890 expansion results in an empty string, the value of &$primary_hostname$& is
17891 used. Other expansion failures cause a message to be written to the main and
17892 panic logs, and the SMTP command receives a temporary error. Typically, the
17893 value of &%smtp_active_hostname%& depends on the incoming interface address.
17894 For example:
17895 .code
17896 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17897   {cox.mydomain}{box.mydomain}}
17898 .endd
17899
17900 Although &$smtp_active_hostname$& is primarily concerned with incoming
17901 messages, it is also used as the default for HELO commands in callout
17902 verification if there is no remote transport from which to obtain a
17903 &%helo_data%& value.
17904
17905 .option smtp_backlog_monitor main integer 0
17906 .cindex "connection backlog" monitoring
17907 If this option is set to greater than zero, and the backlog of available
17908 TCP connections on a socket listening for SMTP is larger than it, a line
17909 is logged giving the value and the socket address and port.
17910 The value is retrived jsut before an accept call.
17911 This facility is only available on Linux.
17912
17913 .option smtp_banner main string&!! "see below"
17914 .cindex "SMTP" "welcome banner"
17915 .cindex "banner for SMTP"
17916 .cindex "welcome banner for SMTP"
17917 .cindex "customizing" "SMTP banner"
17918 If a connect ACL does not supply a message,
17919 this string (which is expanded every time it is used) is output as the initial
17920 positive response to an SMTP connection. The default setting is:
17921 .code
17922 smtp_banner = $smtp_active_hostname ESMTP Exim \
17923   $version_number $tod_full
17924 .endd
17925 Failure to expand the string causes a panic error;
17926 a forced fail just closes the connection.
17927 If you want to create a
17928 multiline response to the initial SMTP connection, use &"\n"& in the string at
17929 appropriate points, but not at the end. Note that the 220 code is not included
17930 in this string. Exim adds it automatically (several times in the case of a
17931 multiline response).
17932
17933
17934 .option smtp_check_spool_space main boolean true
17935 .cindex "checking disk space"
17936 .cindex "disk space, checking"
17937 .cindex "spool directory" "checking space"
17938 When this option is set, if an incoming SMTP session encounters the SIZE
17939 option on a MAIL command, it checks that there is enough space in the
17940 spool directory's partition to accept a message of that size, while still
17941 leaving free the amount specified by &%check_spool_space%& (even if that value
17942 is zero). If there isn't enough space, a temporary error code is returned.
17943
17944
17945 .option smtp_connect_backlog main integer 20
17946 .cindex "connection backlog" "set maximum"
17947 .cindex "SMTP" "connection backlog"
17948 .cindex "backlog of connections"
17949 This option specifies a maximum number of waiting SMTP connections. Exim passes
17950 this value to the TCP/IP system when it sets up its listener. Once this number
17951 of connections are waiting for the daemon's attention, subsequent connection
17952 attempts are refused at the TCP/IP level. At least, that is what the manuals
17953 say; in some circumstances such connection attempts have been observed to time
17954 out instead. For large systems it is probably a good idea to increase the
17955 value (to 50, say). It also gives some protection against denial-of-service
17956 attacks by SYN flooding.
17957
17958
17959 .option smtp_enforce_sync main boolean true
17960 .cindex "SMTP" "synchronization checking"
17961 .cindex "synchronization checking in SMTP"
17962 The SMTP protocol specification requires the client to wait for a response from
17963 the server at certain points in the dialogue. Without PIPELINING these
17964 synchronization points are after every command; with PIPELINING they are
17965 fewer, but they still exist.
17966
17967 Some spamming sites send out a complete set of SMTP commands without waiting
17968 for any response. Exim protects against this by rejecting a message if the
17969 client has sent further input when it should not have. The error response &"554
17970 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17971 for this error cannot be perfect because of transmission delays (unexpected
17972 input may be on its way but not yet received when Exim checks). However, it
17973 does detect many instances.
17974
17975 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17976 If you want to disable the check selectively (for example, only for certain
17977 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17978 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17979
17980
17981
17982 .option smtp_etrn_command main string&!! unset
17983 .cindex "ETRN" "command to be run"
17984 .cindex "ESMTP extensions" ETRN
17985 .vindex "&$domain$&"
17986 If this option is set, the given command is run whenever an SMTP ETRN
17987 command is received from a host that is permitted to issue such commands (see
17988 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17989 are independently expanded. The expansion variable &$domain$& is set to the
17990 argument of the ETRN command, and no syntax checking is done on it. For
17991 example:
17992 .code
17993 smtp_etrn_command = /etc/etrn_command $domain \
17994                     $sender_host_address
17995 .endd
17996 If the option is not set, the argument for the ETRN command must
17997 be a &'#'& followed by an address string.
17998 In this case an &'exim -R <string>'& command is used;
17999 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
18000
18001 A new process is created to run the command, but Exim does not wait for it to
18002 complete. Consequently, its status cannot be checked. If the command cannot be
18003 run, a line is written to the panic log, but the ETRN caller still receives
18004 a 250 success response. Exim is normally running under its own uid when
18005 receiving SMTP, so it is not possible for it to change the uid before running
18006 the command.
18007
18008
18009 .option smtp_etrn_serialize main boolean true
18010 .cindex "ETRN" "serializing"
18011 When this option is set, it prevents the simultaneous execution of more than
18012 one identical command as a result of ETRN in an SMTP connection. See
18013 section &<<SECTETRN>>& for details.
18014
18015
18016 .option smtp_load_reserve main fixed-point unset
18017 .cindex "load average"
18018 If the system load average ever gets higher than this, incoming SMTP calls are
18019 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
18020 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
18021 the load is over the limit. The option has no effect on ancient operating
18022 systems on which Exim cannot determine the load average. See also
18023 &%deliver_queue_load_max%& and &%queue_only_load%&.
18024
18025
18026
18027 .option smtp_max_synprot_errors main integer 3
18028 .cindex "SMTP" "limiting syntax and protocol errors"
18029 .cindex "limit" "SMTP syntax and protocol errors"
18030 Exim rejects SMTP commands that contain syntax or protocol errors. In
18031 particular, a syntactically invalid email address, as in this command:
18032 .code
18033 RCPT TO:<abc xyz@a.b.c>
18034 .endd
18035 causes immediate rejection of the command, before any other tests are done.
18036 (The ACL cannot be run if there is no valid address to set up for it.) An
18037 example of a protocol error is receiving RCPT before MAIL. If there are
18038 too many syntax or protocol errors in one SMTP session, the connection is
18039 dropped. The limit is set by this option.
18040
18041 .cindex "PIPELINING" "expected errors"
18042 When the PIPELINING extension to SMTP is in use, some protocol errors are
18043 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
18044 Exim assumes that PIPELINING will be used if it advertises it (see
18045 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
18046 not count towards the limit.
18047
18048
18049
18050 .option smtp_max_unknown_commands main integer 3
18051 .cindex "SMTP" "limiting unknown commands"
18052 .cindex "limit" "unknown SMTP commands"
18053 If there are too many unrecognized commands in an incoming SMTP session, an
18054 Exim server drops the connection. This is a defence against some kinds of abuse
18055 that subvert web
18056 clients
18057 into making connections to SMTP ports; in these circumstances, a number of
18058 non-SMTP command lines are sent first.
18059
18060
18061
18062 .options smtp_ratelimit_hosts main "host list&!!" unset &&&
18063          smtp_ratelimit_mail main string unset &&&
18064          smtp_ratelimit_rcpt main string unset
18065 .cindex "SMTP" "rate limiting"
18066 .cindex "limit" "rate of message arrival"
18067 .cindex "RCPT" "rate limiting"
18068 Some sites find it helpful to be able to limit the rate at which certain hosts
18069 can send them messages, and the rate at which an individual message can specify
18070 recipients.
18071
18072 Exim has two rate-limiting facilities. This section describes the older
18073 facility, which can limit rates within a single connection. The newer
18074 &%ratelimit%& ACL condition can limit rates across all connections. See section
18075 &<<SECTratelimiting>>& for details of the newer facility.
18076
18077 When a host matches &%smtp_ratelimit_hosts%&, the values of
18078 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
18079 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
18080 respectively. Each option, if set, must contain a set of four comma-separated
18081 values:
18082
18083 .ilist
18084 A threshold, before which there is no rate limiting.
18085 .next
18086 An initial time delay. Unlike other times in Exim, numbers with decimal
18087 fractional parts are allowed here.
18088 .next
18089 A factor by which to increase the delay each time.
18090 .next
18091 A maximum value for the delay. This should normally be less than 5 minutes,
18092 because after that time, the client is liable to timeout the SMTP command.
18093 .endlist
18094
18095 For example, these settings have been used successfully at the site which
18096 first suggested this feature, for controlling mail from their customers:
18097 .code
18098 smtp_ratelimit_mail = 2,0.5s,1.05,4m
18099 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
18100 .endd
18101 The first setting specifies delays that are applied to MAIL commands after
18102 two have been received over a single connection. The initial delay is 0.5
18103 seconds, increasing by a factor of 1.05 each time. The second setting applies
18104 delays to RCPT commands when more than four occur in a single message.
18105
18106
18107
18108 .option smtp_receive_timeout main time&!! 5m
18109 .cindex "timeout" "for SMTP input"
18110 .cindex "SMTP" "input timeout"
18111 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
18112 input, including batch SMTP. If a line of input (either an SMTP command or a
18113 data line) is not received within this time, the SMTP connection is dropped and
18114 the message is abandoned.
18115 A line is written to the log containing one of the following messages:
18116 .code
18117 SMTP command timeout on connection from...
18118 SMTP data timeout on connection from...
18119 .endd
18120 The former means that Exim was expecting to read an SMTP command; the latter
18121 means that it was in the DATA phase, reading the contents of a message.
18122
18123 If the first character of the option is a &"$"& the option is
18124 expanded before use and may depend on
18125 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18126
18127
18128 .oindex "&%-os%&"
18129 The value set by this option can be overridden by the
18130 &%-os%& command-line option. A setting of zero time disables the timeout, but
18131 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18132 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18133 timeout is controlled by &%receive_timeout%& and &%-or%&.
18134
18135
18136 .option smtp_reserve_hosts main "host list&!!" unset
18137 This option defines hosts for which SMTP connections are reserved; see
18138 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18139
18140
18141 .option smtp_return_error_details main boolean false
18142 .cindex "SMTP" "details policy failures"
18143 .cindex "policy control" "rejection, returning details"
18144 In the default state, Exim uses bland messages such as
18145 &"Administrative prohibition"& when it rejects SMTP commands for policy
18146 reasons. Many sysadmins like this because it gives away little information
18147 to spammers. However, some other sysadmins who are applying strict checking
18148 policies want to give out much fuller information about failures. Setting
18149 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18150 example, instead of &"Administrative prohibition"&, it might give:
18151 .code
18152 550-Rejected after DATA: '>' missing at end of address:
18153 550 failing address in "From" header is: <user@dom.ain
18154 .endd
18155
18156
18157 .option smtputf8_advertise_hosts main "host list&!!" *
18158 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18159 .cindex "ESMTP extensions" SMTPUTF8
18160 When Exim is built with support for internationalised mail names,
18161 the availability thereof is advertised in
18162 response to EHLO only to those client hosts that match this option. See
18163 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18164
18165
18166 .option spamd_address main string "127.0.0.1 783"
18167 This option is available when Exim is compiled with the content-scanning
18168 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18169 See section &<<SECTscanspamass>>& for more details.
18170
18171
18172
18173 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18174 This option is available when Exim is compiled with SPF support.
18175 See section &<<SECSPF>>& for more details.
18176
18177 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18178 This option is available when Exim is compiled with SPF support.  It
18179 allows the customisation of the SMTP comment that the SPF library
18180 generates.  You are strongly encouraged to link to your own explanative
18181 site. The template must not contain spaces. If you need spaces in the
18182 output, use the proper placeholder. If libspf2 can not parse the
18183 template, it uses a built-in default broken link. The following placeholders
18184 (along with Exim variables (but see below)) are allowed in the template:
18185 .ilist
18186 &*%_*&: A space.
18187 .next
18188 &*%{L}*&: Envelope sender's local part.
18189 .next
18190 &*%{S}*&: Envelope sender.
18191 .next
18192 &*%{O}*&: Envelope sender's domain.
18193 .next
18194 &*%{D}*&: Current(?) domain.
18195 .next
18196 &*%{I}*&: SMTP client Ip.
18197 .next
18198 &*%{C}*&: SMTP client pretty IP.
18199 .next
18200 &*%{T}*&: Epoch time (UTC).
18201 .next
18202 &*%{P}*&: SMTP client domain name.
18203 .next
18204 &*%{V}*&: IP version.
18205 .next
18206 &*%{H}*&: EHLO/HELO domain.
18207 .next
18208 &*%{R}*&: Receiving domain.
18209 .endlist
18210 The capitalized placeholders do proper URL encoding, if you use them
18211 lowercased, no encoding takes place.  This list was compiled from the
18212 libspf2 sources.
18213
18214 A note on using Exim variables: As
18215 currently the SPF library is initialized before the SMTP EHLO phase,
18216 the variables useful for expansion are quite limited.
18217
18218
18219 .option split_spool_directory main boolean false
18220 .cindex "multiple spool directories"
18221 .cindex "spool directory" "split"
18222 .cindex "directories, multiple"
18223 If this option is set, it causes Exim to split its input directory into 62
18224 subdirectories, each with a single alphanumeric character as its name. The
18225 sixth character of the message id is used to allocate messages to
18226 subdirectories; this is the least significant base-62 digit of the time of
18227 arrival of the message.
18228
18229 Splitting up the spool in this way may provide better performance on systems
18230 where there are long mail queues, by reducing the number of files in any one
18231 directory. The msglog directory is also split up in a similar way to the input
18232 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18233 are still placed in the single directory &_msglog.OLD_&.
18234
18235 It is not necessary to take any special action for existing messages when
18236 changing &%split_spool_directory%&. Exim notices messages that are in the
18237 &"wrong"& place, and continues to process them. If the option is turned off
18238 after a period of being on, the subdirectories will eventually empty and be
18239 automatically deleted.
18240
18241 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18242 changes. Instead of creating a list of all messages in the queue, and then
18243 trying to deliver each one, in turn, it constructs a list of those in one
18244 sub-directory and tries to deliver them, before moving on to the next
18245 sub-directory. The sub-directories are processed in a random order. This
18246 spreads out the scanning of the input directories, and uses less memory. It is
18247 particularly beneficial when there are lots of messages in the queue. However,
18248 if &%queue_run_in_order%& is set, none of this new processing happens. The
18249 entire queue has to be scanned and sorted before any deliveries can start.
18250
18251
18252 .option spool_directory main string&!! "set at compile time"
18253 .cindex "spool directory" "path to"
18254 This defines the directory in which Exim keeps its spool, that is, the messages
18255 it is waiting to deliver. The default value is taken from the compile-time
18256 configuration setting, if there is one. If not, this option must be set. The
18257 string is expanded, so it can contain, for example, a reference to
18258 &$primary_hostname$&.
18259
18260 If the spool directory name is fixed on your installation, it is recommended
18261 that you set it at build time rather than from this option, particularly if the
18262 log files are being written to the spool directory (see &%log_file_path%&).
18263 Otherwise log files cannot be used for errors that are detected early on, such
18264 as failures in the configuration file.
18265
18266 By using this option to override the compiled-in path, it is possible to run
18267 tests of Exim without using the standard spool.
18268
18269 .option spool_wireformat main boolean false
18270 .cindex "spool directory" "file formats"
18271 If this option is set, Exim may for some messages use an alternative format
18272 for data-files in the spool which matches the wire format.
18273 Doing this permits more efficient message reception and transmission.
18274 Currently it is only done for messages received using the ESMTP CHUNKING
18275 option.
18276
18277 The following variables will not have useful values:
18278 .code
18279 $max_received_linelength
18280 $body_linecount
18281 $body_zerocount
18282 .endd
18283
18284 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18285 and any external programs which are passed a reference to a message data file
18286 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18287 will need to be aware of the different formats potentially available.
18288
18289 Using any of the ACL conditions noted will negate the reception benefit
18290 (as a Unix-mbox-format file is constructed for them).
18291 The transmission benefit is maintained.
18292
18293 .option sqlite_lock_timeout main time 5s
18294 .cindex "sqlite lookup type" "lock timeout"
18295 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18296 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18297
18298 .option strict_acl_vars main boolean false
18299 .cindex "&ACL;" "variables, handling unset"
18300 This option controls what happens if a syntactically valid but undefined ACL
18301 variable is referenced. If it is false (the default), an empty string
18302 is substituted; if it is true, an error is generated. See section
18303 &<<SECTaclvariables>>& for details of ACL variables.
18304
18305 .option strip_excess_angle_brackets main boolean false
18306 .cindex "angle brackets, excess"
18307 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18308 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18309 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18310 passed on to another MTA, the excess angle brackets are not passed on. If this
18311 option is not set, multiple pairs of angle brackets cause a syntax error.
18312
18313
18314 .option strip_trailing_dot main boolean false
18315 .cindex "trailing dot on domain"
18316 .cindex "dot" "trailing on domain"
18317 If this option is set, a trailing dot at the end of a domain in an address is
18318 ignored. If this is in the envelope and the message is passed on to another
18319 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18320 domain causes a syntax error.
18321 However, addresses in header lines are checked only when an ACL requests header
18322 syntax checking.
18323
18324
18325 .option syslog_duplication main boolean true
18326 .cindex "syslog" "duplicate log lines; suppressing"
18327 When Exim is logging to syslog, it writes the log lines for its three
18328 separate logs at different syslog priorities so that they can in principle
18329 be separated on the logging hosts. Some installations do not require this
18330 separation, and in those cases, the duplication of certain log lines is a
18331 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18332 particular log line is written to syslog. For lines that normally go to
18333 both the main log and the reject log, the reject log version (possibly
18334 containing message header lines) is written, at LOG_NOTICE priority.
18335 Lines that normally go to both the main and the panic log are written at
18336 the LOG_ALERT priority.
18337
18338
18339 .option syslog_facility main string unset
18340 .cindex "syslog" "facility; setting"
18341 This option sets the syslog &"facility"& name, used when Exim is logging to
18342 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18343 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18344 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18345 details of Exim's logging.
18346
18347
18348 .option syslog_pid main boolean true
18349 .cindex "syslog" "pid"
18350 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18351 omitted when these lines are sent to syslog. (Syslog normally prefixes
18352 the log lines with the PID of the logging process automatically.) You need
18353 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18354 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18355
18356
18357
18358 .option syslog_processname main string &`exim`&
18359 .cindex "syslog" "process name; setting"
18360 This option sets the syslog &"ident"& name, used when Exim is logging to
18361 syslog. The value must be no longer than 32 characters. See chapter
18362 &<<CHAPlog>>& for details of Exim's logging.
18363
18364
18365
18366 .option syslog_timestamp main boolean true
18367 .cindex "syslog" "timestamps"
18368 .cindex timestamps syslog
18369 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18370 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18371 details of Exim's logging.
18372
18373
18374 .option system_filter main string&!! unset
18375 .cindex "filter" "system filter"
18376 .cindex "system filter" "specifying"
18377 .cindex "Sieve filter" "not available for system filter"
18378 This option specifies an Exim filter file that is applied to all messages at
18379 the start of each delivery attempt, before any routing is done. System filters
18380 must be Exim filters; they cannot be Sieve filters. If the system filter
18381 generates any deliveries to files or pipes, or any new mail messages, the
18382 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18383 which transports are to be used. Details of this facility are given in chapter
18384 &<<CHAPsystemfilter>>&.
18385 A forced expansion failure results in no filter operation.
18386
18387
18388 .option system_filter_directory_transport main string&!! unset
18389 .vindex "&$address_file$&"
18390 This sets the name of the transport driver that is to be used when the
18391 &%save%& command in a system message filter specifies a path ending in &"/"&,
18392 implying delivery of each message into a separate file in some directory.
18393 During the delivery, the variable &$address_file$& contains the path name.
18394
18395
18396 .option system_filter_file_transport main string&!! unset
18397 .cindex "file" "transport for system filter"
18398 This sets the name of the transport driver that is to be used when the &%save%&
18399 command in a system message filter specifies a path not ending in &"/"&. During
18400 the delivery, the variable &$address_file$& contains the path name.
18401
18402 .option system_filter_group main string unset
18403 .cindex "gid (group id)" "system filter"
18404 This option is used only when &%system_filter_user%& is also set. It sets the
18405 gid under which the system filter is run, overriding any gid that is associated
18406 with the user. The value may be numerical or symbolic.
18407
18408 .option system_filter_pipe_transport main string&!! unset
18409 .cindex "&(pipe)& transport" "for system filter"
18410 .vindex "&$address_pipe$&"
18411 This specifies the transport driver that is to be used when a &%pipe%& command
18412 is used in a system filter. During the delivery, the variable &$address_pipe$&
18413 contains the pipe command.
18414
18415
18416 .option system_filter_reply_transport main string&!! unset
18417 .cindex "&(autoreply)& transport" "for system filter"
18418 This specifies the transport driver that is to be used when a &%mail%& command
18419 is used in a system filter.
18420
18421
18422 .option system_filter_user main string unset
18423 .cindex "uid (user id)" "system filter"
18424 If this option is set to root, the system filter is run in the main Exim
18425 delivery process, as root.  Otherwise, the system filter runs in a separate
18426 process, as the given user, defaulting to the Exim run-time user.
18427 Unless the string consists entirely of digits, it
18428 is looked up in the password data. Failure to find the named user causes a
18429 configuration error. The gid is either taken from the password data, or
18430 specified by &%system_filter_group%&. When the uid is specified numerically,
18431 &%system_filter_group%& is required to be set.
18432
18433 If the system filter generates any pipe, file, or reply deliveries, the uid
18434 under which the filter is run is used when transporting them, unless a
18435 transport option overrides.
18436
18437
18438 .option tcp_nodelay main boolean true
18439 .cindex "daemon" "TCP_NODELAY on sockets"
18440 .cindex "Nagle algorithm"
18441 .cindex "TCP_NODELAY on listening sockets"
18442 If this option is set false, it stops the Exim daemon setting the
18443 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18444 turns off the &"Nagle algorithm"&, which is a way of improving network
18445 performance in interactive (character-by-character) situations. Turning it off
18446 should improve Exim's performance a bit, so that is what happens by default.
18447 However, it appears that some broken clients cannot cope, and time out. Hence
18448 this option. It affects only those sockets that are set up for listening by the
18449 daemon. Sockets created by the smtp transport for delivering mail always set
18450 TCP_NODELAY.
18451
18452
18453 .option timeout_frozen_after main time 0s
18454 .cindex "frozen messages" "timing out"
18455 .cindex "timeout" "frozen messages"
18456 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18457 message of any kind that has been in the queue for longer than the given time
18458 is automatically cancelled at the next queue run. If the frozen message is a
18459 bounce message, it is just discarded; otherwise, a bounce is sent to the
18460 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18461 If you want to timeout frozen bounce messages earlier than other kinds of
18462 frozen message, see &%ignore_bounce_errors_after%&.
18463
18464 &*Note:*& the default value of zero means no timeouts; with this setting,
18465 frozen messages remain in the queue forever (except for any frozen bounce
18466 messages that are released by &%ignore_bounce_errors_after%&).
18467
18468
18469 .option timezone main string unset
18470 .cindex "timezone, setting"
18471 .cindex "environment" "values from"
18472 The value of &%timezone%& is used to set the environment variable TZ while
18473 running Exim (if it is different on entry). This ensures that all timestamps
18474 created by Exim are in the required timezone. If you want all your timestamps
18475 to be in UTC (aka GMT) you should set
18476 .code
18477 timezone = UTC
18478 .endd
18479 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18480 or, if that is not set, from the value of the TZ environment variable when Exim
18481 is built. If &%timezone%& is set to the empty string, either at build or run
18482 time, any existing TZ variable is removed from the environment when Exim
18483 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18484 unfortunately not all, operating systems.
18485
18486
18487 .option tls_advertise_hosts main "host list&!!" *
18488 .cindex "TLS" "advertising"
18489 .cindex "encryption" "on SMTP connection"
18490 .cindex "SMTP" "encrypted connection"
18491 .cindex "ESMTP extensions" STARTTLS
18492 When Exim is built with support for TLS encrypted connections, the availability
18493 of the STARTTLS command to set up an encrypted session is advertised in
18494 response to EHLO only to those client hosts that match this option. See
18495 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18496 Note that the default value requires that a certificate be supplied
18497 using the &%tls_certificate%& option.  If TLS support for incoming connections
18498 is not required the &%tls_advertise_hosts%& option should be set empty.
18499
18500
18501 .option tls_alpn main "string list&!!" "smtp : esmtp"
18502 .cindex TLS "Application Layer Protocol Names"
18503 .cindex TLS ALPN
18504 .cindex ALPN "set acceptable names for server"
18505 If this option is set,
18506 the TLS library supports ALPN,
18507 and the client offers either more than one
18508 ALPN name or a name which does not match the list,
18509 the TLS connection is declined.
18510
18511
18512 .option tls_certificate main "string list&!!" unset
18513 .cindex "TLS" "server certificate; location of"
18514 .cindex "certificate" "server, location of"
18515 The value of this option is expanded, and must then be a list of absolute paths to
18516 files which contain the server's certificates (in PEM format).
18517 Commonly only one file is needed.
18518 The server's private key is also
18519 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18520 &<<CHAPTLS>>& for further details.
18521
18522 &*Note*&: The certificates defined by this option are used only when Exim is
18523 receiving incoming messages as a server. If you want to supply certificates for
18524 use when sending messages as a client, you must set the &%tls_certificate%&
18525 option in the relevant &(smtp)& transport.
18526
18527 &*Note*&: If you use filenames based on IP addresses, change the list
18528 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18529
18530 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18531 when a list of more than one
18532 file is used, the &$tls_in_ourcert$& variable is unreliable.
18533 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18534
18535 .cindex SNI "selecting server certificate based on"
18536 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18537 if the OpenSSL build supports TLS extensions and the TLS client sends the
18538 Server Name Indication extension, then this option and others documented in
18539 &<<SECTtlssni>>& will be re-expanded.
18540
18541 If this option is unset or empty a self-signed certificate will be
18542 used.
18543 Under Linux this is generated at daemon startup; on other platforms it will be
18544 generated fresh for every connection.
18545
18546 .option tls_crl main string&!! unset
18547 .cindex "TLS" "server certificate revocation list"
18548 .cindex "certificate" "revocation list for server"
18549 This option specifies a certificate revocation list. The expanded value must
18550 be the name of a file that contains CRLs in PEM format.
18551
18552 Under OpenSSL the option can specify a directory with CRL files.
18553
18554 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18555 for each signing element of the certificate chain (i.e. all but the leaf).
18556 For the file variant this can be multiple PEM blocks in the one file.
18557
18558 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18559
18560
18561 .option tls_dh_max_bits main integer 2236
18562 .cindex "TLS" "D-H bit count"
18563 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18564 the chosen TLS library.  That value might prove to be too high for
18565 interoperability.  This option provides a maximum clamp on the value
18566 suggested, trading off security for interoperability.
18567
18568 The value must be at least 1024.
18569
18570 The value 2236 was chosen because, at time of adding the option, it was the
18571 hard-coded maximum value supported by the NSS cryptographic library, as used
18572 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18573
18574 If you prefer more security and are willing to break some clients, raise this
18575 number.
18576
18577 Note that the value passed to GnuTLS for *generating* a new prime may be a
18578 little less than this figure, because GnuTLS is inexact and may produce a
18579 larger prime than requested.
18580
18581
18582 .option tls_dhparam main string&!! unset
18583 .cindex "TLS" "D-H parameters for server"
18584 The value of this option is expanded and indicates the source of DH parameters
18585 to be used by Exim.
18586
18587 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18588 local DH parameters*&, which has been supported across all versions of Exim.  The
18589 other specific constants available are a fallback so that even when
18590 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18591
18592 If &%tls_dhparam%& is a filename starting with a &`/`&,
18593 then it names a file from which DH
18594 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18595 PKCS#3 representation of the DH prime.  If the file does not exist, for
18596 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18597 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18598 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18599 and treated as though the &%tls_dhparam%& were set to "none".
18600
18601 If this option expands to the string "none", then no DH parameters will be
18602 loaded by Exim.
18603
18604 If this option expands to the string "historic" and Exim is using GnuTLS, then
18605 Exim will attempt to load a file from inside the spool directory.  If the file
18606 does not exist, Exim will attempt to create it.
18607 See section &<<SECTgnutlsparam>>& for further details.
18608
18609 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18610 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18611
18612 In older versions of Exim the default was the 2048 bit prime described in section
18613 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18614 in IKE is assigned number 23.
18615
18616 Otherwise, the option must expand to the name used by Exim for any of a number
18617 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18618 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18619 the number used by IKE, or "default" which corresponds to
18620 &`exim.dev.20160529.3`&.
18621
18622 The available standard primes are:
18623 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18624 &`ike1`&, &`ike2`&, &`ike5`&,
18625 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18626 &`ike22`&, &`ike23`& and &`ike24`&.
18627
18628 The available additional primes are:
18629 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18630
18631 Some of these will be too small to be accepted by clients.
18632 Some may be too large to be accepted by clients.
18633 The open cryptographic community has suspicions about the integrity of some
18634 of the later IKE values, which led into RFC7919 providing new fixed constants
18635 (the "ffdhe" identifiers).
18636
18637 At this point, all of the "ike" values should be considered obsolete;
18638 they are still in Exim to avoid breaking unusual configurations, but are
18639 candidates for removal the next time we have backwards-incompatible changes.
18640 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18641 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18642 SHOULD NOT.
18643 Because of this, Exim regards them as deprecated; if either of the first pair
18644 are used, warnings will be logged in the paniclog, and if any are used then
18645 warnings will be logged in the mainlog.
18646 All four will be removed in a future Exim release.
18647
18648 The TLS protocol does not negotiate an acceptable size for this; clients tend
18649 to hard-drop connections if what is offered by the server is unacceptable,
18650 whether too large or too small, and there's no provision for the client to
18651 tell the server what these constraints are.  Thus, as a server operator, you
18652 need to make an educated guess as to what is most likely to work for your
18653 userbase.
18654
18655 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18656 is most likely to maximise interoperability.  The upper bound comes from
18657 applications using the Mozilla Network Security Services (NSS) library, which
18658 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18659 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18660 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18661 acceptable bound from 1024 to 2048.
18662
18663
18664 .option tls_eccurve main string list&!! &`auto`&
18665 .cindex TLS "EC cryptography"
18666 This option selects EC curves for use by Exim when used with OpenSSL.
18667 It has no effect when Exim is used with GnuTLS
18668 (the equivalent can be done using a priority string for the
18669 &%tls_require_ciphers%& option).
18670
18671 After expansion it must contain
18672 one or (only for OpenSSL versiona 1.1.1 onwards) more
18673 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18674 Consult your OpenSSL manual for valid curve names.
18675
18676 For OpenSSL versions before (and not including) 1.0.2, the string
18677 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18678 &`auto`& tells the library to choose.
18679
18680 If the option expands to an empty string, the effect is undefined.
18681
18682
18683 .option tls_ocsp_file main string&!! unset
18684 .cindex TLS "certificate status"
18685 .cindex TLS "OCSP proof file"
18686 This option
18687 must if set expand to the absolute path to a file which contains a current
18688 status proof for the server's certificate, as obtained from the
18689 Certificate Authority.
18690
18691 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18692 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18693
18694 For OpenSSL 1.1.0 or later, and
18695 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18696 of files, to match a list given for the &%tls_certificate%& option.
18697 The ordering of the two lists must match.
18698 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18699
18700 The file(s) should be in DER format,
18701 except for GnuTLS 3.6.3 or later
18702 or for OpenSSL,
18703 when an optional filetype prefix can be used.
18704 The prefix must be one of "DER" or "PEM", followed by
18705 a single space.  If one is used it sets the format for subsequent
18706 files in the list; the initial format is DER.
18707 If multiple proofs are wanted, for multiple chain elements
18708 (this only works under TLS1.3)
18709 they must be coded as a combined OCSP response.
18710
18711 Although GnuTLS will accept PEM files with multiple separate
18712 PEM blobs (ie. separate OCSP responses), it sends them in the
18713 TLS Certificate record interleaved with the certificates of the chain;
18714 although a GnuTLS client is happy with that, an OpenSSL client is not.
18715
18716 .option tls_on_connect_ports main "string list" unset
18717 .cindex SSMTP
18718 .cindex SMTPS
18719 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18720 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18721 set up without waiting for the client to issue a STARTTLS command. For
18722 further details, see section &<<SECTsupobssmt>>&.
18723
18724
18725
18726 .option tls_privatekey main "string list&!!" unset
18727 .cindex "TLS" "server private key; location of"
18728 The value of this option is expanded, and must then be a list of absolute paths to
18729 files which contains the server's private keys.
18730 If this option is unset, or if
18731 the expansion is forced to fail, or the result is an empty string, the private
18732 key is assumed to be in the same file as the server's certificates. See chapter
18733 &<<CHAPTLS>>& for further details.
18734
18735 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18736
18737
18738 .option tls_remember_esmtp main boolean false
18739 .cindex "TLS" "esmtp state; remembering"
18740 .cindex "TLS" "broken clients"
18741 If this option is set true, Exim violates the RFCs by remembering that it is in
18742 &"esmtp"& state after successfully negotiating a TLS session. This provides
18743 support for broken clients that fail to send a new EHLO after starting a
18744 TLS session.
18745
18746
18747 .option tls_require_ciphers main string&!! unset
18748 .cindex "TLS" "requiring specific ciphers"
18749 .cindex "cipher" "requiring specific"
18750 This option controls which ciphers can be used for incoming TLS connections.
18751 The &(smtp)& transport has an option of the same name for controlling outgoing
18752 connections. This option is expanded for each connection, so can be varied for
18753 different clients if required. The value of this option must be a list of
18754 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18755 in somewhat different ways. If GnuTLS is being used, the client controls the
18756 preference order of the available ciphers. Details are given in sections
18757 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18758
18759
18760 .option tls_resumption_hosts main "host list&!!" unset
18761 .cindex TLS resumption
18762 This option controls which connections to offer the TLS resumption feature.
18763 See &<<SECTresumption>>& for details.
18764
18765
18766 .option tls_try_verify_hosts main "host list&!!" unset
18767 .cindex "TLS" "client certificate verification"
18768 .cindex "certificate" "verification of client"
18769 See &%tls_verify_hosts%& below.
18770
18771
18772 .option tls_verify_certificates main string&!! system
18773 .cindex "TLS" "client certificate verification"
18774 .cindex "certificate" "verification of client"
18775 The value of this option is expanded, and must then be either the
18776 word "system"
18777 or the absolute path to
18778 a file or directory containing permitted certificates for clients that
18779 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18780
18781 The "system" value for the option will use a
18782 system default location compiled into the SSL library.
18783 This is not available for GnuTLS versions preceding 3.0.20,
18784 and will be taken as empty; an explicit location
18785 must be specified.
18786
18787 The use of a directory for the option value is not available for GnuTLS versions
18788 preceding 3.3.6 and a single file must be used.
18789
18790 With OpenSSL the certificates specified
18791 explicitly
18792 either by file or directory
18793 are added to those given by the system default location.
18794
18795 These certificates should be for the certificate authorities trusted, rather
18796 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18797 the value is a file then the certificates are sent by Exim as a server to
18798 connecting clients, defining the list of accepted certificate authorities.
18799 Thus the values defined should be considered public data.  To avoid this,
18800 use the explicit directory version. (If your peer is Exim up to 4.85,
18801 using GnuTLS, you may need to send the CAs (thus using the file
18802 variant). Otherwise the peer doesn't send its certificate.)
18803
18804 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18805
18806 A forced expansion failure or setting to an empty string is equivalent to
18807 being unset.
18808
18809
18810 .option tls_verify_hosts main "host list&!!" unset
18811 .cindex "TLS" "client certificate verification"
18812 .cindex "certificate" "verification of client"
18813 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18814 certificates from clients. The expected certificates are defined by
18815 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18816 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18817 &%tls_verify_certificates%& is not set.
18818
18819 Any client that matches &%tls_verify_hosts%& is constrained by
18820 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18821 present one of the listed certificates. If it does not, the connection is
18822 aborted.
18823 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18824 the host to use TLS. It can still send SMTP commands through unencrypted
18825 connections. Forcing a client to use TLS has to be done separately using an
18826 ACL to reject inappropriate commands when the connection is not encrypted.
18827
18828 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18829 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18830 certificate and checks it against &%tls_verify_certificates%&, but does not
18831 abort the connection if there is no certificate or if it does not match. This
18832 state can be detected in an ACL, which makes it possible to implement policies
18833 such as &"accept for relay only if a verified certificate has been received,
18834 but accept for local delivery if encrypted, even without a verified
18835 certificate"&.
18836
18837 Client hosts that match neither of these lists are not asked to present
18838 certificates.
18839
18840
18841 .option trusted_groups main "string list&!!" unset
18842 .cindex "trusted groups"
18843 .cindex "groups" "trusted"
18844 This option is expanded just once, at the start of Exim's processing. If this
18845 option is set, any process that is running in one of the listed groups, or
18846 which has one of them as a supplementary group, is trusted. The groups can be
18847 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18848 details of what trusted callers are permitted to do. If neither
18849 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18850 are trusted.
18851
18852 .option trusted_users main "string list&!!" unset
18853 .cindex "trusted users"
18854 .cindex "user" "trusted"
18855 This option is expanded just once, at the start of Exim's processing. If this
18856 option is set, any process that is running as one of the listed users is
18857 trusted. The users can be specified numerically or by name. See section
18858 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18859 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18860 Exim user are trusted.
18861
18862 .option unknown_login main string&!! unset
18863 .cindex "uid (user id)" "unknown caller"
18864 .vindex "&$caller_uid$&"
18865 This is a specialized feature for use in unusual configurations. By default, if
18866 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18867 gives up. The &%unknown_login%& option can be used to set a login name to be
18868 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18869 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18870 is used for the user's real name (gecos field), unless this has been set by the
18871 &%-F%& option.
18872
18873 .option unknown_username main string unset
18874 See &%unknown_login%&.
18875
18876 .option untrusted_set_sender main "address list&!!" unset
18877 .cindex "trusted users"
18878 .cindex "sender" "setting by untrusted user"
18879 .cindex "untrusted user setting sender"
18880 .cindex "user" "untrusted setting sender"
18881 .cindex "envelope from"
18882 .cindex "envelope sender"
18883 When an untrusted user submits a message to Exim using the standard input, Exim
18884 normally creates an envelope sender address from the user's login and the
18885 default qualification domain. Data from the &%-f%& option (for setting envelope
18886 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18887 is used) is ignored.
18888
18889 However, untrusted users are permitted to set an empty envelope sender address,
18890 to declare that a message should never generate any bounces. For example:
18891 .code
18892 exim -f '<>' user@domain.example
18893 .endd
18894 .vindex "&$sender_ident$&"
18895 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18896 other envelope sender addresses in a controlled way. When it is set, untrusted
18897 users are allowed to set envelope sender addresses that match any of the
18898 patterns in the list. Like all address lists, the string is expanded. The
18899 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18900 users to setting senders that start with their login ids
18901 followed by a hyphen
18902 by a setting like this:
18903 .code
18904 untrusted_set_sender = ^$sender_ident-
18905 .endd
18906 If you want to allow untrusted users to set envelope sender addresses without
18907 restriction, you can use
18908 .code
18909 untrusted_set_sender = *
18910 .endd
18911 The &%untrusted_set_sender%& option applies to all forms of local input, but
18912 only to the setting of the envelope sender. It does not permit untrusted users
18913 to use the other options which trusted user can use to override message
18914 parameters. Furthermore, it does not stop Exim from removing an existing
18915 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18916 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18917 overriding these actions. The handling of the &'Sender:'& header is also
18918 described in section &<<SECTthesenhea>>&.
18919
18920 The log line for a message's arrival shows the envelope sender following
18921 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18922 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18923 envelope sender address, the user's login is shown in parentheses after the
18924 sender address.
18925
18926
18927 .option uucp_from_pattern main string "see below"
18928 .cindex "&""From""& line"
18929 .cindex "UUCP" "&""From""& line"
18930 Some applications that pass messages to an MTA via a command line interface use
18931 an initial line starting with &"From&~"& to pass the envelope sender. In
18932 particular, this is used by UUCP software. Exim recognizes such a line by means
18933 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18934 matches, the sender address is constructed by expanding the contents of
18935 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18936 default pattern recognizes lines in the following two forms:
18937 .code
18938 From ph10 Fri Jan  5 12:35 GMT 1996
18939 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18940 .endd
18941 The pattern can be seen by running
18942 .code
18943 exim -bP uucp_from_pattern
18944 .endd
18945 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18946 year in the second case. The first word after &"From&~"& is matched in the
18947 regular expression by a parenthesized subpattern. The default value for
18948 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18949 (&"ph10"& in the example above) as the message's sender. See also
18950 &%ignore_fromline_hosts%&.
18951
18952
18953 .option uucp_from_sender main string&!! &`$1`&
18954 See &%uucp_from_pattern%& above.
18955
18956
18957 .option warn_message_file main string&!! unset
18958 .cindex "warning of delay" "customizing the message"
18959 .cindex "customizing" "warning message"
18960 This option defines a template file containing paragraphs of text to be used
18961 for constructing the warning message which is sent by Exim when a message has
18962 been in the queue for a specified amount of time, as specified by
18963 &%delay_warning%&. Details of the file's contents are given in chapter
18964 &<<CHAPemsgcust>>&.
18965 .cindex warn_message_file "tainted data"
18966 The option is expanded to give the file path, which must be
18967 absolute and untainted.
18968 See also &%bounce_message_file%&.
18969
18970
18971 .option wellknown_advertise_hosts main boolean unset
18972 .cindex WELLKNOWN advertisement
18973 .cindex "ESMTP extensions" WELLKNOWN
18974 This option enables the advertising of the SMTP WELLKNOWN extension.
18975 See also the &%acl_smtp_wellknown%& ACL (&<<SECTWELLKNOWNACL>>&).
18976
18977 .option write_rejectlog main boolean true
18978 .cindex "reject log" "disabling"
18979 If this option is set false, Exim no longer writes anything to the reject log.
18980 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18981 .ecindex IIDconfima
18982 .ecindex IIDmaiconf
18983
18984
18985
18986
18987 . ////////////////////////////////////////////////////////////////////////////
18988 . ////////////////////////////////////////////////////////////////////////////
18989
18990 .chapter "Generic options for routers" "CHAProutergeneric"
18991 .scindex IIDgenoprou1 "options" "generic; for routers"
18992 .scindex IIDgenoprou2 "generic options" "router"
18993 This chapter describes the generic options that apply to all routers.
18994 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18995
18996 For a general description of how a router operates, see sections
18997 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18998 which the preconditions are tested. The order of expansion of the options that
18999 provide data for a transport is: &%errors_to%&, &%headers_add%&,
19000 &%headers_remove%&, &%transport%&.
19001
19002 The name of a router is limited to be &drivernamemax; ASCII characters long;
19003 prior to Exim 4.95 names would be silently truncated at this length, but now
19004 it is enforced.
19005
19006
19007 .option address_data routers string&!! unset
19008 .cindex "router" "data attached to address"
19009 The string is expanded just before the router is run, that is, after all the
19010 precondition tests have succeeded. If the expansion is forced to fail, the
19011 router declines, the value of &%address_data%& remains unchanged, and the
19012 &%more%& option controls what happens next. Other expansion failures cause
19013 delivery of the address to be deferred.
19014
19015 .vindex "&$address_data$&"
19016 When the expansion succeeds, the value is retained with the address, and can be
19017 accessed using the variable &$address_data$& in the current router, subsequent
19018 routers, and the eventual transport.
19019
19020 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
19021 that runs a user's filter file, the contents of &$address_data$& are accessible
19022 in the filter. This is not normally a problem, because such data is usually
19023 either not confidential or it &"belongs"& to the current user, but if you do
19024 put confidential data into &$address_data$& you need to remember this point.
19025
19026 Even if the router declines or passes, the value of &$address_data$& remains
19027 with the address, though it can be changed by another &%address_data%& setting
19028 on a subsequent router. If a router generates child addresses, the value of
19029 &$address_data$& propagates to them. This also applies to the special kind of
19030 &"child"& that is generated by a router with the &%unseen%& option.
19031
19032 The idea of &%address_data%& is that you can use it to look up a lot of data
19033 for the address once, and then pick out parts of the data later. For example,
19034 you could use a single LDAP lookup to return a string of the form
19035 .code
19036 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
19037 .endd
19038 In the transport you could pick out the mailbox by a setting such as
19039 .code
19040 file = ${extract{mailbox}{$address_data}}
19041 .endd
19042 This makes the configuration file less messy, and also reduces the number of
19043 lookups (though Exim does cache lookups).
19044
19045 See also the &%set%& option below.
19046
19047 .vindex "&$sender_address_data$&"
19048 .vindex "&$address_data$&"
19049 The &%address_data%& facility is also useful as a means of passing information
19050 from one router to another, and from a router to a transport. In addition, if
19051 &$address_data$& is set by a router when verifying a recipient address from an
19052 ACL, it remains available for use in the rest of the ACL statement. After
19053 verifying a sender, the value is transferred to &$sender_address_data$&.
19054
19055
19056
19057 .option address_test routers&!? boolean true
19058 .oindex "&%-bt%&"
19059 .cindex "router" "skipping when address testing"
19060 If this option is set false, the router is skipped when routing is being tested
19061 by means of the &%-bt%& command line option. This can be a convenience when
19062 your first router sends messages to an external scanner, because it saves you
19063 having to set the &"already scanned"& indicator when testing real address
19064 routing.
19065
19066
19067
19068 .option cannot_route_message routers string&!! unset
19069 .cindex "router" "customizing &""cannot route""& message"
19070 .cindex "customizing" "&""cannot route""& message"
19071 This option specifies a text message that is used when an address cannot be
19072 routed because Exim has run out of routers. The default message is
19073 &"Unrouteable address"&. This option is useful only on routers that have
19074 &%more%& set false, or on the very last router in a configuration, because the
19075 value that is used is taken from the last router that is considered. This
19076 includes a router that is skipped because its preconditions are not met, as
19077 well as a router that declines. For example, using the default configuration,
19078 you could put:
19079 .code
19080 cannot_route_message = Remote domain not found in DNS
19081 .endd
19082 on the first router, which is a &(dnslookup)& router with &%more%& set false,
19083 and
19084 .code
19085 cannot_route_message = Unknown local user
19086 .endd
19087 on the final router that checks for local users. If string expansion fails for
19088 this option, the default message is used. Unless the expansion failure was
19089 explicitly forced, a message about the failure is written to the main and panic
19090 logs, in addition to the normal message about the routing failure.
19091
19092
19093 .option caseful_local_part routers boolean false
19094 .cindex "case of local parts"
19095 .cindex "router" "case of local parts"
19096 By default, routers handle the local parts of addresses in a case-insensitive
19097 manner, though the actual case is preserved for transmission with the message.
19098 If you want the case of letters to be significant in a router, you must set
19099 this option true. For individual router options that contain address or local
19100 part lists (for example, &%local_parts%&), case-sensitive matching can be
19101 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
19102 more details.
19103
19104 .vindex "&$local_part$&"
19105 .vindex "&$original_local_part$&"
19106 .vindex "&$parent_local_part$&"
19107 The value of the &$local_part$& variable is forced to lower case while a
19108 router is running unless &%caseful_local_part%& is set. When a router assigns
19109 an address to a transport, the value of &$local_part$& when the transport runs
19110 is the same as it was in the router. Similarly, when a router generates child
19111 addresses by aliasing or forwarding, the values of &$original_local_part$&
19112 and &$parent_local_part$& are those that were used by the redirecting router.
19113
19114 This option applies to the processing of an address by a router. When a
19115 recipient address is being processed in an ACL, there is a separate &%control%&
19116 modifier that can be used to specify case-sensitive processing within the ACL
19117 (see section &<<SECTcontrols>>&).
19118
19119
19120
19121 .option check_local_user routers&!? boolean false
19122 .cindex "local user, checking in router"
19123 .cindex "router" "checking for local user"
19124 .cindex "&_/etc/passwd_&"
19125 .vindex "&$home$&"
19126 When this option is true, Exim checks that the local part of the recipient
19127 address (with affixes removed if relevant) is the name of an account on the
19128 local system. The check is done by calling the &[getpwnam()]& function rather
19129 than trying to read &_/etc/passwd_& directly. This means that other methods of
19130 holding password data (such as NIS) are supported. If the local part is a local
19131 user,
19132 .cindex "tainted data" "de-tainting"
19133 .cindex "de-tainting" "using router check_local_user option"
19134 &$local_part_data$& is set to an untainted version of the local part and
19135 &$home$& is set from the password data. The latter can be tested in other
19136 preconditions that are evaluated after this one (the order of evaluation is
19137 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19138 overridden by &%router_home_directory%&. If the local part is not a local user,
19139 the router is skipped.
19140
19141 If you want to check that the local part is either the name of a local user
19142 or matches something else, you cannot combine &%check_local_user%& with a
19143 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19144 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19145 setting to achieve this. For example:
19146 .code
19147 local_parts = passwd;$local_part : lsearch;/etc/other/users
19148 .endd
19149 Note, however, that the side effects of &%check_local_user%& (such as setting
19150 up a home directory) do not occur when a &(passwd)& lookup is used in a
19151 &%local_parts%& (or any other) precondition.
19152
19153
19154
19155 .option condition routers&!? string&!! unset
19156 .cindex "router" "customized precondition"
19157 This option specifies a general precondition test that has to succeed for the
19158 router to be called. The &%condition%& option is the last precondition to be
19159 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19160 result is a forced failure, or an empty string, or one of the strings &"0"& or
19161 &"no"& or &"false"& (checked without regard to the case of the letters), the
19162 router is skipped, and the address is offered to the next one.
19163
19164 If the result is any other value, the router is run (as this is the last
19165 precondition to be evaluated, all the other preconditions must be true).
19166
19167 This option is unusual in that multiple &%condition%& options may be present.
19168 All &%condition%& options must succeed.
19169
19170 The &%condition%& option provides a means of applying custom conditions to the
19171 running of routers. Note that in the case of a simple conditional expansion,
19172 the default expansion values are exactly what is wanted. For example:
19173 .code
19174 condition = ${if >{$message_age}{600}}
19175 .endd
19176 Because of the default behaviour of the string expansion, this is equivalent to
19177 .code
19178 condition = ${if >{$message_age}{600}{true}{}}
19179 .endd
19180
19181 A multiple condition example, which succeeds:
19182 .code
19183 condition = ${if >{$message_age}{600}}
19184 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19185 condition = foobar
19186 .endd
19187
19188 If the expansion fails (other than forced failure) delivery is deferred. Some
19189 of the other precondition options are common special cases that could in fact
19190 be specified using &%condition%&.
19191
19192 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19193 are far older, and use one set of semantics.  ACLs are newer and when
19194 they were created, the ACL &%condition%& process was given far stricter
19195 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19196 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19197 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19198 Router rules processing behavior.
19199
19200 This is best illustrated in an example:
19201 .code
19202 # If used in an ACL condition will fail with a syntax error, but
19203 # in a router condition any extra characters are treated as a string
19204
19205 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19206 true {yes} {no}}
19207
19208 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19209  {yes} {no}}
19210 .endd
19211 In each example above, the &%if%& statement actually ends after
19212 &"{google.com}}"&.  Since no true or false braces were defined, the
19213 default &%if%& behavior is to return a boolean true or a null answer
19214 (which evaluates to false). The rest of the line is then treated as a
19215 string. So the first example resulted in the boolean answer &"true"&
19216 with the string &" {yes} {no}}"& appended to it. The second example
19217 resulted in the null output (indicating false) with the string
19218 &" {yes} {no}}"& appended to it.
19219
19220 In fact you can put excess forward braces in too.  In the router
19221 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19222 mean something, like after a &"$"& or when required as part of a
19223 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19224 string characters.
19225
19226 Thus, in a Router, the above expansion strings will both always evaluate
19227 true, as the result of expansion is a non-empty string which doesn't
19228 match an explicit false value.  This can be tricky to debug.  By
19229 contrast, in an ACL either of those strings will always result in an
19230 expansion error because the result doesn't look sufficiently boolean.
19231
19232
19233 .option debug_print routers string&!! unset
19234 .cindex "testing" "variables in drivers"
19235 If this option is set and debugging is enabled (see the &%-d%& command line
19236 option) or in address-testing mode (see the &%-bt%& command line option),
19237 the string is expanded and included in the debugging output.
19238 If expansion of the string fails, the error message is written to the debugging
19239 output, and Exim carries on processing.
19240 This option is provided to help with checking out the values of variables and
19241 so on when debugging router configurations. For example, if a &%condition%&
19242 option appears not to be working, &%debug_print%& can be used to output the
19243 variables it references. The output happens after checks for &%domains%&,
19244 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19245 are tested. A newline is added to the text if it does not end with one.
19246 The variable &$router_name$& contains the name of the router.
19247
19248
19249
19250 .option disable_logging routers boolean false
19251 If this option is set true, nothing is logged for any routing errors
19252 or for any deliveries caused by this router. You should not set this option
19253 unless you really, really know what you are doing. See also the generic
19254 transport option of the same name.
19255
19256 .option dnssec_request_domains routers "domain list&!!" *
19257 .cindex "MX record" "security"
19258 .cindex "DNSSEC" "MX lookup"
19259 .cindex "security" "MX lookup"
19260 .cindex "DNS" "DNSSEC"
19261 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19262 the DNSSEC request bit set.
19263 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19264
19265 .option dnssec_require_domains routers "domain list&!!" unset
19266 .cindex "MX record" "security"
19267 .cindex "DNSSEC" "MX lookup"
19268 .cindex "security" "MX lookup"
19269 .cindex "DNS" "DNSSEC"
19270 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19271 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19272 (AD bit) set will be ignored and logged as a host-lookup failure.
19273 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19274
19275
19276 .option domains routers&!? "domain list&!!" unset
19277 .cindex "router" "restricting to specific domains"
19278 .vindex "&$domain_data$&"
19279 If this option is set, the router is skipped unless the current domain matches
19280 the list.
19281 The data returned by the list check
19282 is placed in &$domain_data$& for use in string
19283 expansions of the driver's private options and in the transport.
19284 See section &<<SECTrouprecon>>& for
19285 a list of the order in which preconditions are evaluated.
19286
19287 A complex example, using a file like:
19288 .code
19289 alice@dom1
19290 bill@dom1
19291 maggie@dom1
19292 .endd
19293 and checking both domain and local_part
19294 .code
19295 domains =         ${domain:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19296 local_parts = ${local_part:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19297 .endd
19298
19299
19300
19301 .option driver routers string unset
19302 This option must always be set. It specifies which of the available routers is
19303 to be used.
19304
19305
19306 .option dsn_lasthop routers boolean false
19307 .cindex "DSN" "success"
19308 .cindex "Delivery Status Notification" "success"
19309 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19310 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19311 instead send a success DSN as if the next hop does not support DSN.
19312 Not effective on redirect routers.
19313
19314
19315
19316 .option errors_to routers string&!! unset
19317 .cindex "envelope from"
19318 .cindex "envelope sender"
19319 .cindex "router" "changing address for errors"
19320 If a router successfully handles an address, it may assign the address to a
19321 transport for delivery or it may generate child addresses. In both cases, if
19322 there is a delivery problem during later processing, the resulting bounce
19323 message is sent to the address that results from expanding this string,
19324 provided that the address verifies successfully. The &%errors_to%& option is
19325 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19326
19327 The &%errors_to%& setting associated with an address can be overridden if it
19328 subsequently passes through other routers that have their own &%errors_to%&
19329 settings, or if the message is delivered by a transport with a &%return_path%&
19330 setting.
19331
19332 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19333 the expansion fails to verify, the errors address associated with the incoming
19334 address is used. At top level, this is the envelope sender. A non-forced
19335 expansion failure causes delivery to be deferred.
19336
19337 If an address for which &%errors_to%& has been set ends up being delivered over
19338 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19339 any bounces that are generated by other MTAs on the delivery route are also
19340 sent there. You can set &%errors_to%& to the empty string by either of these
19341 settings:
19342 .code
19343 errors_to =
19344 errors_to = ""
19345 .endd
19346 An expansion item that yields an empty string has the same effect. If you do
19347 this, a locally detected delivery error for addresses processed by this router
19348 no longer gives rise to a bounce message; the error is discarded. If the
19349 address is delivered to a remote host, the return path is set to &`<>`&, unless
19350 overridden by the &%return_path%& option on the transport.
19351
19352 .vindex "&$address_data$&"
19353 If for some reason you want to discard local errors, but use a non-empty
19354 MAIL command for remote delivery, you can preserve the original return
19355 path in &$address_data$& in the router, and reinstate it in the transport by
19356 setting &%return_path%&.
19357
19358 The most common use of &%errors_to%& is to direct mailing list bounces to the
19359 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19360 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19361
19362
19363
19364 .option expn routers&!? boolean true
19365 .cindex "address" "testing"
19366 .cindex "testing" "addresses"
19367 .cindex "EXPN" "router skipping"
19368 .cindex "router" "skipping for EXPN"
19369 If this option is turned off, the router is skipped when testing an address
19370 as a result of processing an SMTP EXPN command. You might, for example,
19371 want to turn it off on a router for users' &_.forward_& files, while leaving it
19372 on for the system alias file.
19373 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19374 are evaluated.
19375
19376 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19377 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19378 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19379
19380
19381
19382 .option fail_verify routers boolean false
19383 .cindex "router" "forcing verification failure"
19384 Setting this option has the effect of setting both &%fail_verify_sender%& and
19385 &%fail_verify_recipient%& to the same value.
19386
19387
19388
19389 .option fail_verify_recipient routers boolean false
19390 If this option is true and an address is accepted by this router when
19391 verifying a recipient, verification fails.
19392
19393
19394
19395 .option fail_verify_sender routers boolean false
19396 If this option is true and an address is accepted by this router when
19397 verifying a sender, verification fails.
19398
19399
19400
19401 .option fallback_hosts routers "string list" unset
19402 .cindex "router" "fallback hosts"
19403 .cindex "fallback" "hosts specified on router"
19404 String expansion is not applied to this option. The argument must be a
19405 colon-separated list of host names or IP addresses. The list separator can be
19406 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19407 each name or address. In fact, the format of each item is exactly the same as
19408 defined for the list of hosts in a &(manualroute)& router (see section
19409 &<<SECTformatonehostitem>>&).
19410
19411 If a router queues an address for a remote transport, this host list is
19412 associated with the address, and used instead of the transport's fallback host
19413 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19414 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19415 transport for further details.
19416
19417
19418 .option group routers string&!! "see below"
19419 .cindex "gid (group id)" "local delivery"
19420 .cindex "local transports" "uid and gid"
19421 .cindex "transport" "local"
19422 .cindex "router" "setting group"
19423 When a router queues an address for a transport, and the transport does not
19424 specify a group, the group given here is used when running the delivery
19425 process.
19426 The group may be specified numerically or by name. If expansion fails, the
19427 error is logged and delivery is deferred.
19428 The default is unset, unless &%check_local_user%& is set, when the default
19429 is taken from the password information. See also &%initgroups%& and &%user%&
19430 and the discussion in chapter &<<CHAPenvironment>>&.
19431
19432
19433
19434 .option headers_add routers list&!! unset
19435 .cindex "header lines" "adding"
19436 .cindex "router" "adding header lines"
19437 This option specifies a list of text headers,
19438 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19439 that is associated with any addresses that are accepted by the router.
19440 Each item is separately expanded, at routing time.  However, this
19441 option has no effect when an address is just being verified. The way in which
19442 the text is used to add header lines at transport time is described in section
19443 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19444 message is in the process of being transported. This means that references to
19445 header lines in string expansions in the transport's configuration do not
19446 &"see"& the added header lines.
19447
19448 The &%headers_add%& option is expanded after &%errors_to%&, but before
19449 &%headers_remove%& and &%transport%&. If an item is empty, or if
19450 an item expansion is forced to fail, the item has no effect. Other expansion
19451 failures are treated as configuration errors.
19452
19453 Unlike most options, &%headers_add%& can be specified multiple times
19454 for a router; all listed headers are added.
19455
19456 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19457 router that has the &%one_time%& option set.
19458
19459 .cindex "duplicate addresses"
19460 .oindex "&%unseen%&"
19461 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19462 additions are deleted when the address is passed on to subsequent routers.
19463 For a &%redirect%& router, if a generated address is the same as the incoming
19464 address, this can lead to duplicate addresses with different header
19465 modifications. Exim does not do duplicate deliveries (except, in certain
19466 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19467 which of the duplicates is discarded, so this ambiguous situation should be
19468 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19469
19470
19471
19472 .option headers_remove routers list&!! unset
19473 .cindex "header lines" "removing"
19474 .cindex "router" "removing header lines"
19475 This option specifies a list of text headers,
19476 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19477 that is associated with any addresses that are accepted by the router.
19478 However, the option has no effect when an address is just being verified.
19479 Each list item is separately expanded, at transport time.
19480 If an item ends in *, it will match any header with the given prefix.
19481 The way in which
19482 the text is used to remove header lines at transport time is described in
19483 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19484 the message is in the process of being transported. This means that references
19485 to header lines in string expansions in the transport's configuration still
19486 &"see"& the original header lines.
19487
19488 The &%headers_remove%& option is handled after &%errors_to%& and
19489 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19490 the item has no effect. Other expansion failures are treated as configuration
19491 errors.
19492
19493 Unlike most options, &%headers_remove%& can be specified multiple times
19494 for a router; all listed headers are removed.
19495
19496 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19497 router that has the &%one_time%& option set.
19498
19499 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19500 removal requests are deleted when the address is passed on to subsequent
19501 routers, and this can lead to problems with duplicates -- see the similar
19502 warning for &%headers_add%& above.
19503
19504 &*Warning 3*&: Because of the separate expansion of the list items,
19505 items that contain a list separator must have it doubled.
19506 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19507
19508
19509
19510 .option ignore_target_hosts routers "host list&!!" unset
19511 .cindex "IP address" "discarding"
19512 .cindex "router" "discarding IP addresses"
19513 Although this option is a host list, it should normally contain IP address
19514 entries rather than names. If any host that is looked up by the router has an
19515 IP address that matches an item in this list, Exim behaves as if that IP
19516 address did not exist. This option allows you to cope with rogue DNS entries
19517 like
19518 .code
19519 remote.domain.example.  A  127.0.0.1
19520 .endd
19521 by setting
19522 .code
19523 ignore_target_hosts = 127.0.0.1
19524 .endd
19525 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19526 discarded in this way, the router declines. In a conventional configuration, an
19527 attempt to mail to such a domain would normally provoke the &"unrouteable
19528 domain"& error, and an attempt to verify an address in the domain would fail.
19529 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19530 router declines if presented with one of the listed addresses.
19531
19532 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19533 means of the first or the second of the following settings, respectively:
19534 .code
19535 ignore_target_hosts = 0.0.0.0/0
19536 ignore_target_hosts = <; 0::0/0
19537 .endd
19538 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19539 in the second line matches all IPv6 addresses.
19540
19541 This option may also be useful for ignoring link-local and site-local IPv6
19542 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19543 is expanded before use as a list, it is possible to make it dependent on the
19544 domain that is being routed.
19545
19546 .vindex "&$host_address$&"
19547 During its expansion, &$host_address$& is set to the IP address that is being
19548 checked.
19549
19550 .option initgroups routers boolean false
19551 .cindex "additional groups"
19552 .cindex "groups" "additional"
19553 .cindex "local transports" "uid and gid"
19554 .cindex "transport" "local"
19555 If the router queues an address for a transport, and this option is true, and
19556 the uid supplied by the router is not overridden by the transport, the
19557 &[initgroups()]& function is called when running the transport to ensure that
19558 any additional groups associated with the uid are set up. See also &%group%&
19559 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19560
19561
19562
19563 .option local_part_prefix routers&!? "string list" unset
19564 .cindex affix "router precondition"
19565 .cindex "router" "prefix for local part"
19566 .cindex "prefix" "for local part, used in router"
19567 If this option is set, the router is skipped unless the local part starts with
19568 one of the given strings, or &%local_part_prefix_optional%& is true. See
19569 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19570 evaluated.
19571
19572 The list is scanned from left to right, and the first prefix that matches is
19573 used. A limited form of wildcard is available; if the prefix begins with an
19574 asterisk, it matches the longest possible sequence of arbitrary characters at
19575 the start of the local part. An asterisk should therefore always be followed by
19576 some character that does not occur in normal local parts.
19577 .cindex "multiple mailboxes"
19578 .cindex "mailbox" "multiple"
19579 Wildcarding can be used to set up multiple user mailboxes, as described in
19580 section &<<SECTmulbox>>&.
19581
19582 .vindex "&$local_part$&"
19583 .vindex "&$local_part_prefix$&"
19584 During the testing of the &%local_parts%& option, and while the router is
19585 running, the prefix is removed from the local part, and is available in the
19586 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19587 the router accepts the address, this remains true during subsequent delivery by
19588 a transport. In particular, the local part that is transmitted in the RCPT
19589 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19590 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19591 the relevant transport.
19592
19593 .vindex &$local_part_prefix_v$&
19594 If wildcarding (above) was used then the part of the prefix matching the
19595 wildcard is available in &$local_part_prefix_v$&.
19596
19597 When an address is being verified, &%local_part_prefix%& affects only the
19598 behaviour of the router. If the callout feature of verification is in use, this
19599 means that the full address, including the prefix, will be used during the
19600 callout.
19601
19602 The prefix facility is commonly used to handle local parts of the form
19603 &%owner-something%&. Another common use is to support local parts of the form
19604 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19605 to tell a user their forwarding is broken &-- by placing a router like this one
19606 immediately before the router that handles &_.forward_& files:
19607 .code
19608 real_localuser:
19609   driver = accept
19610   local_part_prefix = real-
19611   check_local_user
19612   transport = local_delivery
19613 .endd
19614 For security, it would probably be a good idea to restrict the use of this
19615 router to locally-generated messages, using a condition such as this:
19616 .code
19617   condition = ${if match {$sender_host_address}\
19618                          {\N^(|127\.0\.0\.1)$\N}}
19619 .endd
19620
19621 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19622 both conditions must be met if not optional. Care must be taken if wildcards
19623 are used in both a prefix and a suffix on the same router. Different
19624 separator characters must be used to avoid ambiguity.
19625
19626
19627 .option local_part_prefix_optional routers boolean false
19628 See &%local_part_prefix%& above.
19629
19630
19631
19632 .option local_part_suffix routers&!? "string list" unset
19633 .cindex "router" "suffix for local part"
19634 .cindex "suffix for local part" "used in router"
19635 This option operates in the same way as &%local_part_prefix%&, except that the
19636 local part must end (rather than start) with the given string, the
19637 &%local_part_suffix_optional%& option determines whether the suffix is
19638 mandatory, and the wildcard * character, if present, must be the last
19639 character of the suffix. This option facility is commonly used to handle local
19640 parts of the form &%something-request%& and multiple user mailboxes of the form
19641 &%username-foo%&.
19642
19643
19644 .option local_part_suffix_optional routers boolean false
19645 See &%local_part_suffix%& above.
19646
19647
19648
19649 .option local_parts routers&!? "local part list&!!" unset
19650 .cindex "router" "restricting to specific local parts"
19651 .cindex "local part" "checking in router"
19652 The router is run only if the local part of the address matches the list.
19653 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19654 are evaluated, and
19655 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19656 string is expanded, it is possible to make it depend on the domain, for
19657 example:
19658 .code
19659 local_parts = dbm;/usr/local/specials/$domain_data
19660 .endd
19661 .vindex "&$local_part_data$&"
19662 the data returned by the list check
19663 for the local part is placed in the variable &$local_part_data$& for use in
19664 expansions of the router's private options or in the transport.
19665 You might use this option, for
19666 example, if you have a large number of local virtual domains, and you want to
19667 send all postmaster mail to the same place without having to set up an alias in
19668 each virtual domain:
19669 .code
19670 postmaster:
19671   driver = redirect
19672   local_parts = postmaster
19673   data = postmaster@real.domain.example
19674 .endd
19675
19676
19677 .option log_as_local routers boolean "see below"
19678 .cindex "log" "delivery line"
19679 .cindex "delivery" "log line format"
19680 Exim has two logging styles for delivery, the idea being to make local
19681 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19682 recipient address is given just as the local part, without a domain. The use of
19683 this style is controlled by this option. It defaults to true for the &(accept)&
19684 router, and false for all the others. This option applies only when a
19685 router assigns an address to a transport. It has no effect on routers that
19686 redirect addresses.
19687
19688
19689
19690 .option more routers boolean&!! true
19691 The result of string expansion for this option must be a valid boolean value,
19692 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19693 result causes an error, and delivery is deferred. If the expansion is forced to
19694 fail, the default value for the option (true) is used. Other failures cause
19695 delivery to be deferred.
19696
19697 If this option is set false, and the router declines to handle the address, no
19698 further routers are tried, routing fails, and the address is bounced.
19699 .oindex "&%self%&"
19700 However, if the router explicitly passes an address to the following router by
19701 means of the setting
19702 .code
19703 self = pass
19704 .endd
19705 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19706 does not affect the behaviour if one of the precondition tests fails. In that
19707 case, the address is always passed to the next router.
19708
19709 Note that &%address_data%& is not considered to be a precondition. If its
19710 expansion is forced to fail, the router declines, and the value of &%more%&
19711 controls what happens next.
19712
19713
19714 .option pass_on_timeout routers boolean false
19715 .cindex "timeout" "of router"
19716 .cindex "router" "timeout"
19717 If a router times out during a host lookup, it normally causes deferral of the
19718 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19719 router, overriding &%no_more%&. This may be helpful for systems that are
19720 intermittently connected to the Internet, or those that want to pass to a smart
19721 host any messages that cannot immediately be delivered.
19722
19723 There are occasional other temporary errors that can occur while doing DNS
19724 lookups. They are treated in the same way as a timeout, and this option
19725 applies to all of them.
19726
19727
19728
19729 .option pass_router routers string unset
19730 .cindex "router" "go to after &""pass""&"
19731 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19732 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19733 routing to continue, and overriding a false setting of &%more%&. When one of
19734 these routers returns &"pass"&, the address is normally handed on to the next
19735 router in sequence. This can be changed by setting &%pass_router%& to the name
19736 of another router. However (unlike &%redirect_router%&) the named router must
19737 be below the current router, to avoid loops. Note that this option applies only
19738 to the special case of &"pass"&. It does not apply when a router returns
19739 &"decline"& because it cannot handle an address.
19740
19741
19742
19743 .option redirect_router routers string unset
19744 .cindex "router" "start at after redirection"
19745 Sometimes an administrator knows that it is pointless to reprocess addresses
19746 generated from alias or forward files with the same router again. For
19747 example, if an alias file translates real names into login ids there is no
19748 point searching the alias file a second time, especially if it is a large file.
19749
19750 The &%redirect_router%& option can be set to the name of any router instance.
19751 It causes the routing of any generated addresses to start at the named router
19752 instead of at the first router. This option has no effect if the router in
19753 which it is set does not generate new addresses.
19754
19755
19756
19757 .option require_files routers&!? "string list&!!" unset
19758 .cindex "file" "requiring for router"
19759 .cindex "router" "requiring file existence"
19760 This option provides a general mechanism for predicating the running of a
19761 router on the existence or non-existence of certain files or directories.
19762 Before running a router, as one of its precondition tests, Exim works its way
19763 through the &%require_files%& list, expanding each item separately.
19764
19765 Because the list is split before expansion, any colons in expansion items must
19766 be doubled, or the facility for using a different list separator must be used
19767 (&<<SECTlistsepchange>>&).
19768 If any expansion is forced to fail, the item is ignored. Other expansion
19769 failures cause routing of the address to be deferred.
19770
19771 If any expanded string is empty, it is ignored. Otherwise, except as described
19772 below, each string must be a fully qualified file path, optionally preceded by
19773 &"!"&. The paths are passed to the &[stat()]& function to test for the
19774 existence of the files or directories. The router is skipped if any paths not
19775 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19776
19777 .cindex "NFS"
19778 If &[stat()]& cannot determine whether a file exists or not, delivery of
19779 the message is deferred. This can happen when NFS-mounted filesystems are
19780 unavailable.
19781
19782 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19783 options, so you cannot use it to check for the existence of a file in which to
19784 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19785 full list of the order in which preconditions are evaluated.) However, as
19786 these options are all expanded, you can use the &%exists%& expansion condition
19787 to make such tests. The &%require_files%& option is intended for checking files
19788 that the router may be going to use internally, or which are needed by a
19789 transport (e.g., &_.procmailrc_&).
19790
19791 During delivery, the &[stat()]& function is run as root, but there is a
19792 facility for some checking of the accessibility of a file by another user.
19793 This is not a proper permissions check, but just a &"rough"& check that
19794 operates as follows:
19795
19796 If an item in a &%require_files%& list does not contain any forward slash
19797 characters, it is taken to be the user (and optional group, separated by a
19798 comma) to be checked for subsequent files in the list. If no group is specified
19799 but the user is specified symbolically, the gid associated with the uid is
19800 used. For example:
19801 .code
19802 require_files = mail:/some/file
19803 require_files = $local_part_data:$home/.procmailrc
19804 .endd
19805 If a user or group name in a &%require_files%& list does not exist, the
19806 &%require_files%& condition fails.
19807
19808 Exim performs the check by scanning along the components of the file path, and
19809 checking the access for the given uid and gid. It checks for &"x"& access on
19810 directories, and &"r"& access on the final file. Note that this means that file
19811 access control lists, if the operating system has them, are ignored.
19812
19813 &*Warning 1*&: When the router is being run to verify addresses for an
19814 incoming SMTP message, Exim is not running as root, but under its own uid. This
19815 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19816 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19817 user is not permitted to read one of the directories on the file's path.
19818
19819 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19820 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19821 without root access. In this case, if a check for access by a particular user
19822 is requested, Exim creates a subprocess that runs as that user, and tries the
19823 check again in that process.
19824
19825 The default action for handling an unresolved EACCES is to consider it to
19826 be caused by a configuration error, and routing is deferred because the
19827 existence or non-existence of the file cannot be determined. However, in some
19828 circumstances it may be desirable to treat this condition as if the file did
19829 not exist. If the filename (or the exclamation mark that precedes the filename
19830 for non-existence) is preceded by a plus sign, the EACCES error is treated
19831 as if the file did not exist. For example:
19832 .code
19833 require_files = +/some/file
19834 .endd
19835 If the router is not an essential part of verification (for example, it
19836 handles users' &_.forward_& files), another solution is to set the &%verify%&
19837 option false so that the router is skipped when verifying.
19838
19839
19840
19841 .option retry_use_local_part routers boolean "see below"
19842 .cindex "hints database" "retry keys"
19843 .cindex "local part" "in retry keys"
19844 When a delivery suffers a temporary routing failure, a retry record is created
19845 in Exim's hints database. For addresses whose routing depends only on the
19846 domain, the key for the retry record should not involve the local part, but for
19847 other addresses, both the domain and the local part should be included.
19848 Usually, remote routing is of the former kind, and local routing is of the
19849 latter kind.
19850
19851 This option controls whether the local part is used to form the key for retry
19852 hints for addresses that suffer temporary errors while being handled by this
19853 router. The default value is true for any router that has any of
19854 &%check_local_user%&,
19855 &%local_parts%&,
19856 &%condition%&,
19857 &%local_part_prefix%&,
19858 &%local_part_suffix%&,
19859 &%senders%& or
19860 &%require_files%&
19861 set, and false otherwise. Note that this option does not apply to hints keys
19862 for transport delays; they are controlled by a generic transport option of the
19863 same name.
19864
19865 Failing to set this option when it is needed
19866 (because a remote router handles only some of the local-parts for a domain)
19867 can result in incorrect error messages being generated.
19868
19869 The setting of &%retry_use_local_part%& applies only to the router on which it
19870 appears. If the router generates child addresses, they are routed
19871 independently; this setting does not become attached to them.
19872
19873
19874
19875 .option router_home_directory routers string&!! unset
19876 .cindex "router" "home directory for"
19877 .cindex "home directory" "for router"
19878 .vindex "&$home$&"
19879 This option sets a home directory for use while the router is running. (Compare
19880 &%transport_home_directory%&, which sets a home directory for later
19881 transporting.) In particular, if used on a &(redirect)& router, this option
19882 sets a value for &$home$& while a filter is running. The value is expanded;
19883 forced expansion failure causes the option to be ignored &-- other failures
19884 cause the router to defer.
19885
19886 Expansion of &%router_home_directory%& happens immediately after the
19887 &%check_local_user%& test (if configured), before any further expansions take
19888 place.
19889 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19890 are evaluated.)
19891 While the router is running, &%router_home_directory%& overrides the value of
19892 &$home$& that came from &%check_local_user%&.
19893
19894 When a router accepts an address and assigns it to a local transport (including
19895 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19896 delivery), the home directory setting for the transport is taken from the first
19897 of these values that is set:
19898
19899 .ilist
19900 The &%home_directory%& option on the transport;
19901 .next
19902 The &%transport_home_directory%& option on the router;
19903 .next
19904 The password data if &%check_local_user%& is set on the router;
19905 .next
19906 The &%router_home_directory%& option on the router.
19907 .endlist
19908
19909 In other words, &%router_home_directory%& overrides the password data for the
19910 router, but not for the transport.
19911
19912
19913
19914 .option self routers string freeze
19915 .cindex "MX record" "pointing to local host"
19916 .cindex "local host" "MX pointing to"
19917 This option applies to those routers that use a recipient address to find a
19918 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19919 and &(manualroute)& routers.
19920 Certain configurations of the &(queryprogram)& router can also specify a list
19921 of remote hosts.
19922 Usually such routers are configured to send the message to a remote host via an
19923 &(smtp)& transport. The &%self%& option specifies what happens when the first
19924 host on the list turns out to be the local host.
19925 The way in which Exim checks for the local host is described in section
19926 &<<SECTreclocipadd>>&.
19927
19928 Normally this situation indicates either an error in Exim's configuration (for
19929 example, the router should be configured not to process this domain), or an
19930 error in the DNS (for example, the MX should not point to this host). For this
19931 reason, the default action is to log the incident, defer the address, and
19932 freeze the message. The following alternatives are provided for use in special
19933 cases:
19934
19935 .vlist
19936 .vitem &%defer%&
19937 Delivery of the message is tried again later, but the message is not frozen.
19938
19939 .vitem "&%reroute%&: <&'domain'&>"
19940 The domain is changed to the given domain, and the address is passed back to
19941 be reprocessed by the routers. No rewriting of headers takes place. This
19942 behaviour is essentially a redirection.
19943
19944 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19945 The domain is changed to the given domain, and the address is passed back to be
19946 reprocessed by the routers. Any headers that contain the original domain are
19947 rewritten.
19948
19949 .vitem &%pass%&
19950 .oindex "&%more%&"
19951 .vindex "&$self_hostname$&"
19952 The router passes the address to the next router, or to the router named in the
19953 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19954 subsequent routing and delivery, the variable &$self_hostname$& contains the
19955 name of the local host that the router encountered. This can be used to
19956 distinguish between different cases for hosts with multiple names. The
19957 combination
19958 .code
19959 self = pass
19960 no_more
19961 .endd
19962 ensures that only those addresses that routed to the local host are passed on.
19963 Without &%no_more%&, addresses that were declined for other reasons would also
19964 be passed to the next router.
19965
19966 .vitem &%fail%&
19967 Delivery fails and an error report is generated.
19968
19969 .vitem &%send%&
19970 .cindex "local host" "sending to"
19971 The anomaly is ignored and the address is queued for the transport. This
19972 setting should be used with extreme caution. For an &(smtp)& transport, it
19973 makes sense only in cases where the program that is listening on the SMTP port
19974 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19975 different configuration file that handles the domain in another way.
19976 .endlist
19977
19978
19979
19980 .option senders routers&!? "address list&!!" unset
19981 .cindex "router" "checking senders"
19982 If this option is set, the router is skipped unless the message's sender
19983 address matches something on the list.
19984 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19985 are evaluated.
19986
19987 There are issues concerning verification when the running of routers is
19988 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19989 setting, it sets the sender to the null string. When using the &%-bt%& option
19990 to check a configuration file, it is necessary also to use the &%-f%& option to
19991 set an appropriate sender. For incoming mail, the sender is unset when
19992 verifying the sender, but is available when verifying any recipients. If the
19993 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19994 matters.
19995
19996
19997 .option set routers "string list" unset
19998 .cindex router variables
19999 This option may be used multiple times on a router;
20000 because of this the list aspect is mostly irrelevant.
20001 The list separator is a semicolon but can be changed in the
20002 usual way.
20003
20004 Each list-element given must be of the form &"name = value"&
20005 and the names used must start with the string &"r_"&.
20006 Values containing a list-separator should have them doubled.
20007 When a router runs, the strings are evaluated in order,
20008 to create variables which are added to the set associated with
20009 the address.
20010 This is done immediately after all the preconditions, before the
20011 evaluation of the &%address_data%& option.
20012 The variable is set with the expansion of the value.
20013 The variables can be used by the router options
20014 (not including any preconditions)
20015 and by the transport.
20016 Later definitions of a given named variable will override former ones.
20017 Variable use is via the usual &$r_...$& syntax.
20018
20019 This is similar to the &%address_data%& option, except that
20020 many independent variables can be used, with choice of naming.
20021
20022
20023 .option translate_ip_address routers string&!! unset
20024 .cindex "IP address" "translating"
20025 .cindex "packet radio"
20026 .cindex "router" "IP address translation"
20027 There exist some rare networking situations (for example, packet radio) where
20028 it is helpful to be able to translate IP addresses generated by normal routing
20029 mechanisms into other IP addresses, thus performing a kind of manual IP
20030 routing. This should be done only if the normal IP routing of the TCP/IP stack
20031 is inadequate or broken. Because this is an extremely uncommon requirement, the
20032 code to support this option is not included in the Exim binary unless
20033 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
20034
20035 .vindex "&$host_address$&"
20036 The &%translate_ip_address%& string is expanded for every IP address generated
20037 by the router, with the generated address set in &$host_address$&. If the
20038 expansion is forced to fail, no action is taken.
20039 For any other expansion error, delivery of the message is deferred.
20040 If the result of the expansion is an IP address, that replaces the original
20041 address; otherwise the result is assumed to be a host name &-- this is looked
20042 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
20043 produce one or more replacement IP addresses. For example, to subvert all IP
20044 addresses in some specific networks, this could be added to a router:
20045 .code
20046 translate_ip_address = \
20047   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
20048     {$value}fail}}
20049 .endd
20050 The file would contain lines like
20051 .code
20052 10.2.3.128/26    some.host
20053 10.8.4.34/26     10.44.8.15
20054 .endd
20055 You should not make use of this facility unless you really understand what you
20056 are doing.
20057
20058
20059
20060 .option transport routers string&!! unset
20061 This option specifies the transport to be used when a router accepts an address
20062 and sets it up for delivery. A transport is never needed if a router is used
20063 only for verification. The value of the option is expanded at routing time,
20064 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
20065 and result must be the name of one of the configured transports. If it is not,
20066 delivery is deferred.
20067
20068 The &%transport%& option is not used by the &(redirect)& router, but it does
20069 have some private options that set up transports for pipe and file deliveries
20070 (see chapter &<<CHAPredirect>>&).
20071
20072
20073
20074 .option transport_current_directory routers string&!! unset
20075 .cindex "current directory for local transport"
20076 This option associates a current directory with any address that is routed
20077 to a local transport. This can happen either because a transport is
20078 explicitly configured for the router, or because it generates a delivery to a
20079 file or a pipe. During the delivery process (that is, at transport time), this
20080 option string is expanded and is set as the current directory, unless
20081 overridden by a setting on the transport.
20082 If the expansion fails for any reason, including forced failure, an error is
20083 logged, and delivery is deferred.
20084 See chapter &<<CHAPenvironment>>& for details of the local delivery
20085 environment.
20086
20087
20088
20089
20090 .option transport_home_directory routers string&!! "see below"
20091 .cindex "home directory" "for local transport"
20092 This option associates a home directory with any address that is routed to a
20093 local transport. This can happen either because a transport is explicitly
20094 configured for the router, or because it generates a delivery to a file or a
20095 pipe. During the delivery process (that is, at transport time), the option
20096 string is expanded and is set as the home directory, unless overridden by a
20097 setting of &%home_directory%& on the transport.
20098 If the expansion fails for any reason, including forced failure, an error is
20099 logged, and delivery is deferred.
20100
20101 If the transport does not specify a home directory, and
20102 &%transport_home_directory%& is not set for the router, the home directory for
20103 the transport is taken from the password data if &%check_local_user%& is set for
20104 the router. Otherwise it is taken from &%router_home_directory%& if that option
20105 is set; if not, no home directory is set for the transport.
20106
20107 See chapter &<<CHAPenvironment>>& for further details of the local delivery
20108 environment.
20109
20110
20111
20112
20113 .option unseen routers boolean&!! false
20114 .cindex "router" "carrying on after success"
20115 The result of string expansion for this option must be a valid boolean value,
20116 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
20117 result causes an error, and delivery is deferred. If the expansion is forced to
20118 fail, the default value for the option (false) is used. Other failures cause
20119 delivery to be deferred.
20120
20121 When this option is set true, routing does not cease if the router accepts the
20122 address. Instead, a copy of the incoming address is passed to the next router,
20123 overriding a false setting of &%more%&. There is little point in setting
20124 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
20125 the value of &%unseen%& contains expansion items (and therefore, presumably, is
20126 sometimes true and sometimes false).
20127
20128 .cindex "copy of message (&%unseen%& option)"
20129 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
20130 qualifier in filter files. It can be used to cause copies of messages to be
20131 delivered to some other destination, while also carrying out a normal delivery.
20132 In effect, the current address is made into a &"parent"& that has two children
20133 &-- one that is delivered as specified by this router, and a clone that goes on
20134 to be routed further. For this reason, &%unseen%& may not be combined with the
20135 &%one_time%& option in a &(redirect)& router.
20136
20137 &*Warning*&: Header lines added to the address (or specified for removal) by
20138 this router or by previous routers affect the &"unseen"& copy of the message
20139 only. The clone that continues to be processed by further routers starts with
20140 no added headers and none specified for removal. For a &%redirect%& router, if
20141 a generated address is the same as the incoming address, this can lead to
20142 duplicate addresses with different header modifications. Exim does not do
20143 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20144 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20145 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20146 &%redirect%& router may be of help.
20147
20148 Unlike the handling of header modifications, any data that was set by the
20149 &%address_data%& option in the current or previous routers &'is'& passed on to
20150 subsequent routers.
20151
20152
20153 .option user routers string&!! "see below"
20154 .cindex "uid (user id)" "local delivery"
20155 .cindex "local transports" "uid and gid"
20156 .cindex "transport" "local"
20157 .cindex "router" "user for filter processing"
20158 .cindex "filter" "user for processing"
20159 When a router queues an address for a transport, and the transport does not
20160 specify a user, the user given here is used when running the delivery process.
20161 The user may be specified numerically or by name. If expansion fails, the
20162 error is logged and delivery is deferred.
20163 This user is also used by the &(redirect)& router when running a filter file.
20164 The default is unset, except when &%check_local_user%& is set. In this case,
20165 the default is taken from the password information. If the user is specified as
20166 a name, and &%group%& is not set, the group associated with the user is used.
20167 See also &%initgroups%& and &%group%& and the discussion in chapter
20168 &<<CHAPenvironment>>&.
20169
20170
20171
20172 .option verify routers&!? boolean true
20173 Setting this option has the effect of setting &%verify_sender%& and
20174 &%verify_recipient%& to the same value.
20175
20176
20177 .option verify_only routers&!? boolean false
20178 .cindex "EXPN" "with &%verify_only%&"
20179 .oindex "&%-bv%&"
20180 .cindex "router" "used only when verifying"
20181 If this option is set, the router is used only when verifying an address,
20182 delivering in cutthrough mode or
20183 testing with the &%-bv%& option, not when actually doing a delivery, testing
20184 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20185 restricted to verifying only senders or recipients by means of
20186 &%verify_sender%& and &%verify_recipient%&.
20187
20188 &*Warning*&: When the router is being run to verify addresses for an incoming
20189 SMTP message, Exim is not running as root, but under its own uid. If the router
20190 accesses any files, you need to make sure that they are accessible to the Exim
20191 user or group.
20192
20193
20194 .option verify_recipient routers&!? boolean true
20195 If this option is false, the router is skipped when verifying recipient
20196 addresses,
20197 delivering in cutthrough mode
20198 or testing recipient verification using &%-bv%&.
20199 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20200 are evaluated.
20201 See also the &$verify_mode$& variable.
20202
20203
20204 .option verify_sender routers&!? boolean true
20205 If this option is false, the router is skipped when verifying sender addresses
20206 or testing sender verification using &%-bvs%&.
20207 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20208 are evaluated.
20209 See also the &$verify_mode$& variable.
20210 .ecindex IIDgenoprou1
20211 .ecindex IIDgenoprou2
20212
20213
20214
20215
20216
20217
20218 . ////////////////////////////////////////////////////////////////////////////
20219 . ////////////////////////////////////////////////////////////////////////////
20220
20221 .chapter "The accept router" "CHID4"
20222 .cindex "&(accept)& router"
20223 .cindex "routers" "&(accept)&"
20224 The &(accept)& router has no private options of its own. Unless it is being
20225 used purely for verification (see &%verify_only%&) a transport is required to
20226 be defined by the generic &%transport%& option. If the preconditions that are
20227 specified by generic options are met, the router accepts the address and queues
20228 it for the given transport. The most common use of this router is for setting
20229 up deliveries to local mailboxes. For example:
20230 .code
20231 localusers:
20232   driver = accept
20233   domains = mydomain.example
20234   check_local_user
20235   transport = local_delivery
20236 .endd
20237 The &%domains%& condition in this example checks the domain of the address, and
20238 &%check_local_user%& checks that the local part is the login of a local user.
20239 When both preconditions are met, the &(accept)& router runs, and queues the
20240 address for the &(local_delivery)& transport.
20241
20242
20243
20244
20245
20246
20247 . ////////////////////////////////////////////////////////////////////////////
20248 . ////////////////////////////////////////////////////////////////////////////
20249
20250 .chapter "The dnslookup router" "CHAPdnslookup"
20251 .scindex IIDdnsrou1 "&(dnslookup)& router"
20252 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20253 The &(dnslookup)& router looks up the hosts that handle mail for the
20254 recipient's domain in the DNS. A transport must always be set for this router,
20255 unless &%verify_only%& is set.
20256
20257 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20258 SRV records. If none are found, or if SRV support is not configured,
20259 MX records are looked up. If no MX records exist, address records are sought.
20260 However, &%mx_domains%& can be set to disable the direct use of address
20261 records.
20262
20263 MX records of equal priority are sorted by Exim into a random order. Exim then
20264 looks for address records for the host names obtained from MX or SRV records.
20265 When a host has more than one IP address, they are sorted into a random order,
20266 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20267 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20268 generic option, the router declines.
20269
20270 Unless they have the highest priority (lowest MX value), MX records that point
20271 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20272 are discarded, together with any other MX records of equal or lower priority.
20273
20274 .cindex "MX record" "pointing to local host"
20275 .cindex "local host" "MX pointing to"
20276 .oindex "&%self%&" "in &(dnslookup)& router"
20277 If the host pointed to by the highest priority MX record, or looked up as an
20278 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20279 happens is controlled by the generic &%self%& option.
20280
20281
20282 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20283 There have been problems with DNS servers when SRV records are looked up.
20284 Some misbehaving servers return a DNS error or timeout when a non-existent
20285 SRV record is sought. Similar problems have in the past been reported for
20286 MX records. The global &%dns_again_means_nonexist%& option can help with this
20287 problem, but it is heavy-handed because it is a global option.
20288
20289 For this reason, there are two options, &%srv_fail_domains%& and
20290 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20291 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20292 an attempt to look up an SRV or MX record causes one of these results, and the
20293 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20294 such record"&. In the case of an SRV lookup, this means that the router
20295 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20296 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20297 case routing fails.
20298
20299
20300 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20301 .cindex "&(dnslookup)& router" "declines"
20302 There are a few cases where a &(dnslookup)& router will decline to accept
20303 an address; if such a router is expected to handle "all remaining non-local
20304 domains", then it is important to set &%no_more%&.
20305
20306 The router will defer rather than decline if the domain
20307 is found in the &%fail_defer_domains%& router option.
20308
20309 Reasons for a &(dnslookup)& router to decline currently include:
20310 .ilist
20311 The domain does not exist in DNS
20312 .next
20313 The domain exists but the MX record's host part is just "."; this is a common
20314 convention (borrowed from SRV) used to indicate that there is no such service
20315 for this domain and to not fall back to trying A/AAAA records.
20316 .next
20317 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20318 .next
20319 MX record points to a non-existent host.
20320 .next
20321 MX record points to an IP address and the main section option
20322 &%allow_mx_to_ip%& is not set.
20323 .next
20324 MX records exist and point to valid hosts, but all hosts resolve only to
20325 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20326 .next
20327 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20328 &%dns_check_names_pattern%& for handling one variant of this)
20329 .next
20330 &%check_secondary_mx%& is set on this router but the local host can
20331 not be found in the MX records (see below)
20332 .endlist
20333
20334
20335
20336
20337 .section "Private options for dnslookup" "SECID118"
20338 .cindex "options" "&(dnslookup)& router"
20339 The private options for the &(dnslookup)& router are as follows:
20340
20341 .option check_secondary_mx dnslookup boolean false
20342 .cindex "MX record" "checking for secondary"
20343 If this option is set, the router declines unless the local host is found in
20344 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20345 process domains for which the local host is a secondary mail exchanger
20346 differently to other domains. The way in which Exim decides whether a host is
20347 the local host is described in section &<<SECTreclocipadd>>&.
20348
20349
20350 .option check_srv dnslookup string&!! unset
20351 .cindex "SRV record" "enabling use of"
20352 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20353 addition to MX and address records. The support is disabled by default. To
20354 enable SRV support, set the &%check_srv%& option to the name of the service
20355 required. For example,
20356 .code
20357 check_srv = smtp
20358 .endd
20359 looks for SRV records that refer to the normal smtp service. The option is
20360 expanded, so the service name can vary from message to message or address
20361 to address. This might be helpful if SRV records are being used for a
20362 submission service. If the expansion is forced to fail, the &%check_srv%&
20363 option is ignored, and the router proceeds to look for MX records in the
20364 normal way.
20365
20366 When the expansion succeeds, the router searches first for SRV records for
20367 the given service (it assumes TCP protocol). A single SRV record with a
20368 host name that consists of just a single dot indicates &"no such service for
20369 this domain"&; if this is encountered, the router declines. If other kinds of
20370 SRV record are found, they are used to construct a host list for delivery
20371 according to the rules of RFC 2782. MX records are not sought in this case.
20372
20373 When no SRV records are found, MX records (and address records) are sought in
20374 the traditional way. In other words, SRV records take precedence over MX
20375 records, just as MX records take precedence over address records. Note that
20376 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20377 defined it. It is apparently believed that MX records are sufficient for email
20378 and that SRV records should not be used for this purpose. However, SRV records
20379 have an additional &"weight"& feature which some people might find useful when
20380 trying to split an SMTP load between hosts of different power.
20381
20382 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20383 when there is a DNS lookup error.
20384
20385
20386
20387
20388 .option fail_defer_domains dnslookup "domain list&!!" unset
20389 .cindex "MX record" "not found"
20390 DNS lookups for domains matching &%fail_defer_domains%&
20391 which find no matching record will cause the router to defer
20392 rather than the default behaviour of decline.
20393 This maybe be useful for queueing messages for a newly created
20394 domain while the DNS configuration is not ready.
20395 However, it will result in any message with mistyped domains
20396 also being queued.
20397
20398
20399 .option ipv4_only "string&!!" unset
20400 .cindex IPv6 disabling
20401 .cindex DNS "IPv6 disabling"
20402 The string is expanded, and if the result is anything but a forced failure,
20403 or an empty string, or one of the strings “0” or “no” or “false”
20404 (checked without regard to the case of the letters),
20405 only A records are used.
20406
20407 .option ipv4_prefer "string&!!" unset
20408 .cindex IPv4 preference
20409 .cindex DNS "IPv4 preference"
20410 The string is expanded, and if the result is anything but a forced failure,
20411 or an empty string, or one of the strings “0” or “no” or “false”
20412 (checked without regard to the case of the letters),
20413 A records are sorted before AAAA records (inverting the default).
20414
20415 .option mx_domains dnslookup "domain list&!!" unset
20416 .cindex "MX record" "required to exist"
20417 .cindex "SRV record" "required to exist"
20418 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20419 record in order to be recognized. (The name of this option could be improved.)
20420 For example, if all the mail hosts in &'fict.example'& are known to have MX
20421 records, except for those in &'discworld.fict.example'&, you could use this
20422 setting:
20423 .code
20424 mx_domains = ! *.discworld.fict.example : *.fict.example
20425 .endd
20426 This specifies that messages addressed to a domain that matches the list but
20427 has no MX record should be bounced immediately instead of being routed using
20428 the address record.
20429
20430
20431 .option mx_fail_domains dnslookup "domain list&!!" unset
20432 If the DNS lookup for MX records for one of the domains in this list causes a
20433 DNS lookup error, Exim behaves as if no MX records were found. See section
20434 &<<SECTprowitdnsloo>>& for more discussion.
20435
20436
20437
20438
20439 .option qualify_single dnslookup boolean true
20440 .cindex "DNS" "resolver options"
20441 .cindex "DNS" "qualifying single-component names"
20442 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20443 lookups. Typically, but not standardly, this causes the resolver to qualify
20444 single-component names with the default domain. For example, on a machine
20445 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20446 &'thesaurus.ref.example'& inside the resolver. For details of what your
20447 resolver actually does, consult your man pages for &'resolver'& and
20448 &'resolv.conf'&.
20449
20450
20451
20452 .option rewrite_headers dnslookup boolean true
20453 .cindex "rewriting" "header lines"
20454 .cindex "header lines" "rewriting"
20455 If the domain name in the address that is being processed is not fully
20456 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20457 an address is specified as &'dormouse@teaparty'&, the domain might be
20458 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20459 occur as a result of setting the &%widen_domains%& option. If
20460 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20461 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20462 header lines of the message are rewritten with the full domain name.
20463
20464 This option should be turned off only when it is known that no message is
20465 ever going to be sent outside an environment where the abbreviation makes
20466 sense.
20467
20468 When an MX record is looked up in the DNS and matches a wildcard record, name
20469 servers normally return a record containing the name that has been looked up,
20470 making it impossible to detect whether a wildcard was present or not. However,
20471 some name servers have recently been seen to return the wildcard entry. If the
20472 name returned by a DNS lookup begins with an asterisk, it is not used for
20473 header rewriting.
20474
20475
20476 .option same_domain_copy_routing dnslookup boolean false
20477 .cindex "address" "copying routing"
20478 Addresses with the same domain are normally routed by the &(dnslookup)& router
20479 to the same list of hosts. However, this cannot be presumed, because the router
20480 options and preconditions may refer to the local part of the address. By
20481 default, therefore, Exim routes each address in a message independently. DNS
20482 servers run caches, so repeated DNS lookups are not normally expensive, and in
20483 any case, personal messages rarely have more than a few recipients.
20484
20485 If you are running mailing lists with large numbers of subscribers at the same
20486 domain, and you are using a &(dnslookup)& router which is independent of the
20487 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20488 lookups for identical domains in one message. In this case, when &(dnslookup)&
20489 routes an address to a remote transport, any other unrouted addresses in the
20490 message that have the same domain are automatically given the same routing
20491 without processing them independently,
20492 provided the following conditions are met:
20493
20494 .ilist
20495 No router that processed the address specified &%headers_add%& or
20496 &%headers_remove%&.
20497 .next
20498 The router did not change the address in any way, for example, by &"widening"&
20499 the domain.
20500 .endlist
20501
20502
20503
20504
20505 .option search_parents dnslookup boolean false
20506 .cindex "DNS" "resolver options"
20507 When this option is true, the resolver option RES_DNSRCH is set for DNS
20508 lookups. This is different from the &%qualify_single%& option in that it
20509 applies to domains containing dots. Typically, but not standardly, it causes
20510 the resolver to search for the name in the current domain and in parent
20511 domains. For example, on a machine in the &'fict.example'& domain, if looking
20512 up &'teaparty.wonderland'& failed, the resolver would try
20513 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20514 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20515
20516 Setting this option true can cause problems in domains that have a wildcard MX
20517 record, because any domain that does not have its own MX record matches the
20518 local wildcard.
20519
20520
20521
20522 .option srv_fail_domains dnslookup "domain list&!!" unset
20523 If the DNS lookup for SRV records for one of the domains in this list causes a
20524 DNS lookup error, Exim behaves as if no SRV records were found. See section
20525 &<<SECTprowitdnsloo>>& for more discussion.
20526
20527
20528
20529
20530 .option widen_domains dnslookup "string list" unset
20531 .cindex "domain" "partial; widening"
20532 If a DNS lookup fails and this option is set, each of its strings in turn is
20533 added onto the end of the domain, and the lookup is tried again. For example,
20534 if
20535 .code
20536 widen_domains = fict.example:ref.example
20537 .endd
20538 is set and a lookup of &'klingon.dictionary'& fails,
20539 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20540 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20541 and &%search_parents%& options can cause some widening to be undertaken inside
20542 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20543 when verifying, unless &%rewrite_headers%& is false (not the default).
20544
20545
20546 .section "Effect of qualify_single and search_parents" "SECID119"
20547 When a domain from an envelope recipient is changed by the resolver as a result
20548 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20549 corresponding address in the message's header lines unless &%rewrite_headers%&
20550 is set false. Exim then re-routes the address, using the full domain.
20551
20552 These two options affect only the DNS lookup that takes place inside the router
20553 for the domain of the address that is being routed. They do not affect lookups
20554 such as that implied by
20555 .code
20556 domains = @mx_any
20557 .endd
20558 that may happen while processing a router precondition before the router is
20559 entered. No widening ever takes place for these lookups.
20560 .ecindex IIDdnsrou1
20561 .ecindex IIDdnsrou2
20562
20563
20564
20565
20566
20567
20568
20569
20570
20571 . ////////////////////////////////////////////////////////////////////////////
20572 . ////////////////////////////////////////////////////////////////////////////
20573
20574 .chapter "The ipliteral router" "CHID5"
20575 .cindex "&(ipliteral)& router"
20576 .cindex "domain literal" "routing"
20577 .cindex "routers" "&(ipliteral)&"
20578 This router has no private options. Unless it is being used purely for
20579 verification (see &%verify_only%&) a transport is required to be defined by the
20580 generic &%transport%& option. The router accepts the address if its domain part
20581 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20582 router handles the address
20583 .code
20584 root@[192.168.1.1]
20585 .endd
20586 by setting up delivery to the host with that IP address. IPv4 domain literals
20587 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20588 are similar, but the address is preceded by &`ipv6:`&. For example:
20589 .code
20590 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20591 .endd
20592 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20593 grounds that sooner or later somebody will try it.
20594
20595 .oindex "&%self%&" "in &(ipliteral)& router"
20596 If the IP address matches something in &%ignore_target_hosts%&, the router
20597 declines. If an IP literal turns out to refer to the local host, the generic
20598 &%self%& option determines what happens.
20599
20600 The RFCs require support for domain literals; however, their use is
20601 controversial in today's Internet. If you want to use this router, you must
20602 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20603 Exim will not recognize the domain literal syntax in addresses.
20604
20605
20606
20607 . ////////////////////////////////////////////////////////////////////////////
20608 . ////////////////////////////////////////////////////////////////////////////
20609
20610 .chapter "The iplookup router" "CHID6"
20611 .cindex "&(iplookup)& router"
20612 .cindex "routers" "&(iplookup)&"
20613 The &(iplookup)& router was written to fulfil a specific requirement in
20614 Cambridge University (which in fact no longer exists). For this reason, it is
20615 not included in the binary of Exim by default. If you want to include it, you
20616 must set
20617 .code
20618 ROUTER_IPLOOKUP=yes
20619 .endd
20620 in your &_Local/Makefile_& configuration file.
20621
20622 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20623 connection to one or more specific hosts. The host can then return the same or
20624 a different address &-- in effect rewriting the recipient address in the
20625 message's envelope. The new address is then passed on to subsequent routers. If
20626 this process fails, the address can be passed on to other routers, or delivery
20627 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20628 must not be specified for it.
20629
20630 .cindex "options" "&(iplookup)& router"
20631 .option hosts iplookup string unset
20632 This option must be supplied. Its value is a colon-separated list of host
20633 names. The hosts are looked up using &[gethostbyname()]&
20634 (or &[getipnodebyname()]& when available)
20635 and are tried in order until one responds to the query. If none respond, what
20636 happens is controlled by &%optional%&.
20637
20638
20639 .option optional iplookup boolean false
20640 If &%optional%& is true, if no response is obtained from any host, the address
20641 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20642 delivery to the address is deferred.
20643
20644
20645 .option port iplookup integer 0
20646 .cindex "port" "&(iplookup)& router"
20647 This option must be supplied. It specifies the port number for the TCP or UDP
20648 call.
20649
20650
20651 .option protocol iplookup string udp
20652 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20653 protocols is to be used.
20654
20655
20656 .option query iplookup string&!! "see below"
20657 This defines the content of the query that is sent to the remote hosts. The
20658 default value is:
20659 .code
20660 $local_part@$domain $local_part@$domain
20661 .endd
20662 The repetition serves as a way of checking that a response is to the correct
20663 query in the default case (see &%response_pattern%& below).
20664
20665
20666 .option reroute iplookup string&!! unset
20667 If this option is not set, the rerouted address is precisely the byte string
20668 returned by the remote host, up to the first white space, if any. If set, the
20669 string is expanded to form the rerouted address. It can include parts matched
20670 in the response by &%response_pattern%& by means of numeric variables such as
20671 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20672 whether or not a pattern is in use. In all cases, the rerouted address must end
20673 up in the form &'local_part@domain'&.
20674
20675
20676 .option response_pattern iplookup string unset
20677 This option can be set to a regular expression that is applied to the string
20678 returned from the remote host. If the pattern does not match the response, the
20679 router declines. If &%response_pattern%& is not set, no checking of the
20680 response is done, unless the query was defaulted, in which case there is a
20681 check that the text returned after the first white space is the original
20682 address. This checks that the answer that has been received is in response to
20683 the correct question. For example, if the response is just a new domain, the
20684 following could be used:
20685 .code
20686 response_pattern = ^([^@]+)$
20687 reroute = $local_part@$1
20688 .endd
20689
20690 .option timeout iplookup time 5s
20691 This specifies the amount of time to wait for a response from the remote
20692 machine. The same timeout is used for the &[connect()]& function for a TCP
20693 call. It does not apply to UDP.
20694
20695
20696
20697
20698 . ////////////////////////////////////////////////////////////////////////////
20699 . ////////////////////////////////////////////////////////////////////////////
20700
20701 .chapter "The manualroute router" "CHID7"
20702 .scindex IIDmanrou1 "&(manualroute)& router"
20703 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20704 .cindex "domain" "manually routing"
20705 The &(manualroute)& router is so-called because it provides a way of manually
20706 routing an address according to its domain. It is mainly used when you want to
20707 route addresses to remote hosts according to your own rules, bypassing the
20708 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20709 route to local transports, a facility that may be useful if you want to save
20710 messages for dial-in hosts in local files.
20711
20712 The &(manualroute)& router compares a list of domain patterns with the domain
20713 it is trying to route. If there is no match, the router declines. Each pattern
20714 has associated with it a list of hosts and some other optional data, which may
20715 include a transport. The combination of a pattern and its data is called a
20716 &"routing rule"&. For patterns that do not have an associated transport, the
20717 generic &%transport%& option must specify a transport, unless the router is
20718 being used purely for verification (see &%verify_only%&).
20719
20720 .vindex "&$host$&"
20721 In the case of verification, matching the domain pattern is sufficient for the
20722 router to accept the address. When actually routing an address for delivery,
20723 an address that matches a domain pattern is queued for the associated
20724 transport. If the transport is not a local one, a host list must be associated
20725 with the pattern; IP addresses are looked up for the hosts, and these are
20726 passed to the transport along with the mail address. For local transports, a
20727 host list is optional. If it is present, it is passed in &$host$& as a single
20728 text string.
20729
20730 The list of routing rules can be provided as an inline string in
20731 &%route_list%&, or the data can be obtained by looking up the domain in a file
20732 or database by setting &%route_data%&. Only one of these settings may appear in
20733 any one instance of &(manualroute)&. The format of routing rules is described
20734 below, following the list of private options.
20735
20736
20737 .section "Private options for manualroute" "SECTprioptman"
20738
20739 .cindex "options" "&(manualroute)& router"
20740 The private options for the &(manualroute)& router are as follows:
20741
20742 .option host_all_ignored manualroute string defer
20743 See &%host_find_failed%&.
20744
20745 .option host_find_failed manualroute string freeze
20746 This option controls what happens when &(manualroute)& tries to find an IP
20747 address for a host, and the host does not exist. The option can be set to one
20748 of the following values:
20749 .code
20750 decline
20751 defer
20752 fail
20753 freeze
20754 ignore
20755 pass
20756 .endd
20757 The default (&"freeze"&) assumes that this state is a serious configuration
20758 error. The difference between &"pass"& and &"decline"& is that the former
20759 forces the address to be passed to the next router (or the router defined by
20760 &%pass_router%&),
20761 .oindex "&%more%&"
20762 overriding &%no_more%&, whereas the latter passes the address to the next
20763 router only if &%more%& is true.
20764
20765 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20766 cannot be found. If all the hosts in the list are ignored, the behaviour is
20767 controlled by the &%host_all_ignored%& option. This takes the same values
20768 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20769
20770 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20771 state; if a host lookup gets a temporary error, delivery is deferred unless the
20772 generic &%pass_on_timeout%& option is set.
20773
20774
20775 .option hosts_randomize manualroute boolean false
20776 .cindex "randomized host list"
20777 .cindex "host" "list of; randomized"
20778 If this option is set, the order of the items in a host list in a routing rule
20779 is randomized each time the list is used, unless an option in the routing rule
20780 overrides (see below). Randomizing the order of a host list can be used to do
20781 crude load sharing. However, if more than one mail address is routed by the
20782 same router to the same host list, the host lists are considered to be the same
20783 (even though they may be randomized into different orders) for the purpose of
20784 deciding whether to batch the deliveries into a single SMTP transaction.
20785
20786 When &%hosts_randomize%& is true, a host list may be split
20787 into groups whose order is separately randomized. This makes it possible to
20788 set up MX-like behaviour. The boundaries between groups are indicated by an
20789 item that is just &`+`& in the host list. For example:
20790 .code
20791 route_list = * host1:host2:host3:+:host4:host5
20792 .endd
20793 The order of the first three hosts and the order of the last two hosts is
20794 randomized for each use, but the first three always end up before the last two.
20795 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20796 randomized host list is passed to an &(smtp)& transport that also has
20797 &%hosts_randomize set%&, the list is not re-randomized.
20798
20799
20800 .option route_data manualroute string&!! unset
20801 If this option is set, it must expand to yield the data part of a routing rule.
20802 Typically, the expansion string includes a lookup based on the domain. For
20803 example:
20804 .code
20805 route_data = ${lookup{$domain}dbm{/etc/routes}}
20806 .endd
20807 If the expansion is forced to fail, or the result is an empty string, the
20808 router declines. Other kinds of expansion failure cause delivery to be
20809 deferred.
20810
20811
20812 .option route_list manualroute "string list" unset
20813 This string is a list of routing rules, in the form defined below. Note that,
20814 unlike most string lists, the items are separated by semicolons. This is so
20815 that they may contain colon-separated host lists.
20816
20817
20818 .option same_domain_copy_routing manualroute boolean false
20819 .cindex "address" "copying routing"
20820 Addresses with the same domain are normally routed by the &(manualroute)&
20821 router to the same list of hosts. However, this cannot be presumed, because the
20822 router options and preconditions may refer to the local part of the address. By
20823 default, therefore, Exim routes each address in a message independently. DNS
20824 servers run caches, so repeated DNS lookups are not normally expensive, and in
20825 any case, personal messages rarely have more than a few recipients.
20826
20827 If you are running mailing lists with large numbers of subscribers at the same
20828 domain, and you are using a &(manualroute)& router which is independent of the
20829 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20830 lookups for identical domains in one message. In this case, when
20831 &(manualroute)& routes an address to a remote transport, any other unrouted
20832 addresses in the message that have the same domain are automatically given the
20833 same routing without processing them independently. However, this is only done
20834 if &%headers_add%& and &%headers_remove%& are unset.
20835
20836
20837
20838
20839 .section "Routing rules in route_list" "SECID120"
20840 The value of &%route_list%& is a string consisting of a sequence of routing
20841 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20842 entered as two semicolons. Alternatively, the list separator can be changed as
20843 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20844 Empty rules are ignored. The format of each rule is
20845 .display
20846 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20847 .endd
20848 The following example contains two rules, each with a simple domain pattern and
20849 no options:
20850 .code
20851 route_list = \
20852   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20853   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20854 .endd
20855 The three parts of a rule are separated by white space. The pattern and the
20856 list of hosts can be enclosed in quotes if necessary, and if they are, the
20857 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20858 single domain pattern, which is the only mandatory item in the rule. The
20859 pattern is in the same format as one item in a domain list (see section
20860 &<<SECTdomainlist>>&),
20861 except that it may not be the name of an interpolated file.
20862 That is, it may be wildcarded, or a regular expression, or a file or database
20863 lookup (with semicolons doubled, because of the use of semicolon as a separator
20864 in a &%route_list%&).
20865
20866 The rules in &%route_list%& are searched in order until one of the patterns
20867 matches the domain that is being routed. The list of hosts and then options are
20868 then used as described below. If there is no match, the router declines. When
20869 &%route_list%& is set, &%route_data%& must not be set.
20870
20871
20872
20873 .section "Routing rules in route_data" "SECID121"
20874 The use of &%route_list%& is convenient when there are only a small number of
20875 routing rules. For larger numbers, it is easier to use a file or database to
20876 hold the routing information, and use the &%route_data%& option instead.
20877 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20878 Most commonly, &%route_data%& is set as a string that contains an
20879 expansion lookup. For example, suppose we place two routing rules in a file
20880 like this:
20881 .code
20882 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20883 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20884 .endd
20885 This data can be accessed by setting
20886 .code
20887 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20888 .endd
20889 Failure of the lookup results in an empty string, causing the router to
20890 decline. However, you do not have to use a lookup in &%route_data%&. The only
20891 requirement is that the result of expanding the string is a list of hosts,
20892 possibly followed by options, separated by white space. The list of hosts must
20893 be enclosed in quotes if it contains white space.
20894
20895
20896
20897
20898 .section "Format of the list of hosts" "SECID122"
20899 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20900 always separately expanded before use. If the expansion fails, the router
20901 declines. The result of the expansion must be a colon-separated list of names
20902 and/or IP addresses, optionally also including ports.
20903 If the list is written with spaces, it must be protected with quotes.
20904 The format of each item
20905 in the list is described in the next section. The list separator can be changed
20906 as described in section &<<SECTlistsepchange>>&.
20907
20908 If the list of hosts was obtained from a &%route_list%& item, the following
20909 variables are set during its expansion:
20910
20911 .ilist
20912 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20913 If the domain was matched against a regular expression, the numeric variables
20914 &$1$&, &$2$&, etc. may be set. For example:
20915 .code
20916 route_list = ^domain(\d+)   host-$1.text.example
20917 .endd
20918 .next
20919 &$0$& is always set to the entire domain.
20920 .next
20921 &$1$& is also set when partial matching is done in a file lookup.
20922
20923 .next
20924 .vindex "&$value$&"
20925 If the pattern that matched the domain was a lookup item, the data that was
20926 looked up is available in the expansion variable &$value$&. For example:
20927 .code
20928 route_list = lsearch;;/some/file.routes  $value
20929 .endd
20930 .endlist
20931
20932 Note the doubling of the semicolon in the pattern that is necessary because
20933 semicolon is the default route list separator.
20934
20935
20936
20937 .section "Format of one host item" "SECTformatonehostitem"
20938 Each item in the list of hosts can be either a host name or an IP address,
20939 optionally with an attached port number, or it can be a single "+"
20940 (see &%hosts_randomize%&).
20941 When no port is given, an IP address
20942 is not enclosed in brackets. When a port is specified, it overrides the port
20943 specification on the transport. The port is separated from the name or address
20944 by a colon. This leads to some complications:
20945
20946 .ilist
20947 Because colon is the default separator for the list of hosts, either
20948 the colon that specifies a port must be doubled, or the list separator must
20949 be changed. The following two examples have the same effect:
20950 .code
20951 route_list = * "host1.tld::1225 : host2.tld::1226"
20952 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20953 .endd
20954 .next
20955 When IPv6 addresses are involved, it gets worse, because they contain
20956 colons of their own. To make this case easier, it is permitted to
20957 enclose an IP address (either v4 or v6) in square brackets if a port
20958 number follows. For example:
20959 .code
20960 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20961 .endd
20962 .endlist
20963
20964 .section "How the list of hosts is used" "SECThostshowused"
20965 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20966 the hosts is tried, in the order specified, when carrying out the SMTP
20967 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20968 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20969 transport.
20970
20971 Hosts may be listed by name or by IP address. An unadorned name in the list of
20972 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20973 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20974 records in the DNS. For example:
20975 .code
20976 route_list = *  x.y.z:p.q.r/MX:e.f.g
20977 .endd
20978 If this feature is used with a port specifier, the port must come last. For
20979 example:
20980 .code
20981 route_list = *  dom1.tld/mx::1225
20982 .endd
20983 If the &%hosts_randomize%& option is set, the order of the items in the list is
20984 randomized before any lookups are done. Exim then scans the list; for any name
20985 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20986 be an interface on the local host and the item is not the first in the list,
20987 Exim discards it and any subsequent items. If it is the first item, what
20988 happens is controlled by the
20989 .oindex "&%self%&" "in &(manualroute)& router"
20990 &%self%& option of the router.
20991
20992 A name on the list that is followed by &`/MX`& is replaced with the list of
20993 hosts obtained by looking up MX records for the name. This is always a DNS
20994 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20995 below) are not relevant here. The order of these hosts is determined by the
20996 preference values in the MX records, according to the usual rules. Because
20997 randomizing happens before the MX lookup, it does not affect the order that is
20998 defined by MX preferences.
20999
21000 If the local host is present in the sublist obtained from MX records, but is
21001 not the most preferred host in that list, it and any equally or less
21002 preferred hosts are removed before the sublist is inserted into the main list.
21003
21004 If the local host is the most preferred host in the MX list, what happens
21005 depends on where in the original list of hosts the &`/MX`& item appears. If it
21006 is not the first item (that is, there are previous hosts in the main list),
21007 Exim discards this name and any subsequent items in the main list.
21008
21009 If the MX item is first in the list of hosts, and the local host is the
21010 most preferred host, what happens is controlled by the &%self%& option of the
21011 router.
21012
21013 DNS failures when lookup up the MX records are treated in the same way as DNS
21014 failures when looking up IP addresses: &%pass_on_timeout%& and
21015 &%host_find_failed%& are used when relevant.
21016
21017 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
21018 whether obtained from an MX lookup or not.
21019
21020
21021
21022 .section "How the options are used" "SECThowoptused"
21023 The options are a sequence of words, space-separated.
21024 One of the words can be the name of a transport; this overrides the
21025 &%transport%& option on the router for this particular routing rule only. The
21026 other words (if present) control randomization of the list of hosts on a
21027 per-rule basis, and how the IP addresses of the hosts are to be found when
21028 routing to a remote transport. These options are as follows:
21029
21030 .ilist
21031 &%randomize%&: randomize the order of the hosts in this list, overriding the
21032 setting of &%hosts_randomize%& for this routing rule only.
21033 .next
21034 &%no_randomize%&: do not randomize the order of the hosts in this list,
21035 overriding the setting of &%hosts_randomize%& for this routing rule only.
21036 .next
21037 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
21038 find IP addresses. This function may ultimately cause a DNS lookup, but it may
21039 also look in &_/etc/hosts_& or other sources of information.
21040 .next
21041 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
21042 no address records are found. If there is a temporary DNS error (such as a
21043 timeout), delivery is deferred.
21044 .next
21045 &%ipv4_only%&: in direct DNS lookups, look up only A records.
21046 .next
21047 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
21048 .endlist
21049
21050 For example:
21051 .code
21052 route_list = domain1  host1:host2:host3  randomize bydns;\
21053              domain2  host4:host5
21054 .endd
21055 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
21056 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
21057 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
21058 or &[gethostbyname()]&, and the result of the lookup is the result of that
21059 call.
21060
21061 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
21062 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
21063 instead of TRY_AGAIN. That is why the default action is to try a DNS
21064 lookup first. Only if that gives a definite &"no such host"& is the local
21065 function called.
21066
21067 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
21068 inadvertent constraint that a transport name as an option had to be the last
21069 option specified.
21070
21071
21072
21073 If no IP address for a host can be found, what happens is controlled by the
21074 &%host_find_failed%& option.
21075
21076 .vindex "&$host$&"
21077 When an address is routed to a local transport, IP addresses are not looked up.
21078 The host list is passed to the transport in the &$host$& variable.
21079
21080
21081
21082 .section "Manualroute examples" "SECID123"
21083 In some of the examples that follow, the presence of the &%remote_smtp%&
21084 transport, as defined in the default configuration file, is assumed:
21085
21086 .ilist
21087 .cindex "smart host" "example router"
21088 The &(manualroute)& router can be used to forward all external mail to a
21089 &'smart host'&. If you have set up, in the main part of the configuration, a
21090 named domain list that contains your local domains, for example:
21091 .code
21092 domainlist local_domains = my.domain.example
21093 .endd
21094 You can arrange for all other domains to be routed to a smart host by making
21095 your first router something like this:
21096 .code
21097 smart_route:
21098   driver = manualroute
21099   domains = !+local_domains
21100   transport = remote_smtp
21101   route_list = * smarthost.ref.example
21102 .endd
21103 This causes all non-local addresses to be sent to the single host
21104 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
21105 they are tried in order
21106 (but you can use &%hosts_randomize%& to vary the order each time).
21107 Another way of configuring the same thing is this:
21108 .code
21109 smart_route:
21110   driver = manualroute
21111   transport = remote_smtp
21112   route_list = !+local_domains  smarthost.ref.example
21113 .endd
21114 There is no difference in behaviour between these two routers as they stand.
21115 However, they behave differently if &%no_more%& is added to them. In the first
21116 example, the router is skipped if the domain does not match the &%domains%&
21117 precondition; the following router is always tried. If the router runs, it
21118 always matches the domain and so can never decline. Therefore, &%no_more%&
21119 would have no effect. In the second case, the router is never skipped; it
21120 always runs. However, if it doesn't match the domain, it declines. In this case
21121 &%no_more%& would prevent subsequent routers from running.
21122
21123 .next
21124 .cindex "mail hub example"
21125 A &'mail hub'& is a host which receives mail for a number of domains via MX
21126 records in the DNS and delivers it via its own private routing mechanism. Often
21127 the final destinations are behind a firewall, with the mail hub being the one
21128 machine that can connect to machines both inside and outside the firewall. The
21129 &(manualroute)& router is usually used on a mail hub to route incoming messages
21130 to the correct hosts. For a small number of domains, the routing can be inline,
21131 using the &%route_list%& option, but for a larger number a file or database
21132 lookup is easier to manage.
21133
21134 If the domain names are in fact the names of the machines to which the mail is
21135 to be sent by the mail hub, the configuration can be quite simple. For
21136 example:
21137 .code
21138 hub_route:
21139   driver = manualroute
21140   transport = remote_smtp
21141   route_list = *.rhodes.tvs.example  $domain
21142 .endd
21143 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21144 whose names are the same as the mail domains. A similar approach can be taken
21145 if the host name can be obtained from the domain name by a string manipulation
21146 that the expansion facilities can handle. Otherwise, a lookup based on the
21147 domain can be used to find the host:
21148 .code
21149 through_firewall:
21150   driver = manualroute
21151   transport = remote_smtp
21152   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21153 .endd
21154 The result of the lookup must be the name or IP address of the host (or
21155 hosts) to which the address is to be routed. If the lookup fails, the route
21156 data is empty, causing the router to decline. The address then passes to the
21157 next router.
21158
21159 .next
21160 .cindex "batched SMTP output example"
21161 .cindex "SMTP" "batched outgoing; example"
21162 You can use &(manualroute)& to deliver messages to pipes or files in batched
21163 SMTP format for onward transportation by some other means. This is one way of
21164 storing mail for a dial-up host when it is not connected. The route list entry
21165 can be as simple as a single domain name in a configuration like this:
21166 .code
21167 save_in_file:
21168   driver = manualroute
21169   transport = batchsmtp_appendfile
21170   route_list = saved.domain.example
21171 .endd
21172 though often a pattern is used to pick up more than one domain. If there are
21173 several domains or groups of domains with different transport requirements,
21174 different transports can be listed in the routing information:
21175 .code
21176 save_in_file:
21177   driver = manualroute
21178   route_list = \
21179     *.saved.domain1.example  $domain  batch_appendfile; \
21180     *.saved.domain2.example  \
21181       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21182       batch_pipe
21183 .endd
21184 .vindex "&$domain$&"
21185 .vindex "&$host$&"
21186 The first of these just passes the domain in the &$host$& variable, which
21187 doesn't achieve much (since it is also in &$domain$&), but the second does a
21188 file lookup to find a value to pass, causing the router to decline to handle
21189 the address if the lookup fails.
21190
21191 .next
21192 .cindex "UUCP" "example of router for"
21193 Routing mail directly to UUCP software is a specific case of the use of
21194 &(manualroute)& in a gateway to another mail environment. This is an example of
21195 one way it can be done:
21196 .code
21197 # Transport
21198 uucp:
21199   driver = pipe
21200   user = nobody
21201   command = /usr/local/bin/uux -r - \
21202     ${substr_-5:$host}!rmail ${local_part}
21203   return_fail_output = true
21204
21205 # Router
21206 uucphost:
21207   transport = uucp
21208   driver = manualroute
21209   route_data = \
21210     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21211 .endd
21212 The file &_/usr/local/exim/uucphosts_& contains entries like
21213 .code
21214 darksite.ethereal.example:           darksite.UUCP
21215 .endd
21216 It can be set up more simply without adding and removing &".UUCP"& but this way
21217 makes clear the distinction between the domain name
21218 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21219 .endlist
21220 .ecindex IIDmanrou1
21221 .ecindex IIDmanrou2
21222
21223
21224
21225
21226
21227
21228
21229
21230 . ////////////////////////////////////////////////////////////////////////////
21231 . ////////////////////////////////////////////////////////////////////////////
21232
21233 .chapter "The queryprogram router" "CHAPdriverlast"
21234 .scindex IIDquerou1 "&(queryprogram)& router"
21235 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21236 .cindex "routing" "by external program"
21237 The &(queryprogram)& router routes an address by running an external command
21238 and acting on its output. This is an expensive way to route, and is intended
21239 mainly for use in lightly-loaded systems, or for performing experiments.
21240 However, if it is possible to use the precondition options (&%domains%&,
21241 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21242 be used in special cases, even on a busy host. There are the following private
21243 options:
21244 .cindex "options" "&(queryprogram)& router"
21245
21246 .option command queryprogram string&!! unset
21247 This option must be set. It specifies the command that is to be run. The
21248 command is split up into a command name and arguments, and then each is
21249 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21250 &<<CHAPpipetransport>>&).
21251
21252
21253 .option command_group queryprogram string unset
21254 .cindex "gid (group id)" "in &(queryprogram)& router"
21255 This option specifies a gid to be set when running the command while routing an
21256 address for deliver. It must be set if &%command_user%& specifies a numerical
21257 uid. If it begins with a digit, it is interpreted as the numerical value of the
21258 gid. Otherwise it is looked up using &[getgrnam()]&.
21259
21260
21261 .option command_user queryprogram string unset
21262 .cindex "uid (user id)" "for &(queryprogram)&"
21263 This option must be set. It specifies the uid which is set when running the
21264 command while routing an address for delivery. If the value begins with a digit,
21265 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21266 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21267 not set, a value for the gid also.
21268
21269 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21270 root, which it does during a normal delivery in a conventional configuration.
21271 However, when an address is being verified during message reception, Exim is
21272 usually running as the Exim user, not as root. If the &(queryprogram)& router
21273 is called from a non-root process, Exim cannot change uid or gid before running
21274 the command. In this circumstance the command runs under the current uid and
21275 gid.
21276
21277
21278 .option current_directory queryprogram string /
21279 This option specifies an absolute path which is made the current directory
21280 before running the command.
21281
21282
21283 .option timeout queryprogram time 1h
21284 If the command does not complete within the timeout period, its process group
21285 is killed and the message is frozen. A value of zero time specifies no
21286 timeout.
21287
21288
21289 The standard output of the command is connected to a pipe, which is read when
21290 the command terminates. It should consist of a single line of output,
21291 containing up to five fields, separated by white space. The maximum length of
21292 the line is 1023 characters. Longer lines are silently truncated. The first
21293 field is one of the following words (case-insensitive):
21294
21295 .ilist
21296 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21297 below).
21298 .next
21299 &'Decline'&: the router declines; pass the address to the next router, unless
21300 &%no_more%& is set.
21301 .next
21302 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21303 subsequent text on the line is an error message. If the router is run as part
21304 of address verification during an incoming SMTP message, the message is
21305 included in the SMTP response.
21306 .next
21307 &'Defer'&: routing could not be completed at this time; try again later. Any
21308 subsequent text on the line is an error message which is logged. It is not
21309 included in any SMTP response.
21310 .next
21311 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21312 .next
21313 &'Pass'&: pass the address to the next router (or the router specified by
21314 &%pass_router%&), overriding &%no_more%&.
21315 .next
21316 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21317 new addresses, which are routed independently, starting with the first router,
21318 or the router specified by &%redirect_router%&, if set.
21319 .endlist
21320
21321 When the first word is &'accept'&, the remainder of the line consists of a
21322 number of keyed data values, as follows (split into two lines here, to fit on
21323 the page):
21324 .code
21325 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21326 LOOKUP=byname|bydns DATA=<text>
21327 .endd
21328 The data items can be given in any order, and all are optional. If no transport
21329 is included, the transport specified by the generic &%transport%& option is
21330 used. The list of hosts and the lookup type are needed only if the transport is
21331 an &(smtp)& transport that does not itself supply a list of hosts.
21332
21333 The format of the list of hosts is the same as for the &(manualroute)& router.
21334 As well as host names and IP addresses with optional port numbers, as described
21335 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21336 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21337 (see section &<<SECThostshowused>>&).
21338
21339 If the lookup type is not specified, Exim behaves as follows when trying to
21340 find an IP address for each host: First, a DNS lookup is done. If this yields
21341 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21342 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21343 result of the lookup is the result of that call.
21344
21345 .vindex "&$address_data$&"
21346 If the DATA field is set, its value is placed in the &$address_data$&
21347 variable. For example, this return line
21348 .code
21349 accept hosts=x1.y.example:x2.y.example data="rule1"
21350 .endd
21351 routes the address to the default transport, passing a list of two hosts. When
21352 the transport runs, the string &"rule1"& is in &$address_data$&.
21353 .ecindex IIDquerou1
21354 .ecindex IIDquerou2
21355
21356
21357
21358
21359 . ////////////////////////////////////////////////////////////////////////////
21360 . ////////////////////////////////////////////////////////////////////////////
21361
21362 .chapter "The redirect router" "CHAPredirect"
21363 .scindex IIDredrou1 "&(redirect)& router"
21364 .scindex IIDredrou2 "routers" "&(redirect)&"
21365 .cindex "alias file" "in a &(redirect)& router"
21366 .cindex "address redirection" "&(redirect)& router"
21367 The &(redirect)& router handles several kinds of address redirection. Its most
21368 common uses are for resolving local part aliases from a central alias file
21369 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21370 files, but it has many other potential uses. The incoming address can be
21371 redirected in several different ways:
21372
21373 .ilist
21374 It can be replaced by one or more new addresses which are themselves routed
21375 independently.
21376 .next
21377 It can be routed to be delivered to a given file or directory.
21378 .next
21379 It can be routed to be delivered to a specified pipe command.
21380 .next
21381 It can cause an automatic reply to be generated.
21382 .next
21383 It can be forced to fail, optionally with a custom error message.
21384 .next
21385 It can be temporarily deferred, optionally with a custom message.
21386 .next
21387 It can be discarded.
21388 .endlist
21389
21390 The generic &%transport%& option must not be set for &(redirect)& routers.
21391 However, there are some private options which define transports for delivery to
21392 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21393 &%pipe_transport%& and &%reply_transport%& descriptions below.
21394
21395 If success DSNs have been requested
21396 .cindex "DSN" "success"
21397 .cindex "Delivery Status Notification" "success"
21398 redirection triggers one and the DSN options are not passed any further.
21399
21400
21401
21402 .section "Redirection data" "SECID124"
21403 The router operates by interpreting a text string which it obtains either by
21404 expanding the contents of the &%data%& option, or by reading the entire
21405 contents of a file whose name is given in the &%file%& option. These two
21406 options are mutually exclusive. The first is commonly used for handling system
21407 aliases, in a configuration like this:
21408 .code
21409 system_aliases:
21410   driver = redirect
21411   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21412 .endd
21413 If the lookup fails, the expanded string in this example is empty. When the
21414 expansion of &%data%& results in an empty string, the router declines. A forced
21415 expansion failure also causes the router to decline; other expansion failures
21416 cause delivery to be deferred.
21417
21418 A configuration using &%file%& is commonly used for handling users'
21419 &_.forward_& files, like this:
21420 .code
21421 userforward:
21422   driver = redirect
21423   check_local_user
21424   file = $home/.forward
21425   no_verify
21426 .endd
21427 If the file does not exist, or causes no action to be taken (for example, it is
21428 empty or consists only of comments), the router declines. &*Warning*&: This
21429 is not the case when the file contains syntactically valid items that happen to
21430 yield empty addresses, for example, items containing only RFC 2822 address
21431 comments.
21432
21433 .cindex "tainted data" "in filenames"
21434 .cindex redirect "tainted data"
21435 Tainted data may not be used for a filename.
21436
21437 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21438 directly for redirection,
21439 as they are provided by a potential attacker.
21440 In the examples above, &$local_part$& is used for looking up data held locally
21441 on the system, and not used directly (the second example derives &$home$& via
21442 the passsword file or database, using &$local_part$&).
21443
21444
21445
21446 .section "Forward files and address verification" "SECID125"
21447 .cindex "address redirection" "while verifying"
21448 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21449 &_.forward_& files, as in the example above. There are two reasons for this:
21450
21451 .ilist
21452 When Exim is receiving an incoming SMTP message from a remote host, it is
21453 running under the Exim uid, not as root. Exim is unable to change uid to read
21454 the file as the user, and it may not be able to read it as the Exim user. So in
21455 practice the router may not be able to operate.
21456 .next
21457 However, even when the router can operate, the existence of a &_.forward_& file
21458 is unimportant when verifying an address. What should be checked is whether the
21459 local part is a valid user name or not. Cutting out the redirection processing
21460 saves some resources.
21461 .endlist
21462
21463
21464
21465
21466
21467
21468 .section "Interpreting redirection data" "SECID126"
21469 .cindex "Sieve filter" "specifying in redirection data"
21470 .cindex "filter" "specifying in redirection data"
21471 The contents of the data string, whether obtained from &%data%& or &%file%&,
21472 can be interpreted in two different ways:
21473
21474 .ilist
21475 If the &%allow_filter%& option is set true, and the data begins with the text
21476 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21477 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21478 respectively. Details of the syntax and semantics of filter files are described
21479 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21480 document is intended for use by end users.
21481 .next
21482 Otherwise, the data must be a comma-separated list of redirection items, as
21483 described in the next section.
21484 .endlist
21485
21486 When a message is redirected to a file (a &"mail folder"&), the filename given
21487 in a non-filter redirection list must always be an absolute path. A filter may
21488 generate a relative path &-- how this is handled depends on the transport's
21489 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21490 for the &(appendfile)& transport.
21491
21492
21493
21494 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21495 .cindex "address redirection" "non-filter list items"
21496 When the redirection data is not an Exim or Sieve filter, for example, if it
21497 comes from a conventional alias or forward file, it consists of a list of
21498 addresses, filenames, pipe commands, or certain special items (see section
21499 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21500 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21501 depending on their default values. The items in the list are separated by
21502 commas or newlines.
21503 If a comma is required in an item, the entire item must be enclosed in double
21504 quotes.
21505
21506 Lines starting with a # character are comments, and are ignored, and # may
21507 also appear following a comma, in which case everything between the # and the
21508 next newline character is ignored.
21509
21510 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21511 double quotes are retained because some forms of mail address require their use
21512 (but never to enclose the entire address). In the following description,
21513 &"item"& refers to what remains after any surrounding double quotes have been
21514 removed.
21515
21516 .vindex "&$local_part$&"
21517 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21518 and the expansion contains a reference to &$local_part$&, you should make use
21519 of the &%quote_local_part%& expansion operator, in case the local part contains
21520 special characters. For example, to redirect all mail for the domain
21521 &'obsolete.example'&, retaining the existing local part, you could use this
21522 setting:
21523 .code
21524 data = ${quote_local_part:$local_part}@newdomain.example
21525 .endd
21526
21527
21528 .section "Redirecting to a local mailbox" "SECTredlocmai"
21529 .cindex "routing" "loops in"
21530 .cindex "loop" "while routing, avoidance of"
21531 .cindex "address redirection" "to local mailbox"
21532 A redirection item may safely be the same as the address currently under
21533 consideration. This does not cause a routing loop, because a router is
21534 automatically skipped if any ancestor of the address that is being processed
21535 is the same as the current address and was processed by the current router.
21536 Such an address is therefore passed to the following routers, so it is handled
21537 as if there were no redirection. When making this loop-avoidance test, the
21538 complete local part, including any prefix or suffix, is used.
21539
21540 .cindex "address redirection" "local part without domain"
21541 Specifying the same local part without a domain is a common usage in personal
21542 filter files when the user wants to have messages delivered to the local
21543 mailbox and also forwarded elsewhere. For example, the user whose login is
21544 &'cleo'& might have a &_.forward_& file containing this:
21545 .code
21546 cleo, cleopatra@egypt.example
21547 .endd
21548 .cindex "backslash in alias file"
21549 .cindex "alias file" "backslash in"
21550 For compatibility with other MTAs, such unqualified local parts may be
21551 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21552 it does make a difference if more than one domain is being handled
21553 synonymously.
21554
21555 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21556 2822 address that does not include a domain, the item is qualified using the
21557 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21558 addresses are qualified using the value in &%qualify_recipient%&, but you can
21559 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21560
21561 Care must be taken if there are alias names for local users.
21562 Consider an MTA handling a single local domain where the system alias file
21563 contains:
21564 .code
21565 Sam.Reman: spqr
21566 .endd
21567 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21568 messages in the local mailbox, and also forward copies elsewhere. He creates
21569 this forward file:
21570 .code
21571 Sam.Reman, spqr@reme.elsewhere.example
21572 .endd
21573 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21574 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21575 second time round, because it has previously routed it,
21576 and the following routers presumably cannot handle the alias. The forward file
21577 should really contain
21578 .code
21579 spqr, spqr@reme.elsewhere.example
21580 .endd
21581 but because this is such a common error, the &%check_ancestor%& option (see
21582 below) exists to provide a way to get round it. This is normally set on a
21583 &(redirect)& router that is handling users' &_.forward_& files.
21584
21585
21586
21587 .section "Special items in redirection lists" "SECTspecitredli"
21588 In addition to addresses, the following types of item may appear in redirection
21589 lists (that is, in non-filter redirection data):
21590
21591 .ilist
21592 .cindex "pipe" "in redirection list"
21593 .cindex "address redirection" "to pipe"
21594 An item is treated as a pipe command if it begins with &"|"& and does not parse
21595 as a valid RFC 2822 address that includes a domain. A transport for running the
21596 command must be specified by the &%pipe_transport%& option.
21597 Normally, either the router or the transport specifies a user and a group under
21598 which to run the delivery. The default is to use the Exim user and group.
21599
21600 Single or double quotes can be used for enclosing the individual arguments of
21601 the pipe command; no interpretation of escapes is done for single quotes. If
21602 the command contains a comma character, it is necessary to put the whole item
21603 in double quotes, for example:
21604 .code
21605 "|/some/command ready,steady,go"
21606 .endd
21607 since items in redirection lists are terminated by commas. Do not, however,
21608 quote just the command. An item such as
21609 .code
21610 |"/some/command ready,steady,go"
21611 .endd
21612 is interpreted as a pipe with a rather strange command name, and no arguments.
21613
21614 Note that the above example assumes that the text comes from a lookup source
21615 of some sort, so that the quotes are part of the data.  If composing a
21616 redirect router with a &%data%& option directly specifying this command, the
21617 quotes will be used by the configuration parser to define the extent of one
21618 string, but will not be passed down into the redirect router itself.  There
21619 are two main approaches to get around this: escape quotes to be part of the
21620 data itself, or avoid using this mechanism and instead create a custom
21621 transport with the &%command%& option set and reference that transport from
21622 an &%accept%& router.
21623
21624 .next
21625 .cindex "file" "in redirection list"
21626 .cindex "address redirection" "to file"
21627 An item is interpreted as a path name if it begins with &"/"& and does not
21628 parse as a valid RFC 2822 address that includes a domain. For example,
21629 .code
21630 /home/world/minbari
21631 .endd
21632 is treated as a filename, but
21633 .code
21634 /s=molari/o=babylon/@x400gate.way
21635 .endd
21636 is treated as an address. For a filename, a transport must be specified using
21637 the &%file_transport%& option. However, if the generated path name ends with a
21638 forward slash character, it is interpreted as a directory name rather than a
21639 filename, and &%directory_transport%& is used instead.
21640
21641 Normally, either the router or the transport specifies a user and a group under
21642 which to run the delivery. The default is to use the Exim user and group.
21643
21644 .cindex "&_/dev/null_&"
21645 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21646 bypassed at a high level, and the log entry shows &"**bypassed**"&
21647 instead of a transport name. In this case the user and group are not used.
21648
21649 .next
21650 .cindex "included address list"
21651 .cindex "address redirection" "included external list"
21652 If an item is of the form
21653 .code
21654 :include:<path name>
21655 .endd
21656 a list of further items is taken from the given file and included at that
21657 point. &*Note*&: Such a file can not be a filter file; it is just an
21658 out-of-line addition to the list. The items in the included list are separated
21659 by commas or newlines and are not subject to expansion. If this is the first
21660 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21661 the alias name. This example is incorrect:
21662 .code
21663 list1    :include:/opt/lists/list1
21664 .endd
21665 It must be given as
21666 .code
21667 list1:   :include:/opt/lists/list1
21668 .endd
21669 .cindex "tainted data" "in filenames"
21670 .cindex redirect "tainted data"
21671 Tainted data may not be used for a filename.
21672 .next
21673 .cindex "address redirection" "to black hole"
21674 .cindex "delivery" "discard"
21675 .cindex "delivery" "blackhole"
21676 .cindex "black hole"
21677 .cindex "abandoning mail"
21678 Sometimes you want to throw away mail to a particular local part.  Making the
21679 &%data%& option expand to an empty string does not work, because that causes
21680 the router to decline. Instead, the alias item
21681 .code
21682 :blackhole:
21683 .endd
21684 can be used. It does what its name implies. No delivery is
21685 done, and no error message is generated. This has the same effect as specifying
21686 &_/dev/null_& as a destination, but it can be independently disabled.
21687
21688 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21689 delivery is done for the original local part, even if other redirection items
21690 are present. If you are generating a multi-item list (for example, by reading a
21691 database) and need the ability to provide a no-op item, you must use
21692 &_/dev/null_&.
21693
21694 .next
21695 .cindex "delivery" "forcing failure"
21696 .cindex "delivery" "forcing deferral"
21697 .cindex "failing delivery" "forcing"
21698 .cindex "deferred delivery, forcing"
21699 .cindex "customizing" "failure message"
21700 An attempt to deliver a particular address can be deferred or forced to fail by
21701 redirection items of the form
21702 .code
21703 :defer:
21704 :fail:
21705 .endd
21706 respectively. When a redirection list contains such an item, it applies
21707 to the entire redirection; any other items in the list are ignored. Any
21708 text following &':fail:'& or &':defer:'& is placed in the error text
21709 associated with the failure. For example, an alias file might contain:
21710 .code
21711 X.Employee:  :fail: Gone away, no forwarding address
21712 .endd
21713 In the case of an address that is being verified from an ACL or as the subject
21714 of a
21715 .cindex "VRFY" "error text, display of"
21716 VRFY command, the text is included in the SMTP error response by
21717 default.
21718 .cindex "EXPN" "error text, display of"
21719 The text is not included in the response to an EXPN command. In non-SMTP cases
21720 the text is included in the error message that Exim generates.
21721
21722 .cindex "SMTP" "error codes"
21723 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21724 &':fail:'&. However, if the message starts with three digits followed by a
21725 space, optionally followed by an extended code of the form &'n.n.n'&, also
21726 followed by a space, and the very first digit is the same as the default error
21727 code, the code from the message is used instead. If the very first digit is
21728 incorrect, a panic error is logged, and the default code is used. You can
21729 suppress the use of the supplied code in a redirect router by setting the
21730 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21731 ignored.
21732
21733 .vindex "&$acl_verify_message$&"
21734 In an ACL, an explicitly provided message overrides the default, but the
21735 default message is available in the variable &$acl_verify_message$& and can
21736 therefore be included in a custom message if this is desired.
21737
21738 Normally the error text is the rest of the redirection list &-- a comma does
21739 not terminate it &-- but a newline does act as a terminator. Newlines are not
21740 normally present in alias expansions. In &(lsearch)& lookups they are removed
21741 as part of the continuation process, but they may exist in other kinds of
21742 lookup and in &':include:'& files.
21743
21744 During routing for message delivery (as opposed to verification), a redirection
21745 containing &':fail:'& causes an immediate failure of the incoming address,
21746 whereas &':defer:'& causes the message to remain in the queue so that a
21747 subsequent delivery attempt can happen at a later time. If an address is
21748 deferred for too long, it will ultimately fail, because the normal retry
21749 rules still apply.
21750
21751 .next
21752 .cindex "alias file" "exception to default"
21753 Sometimes it is useful to use a single-key search type with a default (see
21754 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21755 for exceptions to the default. These can be handled by aliasing them to
21756 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21757 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21758 results in an empty redirection list has the same effect.
21759 .endlist
21760
21761
21762 .section "Duplicate addresses" "SECTdupaddr"
21763 .cindex "duplicate addresses"
21764 .cindex "address duplicate, discarding"
21765 .cindex "pipe" "duplicated"
21766 Exim removes duplicate addresses from the list to which it is delivering, so as
21767 to deliver just one copy to each address. This does not apply to deliveries
21768 routed to pipes by different immediate parent addresses, but an indirect
21769 aliasing scheme of the type
21770 .code
21771 pipe:       |/some/command $local_part
21772 localpart1: pipe
21773 localpart2: pipe
21774 .endd
21775 does not work with a message that is addressed to both local parts, because
21776 when the second is aliased to the intermediate local part &"pipe"& it gets
21777 discarded as being the same as a previously handled address. However, a scheme
21778 such as
21779 .code
21780 localpart1: |/some/command $local_part
21781 localpart2: |/some/command $local_part
21782 .endd
21783 does result in two different pipe deliveries, because the immediate parents of
21784 the pipes are distinct.
21785
21786
21787
21788 .section "Repeated redirection expansion" "SECID128"
21789 .cindex "repeated redirection expansion"
21790 .cindex "address redirection" "repeated for each delivery attempt"
21791 When a message cannot be delivered to all of its recipients immediately,
21792 leading to two or more delivery attempts, redirection expansion is carried out
21793 afresh each time for those addresses whose children were not all previously
21794 delivered. If redirection is being used as a mailing list, this can lead to new
21795 members of the list receiving copies of old messages. The &%one_time%& option
21796 can be used to avoid this.
21797
21798
21799 .section "Errors in redirection lists" "SECID129"
21800 .cindex "address redirection" "errors"
21801 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21802 error is skipped, and an entry is written to the main log. This may be useful
21803 for mailing lists that are automatically managed. Otherwise, if an error is
21804 detected while generating the list of new addresses, the original address is
21805 deferred. See also &%syntax_errors_to%&.
21806
21807
21808
21809 .section "Private options for the redirect router" "SECID130"
21810
21811 .cindex "options" "&(redirect)& router"
21812 The private options for the &(redirect)& router are as follows:
21813
21814
21815 .option allow_defer redirect boolean false
21816 Setting this option allows the use of &':defer:'& in non-filter redirection
21817 data, or the &%defer%& command in an Exim filter file.
21818
21819
21820 .option allow_fail redirect boolean false
21821 .cindex "failing delivery" "from filter"
21822 If this option is true, the &':fail:'& item can be used in a redirection list,
21823 and the &%fail%& command may be used in an Exim filter file.
21824
21825
21826 .option allow_filter redirect boolean false
21827 .cindex "filter" "enabling use of"
21828 .cindex "Sieve filter" "enabling use of"
21829 Setting this option allows Exim to interpret redirection data that starts with
21830 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21831 are some features of Exim filter files that some administrators may wish to
21832 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21833
21834 It is also possible to lock out Exim filters or Sieve filters while allowing
21835 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21836
21837
21838 The filter is run using the uid and gid set by the generic &%user%& and
21839 &%group%& options. These take their defaults from the password data if
21840 &%check_local_user%& is set, so in the normal case of users' personal filter
21841 files, the filter is run as the relevant user. When &%allow_filter%& is set
21842 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21843
21844
21845
21846 .option allow_freeze redirect boolean false
21847 .cindex "freezing messages" "allowing in filter"
21848 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21849 This command is more normally encountered in system filters, and is disabled by
21850 default for redirection filters because it isn't something you usually want to
21851 let ordinary users do.
21852
21853
21854
21855 .option check_ancestor redirect boolean false
21856 This option is concerned with handling generated addresses that are the same
21857 as some address in the list of redirection ancestors of the current address.
21858 Although it is turned off by default in the code, it is set in the default
21859 configuration file for handling users' &_.forward_& files. It is recommended
21860 for this use of the &(redirect)& router.
21861
21862 When &%check_ancestor%& is set, if a generated address (including the domain)
21863 is the same as any ancestor of the current address, it is replaced by a copy of
21864 the current address. This helps in the case where local part A is aliased to B,
21865 and B has a &_.forward_& file pointing back to A. For example, within a single
21866 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21867 &_&~jb/.forward_& contains:
21868 .code
21869 \Joe.Bloggs, <other item(s)>
21870 .endd
21871 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21872 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21873 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21874 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21875 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21876 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21877 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21878 original address. See also the &%repeat_use%& option below.
21879
21880
21881 .option check_group redirect boolean "see below"
21882 When the &%file%& option is used, the group owner of the file is checked only
21883 when this option is set. The permitted groups are those listed in the
21884 &%owngroups%& option, together with the user's default group if
21885 &%check_local_user%& is set. If the file has the wrong group, routing is
21886 deferred. The default setting for this option is true if &%check_local_user%&
21887 is set and the &%modemask%& option permits the group write bit, or if the
21888 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21889
21890
21891
21892 .option check_owner redirect boolean "see below"
21893 When the &%file%& option is used, the owner of the file is checked only when
21894 this option is set. If &%check_local_user%& is set, the local user is
21895 permitted; otherwise the owner must be one of those listed in the &%owners%&
21896 option. The default value for this option is true if &%check_local_user%& or
21897 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21898
21899
21900 .option data redirect string&!! unset
21901 This option is mutually exclusive with &%file%&. One or other of them must be
21902 set, but not both. The contents of &%data%& are expanded, and then used as the
21903 list of forwarding items, or as a set of filtering instructions. If the
21904 expansion is forced to fail, or the result is an empty string or a string that
21905 has no effect (consists entirely of comments), the router declines.
21906
21907 When filtering instructions are used, the string must begin with &"#Exim
21908 filter"&, and all comments in the string, including this initial one, must be
21909 terminated with newline characters. For example:
21910 .code
21911 data = #Exim filter\n\
21912        if $h_to: contains Exim then save $home/mail/exim endif
21913 .endd
21914 If you are reading the data from a database where newlines cannot be included,
21915 you can use the &${sg}$& expansion item to turn the escape string of your
21916 choice into a newline.
21917
21918
21919 .option directory_transport redirect string&!! unset
21920 A &(redirect)& router sets up a direct delivery to a directory when a path name
21921 ending with a slash is specified as a new &"address"&. The transport used is
21922 specified by this option, which, after expansion, must be the name of a
21923 configured transport. This should normally be an &(appendfile)& transport.
21924
21925
21926 .option file redirect string&!! unset
21927 This option specifies the name of a file that contains the redirection data. It
21928 is mutually exclusive with the &%data%& option. The string is expanded before
21929 use; if the expansion is forced to fail, the router declines. Other expansion
21930 failures cause delivery to be deferred. The result of a successful expansion
21931 must be an absolute path. The entire file is read and used as the redirection
21932 data. If the data is an empty string or a string that has no effect (consists
21933 entirely of comments), the router declines.
21934
21935 .cindex "NFS" "checking for file existence"
21936 If the attempt to open the file fails with a &"does not exist"& error, Exim
21937 runs a check on the containing directory,
21938 unless &%ignore_enotdir%& is true (see below).
21939 If the directory does not appear to exist, delivery is deferred. This can
21940 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21941 is a mount problem. If the containing directory does exist, but the file does
21942 not, the router declines.
21943
21944
21945 .option file_transport redirect string&!! unset
21946 .vindex "&$address_file$&"
21947 A &(redirect)& router sets up a direct delivery to a file when a path name not
21948 ending in a slash is specified as a new &"address"&. The transport used is
21949 specified by this option, which, after expansion, must be the name of a
21950 configured transport. This should normally be an &(appendfile)& transport. When
21951 it is running, the filename is in &$address_file$&.
21952
21953
21954 .option filter_prepend_home redirect boolean true
21955 When this option is true, if a &(save)& command in an Exim filter specifies a
21956 relative path, and &$home$& is defined, it is automatically prepended to the
21957 relative path. If this option is set false, this action does not happen. The
21958 relative path is then passed to the transport unmodified.
21959
21960
21961 .option forbid_blackhole redirect boolean false
21962 .cindex "restricting access to features"
21963 .cindex "filter" "locking out certain features"
21964 If this option is true, the &':blackhole:'& item may not appear in a
21965 redirection list.
21966
21967
21968 .option forbid_exim_filter redirect boolean false
21969 .cindex "restricting access to features"
21970 .cindex "filter" "locking out certain features"
21971 If this option is set true, only Sieve filters are permitted when
21972 &%allow_filter%& is true.
21973
21974
21975
21976
21977 .option forbid_file redirect boolean false
21978 .cindex "restricting access to features"
21979 .cindex "delivery" "to file; forbidding"
21980 .cindex "filter" "locking out certain features"
21981 .cindex "Sieve filter" "forbidding delivery to a file"
21982 .cindex "Sieve filter" "&""keep""& facility; disabling"
21983 If this option is true, this router may not generate a new address that
21984 specifies delivery to a local file or directory, either from a filter or from a
21985 conventional forward file. This option is forced to be true if &%one_time%& is
21986 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21987 locks out the Sieve's &"keep"& facility.
21988
21989
21990 .option forbid_filter_dlfunc redirect boolean false
21991 .cindex "restricting access to features"
21992 .cindex "filter" "locking out certain features"
21993 If this option is true, string expansions in Exim filters are not allowed to
21994 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21995 functions.
21996
21997 .option forbid_filter_existstest redirect boolean false
21998 .cindex "restricting access to features"
21999 .cindex "filter" "locking out certain features"
22000 .cindex "expansion" "statting a file"
22001 If this option is true, string expansions in Exim filters are not allowed to
22002 make use of the &%exists%& condition or the &%stat%& expansion item.
22003
22004 .option forbid_filter_logwrite redirect boolean false
22005 .cindex "restricting access to features"
22006 .cindex "filter" "locking out certain features"
22007 If this option is true, use of the logging facility in Exim filters is not
22008 permitted. Logging is in any case available only if the filter is being run
22009 under some unprivileged uid (which is normally the case for ordinary users'
22010 &_.forward_& files).
22011
22012
22013 .option forbid_filter_lookup redirect boolean false
22014 .cindex "restricting access to features"
22015 .cindex "filter" "locking out certain features"
22016 If this option is true, string expansions in Exim filter files are not allowed
22017 to make use of &%lookup%& items.
22018
22019
22020 .option forbid_filter_perl redirect boolean false
22021 .cindex "restricting access to features"
22022 .cindex "filter" "locking out certain features"
22023 This option has an effect only if Exim is built with embedded Perl support. If
22024 it is true, string expansions in Exim filter files are not allowed to make use
22025 of the embedded Perl support.
22026
22027
22028 .option forbid_filter_readfile redirect boolean false
22029 .cindex "restricting access to features"
22030 .cindex "filter" "locking out certain features"
22031 If this option is true, string expansions in Exim filter files are not allowed
22032 to make use of &%readfile%& items.
22033
22034
22035 .option forbid_filter_readsocket redirect boolean false
22036 .cindex "restricting access to features"
22037 .cindex "filter" "locking out certain features"
22038 If this option is true, string expansions in Exim filter files are not allowed
22039 to make use of &%readsocket%& items.
22040
22041
22042 .option forbid_filter_reply redirect boolean false
22043 .cindex "restricting access to features"
22044 .cindex "filter" "locking out certain features"
22045 If this option is true, this router may not generate an automatic reply
22046 message. Automatic replies can be generated only from Exim or Sieve filter
22047 files, not from traditional forward files. This option is forced to be true if
22048 &%one_time%& is set.
22049
22050
22051 .option forbid_filter_run redirect boolean false
22052 .cindex "restricting access to features"
22053 .cindex "filter" "locking out certain features"
22054 If this option is true, string expansions in Exim filter files are not allowed
22055 to make use of &%run%& items.
22056
22057
22058 .option forbid_include redirect boolean false
22059 .cindex "restricting access to features"
22060 .cindex "filter" "locking out certain features"
22061 If this option is true, items of the form
22062 .code
22063 :include:<path name>
22064 .endd
22065 are not permitted in non-filter redirection lists.
22066
22067
22068 .option forbid_pipe redirect boolean false
22069 .cindex "restricting access to features"
22070 .cindex "filter" "locking out certain features"
22071 .cindex "delivery" "to pipe; forbidding"
22072 If this option is true, this router may not generate a new address which
22073 specifies delivery to a pipe, either from an Exim filter or from a conventional
22074 forward file. This option is forced to be true if &%one_time%& is set.
22075
22076
22077 .option forbid_sieve_filter redirect boolean false
22078 .cindex "restricting access to features"
22079 .cindex "filter" "locking out certain features"
22080 If this option is set true, only Exim filters are permitted when
22081 &%allow_filter%& is true.
22082
22083
22084 .cindex "SMTP" "error codes"
22085 .option forbid_smtp_code redirect boolean false
22086 If this option is set true, any SMTP error codes that are present at the start
22087 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
22088 the default codes (451 and 550, respectively) are always used.
22089
22090
22091
22092
22093 .option hide_child_in_errmsg redirect boolean false
22094 .cindex "bounce message" "redirection details; suppressing"
22095 If this option is true, it prevents Exim from quoting a child address if it
22096 generates a bounce or delay message for it. Instead it says &"an address
22097 generated from <&'the top level address'&>"&. Of course, this applies only to
22098 bounces generated locally. If a message is forwarded to another host, &'its'&
22099 bounce may well quote the generated address.
22100
22101
22102 .option ignore_eacces redirect boolean false
22103 .cindex "EACCES"
22104 If this option is set and an attempt to open a redirection file yields the
22105 EACCES error (permission denied), the &(redirect)& router behaves as if the
22106 file did not exist.
22107
22108
22109 .option ignore_enotdir redirect boolean false
22110 .cindex "ENOTDIR"
22111 If this option is set and an attempt to open a redirection file yields the
22112 ENOTDIR error (something on the path is not a directory), the &(redirect)&
22113 router behaves as if the file did not exist.
22114
22115 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
22116 router that has the &%file%& option set discovers that the file does not exist
22117 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
22118 against unmounted NFS directories. If the parent can not be statted, delivery
22119 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
22120 is set, because that option tells Exim to ignore &"something on the path is not
22121 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
22122 that some operating systems give ENOENT where others give ENOTDIR.
22123
22124
22125
22126 .option include_directory redirect string unset
22127 If this option is set, the path names of any &':include:'& items in a
22128 redirection list must start with this directory.
22129
22130
22131 .option modemask redirect "octal integer" 022
22132 This specifies mode bits which must not be set for a file specified by the
22133 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22134
22135
22136 .option one_time redirect boolean false
22137 .cindex "one-time aliasing/forwarding expansion"
22138 .cindex "alias file" "one-time expansion"
22139 .cindex "forward file" "one-time expansion"
22140 .cindex "mailing lists" "one-time expansion"
22141 .cindex "address redirection" "one-time expansion"
22142 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22143 files each time it tries to deliver a message causes a problem when one or more
22144 of the generated addresses fails be delivered at the first attempt. The problem
22145 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22146 but of what happens when the redirection list changes during the time that the
22147 message is on Exim's queue. This is particularly true in the case of mailing
22148 lists, where new subscribers might receive copies of messages that were posted
22149 before they subscribed.
22150
22151 If &%one_time%& is set and any addresses generated by the router fail to
22152 deliver at the first attempt, the failing addresses are added to the message as
22153 &"top level"& addresses, and the parent address that generated them is marked
22154 &"delivered"&. Thus, redirection does not happen again at the next delivery
22155 attempt.
22156
22157 &*Warning 1*&: Any header line addition or removal that is specified by this
22158 router would be lost if delivery did not succeed at the first attempt. For this
22159 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22160 permitted when &%one_time%& is set.
22161
22162 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22163 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22164 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22165
22166 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22167 &%one_time%&.
22168
22169 The original top-level address is remembered with each of the generated
22170 addresses, and is output in any log messages. However, any intermediate parent
22171 addresses are not recorded. This makes a difference to the log only if
22172 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22173 typically be used for mailing lists, where there is normally just one level of
22174 expansion.
22175
22176
22177 .option owners redirect "string list" unset
22178 .cindex "ownership" "alias file"
22179 .cindex "ownership" "forward file"
22180 .cindex "alias file" "ownership"
22181 .cindex "forward file" "ownership"
22182 This specifies a list of permitted owners for the file specified by &%file%&.
22183 This list is in addition to the local user when &%check_local_user%& is set.
22184 See &%check_owner%& above.
22185
22186
22187 .option owngroups redirect "string list" unset
22188 This specifies a list of permitted groups for the file specified by &%file%&.
22189 The list is in addition to the local user's primary group when
22190 &%check_local_user%& is set. See &%check_group%& above.
22191
22192
22193 .option pipe_transport redirect string&!! unset
22194 .vindex "&$address_pipe$&"
22195 A &(redirect)& router sets up a direct delivery to a pipe when a string
22196 starting with a vertical bar character is specified as a new &"address"&. The
22197 transport used is specified by this option, which, after expansion, must be the
22198 name of a configured transport. This should normally be a &(pipe)& transport.
22199 When the transport is run, the pipe command is in &$address_pipe$&.
22200
22201
22202 .option qualify_domain redirect string&!! unset
22203 .vindex "&$qualify_recipient$&"
22204 If this option is set, and an unqualified address (one without a domain) is
22205 generated, and that address would normally be qualified by the global setting
22206 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22207 expanding this string. If the expansion fails, the router declines. If you want
22208 to revert to the default, you can have the expansion generate
22209 &$qualify_recipient$&.
22210
22211 This option applies to all unqualified addresses generated by Exim filters,
22212 but for traditional &_.forward_& files, it applies only to addresses that are
22213 not preceded by a backslash. Sieve filters cannot generate unqualified
22214 addresses.
22215
22216 .option qualify_preserve_domain redirect boolean false
22217 .cindex "domain" "in redirection; preserving"
22218 .cindex "preserving domain in redirection"
22219 .cindex "address redirection" "domain; preserving"
22220 If this option is set, the router's local &%qualify_domain%& option must not be
22221 set (a configuration error occurs if it is). If an unqualified address (one
22222 without a domain) is generated, it is qualified with the domain of the parent
22223 address (the immediately preceding ancestor) instead of the global
22224 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22225 this applies whether or not the address is preceded by a backslash.
22226
22227
22228 .option repeat_use redirect boolean true
22229 If this option is set false, the router is skipped for a child address that has
22230 any ancestor that was routed by this router. This test happens before any of
22231 the other preconditions are tested. Exim's default anti-looping rules skip
22232 only when the ancestor is the same as the current address. See also
22233 &%check_ancestor%& above and the generic &%redirect_router%& option.
22234
22235
22236 .option reply_transport redirect string&!! unset
22237 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22238 &%vacation%& command is used in a filter file. The transport used is specified
22239 by this option, which, after expansion, must be the name of a configured
22240 transport. This should normally be an &(autoreply)& transport. Other transports
22241 are unlikely to do anything sensible or useful.
22242
22243
22244 .option rewrite redirect boolean true
22245 .cindex "address redirection" "disabling rewriting"
22246 If this option is set false, addresses generated by the router are not
22247 subject to address rewriting. Otherwise, they are treated like new addresses
22248 and are rewritten according to the global rewriting rules.
22249
22250
22251 .option sieve_inbox redirect string&!! inbox
22252 .new
22253 The value of this option is passed to a Sieve filter to specify the
22254 name of the mailbox used for "keep" operations (explicit or implicit).
22255 .wen
22256
22257 .option sieve_subaddress redirect string&!! unset
22258 The value of this option is passed to a Sieve filter to specify the
22259 :subaddress part of an address.
22260
22261 .option sieve_useraddress redirect string&!! unset
22262 The value of this option is passed to a Sieve filter to specify the :user part
22263 of an address. However, if it is unset, the entire original local part
22264 (including any prefix or suffix) is used for :user.
22265
22266
22267 .option sieve_vacation_directory redirect string&!! unset
22268 .cindex "Sieve filter" "vacation directory"
22269 To enable the &"vacation"& extension for Sieve filters, you must set
22270 &%sieve_vacation_directory%& to the directory where vacation databases are held
22271 (do not put anything else in that directory), and ensure that the
22272 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22273 needs their own directory; Exim will create it if necessary.
22274
22275
22276
22277 .option skip_syntax_errors redirect boolean false
22278 .cindex "forward file" "broken"
22279 .cindex "address redirection" "broken files"
22280 .cindex "alias file" "broken"
22281 .cindex "broken alias or forward files"
22282 .cindex "ignoring faulty addresses"
22283 .cindex "skipping faulty addresses"
22284 .cindex "error" "skipping bad syntax"
22285 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22286 non-filter redirection data are skipped, and each failing address is logged. If
22287 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22288 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22289 are expanded and placed at the head of the error message generated by
22290 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22291 be the same address as the generic &%errors_to%& option. The
22292 &%skip_syntax_errors%& option is often used when handling mailing lists.
22293
22294 If all the addresses in a redirection list are skipped because of syntax
22295 errors, the router declines to handle the original address, and it is passed to
22296 the following routers.
22297
22298 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22299 error in the filter causes filtering to be abandoned without any action being
22300 taken. The incident is logged, and the router declines to handle the address,
22301 so it is passed to the following routers.
22302
22303 .cindex "Sieve filter" "syntax errors in"
22304 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22305 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22306 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22307
22308 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22309 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22310 option, used with an address that does not get redirected, can be used to
22311 notify users of these errors, by means of a router like this:
22312 .code
22313 userforward:
22314   driver = redirect
22315   allow_filter
22316   check_local_user
22317   file = $home/.forward
22318   file_transport = address_file
22319   pipe_transport = address_pipe
22320   reply_transport = address_reply
22321   no_verify
22322   skip_syntax_errors
22323   syntax_errors_to = real-$local_part@$domain
22324   syntax_errors_text = \
22325    This is an automatically generated message. An error has\n\
22326    been found in your .forward file. Details of the error are\n\
22327    reported below. While this error persists, you will receive\n\
22328    a copy of this message for every message that is addressed\n\
22329    to you. If your .forward file is a filter file, or if it is\n\
22330    a non-filter file containing no valid forwarding addresses,\n\
22331    a copy of each incoming message will be put in your normal\n\
22332    mailbox. If a non-filter file contains at least one valid\n\
22333    forwarding address, forwarding to the valid addresses will\n\
22334    happen, and those will be the only deliveries that occur.
22335 .endd
22336 You also need a router to ensure that local addresses that are prefixed by
22337 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22338 put this immediately before the &(userforward)& router:
22339 .code
22340 real_localuser:
22341   driver = accept
22342   check_local_user
22343   local_part_prefix = real-
22344   transport = local_delivery
22345 .endd
22346 For security, it would probably be a good idea to restrict the use of this
22347 router to locally-generated messages, using a condition such as this:
22348 .code
22349   condition = ${if match {$sender_host_address}\
22350                          {\N^(|127\.0\.0\.1)$\N}}
22351 .endd
22352
22353
22354 .option syntax_errors_text redirect string&!! unset
22355 See &%skip_syntax_errors%& above.
22356
22357
22358 .option syntax_errors_to redirect string unset
22359 See &%skip_syntax_errors%& above.
22360 .ecindex IIDredrou1
22361 .ecindex IIDredrou2
22362
22363
22364
22365
22366
22367
22368 . ////////////////////////////////////////////////////////////////////////////
22369 . ////////////////////////////////////////////////////////////////////////////
22370
22371 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22372          "Environment for local transports"
22373 .scindex IIDenvlotra1 "local transports" "environment for"
22374 .scindex IIDenvlotra2 "environment" "local transports"
22375 .scindex IIDenvlotra3 "transport" "local; environment for"
22376 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22377 transport can be thought of as similar to a pipe.) Exim always runs transports
22378 in subprocesses, under specified uids and gids. Typical deliveries to local
22379 mailboxes run under the uid and gid of the local user.
22380
22381 Exim also sets a specific current directory while running the transport; for
22382 some transports a home directory setting is also relevant. The &(pipe)&
22383 transport is the only one that sets up environment variables; see section
22384 &<<SECTpipeenv>>& for details.
22385
22386 The values used for the uid, gid, and the directories may come from several
22387 different places. In many cases, the router that handles the address associates
22388 settings with that address as a result of its &%check_local_user%&, &%group%&,
22389 or &%user%& options. However, values may also be given in the transport's own
22390 configuration, and these override anything that comes from the router.
22391
22392
22393
22394 .section "Concurrent deliveries" "SECID131"
22395 .cindex "concurrent deliveries"
22396 .cindex "simultaneous deliveries"
22397 If two different messages for the same local recipient arrive more or less
22398 simultaneously, the two delivery processes are likely to run concurrently. When
22399 the &(appendfile)& transport is used to write to a file, Exim applies locking
22400 rules to stop concurrent processes from writing to the same file at the same
22401 time.
22402
22403 However, when you use a &(pipe)& transport, it is up to you to arrange any
22404 locking that is needed. Here is a silly example:
22405 .code
22406 my_transport:
22407   driver = pipe
22408   command = /bin/sh -c 'cat >>/some/file'
22409 .endd
22410 This is supposed to write the message at the end of the file. However, if two
22411 messages arrive at the same time, the file will be scrambled. You can use the
22412 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22413 file using the same algorithm that Exim itself uses.
22414
22415
22416
22417
22418 .section "Uids and gids" "SECTenvuidgid"
22419 .cindex "local transports" "uid and gid"
22420 .cindex "transport" "local; uid and gid"
22421 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22422 overrides any group that the router set in the address, even if &%user%& is not
22423 set for the transport. This makes it possible, for example, to run local mail
22424 delivery under the uid of the recipient (set by the router), but in a special
22425 group (set by the transport). For example:
22426 .code
22427 # Routers ...
22428 # User/group are set by check_local_user in this router
22429 local_users:
22430   driver = accept
22431   check_local_user
22432   transport = group_delivery
22433
22434 # Transports ...
22435 # This transport overrides the group
22436 group_delivery:
22437   driver = appendfile
22438   file = /var/spool/mail/$local_part_data
22439   group = mail
22440 .endd
22441 If &%user%& is set for a transport, its value overrides what is set in the
22442 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22443 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22444 set.
22445
22446 .oindex "&%initgroups%&"
22447 When the uid is taken from the transport's configuration, the &[initgroups()]&
22448 function is called for the groups associated with that uid if the
22449 &%initgroups%& option is set for the transport. When the uid is not specified
22450 by the transport, but is associated with the address by a router, the option
22451 for calling &[initgroups()]& is taken from the router configuration.
22452
22453 .cindex "&(pipe)& transport" "uid for"
22454 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22455 is set and &%user%& is not set, the uid of the process that called Exim to
22456 receive the message is used, and if &%group%& is not set, the corresponding
22457 original gid is also used.
22458
22459 This is the detailed preference order for obtaining a gid; the first of the
22460 following that is set is used:
22461
22462 .ilist
22463 A &%group%& setting of the transport;
22464 .next
22465 A &%group%& setting of the router;
22466 .next
22467 A gid associated with a user setting of the router, either as a result of
22468 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22469 .next
22470 The group associated with a non-numeric &%user%& setting of the transport;
22471 .next
22472 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22473 the uid is the creator's uid;
22474 .next
22475 The Exim gid if the Exim uid is being used as a default.
22476 .endlist
22477
22478 If, for example, the user is specified numerically on the router and there are
22479 no group settings, no gid is available. In this situation, an error occurs.
22480 This is different for the uid, for which there always is an ultimate default.
22481 The first of the following that is set is used:
22482
22483 .ilist
22484 A &%user%& setting of the transport;
22485 .next
22486 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22487 .next
22488 A &%user%& setting of the router;
22489 .next
22490 A &%check_local_user%& setting of the router;
22491 .next
22492 The Exim uid.
22493 .endlist
22494
22495 Of course, an error will still occur if the uid that is chosen is on the
22496 &%never_users%& list.
22497
22498
22499
22500
22501
22502 .section "Current and home directories" "SECID132"
22503 .cindex "current directory for local transport"
22504 .cindex "home directory" "for local transport"
22505 .cindex "transport" "local; home directory for"
22506 .cindex "transport" "local; current directory for"
22507 Routers may set current and home directories for local transports by means of
22508 the &%transport_current_directory%& and &%transport_home_directory%& options.
22509 However, if the transport's &%current_directory%& or &%home_directory%& options
22510 are set, they override the router's values. In detail, the home directory
22511 for a local transport is taken from the first of these values that is set:
22512
22513 .ilist
22514 The &%home_directory%& option on the transport;
22515 .next
22516 The &%transport_home_directory%& option on the router;
22517 .next
22518 The password data if &%check_local_user%& is set on the router;
22519 .next
22520 The &%router_home_directory%& option on the router.
22521 .endlist
22522
22523 The current directory is taken from the first of these values that is set:
22524
22525 .ilist
22526 The &%current_directory%& option on the transport;
22527 .next
22528 The &%transport_current_directory%& option on the router.
22529 .endlist
22530
22531
22532 If neither the router nor the transport sets a current directory, Exim uses the
22533 value of the home directory, if it is set. Otherwise it sets the current
22534 directory to &_/_& before running a local transport.
22535
22536
22537
22538 .section "Expansion variables derived from the address" "SECID133"
22539 .vindex "&$domain$&"
22540 .vindex "&$local_part$&"
22541 .vindex "&$original_domain$&"
22542 Normally a local delivery is handling a single address, and in that case the
22543 variables such as &$domain$& and &$local_part$& are set during local
22544 deliveries. However, in some circumstances more than one address may be handled
22545 at once (for example, while writing batch SMTP for onward transmission by some
22546 other means). In this case, the variables associated with the local part are
22547 never set, &$domain$& is set only if all the addresses have the same domain,
22548 and &$original_domain$& is never set.
22549 .ecindex IIDenvlotra1
22550 .ecindex IIDenvlotra2
22551 .ecindex IIDenvlotra3
22552
22553
22554
22555
22556
22557
22558
22559 . ////////////////////////////////////////////////////////////////////////////
22560 . ////////////////////////////////////////////////////////////////////////////
22561
22562 .chapter "Generic options for transports" "CHAPtransportgeneric"
22563 .scindex IIDgenoptra1 "generic options" "transport"
22564 .scindex IIDgenoptra2 "options" "generic; for transports"
22565 .scindex IIDgenoptra3 "transport" "generic options for"
22566 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22567 prior to Exim 4.95 names would be silently truncated at this length, but now
22568 it is enforced.
22569
22570 The following generic options apply to all transports:
22571
22572
22573 .option body_only transports boolean false
22574 .cindex "transport" "body only"
22575 .cindex "message" "transporting body only"
22576 .cindex "body of message" "transporting"
22577 If this option is set, the message's headers are not transported. It is
22578 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22579 or &(pipe)& transports, the settings of &%message_prefix%& and
22580 &%message_suffix%& should be checked, because this option does not
22581 automatically suppress them.
22582
22583
22584 .option current_directory transports string&!! unset
22585 .cindex "transport" "current directory for"
22586 This specifies the current directory that is to be set while running the
22587 transport, overriding any value that may have been set by the router.
22588 If the expansion fails for any reason, including forced failure, an error is
22589 logged, and delivery is deferred.
22590
22591
22592 .option disable_logging transports boolean false
22593 If this option is set true, nothing is logged for any
22594 deliveries by the transport or for any
22595 transport errors. You should not set this option unless you really, really know
22596 what you are doing.
22597
22598
22599 .option debug_print transports string&!! unset
22600 .cindex "testing" "variables in drivers"
22601 If this option is set and debugging is enabled (see the &%-d%& command line
22602 option), the string is expanded and included in the debugging output when the
22603 transport is run.
22604 If expansion of the string fails, the error message is written to the debugging
22605 output, and Exim carries on processing.
22606 This facility is provided to help with checking out the values of variables and
22607 so on when debugging driver configurations. For example, if a &%headers_add%&
22608 option is not working properly, &%debug_print%& could be used to output the
22609 variables it references. A newline is added to the text if it does not end with
22610 one.
22611 The variables &$transport_name$& and &$router_name$& contain the name of the
22612 transport and the router that called it.
22613
22614 .option delivery_date_add transports boolean false
22615 .cindex "&'Delivery-date:'& header line"
22616 If this option is true, a &'Delivery-date:'& header is added to the message.
22617 This gives the actual time the delivery was made. As this is not a standard
22618 header, Exim has a configuration option (&%delivery_date_remove%&) which
22619 requests its removal from incoming messages, so that delivered messages can
22620 safely be resent to other recipients.
22621
22622
22623 .option driver transports string unset
22624 This specifies which of the available transport drivers is to be used.
22625 There is no default, and this option must be set for every transport.
22626
22627
22628 .option envelope_to_add transports boolean false
22629 .cindex "&'Envelope-to:'& header line"
22630 If this option is true, an &'Envelope-to:'& header is added to the message.
22631 This gives the original address(es) in the incoming envelope that caused this
22632 delivery to happen. More than one address may be present if the transport is
22633 configured to handle several addresses at once, or if more than one original
22634 address was redirected to the same final address. As this is not a standard
22635 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22636 its removal from incoming messages, so that delivered messages can safely be
22637 resent to other recipients.
22638
22639 &*Note:*& If used on a transport handling multiple recipients
22640 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22641 transport if &%batch_max%& is greater than 1)
22642 then information about Bcc recipients will be leaked.
22643 Doing so is generally not advised.
22644
22645
22646 .option event_action transports string&!! unset
22647 .cindex events
22648 This option declares a string to be expanded for Exim's events mechanism.
22649 For details see chapter &<<CHAPevents>>&.
22650
22651
22652 .option group transports string&!! "Exim group"
22653 .cindex "transport" "group; specifying"
22654 This option specifies a gid for running the transport process, overriding any
22655 value that the router supplies, and also overriding any value associated with
22656 &%user%& (see below).
22657
22658
22659 .option headers_add transports list&!! unset
22660 .cindex "header lines" "adding in transport"
22661 .cindex "transport" "header lines; adding"
22662 This option specifies a list of text headers,
22663 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22664 which are (separately) expanded and added to the header
22665 portion of a message as it is transported, as described in section
22666 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22667 routers. If the result of the expansion is an empty string, or if the expansion
22668 is forced to fail, no action is taken. Other expansion failures are treated as
22669 errors and cause the delivery to be deferred.
22670
22671 Unlike most options, &%headers_add%& can be specified multiple times
22672 for a transport; all listed headers are added.
22673
22674
22675 .option headers_only transports boolean false
22676 .cindex "transport" "header lines only"
22677 .cindex "message" "transporting headers only"
22678 .cindex "header lines" "transporting"
22679 If this option is set, the message's body is not transported. It is mutually
22680 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22681 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22682 checked, since this option does not automatically suppress them.
22683
22684
22685 .option headers_remove transports list&!! unset
22686 .cindex "header lines" "removing"
22687 .cindex "transport" "header lines; removing"
22688 This option specifies a list of text headers,
22689 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22690 to be removed from the message.
22691 However, the option has no effect when an address is just being verified.
22692 Each list item is separately expanded.
22693 If the result of the expansion is an empty string, or if the expansion
22694 is forced to fail, no action is taken. Other expansion failures are treated as
22695 errors and cause the delivery to be deferred.
22696 If an item ends in *, it will match any header with the given prefix.
22697
22698 Matching headers are omitted from the message as it is transported, as described
22699 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22700 routers.
22701
22702 Unlike most options, &%headers_remove%& can be specified multiple times
22703 for a transport; all listed headers are removed.
22704
22705 &*Warning*&: Because of the separate expansion of the list items,
22706 items that contain a list separator must have it doubled.
22707 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22708
22709
22710
22711 .option headers_rewrite transports string unset
22712 .cindex "transport" "header lines; rewriting"
22713 .cindex "rewriting" "at transport time"
22714 This option allows addresses in header lines to be rewritten at transport time,
22715 that is, as the message is being copied to its destination. The contents of the
22716 option are a colon-separated list of rewriting rules. Each rule is in exactly
22717 the same form as one of the general rewriting rules that are applied when a
22718 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22719 example,
22720 .code
22721 headers_rewrite = a@b c@d f : \
22722                   x@y w@z
22723 .endd
22724 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22725 &'w@z'& in all address-bearing header lines. The rules are applied to the
22726 header lines just before they are written out at transport time, so they affect
22727 only those copies of the message that pass through the transport. However, only
22728 the message's original header lines, and any that were added by a system
22729 filter, are rewritten. If a router or transport adds header lines, they are not
22730 affected by this option. These rewriting rules are &'not'& applied to the
22731 envelope. You can change the return path using &%return_path%&, but you cannot
22732 change envelope recipients at this time.
22733
22734
22735 .option home_directory transports string&!! unset
22736 .cindex "transport" "home directory for"
22737 .vindex "&$home$&"
22738 This option specifies a home directory setting for a local transport,
22739 overriding any value that may be set by the router. The home directory is
22740 placed in &$home$& while expanding the transport's private options. It is also
22741 used as the current directory if no current directory is set by the
22742 &%current_directory%& option on the transport or the
22743 &%transport_current_directory%& option on the router. If the expansion fails
22744 for any reason, including forced failure, an error is logged, and delivery is
22745 deferred.
22746
22747
22748 .option initgroups transports boolean false
22749 .cindex "additional groups"
22750 .cindex "groups" "additional"
22751 .cindex "transport" "group; additional"
22752 If this option is true and the uid for the delivery process is provided by the
22753 transport, the &[initgroups()]& function is called when running the transport
22754 to ensure that any additional groups associated with the uid are set up.
22755
22756
22757 .option max_parallel transports integer&!! unset
22758 .cindex limit "transport parallelism"
22759 .cindex transport "parallel processes"
22760 .cindex transport "concurrency limit"
22761 .cindex "delivery" "parallelism for transport"
22762 If this option is set and expands to an integer greater than zero
22763 it limits the number of concurrent runs of the transport.
22764 The control does not apply to shadow transports.
22765
22766 .cindex "hints database" "transport concurrency control"
22767 Exim implements this control by means of a hints database in which a record is
22768 incremented whenever a transport process is being created. The record
22769 is decremented and possibly removed when the process terminates.
22770 Obviously there is scope for
22771 records to get left lying around if there is a system or program crash. To
22772 guard against this, Exim ignores any records that are more than six hours old.
22773
22774 If you use this option, you should also arrange to delete the
22775 relevant hints database whenever your system reboots. The names of the files
22776 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22777 may be one or two files, depending on the type of DBM in use. The same files
22778 are used for ETRN and smtp transport serialization.
22779
22780
22781 .option message_size_limit transports string&!! 0
22782 .cindex "limit" "message size per transport"
22783 .cindex "size" "of message, limit"
22784 .cindex "transport" "message size; limiting"
22785 This option controls the size of messages passed through the transport. It is
22786 expanded before use; the result of the expansion must be a sequence of decimal
22787 digits, optionally followed by K or M. If the expansion fails for any reason,
22788 including forced failure, or if the result is not of the required form,
22789 delivery is deferred. If the value is greater than zero and the size of a
22790 message exceeds this limit, the address is failed. If there is any chance that
22791 the resulting bounce message could be routed to the same transport, you should
22792 ensure that &%return_size_limit%& is less than the transport's
22793 &%message_size_limit%&, as otherwise the bounce message will fail to get
22794 delivered.
22795
22796
22797
22798 .option rcpt_include_affixes transports boolean false
22799 .cindex "prefix" "for local part, including in envelope"
22800 .cindex "suffix for local part" "including in envelope"
22801 .cindex "local part" "prefix"
22802 .cindex "local part" "suffix"
22803 When this option is false (the default), and an address that has had any
22804 affixes (prefixes or suffixes) removed from the local part is delivered by any
22805 form of SMTP or LMTP, the affixes are not included. For example, if a router
22806 that contains
22807 .code
22808 local_part_prefix = *-
22809 .endd
22810 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22811 is delivered with
22812 .code
22813 RCPT TO:<xyz@some.domain>
22814 .endd
22815 This is also the case when an ACL-time callout is being used to verify a
22816 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22817 whole local part is included in the RCPT command. This option applies to BSMTP
22818 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22819 &(lmtp)& and &(smtp)& transports.
22820
22821
22822 .option retry_use_local_part transports boolean "see below"
22823 .cindex "hints database" "retry keys"
22824 When a delivery suffers a temporary failure, a retry record is created
22825 in Exim's hints database. For remote deliveries, the key for the retry record
22826 is based on the name and/or IP address of the failing remote host. For local
22827 deliveries, the key is normally the entire address, including both the local
22828 part and the domain. This is suitable for most common cases of local delivery
22829 temporary failure &-- for example, exceeding a mailbox quota should delay only
22830 deliveries to that mailbox, not to the whole domain.
22831
22832 However, in some special cases you may want to treat a temporary local delivery
22833 as a failure associated with the domain, and not with a particular local part.
22834 (For example, if you are storing all mail for some domain in files.) You can do
22835 this by setting &%retry_use_local_part%& false.
22836
22837 For all the local transports, its default value is true. For remote transports,
22838 the default value is false for tidiness, but changing the value has no effect
22839 on a remote transport in the current implementation.
22840
22841
22842 .option return_path transports string&!! unset
22843 .cindex "envelope sender"
22844 .cindex "envelope from"
22845 .cindex "transport" "return path; changing"
22846 .cindex "return path" "changing in transport"
22847 If this option is set, the string is expanded at transport time and replaces
22848 the existing return path (envelope sender) value in the copy of the message
22849 that is being delivered. An empty return path is permitted. This feature is
22850 designed for remote deliveries, where the value of this option is used in the
22851 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22852 only effect is to change the address that is placed in the &'Return-path:'&
22853 header line, if one is added to the message (see the next option).
22854
22855 &*Note:*& A changed return path is not logged unless you add
22856 &%return_path_on_delivery%& to the log selector.
22857
22858 .vindex "&$return_path$&"
22859 The expansion can refer to the existing value via &$return_path$&. This is
22860 either the message's envelope sender, or an address set by the
22861 &%errors_to%& option on a router. If the expansion is forced to fail, no
22862 replacement occurs; if it fails for another reason, delivery is deferred. This
22863 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22864 section &<<SECTverp>>&.
22865
22866 &*Note*&: If a delivery error is detected locally, including the case when a
22867 remote server rejects a message at SMTP time, the bounce message is not sent to
22868 the value of this option. It is sent to the previously set errors address.
22869 This defaults to the incoming sender address, but can be changed by setting
22870 &%errors_to%& in a router.
22871
22872
22873
22874 .option return_path_add transports boolean false
22875 .chindex Return-path:
22876 If this option is true, a &'Return-path:'& header is added to the message.
22877 Although the return path is normally available in the prefix line of BSD
22878 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22879 have easy access to it.
22880
22881 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22882 the delivery SMTP server makes the final delivery"&. This implies that this
22883 header should not be present in incoming messages. Exim has a configuration
22884 option, &%return_path_remove%&, which requests removal of this header from
22885 incoming messages, so that delivered messages can safely be resent to other
22886 recipients.
22887
22888
22889 .option shadow_condition transports string&!! unset
22890 See &%shadow_transport%& below.
22891
22892
22893 .option shadow_transport transports string unset
22894 .cindex "shadow transport"
22895 .cindex "transport" "shadow"
22896 A local transport may set the &%shadow_transport%& option to the name of
22897 another local transport. Shadow remote transports are not supported.
22898
22899 Whenever a delivery to the main transport succeeds, and either
22900 &%shadow_condition%& is unset, or its expansion does not result in the empty
22901 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22902 passed to the shadow transport, with the same delivery address or addresses. If
22903 expansion fails, no action is taken except that non-forced expansion failures
22904 cause a log line to be written.
22905
22906 The result of the shadow transport is discarded and does not affect the
22907 subsequent processing of the message. Only a single level of shadowing is
22908 provided; the &%shadow_transport%& option is ignored on any transport when it
22909 is running as a shadow. Options concerned with output from pipes are also
22910 ignored. The log line for the successful delivery has an item added on the end,
22911 of the form
22912 .code
22913 ST=<shadow transport name>
22914 .endd
22915 If the shadow transport did not succeed, the error message is put in
22916 parentheses afterwards. Shadow transports can be used for a number of different
22917 purposes, including keeping more detailed log information than Exim normally
22918 provides, and implementing automatic acknowledgment policies based on message
22919 headers that some sites insist on.
22920
22921
22922 .option transport_filter transports string&!! unset
22923 .cindex "transport" "filter"
22924 .cindex "filter" "transport filter"
22925 This option sets up a filtering (in the Unix shell sense) process for messages
22926 at transport time. It should not be confused with mail filtering as set up by
22927 individual users or via a system filter.
22928 If unset, or expanding to an empty string, no filtering is done.
22929
22930 When the message is about to be written out, the command specified by
22931 &%transport_filter%& is started up in a separate, parallel process, and
22932 the entire message, including the header lines, is passed to it on its standard
22933 input (this in fact is done from a third process, to avoid deadlock).
22934 The command must be specified as an absolute path.
22935
22936 The process run by the command must use its standard input as the message
22937 data to be transformed, and write the results on its standard output.
22938
22939 The lines of the message that are written to the transport filter are
22940 terminated by newline (&"\n"&). The message is passed to the filter before any
22941 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22942 lines beginning with a dot, and also before any processing implied by the
22943 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22944 &(pipe)& transports.
22945
22946 The standard error for the filter process is set to the same destination as its
22947 standard output; this is read and written to the message's ultimate
22948 destination. The process that writes the message to the filter, the
22949 filter itself, and the original process that reads the result and delivers it
22950 are all run in parallel, like a shell pipeline.
22951
22952 The filter can perform any transformations it likes, but of course should take
22953 care not to break RFC 2822 syntax. Exim does not check the result, except to
22954 test for a final newline when SMTP is in use. All messages transmitted over
22955 SMTP must end with a newline, so Exim supplies one if it is missing.
22956
22957 .cindex "content scanning" "per user"
22958 A transport filter can be used to provide content-scanning on a per-user basis
22959 at delivery time if the only required effect of the scan is to modify the
22960 message. For example, a content scan could insert a new header line containing
22961 a spam score. This could be interpreted by a filter in the user's MUA. It is
22962 not possible to discard a message at this stage.
22963
22964 .cindex "SIZE" "ESMTP extension"
22965 A problem might arise if the filter increases the size of a message that is
22966 being sent down an SMTP connection. If the receiving SMTP server has indicated
22967 support for the SIZE parameter, Exim will have sent the size of the message
22968 at the start of the SMTP session. If what is actually sent is substantially
22969 more, the server might reject the message. This can be worked round by setting
22970 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22971 additions to the message, or to disable the use of SIZE altogether.
22972
22973 .vindex "&$pipe_addresses$&"
22974 The value of the &%transport_filter%& option is the command string for starting
22975 the filter, which is run directly from Exim, not under a shell. The string is
22976 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22977 Exim breaks it up into arguments and then expands each argument separately (see
22978 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22979 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22980 of arguments, one for each address that applies to this delivery. (This isn't
22981 an ideal name for this feature here, but as it was already implemented for the
22982 &(pipe)& transport, it seemed sensible not to change it.)
22983
22984 .vindex "&$host$&"
22985 .vindex "&$host_address$&"
22986 The expansion variables &$host$& and &$host_address$& are available when the
22987 transport is a remote one. They contain the name and IP address of the host to
22988 which the message is being sent. For example:
22989 . used to have $sender_address in this cmdline, but it's tainted
22990 .code
22991 transport_filter = /some/directory/transport-filter.pl \
22992   $host $host_address $pipe_addresses
22993 .endd
22994
22995 Two problems arise if you want to use more complicated expansion items to
22996 generate transport filter commands, both of which due to the fact that the
22997 command is split up &'before'& expansion.
22998 .ilist
22999 If an expansion item contains white space, you must quote it, so that it is all
23000 part of the same command item. If the entire option setting is one such
23001 expansion item, you have to take care what kind of quoting you use. For
23002 example:
23003 .code
23004 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
23005 .endd
23006 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
23007 &(/bin/cmd2)& otherwise.
23008
23009 Option strings in general have any fully-surrounding double quote wrapping
23010 removed early in parsing (see &<<SECTstrings>>&).
23011 Then, for this option, quotes protect against whitespace being
23012 regarded as a separator while splitting into the command argument vector.
23013 Either double or single quotes can be used here;
23014 the former interprets backlash-quoted charachters
23015 and the latter does not.
23016
23017 If double quotes had been used in this example, they would have been
23018 stripped by Exim when it read the option's value. When the value is used, if
23019 the single quotes were missing, the line would be split into two items,
23020 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
23021 Exim tried to expand the first one.
23022 .next
23023 Except for the special case of &$pipe_addresses$& that is mentioned above, an
23024 expansion cannot generate multiple arguments, or a command name followed by
23025 arguments. Consider this example:
23026 .code
23027 transport_filter = ${lookup{$host}lsearch{/a/file}\
23028                     {$value}{/bin/cat}}
23029 .endd
23030 The result of the lookup is interpreted as the name of the command, even
23031 if it contains white space. The simplest way round this is to use a shell:
23032 .code
23033 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
23034                                {$value}{/bin/cat}}
23035 .endd
23036 .endlist
23037
23038 The filter process is run under the same uid and gid as the normal delivery.
23039 For remote deliveries this is the Exim uid/gid by default. The command should
23040 normally yield a zero return code. Transport filters are not supposed to fail.
23041 A non-zero code is taken to mean that the transport filter encountered some
23042 serious problem. Delivery of the message is deferred; the message remains on
23043 the queue and is tried again later. It is not possible to cause a message to be
23044 bounced from a transport filter.
23045
23046 If a transport filter is set on an autoreply transport, the original message is
23047 passed through the filter as it is being copied into the newly generated
23048 message, which happens if the &%return_message%& option is set.
23049
23050
23051 .option transport_filter_timeout transports time 5m
23052 .cindex "transport" "filter, timeout"
23053 When Exim is reading the output of a transport filter, it applies a timeout
23054 that can be set by this option. Exceeding the timeout is normally treated as a
23055 temporary delivery failure. However, if a transport filter is used with a
23056 &(pipe)& transport, a timeout in the transport filter is treated in the same
23057 way as a timeout in the pipe command itself. By default, a timeout is a hard
23058 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
23059 becomes a temporary error.
23060
23061
23062 .option user transports string&!! "Exim user"
23063 .cindex "uid (user id)" "local delivery"
23064 .cindex "transport" "user, specifying"
23065 This option specifies the user under whose uid the delivery process is to be
23066 run, overriding any uid that may have been set by the router. If the user is
23067 given as a name, the uid is looked up from the password data, and the
23068 associated group is taken as the value of the gid to be used if the &%group%&
23069 option is not set.
23070
23071 For deliveries that use local transports, a user and group are normally
23072 specified explicitly or implicitly (for example, as a result of
23073 &%check_local_user%&) by the router or transport.
23074
23075 .cindex "hints database" "access by remote transport"
23076 For remote transports, you should leave this option unset unless you really are
23077 sure you know what you are doing. When a remote transport is running, it needs
23078 to be able to access Exim's hints databases, because each host may have its own
23079 retry data.
23080 .ecindex IIDgenoptra1
23081 .ecindex IIDgenoptra2
23082 .ecindex IIDgenoptra3
23083
23084
23085
23086
23087
23088
23089 . ////////////////////////////////////////////////////////////////////////////
23090 . ////////////////////////////////////////////////////////////////////////////
23091
23092 .chapter "Address batching in local transports" "CHAPbatching" &&&
23093          "Address batching"
23094 .cindex "transport" "local; address batching in"
23095 The only remote transport (&(smtp)&) is normally configured to handle more than
23096 one address at a time, so that when several addresses are routed to the same
23097 remote host, just one copy of the message is sent. Local transports, however,
23098 normally handle one address at a time. That is, a separate instance of the
23099 transport is run for each address that is routed to the transport. A separate
23100 copy of the message is delivered each time.
23101
23102 .cindex "batched local delivery"
23103 .oindex "&%batch_max%&"
23104 .oindex "&%batch_id%&"
23105 In special cases, it may be desirable to handle several addresses at once in a
23106 local transport, for example:
23107
23108 .ilist
23109 In an &(appendfile)& transport, when storing messages in files for later
23110 delivery by some other means, a single copy of the message with multiple
23111 recipients saves space.
23112 .next
23113 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
23114 a single copy saves time, and is the normal way LMTP is expected to work.
23115 .next
23116 In a &(pipe)& transport, when passing the message
23117 to a scanner program or
23118 to some other delivery mechanism such as UUCP, multiple recipients may be
23119 acceptable.
23120 .endlist
23121
23122 These three local transports all have the same options for controlling multiple
23123 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
23124 repeating the information for each transport, these options are described here.
23125
23126 The &%batch_max%& option specifies the maximum number of addresses that can be
23127 delivered together in a single run of the transport. Its default value is one
23128 (no batching). When more than one address is routed to a transport that has a
23129 &%batch_max%& value greater than one, the addresses are delivered in a batch
23130 (that is, in a single run of the transport with multiple recipients), subject
23131 to certain conditions:
23132
23133 .ilist
23134 .vindex "&$local_part$&"
23135 If any of the transport's options contain a reference to &$local_part$&, no
23136 batching is possible.
23137 .next
23138 .vindex "&$domain$&"
23139 If any of the transport's options contain a reference to &$domain$&, only
23140 addresses with the same domain are batched.
23141 .next
23142 .cindex "customizing" "batching condition"
23143 If &%batch_id%& is set, it is expanded for each address, and only those
23144 addresses with the same expanded value are batched. This allows you to specify
23145 customized batching conditions. Failure of the expansion for any reason,
23146 including forced failure, disables batching, but it does not stop the delivery
23147 from taking place.
23148 .next
23149 Batched addresses must also have the same errors address (where to send
23150 delivery errors), the same header additions and removals, the same user and
23151 group for the transport, and if a host list is present, the first host must
23152 be the same.
23153 .endlist
23154
23155 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23156 both when the file or pipe command is specified in the transport, and when it
23157 is specified by a &(redirect)& router, but all the batched addresses must of
23158 course be routed to the same file or pipe command. These two transports have an
23159 option called &%use_bsmtp%&, which causes them to deliver the message in
23160 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23161 &%check_string%& and &%escape_string%& options are forced to the values
23162 .code
23163 check_string = "."
23164 escape_string = ".."
23165 .endd
23166 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23167 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23168 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23169
23170 .cindex "&'Envelope-to:'& header line"
23171 If the generic &%envelope_to_add%& option is set for a batching transport, the
23172 &'Envelope-to:'& header that is added to the message contains all the addresses
23173 that are being processed together. If you are using a batching &(appendfile)&
23174 transport without &%use_bsmtp%&, the only way to preserve the recipient
23175 addresses is to set the &%envelope_to_add%& option.
23176
23177 .cindex "&(pipe)& transport" "with multiple addresses"
23178 .vindex "&$pipe_addresses$&"
23179 If you are using a &(pipe)& transport without BSMTP, and setting the
23180 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23181 the command. This is not a true variable; it is a bit of magic that causes each
23182 of the recipient addresses to be inserted into the command as a separate
23183 argument. This provides a way of accessing all the addresses that are being
23184 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23185 are specified by a &(redirect)& router.
23186
23187
23188
23189
23190 . ////////////////////////////////////////////////////////////////////////////
23191 . ////////////////////////////////////////////////////////////////////////////
23192
23193 .chapter "The appendfile transport" "CHAPappendfile"
23194 .scindex IIDapptra1 "&(appendfile)& transport"
23195 .scindex IIDapptra2 "transports" "&(appendfile)&"
23196 .cindex "directory creation"
23197 .cindex "creating directories"
23198 The &(appendfile)& transport delivers a message by appending it to an existing
23199 file, or by creating an entirely new file in a specified directory. Single
23200 files to which messages are appended can be in the traditional Unix mailbox
23201 format, or optionally in the MBX format supported by the Pine MUA and
23202 University of Washington IMAP daemon, &'inter alia'&. When each message is
23203 being delivered as a separate file, &"maildir"& format can optionally be used
23204 to give added protection against failures that happen part-way through the
23205 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23206 supported. For all file formats, Exim attempts to create as many levels of
23207 directory as necessary, provided that &%create_directory%& is set.
23208
23209 The code for the optional formats is not included in the Exim binary by
23210 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23211 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23212 included.
23213
23214 .cindex "quota" "system"
23215 Exim recognizes system quota errors, and generates an appropriate message. Exim
23216 also supports its own quota control within the transport, for use when the
23217 system facility is unavailable or cannot be used for some reason.
23218
23219 If there is an error while appending to a file (for example, quota exceeded or
23220 partition filled), Exim attempts to reset the file's length and last
23221 modification time back to what they were before. If there is an error while
23222 creating an entirely new file, the new file is removed.
23223
23224 Before appending to a file, a number of security checks are made, and the
23225 file is locked. A detailed description is given below, after the list of
23226 private options.
23227
23228 The &(appendfile)& transport is most commonly used for local deliveries to
23229 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23230 putting messages into files for remote delivery by some means other than Exim.
23231 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23232 option).
23233
23234
23235
23236 .section "The file and directory options" "SECTfildiropt"
23237 The &%file%& option specifies a single file, to which the message is appended;
23238 the &%directory%& option specifies a directory, in which a new file containing
23239 the message is created. Only one of these two options can be set, and for
23240 normal deliveries to mailboxes, one of them &'must'& be set.
23241
23242 .vindex "&$address_file$&"
23243 .vindex "&$local_part$&"
23244 However, &(appendfile)& is also used for delivering messages to files or
23245 directories whose names (or parts of names) are obtained from alias,
23246 forwarding, or filtering operations (for example, a &%save%& command in a
23247 user's Exim filter). When such a transport is running, &$local_part$& contains
23248 the local part that was aliased or forwarded, and &$address_file$& contains the
23249 name (or partial name) of the file or directory generated by the redirection
23250 operation. There are two cases:
23251
23252 .ilist
23253 If neither &%file%& nor &%directory%& is set, the redirection operation
23254 must specify an absolute path (one that begins with &`/`&). This is the most
23255 common case when users with local accounts use filtering to sort mail into
23256 different folders. See for example, the &(address_file)& transport in the
23257 default configuration. If the path ends with a slash, it is assumed to be the
23258 name of a directory. A delivery to a directory can also be forced by setting
23259 &%maildir_format%& or &%mailstore_format%&.
23260 .next
23261 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23262 used to determine the file or directory name for the delivery. Normally, the
23263 contents of &$address_file$& are used in some way in the string expansion.
23264 .endlist
23265 If the &%create_file%& option is set to a path which
23266 matches (see the option definition below for details)
23267 a file or directory name
23268 for the delivery, that name becomes de-tainted.
23269
23270 .cindex "tainted data" "in filenames"
23271 .cindex appendfile "tainted data"
23272 Tainted data may not be used for a file or directory name.
23273 This means that, for instance, &$local_part$& cannot be used directly
23274 as a component of a path.  It can however be used as the key for a lookup
23275 which returns a path (or component).
23276
23277
23278 .cindex "Sieve filter" "configuring &(appendfile)&"
23279 .cindex "Sieve filter" "relative mailbox path handling"
23280 As an example of the second case, consider an environment where users do not
23281 have home directories. They may be permitted to use Exim filter commands of the
23282 form:
23283 .code
23284 save folder23
23285 .endd
23286 or Sieve filter commands of the form:
23287 .code
23288 require "fileinto";
23289 fileinto "folder23";
23290 .endd
23291 In this situation, the expansion of &%file%& or &%directory%& in the transport
23292 must transform the relative path into an appropriate absolute filename. In the
23293 case of Sieve filters, the name &'inbox'& must be handled. It is the
23294 .new
23295 default
23296 .wen
23297 name that
23298 is used as a result of a &"keep"& action in the filter. This example shows one
23299 way of handling this requirement:
23300 .code
23301 file = ${if eq{$address_file}{inbox} \
23302             {/var/mail/$local_part_data} \
23303             {${if eq{${substr_0_1:$address_file}}{/} \
23304                   {$address_file} \
23305                   {$home/mail/$address_file} \
23306             }} \
23307        }
23308 .endd
23309 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23310 location, absolute paths are used without change, and other folders are in the
23311 &_mail_& directory within the home directory.
23312
23313 .new
23314 An alternative for the &"keep"& aspect is to use the &%sieve_inbox%& option
23315 on the redirect router that calls the Sieve filter,
23316 to explicitly set the filename used.
23317 .wen
23318
23319 &*Note 1*&: While processing an Exim filter, a relative path such as
23320 &_folder23_& is turned into an absolute path if a home directory is known to
23321 the router. In particular, this is the case if &%check_local_user%& is set. If
23322 you want to prevent this happening at routing time, you can set
23323 &%router_home_directory%& empty. This forces the router to pass the relative
23324 path to the transport.
23325
23326 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23327 the &%file%& or &%directory%& option is still used if it is set.
23328
23329 .new
23330 &*Note 3*&: Permitting a user to enable writes to an absolute path
23331 may be a security issue.
23332 .wen
23333
23334
23335
23336 .section "Private options for appendfile" "SECID134"
23337 .cindex "options" "&(appendfile)& transport"
23338
23339
23340
23341 .option allow_fifo appendfile boolean false
23342 .cindex "fifo (named pipe)"
23343 .cindex "named pipe (fifo)"
23344 .cindex "pipe" "named (fifo)"
23345 Setting this option permits delivery to named pipes (FIFOs) as well as to
23346 regular files. If no process is reading the named pipe at delivery time, the
23347 delivery is deferred.
23348
23349
23350 .option allow_symlink appendfile boolean false
23351 .cindex "symbolic link" "to mailbox"
23352 .cindex "mailbox" "symbolic link"
23353 By default, &(appendfile)& will not deliver if the path name for the file is
23354 that of a symbolic link. Setting this option relaxes that constraint, but there
23355 are security issues involved in the use of symbolic links. Be sure you know
23356 what you are doing if you set this. Details of exactly what this option affects
23357 are included in the discussion which follows this list of options.
23358
23359
23360 .option batch_id appendfile string&!! unset
23361 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23362 However, batching is automatically disabled for &(appendfile)& deliveries that
23363 happen as a result of forwarding or aliasing or other redirection directly to a
23364 file.
23365
23366
23367 .option batch_max appendfile integer 1
23368 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23369
23370
23371 .option check_group appendfile boolean false
23372 When this option is set, the group owner of the file defined by the &%file%&
23373 option is checked to see that it is the same as the group under which the
23374 delivery process is running. The default setting is false because the default
23375 file mode is 0600, which means that the group is irrelevant.
23376
23377
23378 .option check_owner appendfile boolean true
23379 When this option is set, the owner of the file defined by the &%file%& option
23380 is checked to ensure that it is the same as the user under which the delivery
23381 process is running.
23382
23383
23384 .option check_string appendfile string "see below"
23385 .cindex "&""From""& line"
23386 As &(appendfile)& writes the message, the start of each line is tested for
23387 matching &%check_string%&, and if it does, the initial matching characters are
23388 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23389 a literal string, not a regular expression, and the case of any letters it
23390 contains is significant.
23391
23392 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23393 are forced to &"."& and &".."& respectively, and any settings in the
23394 configuration are ignored. Otherwise, they default to &"From&~"& and
23395 &">From&~"& when the &%file%& option is set, and unset when any of the
23396 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23397
23398 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23399 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23400 &"From&~"& indicates the start of a new message. All four options need changing
23401 if another format is used. For example, to deliver to mailboxes in MMDF format:
23402 .cindex "MMDF format mailbox"
23403 .cindex "mailbox" "MMDF format"
23404 .code
23405 check_string = "\1\1\1\1\n"
23406 escape_string = "\1\1\1\1 \n"
23407 message_prefix = "\1\1\1\1\n"
23408 message_suffix = "\1\1\1\1\n"
23409 .endd
23410 .option create_directory appendfile boolean true
23411 .cindex "directory creation"
23412 When this option is true, Exim attempts to create any missing superior
23413 directories for the file that it is about to write. A created directory's mode
23414 is given by the &%directory_mode%& option.
23415
23416 The group ownership of a newly created directory is highly dependent on the
23417 operating system (and possibly the file system) that is being used. For
23418 example, in Solaris, if the parent directory has the setgid bit set, its group
23419 is propagated to the child; if not, the currently set group is used. However,
23420 in FreeBSD, the parent's group is always used.
23421
23422
23423
23424 .option create_file appendfile string anywhere
23425 This option constrains the location of files and directories that are created
23426 by this transport. It applies to files defined by the &%file%& option and
23427 directories defined by the &%directory%& option. In the case of maildir
23428 delivery, it applies to the top level directory, not the maildir directories
23429 beneath.
23430
23431 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23432 &"belowhome"&, or to an absolute path.
23433
23434 In the second and third cases, a home directory must have been
23435 set for the transport, and the file or directory being created must
23436 reside within it.
23437 The "belowhome" checking additionally checks for attempts to use "../"
23438 to evade the testing.
23439 This option is not useful when an explicit filename is
23440 given for normal mailbox deliveries. It is intended for the case when filenames
23441 are generated from users' &_.forward_& files. These are usually handled
23442 by an &(appendfile)& transport called &%address_file%&. See also
23443 &%file_must_exist%&.
23444
23445 In the fourth case,
23446 the value given for this option must be an absolute path for an
23447 existing directory.
23448 The value is used for checking instead of a home directory;
23449 checking is done in "belowhome" mode.
23450
23451 .cindex "tainted data" "de-tainting"
23452 .cindex "de-tainting" "using appendfile create_file option"
23453 If "belowhome" checking is used, the file or directory path
23454 becomes de-tainted.
23455
23456
23457 .option directory appendfile string&!! unset
23458 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23459 or &%directory%& must be set, unless the delivery is the direct result of a
23460 redirection (see section &<<SECTfildiropt>>&).
23461
23462 When &%directory%& is set, the string is expanded, and the message is delivered
23463 into a new file or files in or below the given directory, instead of being
23464 appended to a single mailbox file. A number of different formats are provided
23465 (see &%maildir_format%& and &%mailstore_format%&), and see section
23466 &<<SECTopdir>>& for further details of this form of delivery.
23467
23468 The result of expansion must not be tainted, unless the &%create_file%& option
23469 specifies a path.
23470
23471
23472 .option directory_file appendfile string&!! "see below"
23473 .cindex "base62"
23474 .vindex "&$inode$&"
23475 When &%directory%& is set, but neither &%maildir_format%& nor
23476 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23477 whose name is obtained by expanding this string. The default value is:
23478 .code
23479 q${base62:$tod_epoch}-$inode
23480 .endd
23481 This generates a unique name from the current time, in base 62 form, and the
23482 inode of the file. The variable &$inode$& is available only when expanding this
23483 option.
23484
23485
23486 .option directory_mode appendfile "octal integer" 0700
23487 If &(appendfile)& creates any directories as a result of the
23488 &%create_directory%& option, their mode is specified by this option.
23489
23490
23491 .option escape_string appendfile string "see description"
23492 See &%check_string%& above.
23493
23494
23495 .option file appendfile string&!! unset
23496 This option is mutually exclusive with the &%directory%& option, but one of
23497 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23498 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23499 specifies a single file, to which the message is appended. One or more of
23500 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23501 &%file%&.
23502
23503 The result of expansion must not be tainted, unless the &%create_file%& option
23504 specifies a path.
23505
23506 .cindex "NFS" "lock file"
23507 .cindex "locking files"
23508 .cindex "lock files"
23509 If you are using more than one host to deliver over NFS into the same
23510 mailboxes, you should always use lock files.
23511
23512 The string value is expanded for each delivery, and must yield an absolute
23513 path. The most common settings of this option are variations on one of these
23514 examples:
23515 .code
23516 file = /var/spool/mail/$local_part_data
23517 file = /home/$local_part_data/inbox
23518 file = $home/inbox
23519 .endd
23520 .cindex "&""sticky""& bit"
23521 In the first example, all deliveries are done into the same directory. If Exim
23522 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23523 create a file in the directory, so the &"sticky"& bit must be turned on for
23524 deliveries to be possible, or alternatively the &%group%& option can be used to
23525 run the delivery under a group id which has write access to the directory.
23526
23527
23528
23529 .option file_format appendfile string unset
23530 .cindex "file" "mailbox; checking existing format"
23531 This option requests the transport to check the format of an existing file
23532 before adding to it. The check consists of matching a specific string at the
23533 start of the file. The value of the option consists of an even number of
23534 colon-separated strings. The first of each pair is the test string, and the
23535 second is the name of a transport. If the transport associated with a matched
23536 string is not the current transport, control is passed over to the other
23537 transport. For example, suppose the standard &(local_delivery)& transport has
23538 this added to it:
23539 .code
23540 file_format = "From       : local_delivery :\
23541                \1\1\1\1\n : local_mmdf_delivery"
23542 .endd
23543 Mailboxes that begin with &"From"& are still handled by this transport, but if
23544 a mailbox begins with four binary ones followed by a newline, control is passed
23545 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23546 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23547 is assumed to match the current transport. If the start of a mailbox doesn't
23548 match any string, or if the transport named for a given string is not defined,
23549 delivery is deferred.
23550
23551
23552 .option file_must_exist appendfile boolean false
23553 If this option is true, the file specified by the &%file%& option must exist.
23554 A temporary error occurs if it does not, causing delivery to be deferred.
23555 If this option is false, the file is created if it does not exist.
23556
23557
23558 .option lock_fcntl_timeout appendfile time 0s
23559 .cindex "timeout" "mailbox locking"
23560 .cindex "mailbox" "locking, blocking and non-blocking"
23561 .cindex "locking files"
23562 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23563 when locking an open mailbox file. If the call fails, the delivery process
23564 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23565 Non-blocking calls are used so that the file is not kept open during the wait
23566 for the lock; the reason for this is to make it as safe as possible for
23567 deliveries over NFS in the case when processes might be accessing an NFS
23568 mailbox without using a lock file. This should not be done, but
23569 misunderstandings and hence misconfigurations are not unknown.
23570
23571 On a busy system, however, the performance of a non-blocking lock approach is
23572 not as good as using a blocking lock with a timeout. In this case, the waiting
23573 is done inside the system call, and Exim's delivery process acquires the lock
23574 and can proceed as soon as the previous lock holder releases it.
23575
23576 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23577 timeout, are used. There may still be some retrying: the maximum number of
23578 retries is
23579 .code
23580 (lock_retries * lock_interval) / lock_fcntl_timeout
23581 .endd
23582 rounded up to the next whole number. In other words, the total time during
23583 which &(appendfile)& is trying to get a lock is roughly the same, unless
23584 &%lock_fcntl_timeout%& is set very large.
23585
23586 You should consider setting this option if you are getting a lot of delayed
23587 local deliveries because of errors of the form
23588 .code
23589 failed to lock mailbox /some/file (fcntl)
23590 .endd
23591
23592 .option lock_flock_timeout appendfile time 0s
23593 This timeout applies to file locking when using &[flock()]& (see
23594 &%use_flock%&); the timeout operates in a similar manner to
23595 &%lock_fcntl_timeout%&.
23596
23597
23598 .option lock_interval appendfile time 3s
23599 This specifies the time to wait between attempts to lock the file. See below
23600 for details of locking.
23601
23602
23603 .option lock_retries appendfile integer 10
23604 This specifies the maximum number of attempts to lock the file. A value of zero
23605 is treated as 1. See below for details of locking.
23606
23607
23608 .option lockfile_mode appendfile "octal integer" 0600
23609 This specifies the mode of the created lock file, when a lock file is being
23610 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23611
23612
23613 .option lockfile_timeout appendfile time 30m
23614 .cindex "timeout" "mailbox locking"
23615 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23616 exists and is older than this value, it is assumed to have been left behind by
23617 accident, and Exim attempts to remove it.
23618
23619
23620 .option mailbox_filecount appendfile string&!! unset
23621 .cindex "mailbox" "specifying size of"
23622 .cindex "size" "of mailbox"
23623 If this option is set, it is expanded, and the result is taken as the current
23624 number of files in the mailbox. It must be a decimal number, optionally
23625 followed by K or M. This provides a way of obtaining this information from an
23626 external source that maintains the data.
23627
23628
23629 .option mailbox_size appendfile string&!! unset
23630 .cindex "mailbox" "specifying size of"
23631 .cindex "size" "of mailbox"
23632 If this option is set, it is expanded, and the result is taken as the current
23633 size the mailbox. It must be a decimal number, optionally followed by K or M.
23634 This provides a way of obtaining this information from an external source that
23635 maintains the data. This is likely to be helpful for maildir deliveries where
23636 it is computationally expensive to compute the size of a mailbox.
23637
23638
23639
23640 .option maildir_format appendfile boolean false
23641 .cindex "maildir format" "specifying"
23642 If this option is set with the &%directory%& option, the delivery is into a new
23643 file, in the &"maildir"& format that is used by other mail software. When the
23644 transport is activated directly from a &(redirect)& router (for example, the
23645 &(address_file)& transport in the default configuration), setting
23646 &%maildir_format%& causes the path received from the router to be treated as a
23647 directory, whether or not it ends with &`/`&. This option is available only if
23648 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23649 &<<SECTmaildirdelivery>>& below for further details.
23650
23651
23652 .option maildir_quota_directory_regex appendfile string "See below"
23653 .cindex "maildir format" "quota; directories included in"
23654 .cindex "quota" "maildir; directories included in"
23655 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23656 a regular expression for specifying directories, relative to the quota
23657 directory (see &%quota_directory%&), that should be included in the quota
23658 calculation. The default value is:
23659 .code
23660 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23661 .endd
23662 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23663 (directories whose names begin with a dot). If you want to exclude the
23664 &_Trash_&
23665 folder from the count (as some sites do), you need to change this setting to
23666 .code
23667 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23668 .endd
23669 This uses a negative lookahead in the regular expression to exclude the
23670 directory whose name is &_.Trash_&. When a directory is excluded from quota
23671 calculations, quota processing is bypassed for any messages that are delivered
23672 directly into that directory.
23673
23674
23675 .option maildir_retries appendfile integer 10
23676 This option specifies the number of times to retry when writing a file in
23677 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23678
23679
23680 .option maildir_tag appendfile string&!! unset
23681 This option applies only to deliveries in maildir format, and is described in
23682 section &<<SECTmaildirdelivery>>& below.
23683
23684
23685 .option maildir_use_size_file appendfile&!! boolean false
23686 .cindex "maildir format" "&_maildirsize_& file"
23687 The result of string expansion for this option must be a valid boolean value.
23688 If it is true, it enables support for &_maildirsize_& files. Exim
23689 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23690 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23691 value is zero. See &%maildir_quota_directory_regex%& above and section
23692 &<<SECTmaildirdelivery>>& below for further details.
23693
23694 .option maildirfolder_create_regex appendfile string unset
23695 .cindex "maildir format" "&_maildirfolder_& file"
23696 .cindex "&_maildirfolder_&, creating"
23697 The value of this option is a regular expression. If it is unset, it has no
23698 effect. Otherwise, before a maildir delivery takes place, the pattern is
23699 matched against the name of the maildir directory, that is, the directory
23700 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23701 delivery. If there is a match, Exim checks for the existence of a file called
23702 &_maildirfolder_& in the directory, and creates it if it does not exist.
23703 See section &<<SECTmaildirdelivery>>& for more details.
23704
23705
23706 .option mailstore_format appendfile boolean false
23707 .cindex "mailstore format" "specifying"
23708 If this option is set with the &%directory%& option, the delivery is into two
23709 new files in  &"mailstore"& format. The option is available only if
23710 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23711 below for further details.
23712
23713
23714 .option mailstore_prefix appendfile string&!! unset
23715 This option applies only to deliveries in mailstore format, and is described in
23716 section &<<SECTopdir>>& below.
23717
23718
23719 .option mailstore_suffix appendfile string&!! unset
23720 This option applies only to deliveries in mailstore format, and is described in
23721 section &<<SECTopdir>>& below.
23722
23723
23724 .option mbx_format appendfile boolean false
23725 .cindex "locking files"
23726 .cindex "file" "locking"
23727 .cindex "file" "MBX format"
23728 .cindex "MBX format, specifying"
23729 This option is available only if Exim has been compiled with SUPPORT_MBX
23730 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23731 the message is appended to the mailbox file in MBX format instead of
23732 traditional Unix format. This format is supported by Pine4 and its associated
23733 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23734
23735 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23736 automatically changed by the use of &%mbx_format%&. They should normally be set
23737 empty when using MBX format, so this option almost always appears in this
23738 combination:
23739 .code
23740 mbx_format = true
23741 message_prefix =
23742 message_suffix =
23743 .endd
23744 If none of the locking options are mentioned in the configuration,
23745 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23746 is possible to specify the other kinds of locking with &%mbx_format%&, but
23747 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23748 interworks with &'c-client'&, providing for shared access to the mailbox. It
23749 should not be used if any program that does not use this form of locking is
23750 going to access the mailbox, nor should it be used if the mailbox file is NFS
23751 mounted, because it works only when the mailbox is accessed from a single host.
23752
23753 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23754 the standard version of &'c-client'&, because as long as it has a mailbox open
23755 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23756 append messages to it.
23757
23758
23759 .option message_prefix appendfile string&!! "see below"
23760 .cindex "&""From""& line"
23761 The string specified here is expanded and output at the start of every message.
23762 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23763 in which case it is:
23764 .code
23765 message_prefix = "From ${if def:return_path{$return_path}\
23766   {MAILER-DAEMON}} $tod_bsdinbox\n"
23767 .endd
23768 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23769 &`\n`& to &`\r\n`& in &%message_prefix%&.
23770
23771 .option message_suffix appendfile string&!! "see below"
23772 The string specified here is expanded and output at the end of every message.
23773 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23774 in which case it is a single newline character. The suffix can be suppressed by
23775 setting
23776 .code
23777 message_suffix =
23778 .endd
23779 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23780 &`\n`& to &`\r\n`& in &%message_suffix%&.
23781
23782 .option mode appendfile "octal integer" 0600
23783 If the output file is created, it is given this mode. If it already exists and
23784 has wider permissions, they are reduced to this mode. If it has narrower
23785 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23786 if the delivery is the result of a &%save%& command in a filter file specifying
23787 a particular mode, the mode of the output file is always forced to take that
23788 value, and this option is ignored.
23789
23790
23791 .option mode_fail_narrower appendfile boolean true
23792 This option applies in the case when an existing mailbox file has a narrower
23793 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23794 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23795 continues with the delivery attempt, using the existing mode of the file.
23796
23797
23798 .option notify_comsat appendfile boolean false
23799 If this option is true, the &'comsat'& daemon is notified after every
23800 successful delivery to a user mailbox. This is the daemon that notifies logged
23801 on users about incoming mail.
23802
23803
23804 .option quota appendfile string&!! unset
23805 .cindex "quota" "imposed by Exim"
23806 This option imposes a limit on the size of the file to which Exim is appending,
23807 or to the total space used in the directory tree when the &%directory%& option
23808 is set. In the latter case, computation of the space used is expensive, because
23809 all the files in the directory (and any sub-directories) have to be
23810 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23811 &%maildir_use_size_file%& for ways to avoid this in environments where users
23812 have no shell access to their mailboxes).
23813
23814 As there is no interlock against two simultaneous deliveries into a
23815 multi-file mailbox, it is possible for the quota to be overrun in this case.
23816 For single-file mailboxes, of course, an interlock is a necessity.
23817
23818 A file's size is taken as its &'used'& value. Because of blocking effects, this
23819 may be a lot less than the actual amount of disk space allocated to the file.
23820 If the sizes of a number of files are being added up, the rounding effect can
23821 become quite noticeable, especially on systems that have large block sizes.
23822 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23823 the obvious value which users understand most easily.
23824
23825 The value of the option is expanded, and must then be a numerical value
23826 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23827 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23828 and further option modifiers. If Exim is running on a system with
23829 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23830 be handled.
23831
23832 The option modifier &%no_check%& can be used to force delivery even if the over
23833 quota condition is met. The quota gets updated as usual.
23834
23835 &*Note*&: A value of zero is interpreted as &"no quota"&.
23836
23837 The expansion happens while Exim is running as root, before it changes uid for
23838 the delivery. This means that files that are inaccessible to the end user can
23839 be used to hold quota values that are looked up in the expansion. When delivery
23840 fails because this quota is exceeded, the handling of the error is as for
23841 system quota failures.
23842
23843 By default, Exim's quota checking mimics system quotas, and restricts the
23844 mailbox to the specified maximum size, though the value is not accurate to the
23845 last byte, owing to separator lines and additional headers that may get added
23846 during message delivery. When a mailbox is nearly full, large messages may get
23847 refused even though small ones are accepted, because the size of the current
23848 message is added to the quota when the check is made. This behaviour can be
23849 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23850 for exceeding the quota does not include the current message. Thus, deliveries
23851 continue until the quota has been exceeded; thereafter, no further messages are
23852 delivered. See also &%quota_warn_threshold%&.
23853
23854
23855 .option quota_directory appendfile string&!! unset
23856 This option defines the directory to check for quota purposes when delivering
23857 into individual files. The default is the delivery directory, or, if a file
23858 called &_maildirfolder_& exists in a maildir directory, the parent of the
23859 delivery directory.
23860
23861
23862 .option quota_filecount appendfile string&!! 0
23863 This option applies when the &%directory%& option is set. It limits the total
23864 number of files in the directory (compare the inode limit in system quotas). It
23865 can only be used if &%quota%& is also set. The value is expanded; an expansion
23866 failure causes delivery to be deferred. A value of zero is interpreted as
23867 &"no quota"&.
23868
23869 The option modifier &%no_check%& can be used to force delivery even if the over
23870 quota condition is met. The quota gets updated as usual.
23871
23872 .option quota_is_inclusive appendfile boolean true
23873 See &%quota%& above.
23874
23875
23876 .option quota_size_regex appendfile string unset
23877 This option applies when one of the delivery modes that writes a separate file
23878 for each message is being used. When Exim wants to find the size of one of
23879 these files in order to test the quota, it first checks &%quota_size_regex%&.
23880 If this is set to a regular expression that matches the filename, and it
23881 captures one string, that string is interpreted as a representation of the
23882 file's size. The value of &%quota_size_regex%& is not expanded.
23883
23884 This feature is useful only when users have no shell access to their mailboxes
23885 &-- otherwise they could defeat the quota simply by renaming the files. This
23886 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23887 the file length to the filename. For example:
23888 .code
23889 maildir_tag = ,S=$message_size
23890 quota_size_regex = ,S=(\d+)
23891 .endd
23892 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23893 number of lines in the message.
23894
23895 The regular expression should not assume that the length is at the end of the
23896 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23897 sometimes add other information onto the ends of message filenames.
23898
23899 Section &<<SECID136>>& contains further information.
23900
23901 This option should not be used when other message-handling software
23902 may duplicate messages by making hardlinks to the files.  When that is done Exim
23903 will count the message size once for each filename, in contrast with the actual
23904 disk usage.  When the option is not set, calculating total usage requires
23905 a system-call per file to get the size; the number of links is then available also
23906 as is used to adjust the effective size.
23907
23908
23909 .option quota_warn_message appendfile string&!! "see below"
23910 See below for the use of this option. If it is not set when
23911 &%quota_warn_threshold%& is set, it defaults to
23912 .code
23913 quota_warn_message = "\
23914   To: $local_part@$domain\n\
23915   Subject: Your mailbox\n\n\
23916   This message is automatically created \
23917   by mail delivery software.\n\n\
23918   The size of your mailbox has exceeded \
23919   a warning threshold that is\n\
23920   set by the system administrator.\n"
23921 .endd
23922
23923
23924 .option quota_warn_threshold appendfile string&!! 0
23925 .cindex "quota" "warning threshold"
23926 .cindex "mailbox" "size warning"
23927 .cindex "size" "of mailbox"
23928 This option is expanded in the same way as &%quota%& (see above). If the
23929 resulting value is greater than zero, and delivery of the message causes the
23930 size of the file or total space in the directory tree to cross the given
23931 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23932 may be specified as a percentage of it by following the value with a percent
23933 sign. For example:
23934 .code
23935 quota = 10M
23936 quota_warn_threshold = 75%
23937 .endd
23938 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23939 percent sign is ignored.
23940
23941 The warning message itself is specified by the &%quota_warn_message%& option,
23942 and it must start with a &'To:'& header line containing the recipient(s) of the
23943 warning message. These do not necessarily have to include the recipient(s) of
23944 the original message. A &'Subject:'& line should also normally be supplied. You
23945 can include any other header lines that you want. If you do not include a
23946 &'From:'& line, the default is:
23947 .code
23948 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23949 .endd
23950 .oindex &%errors_reply_to%&
23951 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23952 option.
23953
23954 The &%quota%& option does not have to be set in order to use this option; they
23955 are independent of one another except when the threshold is specified as a
23956 percentage.
23957
23958
23959 .option use_bsmtp appendfile boolean false
23960 .cindex "envelope from"
23961 .cindex "envelope sender"
23962 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23963 format, with the envelope sender and recipient(s) included as SMTP commands. If
23964 you want to include a leading HELO command with such messages, you can do
23965 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23966 for details of batch SMTP.
23967
23968
23969 .option use_crlf appendfile boolean false
23970 .cindex "carriage return"
23971 .cindex "linefeed"
23972 This option causes lines to be terminated with the two-character CRLF sequence
23973 (carriage return, linefeed) instead of just a linefeed character. In the case
23974 of batched SMTP, the byte sequence written to the file is then an exact image
23975 of what would be sent down a real SMTP connection.
23976
23977 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23978 (which are used to supply the traditional &"From&~"& and blank line separators
23979 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23980 carriage return characters if these are needed. In cases where these options
23981 have non-empty defaults, the values end with a single linefeed, so they must be
23982 changed to end with &`\r\n`& if &%use_crlf%& is set.
23983
23984
23985 .option use_fcntl_lock appendfile boolean "see below"
23986 This option controls the use of the &[fcntl()]& function to lock a file for
23987 exclusive use when a message is being appended. It is set by default unless
23988 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23989 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23990 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23991
23992
23993 .option use_flock_lock appendfile boolean false
23994 This option is provided to support the use of &[flock()]& for file locking, for
23995 the few situations where it is needed. Most modern operating systems support
23996 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23997 each other. Exim uses &[fcntl()]& locking by default.
23998
23999 This option is required only if you are using an operating system where
24000 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
24001 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
24002 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
24003
24004 .cindex "Solaris" "&[flock()]& support"
24005 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
24006 have it (and some, I think, provide a not quite right version built on top of
24007 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
24008 the ability to use it, and any attempt to do so will cause a configuration
24009 error.
24010
24011 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
24012 is just being mapped onto &[fcntl()]& by the OS).
24013
24014
24015 .option use_lockfile appendfile boolean "see below"
24016 If this option is turned off, Exim does not attempt to create a lock file when
24017 appending to a mailbox file. In this situation, the only locking is by
24018 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
24019 sure that every MUA that is ever going to look at your users' mailboxes uses
24020 &[fcntl()]& rather than a lock file, and even then only when you are not
24021 delivering over NFS from more than one host.
24022
24023 .cindex "NFS" "lock file"
24024 In order to append to an NFS file safely from more than one host, it is
24025 necessary to take out a lock &'before'& opening the file, and the lock file
24026 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
24027 file corruption.
24028
24029 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
24030 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
24031 except when &%mbx_format%& is set.
24032
24033
24034 .option use_mbx_lock appendfile boolean "see below"
24035 This option is available only if Exim has been compiled with SUPPORT_MBX
24036 set in &_Local/Makefile_&. Setting the option specifies that special MBX
24037 locking rules be used. It is set by default if &%mbx_format%& is set and none
24038 of the locking options are mentioned in the configuration. The locking rules
24039 are the same as are used by the &'c-client'& library that underlies Pine and
24040 the IMAP4 and POP daemons that come with it (see the discussion below). The
24041 rules allow for shared access to the mailbox. However, this kind of locking
24042 does not work when the mailbox is NFS mounted.
24043
24044 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
24045 &%use_flock_lock%& to control what kind of locking is used in implementing the
24046 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
24047 without &%use_fcntl_lock%& or &%use_flock_lock%&.
24048
24049
24050
24051
24052 .section "Operational details for appending" "SECTopappend"
24053 .cindex "appending to a file"
24054 .cindex "file" "appending"
24055 Before appending to a file, the following preparations are made:
24056
24057 .ilist
24058 If the name of the file is &_/dev/null_&, no action is taken, and a success
24059 return is given.
24060
24061 .next
24062 .cindex "directory creation"
24063 If any directories on the file's path are missing, Exim creates them if the
24064 &%create_directory%& option is set. A created directory's mode is given by the
24065 &%directory_mode%& option.
24066
24067 .next
24068 If &%file_format%& is set, the format of an existing file is checked. If this
24069 indicates that a different transport should be used, control is passed to that
24070 transport.
24071
24072 .next
24073 .cindex "file" "locking"
24074 .cindex "locking files"
24075 .cindex "NFS" "lock file"
24076 If &%use_lockfile%& is set, a lock file is built in a way that will work
24077 reliably over NFS, as follows:
24078
24079 .olist
24080 Create a &"hitching post"& file whose name is that of the lock file with the
24081 current time, primary host name, and process id added, by opening for writing
24082 as a new file. If this fails with an access error, delivery is deferred.
24083 .next
24084 Close the hitching post file, and hard link it to the lock filename.
24085 .next
24086 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
24087 Unlink the hitching post name.
24088 .next
24089 Otherwise, use &[stat()]& to get information about the hitching post file, and
24090 then unlink hitching post name. If the number of links is exactly two, creation
24091 of the lock file succeeded but something (for example, an NFS server crash and
24092 restart) caused this fact not to be communicated to the &[link()]& call.
24093 .next
24094 If creation of the lock file failed, wait for &%lock_interval%& and try again,
24095 up to &%lock_retries%& times. However, since any program that writes to a
24096 mailbox should complete its task very quickly, it is reasonable to time out old
24097 lock files that are normally the result of user agent and system crashes. If an
24098 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
24099 it before trying again.
24100 .endlist olist
24101
24102 .next
24103 A call is made to &[lstat()]& to discover whether the main file exists, and if
24104 so, what its characteristics are. If &[lstat()]& fails for any reason other
24105 than non-existence, delivery is deferred.
24106
24107 .next
24108 .cindex "symbolic link" "to mailbox"
24109 .cindex "mailbox" "symbolic link"
24110 If the file does exist and is a symbolic link, delivery is deferred, unless the
24111 &%allow_symlink%& option is set, in which case the ownership of the link is
24112 checked, and then &[stat()]& is called to find out about the real file, which
24113 is then subjected to the checks below. The check on the top-level link
24114 ownership prevents one user creating a link for another's mailbox in a sticky
24115 directory, though allowing symbolic links in this case is definitely not a good
24116 idea. If there is a chain of symbolic links, the intermediate ones are not
24117 checked.
24118
24119 .next
24120 If the file already exists but is not a regular file, or if the file's owner
24121 and group (if the group is being checked &-- see &%check_group%& above) are
24122 different from the user and group under which the delivery is running,
24123 delivery is deferred.
24124
24125 .next
24126 If the file's permissions are more generous than specified, they are reduced.
24127 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
24128 is set false, in which case the delivery is tried using the existing
24129 permissions.
24130
24131 .next
24132 The file's inode number is saved, and the file is then opened for appending.
24133 If this fails because the file has vanished, &(appendfile)& behaves as if it
24134 hadn't existed (see below). For any other failures, delivery is deferred.
24135
24136 .next
24137 If the file is opened successfully, check that the inode number hasn't
24138 changed, that it is still a regular file, and that the owner and permissions
24139 have not changed. If anything is wrong, defer delivery and freeze the message.
24140
24141 .next
24142 If the file did not exist originally, defer delivery if the &%file_must_exist%&
24143 option is set. Otherwise, check that the file is being created in a permitted
24144 directory if the &%create_file%& option is set (deferring on failure), and then
24145 open for writing as a new file, with the O_EXCL and O_CREAT options,
24146 except when dealing with a symbolic link (the &%allow_symlink%& option must be
24147 set). In this case, which can happen if the link points to a non-existent file,
24148 the file is opened for writing using O_CREAT but not O_EXCL, because
24149 that prevents link following.
24150
24151 .next
24152 .cindex "loop" "while file testing"
24153 If opening fails because the file exists, obey the tests given above for
24154 existing files. However, to avoid looping in a situation where the file is
24155 being continuously created and destroyed, the exists/not-exists loop is broken
24156 after 10 repetitions, and the message is then frozen.
24157
24158 .next
24159 If opening fails with any other error, defer delivery.
24160
24161 .next
24162 .cindex "file" "locking"
24163 .cindex "locking files"
24164 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24165 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24166 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24167 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24168 file, and an exclusive lock on the file whose name is
24169 .code
24170 /tmp/.<device-number>.<inode-number>
24171 .endd
24172 using the device and inode numbers of the open mailbox file, in accordance with
24173 the MBX locking rules. This file is created with a mode that is specified by
24174 the &%lockfile_mode%& option.
24175
24176 If Exim fails to lock the file, there are two possible courses of action,
24177 depending on the value of the locking timeout. This is obtained from
24178 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24179
24180 If the timeout value is zero, the file is closed, Exim waits for
24181 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24182 to lock it again. This happens up to &%lock_retries%& times, after which the
24183 delivery is deferred.
24184
24185 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24186 &[flock()]& are used (with the given timeout), so there has already been some
24187 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24188 immediately. It retries up to
24189 .code
24190 (lock_retries * lock_interval) / <timeout>
24191 .endd
24192 times (rounded up).
24193 .endlist
24194
24195 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24196 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24197
24198
24199 .section "Operational details for delivery to a new file" "SECTopdir"
24200 .cindex "delivery" "to single file"
24201 .cindex "&""From""& line"
24202 When the &%directory%& option is set instead of &%file%&, each message is
24203 delivered into a newly-created file or set of files. When &(appendfile)& is
24204 activated directly from a &(redirect)& router, neither &%file%& nor
24205 &%directory%& is normally set, because the path for delivery is supplied by the
24206 router. (See for example, the &(address_file)& transport in the default
24207 configuration.) In this case, delivery is to a new file if either the path name
24208 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24209
24210 No locking is required while writing the message to a new file, so the various
24211 locking options of the transport are ignored. The &"From"& line that by default
24212 separates messages in a single file is not normally needed, nor is the escaping
24213 of message lines that start with &"From"&, and there is no need to ensure a
24214 newline at the end of each message. Consequently, the default values for
24215 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24216 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24217
24218 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24219 the files in the delivery directory by default. However, you can specify a
24220 different directory by setting &%quota_directory%&. Also, for maildir
24221 deliveries (see below) the &_maildirfolder_& convention is honoured.
24222
24223
24224 .cindex "maildir format"
24225 .cindex "mailstore format"
24226 There are three different ways in which delivery to individual files can be
24227 done, controlled by the settings of the &%maildir_format%& and
24228 &%mailstore_format%& options. Note that code to support maildir or mailstore
24229 formats is not included in the binary unless SUPPORT_MAILDIR or
24230 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24231
24232 .cindex "directory creation"
24233 In all three cases an attempt is made to create the directory and any necessary
24234 sub-directories if they do not exist, provided that the &%create_directory%&
24235 option is set (the default). The location of a created directory can be
24236 constrained by setting &%create_file%&. A created directory's mode is given by
24237 the &%directory_mode%& option. If creation fails, or if the
24238 &%create_directory%& option is not set when creation is required, delivery is
24239 deferred.
24240
24241
24242
24243 .section "Maildir delivery" "SECTmaildirdelivery"
24244 .cindex "maildir format" "description of"
24245 If the &%maildir_format%& option is true, Exim delivers each message by writing
24246 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24247 directory that is defined by the &%directory%& option (the &"delivery
24248 directory"&). If the delivery is successful, the file is renamed into the
24249 &_new_& subdirectory.
24250
24251 In the filename, <&'stime'&> is the current time of day in seconds, and
24252 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24253 Exim checks that the time-of-day clock has moved on by at least one microsecond
24254 before terminating the delivery process. This guarantees uniqueness for the
24255 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24256 opening it. If any response other than ENOENT (does not exist) is given,
24257 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24258
24259 Before Exim carries out a maildir delivery, it ensures that subdirectories
24260 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24261 do not exist, Exim tries to create them and any superior directories in their
24262 path, subject to the &%create_directory%& and &%create_file%& options. If the
24263 &%maildirfolder_create_regex%& option is set, and the regular expression it
24264 contains matches the delivery directory, Exim also ensures that a file called
24265 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24266 &_maildirfolder_& file cannot be created, delivery is deferred.
24267
24268 These features make it possible to use Exim to create all the necessary files
24269 and directories in a maildir mailbox, including subdirectories for maildir++
24270 folders. Consider this example:
24271 .code
24272 maildir_format = true
24273 directory = /var/mail/$local_part_data\
24274            ${if eq{$local_part_suffix}{}{}\
24275            {/.${substr_1:$local_part_suffix}}}
24276 maildirfolder_create_regex = /\.[^/]+$
24277 .endd
24278 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24279 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24280 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24281 not match this name, so Exim will not look for or create the file
24282 &_/var/mail/pimbo/maildirfolder_&, though it will create
24283 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24284
24285 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24286 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24287 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24288 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24289 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24290
24291 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24292 not inadvertently match the toplevel maildir directory, because a
24293 &_maildirfolder_& file at top level would completely break quota calculations.
24294
24295 .cindex "quota" "in maildir delivery"
24296 .cindex "maildir++"
24297 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24298 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24299 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24300 Exim assumes the directory is a maildir++ folder directory, which is one level
24301 down from the user's top level mailbox directory. This causes it to start at
24302 the parent directory instead of the current directory when calculating the
24303 amount of space used.
24304
24305 One problem with delivering into a multi-file mailbox is that it is
24306 computationally expensive to compute the size of the mailbox for quota
24307 checking. Various approaches have been taken to reduce the amount of work
24308 needed. The next two sections describe two of them. A third alternative is to
24309 use some external process for maintaining the size data, and use the expansion
24310 of the &%mailbox_size%& option as a way of importing it into Exim.
24311
24312
24313
24314
24315 .section "Using tags to record message sizes" "SECID135"
24316 If &%maildir_tag%& is set, the string is expanded for each delivery.
24317 When the maildir file is renamed into the &_new_& sub-directory, the
24318 tag is added to its name. However, if adding the tag takes the length of the
24319 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24320 the tag is dropped and the maildir file is created with no tag.
24321
24322
24323 .vindex "&$message_size$&"
24324 Tags can be used to encode the size of files in their names; see
24325 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24326 happens after the message has been written. The value of the &$message_size$&
24327 variable is set to the number of bytes actually written. If the expansion is
24328 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24329 be deferred. The expanded tag may contain any printing characters except &"/"&.
24330 Non-printing characters in the string are ignored; if the resulting string is
24331 empty, it is ignored. If it starts with an alphanumeric character, a leading
24332 colon is inserted; this default has not proven to be the path that popular
24333 maildir implementations have chosen (but changing it in Exim would break
24334 backwards compatibility).
24335
24336 For one common implementation, you might set:
24337 .code
24338 maildir_tag = ,S=${message_size}
24339 .endd
24340 but you should check the documentation of the other software to be sure.
24341
24342 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24343 as this allows Exim to extract the size from your tag, instead of having to
24344 &[stat()]& each message file.
24345
24346
24347 .section "Using a maildirsize file" "SECID136"
24348 .cindex "quota" "in maildir delivery"
24349 .cindex "maildir format" "&_maildirsize_& file"
24350 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24351 storing quota and message size information in a file called &_maildirsize_&
24352 within the toplevel maildir directory. If this file does not exist, Exim
24353 creates it, setting the quota from the &%quota%& option of the transport. If
24354 the maildir directory itself does not exist, it is created before any attempt
24355 to write a &_maildirsize_& file.
24356
24357 The &_maildirsize_& file is used to hold information about the sizes of
24358 messages in the maildir, thus speeding up quota calculations. The quota value
24359 in the file is just a cache; if the quota is changed in the transport, the new
24360 value overrides the cached value when the next message is delivered. The cache
24361 is maintained for the benefit of other programs that access the maildir and
24362 need to know the quota.
24363
24364 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24365 file is maintained (with a zero quota setting), but no quota is imposed.
24366
24367 A regular expression is available for controlling which directories in the
24368 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24369 See the description of the &%maildir_quota_directory_regex%& option above for
24370 details.
24371
24372
24373 .section "Mailstore delivery" "SECID137"
24374 .cindex "mailstore format" "description of"
24375 If the &%mailstore_format%& option is true, each message is written as two
24376 files in the given directory. A unique base name is constructed from the
24377 message id and the current delivery process, and the files that are written use
24378 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24379 contains the message's envelope, and the &_.msg_& file contains the message
24380 itself. The base name is placed in the variable &$mailstore_basename$&.
24381
24382 During delivery, the envelope is first written to a file with the suffix
24383 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24384 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24385 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24386 file before accessing either of them. An alternative approach is to wait for
24387 the absence of a &_.tmp_& file.
24388
24389 The envelope file starts with any text defined by the &%mailstore_prefix%&
24390 option, expanded and terminated by a newline if there isn't one. Then follows
24391 the sender address on one line, then all the recipient addresses, one per line.
24392 There can be more than one recipient only if the &%batch_max%& option is set
24393 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24394 appended to the file, followed by a newline if it does not end with one.
24395
24396 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24397 failure, it is ignored. Other expansion errors are treated as serious
24398 configuration errors, and delivery is deferred. The variable
24399 &$mailstore_basename$& is available for use during these expansions.
24400
24401
24402 .section "Non-special new file delivery" "SECID138"
24403 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24404 file is created directly in the named directory. For example, when delivering
24405 messages into files in batched SMTP format for later delivery to some host (see
24406 section &<<SECTbatchSMTP>>&), a setting such as
24407 .code
24408 directory = /var/bsmtp/$host
24409 .endd
24410 might be used. A message is written to a file with a temporary name, which is
24411 then renamed when the delivery is complete. The final name is obtained by
24412 expanding the contents of the &%directory_file%& option.
24413 .ecindex IIDapptra1
24414 .ecindex IIDapptra2
24415
24416
24417
24418
24419
24420
24421 . ////////////////////////////////////////////////////////////////////////////
24422 . ////////////////////////////////////////////////////////////////////////////
24423
24424 .chapter "The autoreply transport" "CHID8"
24425 .scindex IIDauttra1 "transports" "&(autoreply)&"
24426 .scindex IIDauttra2 "&(autoreply)& transport"
24427 The &(autoreply)& transport is not a true transport in that it does not cause
24428 the message to be transmitted. Instead, it generates a new mail message as an
24429 automatic reply to the incoming message. &'References:'& and
24430 &'Auto-Submitted:'& header lines are included. These are constructed according
24431 to the rules in RFCs 2822 and 3834, respectively.
24432
24433 If the router that passes the message to this transport does not have the
24434 &%unseen%& option set, the original message (for the current recipient) is not
24435 delivered anywhere. However, when the &%unseen%& option is set on the router
24436 that passes the message to this transport, routing of the address continues, so
24437 another router can set up a normal message delivery.
24438
24439
24440 The &(autoreply)& transport is usually run as the result of mail filtering, a
24441 &"vacation"& message being the standard example. However, it can also be run
24442 directly from a router like any other transport. To reduce the possibility of
24443 message cascades, messages created by the &(autoreply)& transport always have
24444 empty envelope sender addresses, like bounce messages.
24445
24446 The parameters of the message to be sent can be specified in the configuration
24447 by options described below. However, these are used only when the address
24448 passed to the transport does not contain its own reply information. When the
24449 transport is run as a consequence of a
24450 &%mail%&
24451 or &%vacation%& command in a filter file, the parameters of the message are
24452 supplied by the filter, and passed with the address. The transport's options
24453 that define the message are then ignored (so they are not usually set in this
24454 case). The message is specified entirely by the filter or by the transport; it
24455 is never built from a mixture of options. However, the &%file_optional%&,
24456 &%mode%&, and &%return_message%& options apply in all cases.
24457
24458 &(Autoreply)& is implemented as a local transport. When used as a result of a
24459 command in a user's filter file, &(autoreply)& normally runs under the uid and
24460 gid of the user, and with appropriate current and home directories (see chapter
24461 &<<CHAPenvironment>>&).
24462
24463 There is a subtle difference between routing a message to a &(pipe)& transport
24464 that generates some text to be returned to the sender, and routing it to an
24465 &(autoreply)& transport. This difference is noticeable only if more than one
24466 address from the same message is so handled. In the case of a pipe, the
24467 separate outputs from the different addresses are gathered up and returned to
24468 the sender in a single message, whereas if &(autoreply)& is used, a separate
24469 message is generated for each address that is passed to it.
24470
24471 Non-printing characters are not permitted in the header lines generated for the
24472 message that &(autoreply)& creates, with the exception of newlines that are
24473 immediately followed by white space. If any non-printing characters are found,
24474 the transport defers.
24475 Whether characters with the top bit set count as printing characters or not is
24476 controlled by the &%print_topbitchars%& global option.
24477
24478 If any of the generic options for manipulating headers (for example,
24479 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24480 of the original message that is included in the generated message when
24481 &%return_message%& is set. They do not apply to the generated message itself.
24482
24483 .vindex "&$sender_address$&"
24484 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24485 the message, indicating that there were no recipients, it does not treat this
24486 as an error. This means that autoreplies sent to &$sender_address$& when this
24487 is empty (because the incoming message is a bounce message) do not cause
24488 problems. They are just discarded.
24489
24490
24491
24492 .section "Private options for autoreply" "SECID139"
24493 .cindex "options" "&(autoreply)& transport"
24494
24495 .option bcc autoreply string&!! unset
24496 This specifies the addresses that are to receive &"blind carbon copies"& of the
24497 message when the message is specified by the transport.
24498
24499
24500 .option cc autoreply string&!! unset
24501 This specifies recipients of the message and the contents of the &'Cc:'& header
24502 when the message is specified by the transport.
24503
24504
24505 .option file autoreply string&!! unset
24506 The contents of the file are sent as the body of the message when the message
24507 is specified by the transport. If both &%file%& and &%text%& are set, the text
24508 string comes first.
24509
24510
24511 .option file_expand autoreply boolean false
24512 If this is set, the contents of the file named by the &%file%& option are
24513 subjected to string expansion as they are added to the message.
24514
24515
24516 .option file_optional autoreply boolean false
24517 If this option is true, no error is generated if the file named by the &%file%&
24518 option or passed with the address does not exist or cannot be read.
24519
24520
24521 .option from autoreply string&!! unset
24522 This specifies the contents of the &'From:'& header when the message is
24523 specified by the transport.
24524
24525
24526 .option headers autoreply string&!! unset
24527 This specifies additional RFC 2822 headers that are to be added to the message
24528 when the message is specified by the transport. Several can be given by using
24529 &"\n"& to separate them. There is no check on the format.
24530
24531
24532 .option log autoreply string&!! unset
24533 This option names a file in which a record of every message sent is logged when
24534 the message is specified by the transport.
24535
24536
24537 .option mode autoreply "octal integer" 0600
24538 If either the log file or the &"once"& file has to be created, this mode is
24539 used.
24540
24541
24542 .option never_mail autoreply "address list&!!" unset
24543 If any run of the transport creates a message with a recipient that matches any
24544 item in the list, that recipient is quietly discarded. If all recipients are
24545 discarded, no message is created. This applies both when the recipients are
24546 generated by a filter and when they are specified in the transport.
24547
24548
24549
24550 .option once autoreply string&!! unset
24551 This option names a file or DBM database in which a record of each &'To:'&
24552 recipient is kept when the message is specified by the transport. &*Note*&:
24553 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24554
24555 If &%once%& is unset, or is set to an empty string, the message is always sent.
24556 By default, if &%once%& is set to a non-empty filename, the message
24557 is not sent if a potential recipient is already listed in the database.
24558 However, if the &%once_repeat%& option specifies a time greater than zero, the
24559 message is sent if that much time has elapsed since a message was last sent to
24560 this recipient. A setting of zero time for &%once_repeat%& (the default)
24561 prevents a message from being sent a second time &-- in this case, zero means
24562 infinity.
24563
24564 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24565 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24566 greater than zero, it changes the way Exim implements the &%once%& option.
24567 Instead of using a DBM file to record every recipient it sends to, it uses a
24568 regular file, whose size will never get larger than the given value.
24569
24570 In the file, Exim keeps a linear list of recipient addresses and the times at
24571 which they were sent messages. If the file is full when a new address needs to
24572 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24573 means that a given recipient may receive multiple messages, but at
24574 unpredictable intervals that depend on the rate of turnover of addresses in the
24575 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24576
24577
24578 .option once_file_size autoreply integer 0
24579 See &%once%& above.
24580
24581
24582 .option once_repeat autoreply time&!! 0s
24583 See &%once%& above.
24584 After expansion, the value of this option must be a valid time value.
24585
24586
24587 .option reply_to autoreply string&!! unset
24588 This specifies the contents of the &'Reply-To:'& header when the message is
24589 specified by the transport.
24590
24591
24592 .option return_message autoreply boolean false
24593 If this is set, a copy of the original message is returned with the new
24594 message, subject to the maximum size set in the &%return_size_limit%& global
24595 configuration option.
24596
24597
24598 .option subject autoreply string&!! unset
24599 This specifies the contents of the &'Subject:'& header when the message is
24600 specified by the transport. It is tempting to quote the original subject in
24601 automatic responses. For example:
24602 .code
24603 subject = Re: $h_subject:
24604 .endd
24605 There is a danger in doing this, however. It may allow a third party to
24606 subscribe your users to an opt-in mailing list, provided that the list accepts
24607 bounce messages as subscription confirmations. Well-managed lists require a
24608 non-bounce message to confirm a subscription, so the danger is relatively
24609 small.
24610
24611
24612
24613 .option text autoreply string&!! unset
24614 This specifies a single string to be used as the body of the message when the
24615 message is specified by the transport. If both &%text%& and &%file%& are set,
24616 the text comes first.
24617
24618
24619 .option to autoreply string&!! unset
24620 This specifies recipients of the message and the contents of the &'To:'& header
24621 when the message is specified by the transport.
24622 .ecindex IIDauttra1
24623 .ecindex IIDauttra2
24624
24625
24626
24627
24628 . ////////////////////////////////////////////////////////////////////////////
24629 . ////////////////////////////////////////////////////////////////////////////
24630
24631 .chapter "The lmtp transport" "CHAPLMTP"
24632 .cindex "transports" "&(lmtp)&"
24633 .cindex "&(lmtp)& transport"
24634 .cindex "LMTP" "over a pipe"
24635 .cindex "LMTP" "over a unix-domain socket"
24636 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24637 specified command
24638 or by interacting with a Unix domain socket.
24639 This transport is something of a cross between the &(pipe)& and &(smtp)&
24640 transports. Exim also has support for using LMTP over TCP/IP; this is
24641 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24642 to be of minority interest, the default build-time configure in &_src/EDITME_&
24643 has it commented out. You need to ensure that
24644 .code
24645 TRANSPORT_LMTP=yes
24646 .endd
24647 .cindex "options" "&(lmtp)& transport"
24648 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24649 included in the Exim binary. The private options of the &(lmtp)& transport are
24650 as follows:
24651
24652 .option batch_id lmtp string&!! unset
24653 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24654
24655
24656 .option batch_max lmtp integer 1
24657 This limits the number of addresses that can be handled in a single delivery.
24658 Most LMTP servers can handle several addresses at once, so it is normally a
24659 good idea to increase this value. See the description of local delivery
24660 batching in chapter &<<CHAPbatching>>&.
24661
24662
24663 .option command lmtp string&!! unset
24664 This option must be set if &%socket%& is not set. The string is a command which
24665 is run in a separate process. It is split up into a command name and list of
24666 arguments, each of which is separately expanded (so expansion cannot change the
24667 number of arguments). The command is run directly, not via a shell. The message
24668 is passed to the new process using the standard input and output to operate the
24669 LMTP protocol.
24670
24671 .option ignore_quota lmtp boolean false
24672 .cindex "LMTP" "ignoring quota errors"
24673 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24674 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24675 in its response to the LHLO command.
24676
24677 .option socket lmtp string&!! unset
24678 This option must be set if &%command%& is not set. The result of expansion must
24679 be the name of a Unix domain socket. The transport connects to the socket and
24680 delivers the message to it using the LMTP protocol.
24681
24682
24683 .option timeout lmtp time 5m
24684 The transport is aborted if the created process or Unix domain socket does not
24685 respond to LMTP commands or message input within this timeout. Delivery
24686 is deferred, and will be tried again later. Here is an example of a typical
24687 LMTP transport:
24688 .code
24689 lmtp:
24690   driver = lmtp
24691   command = /some/local/lmtp/delivery/program
24692   batch_max = 20
24693   user = exim
24694 .endd
24695 This delivers up to 20 addresses at a time, in a mixture of domains if
24696 necessary, running as the user &'exim'&.
24697
24698
24699
24700 . ////////////////////////////////////////////////////////////////////////////
24701 . ////////////////////////////////////////////////////////////////////////////
24702
24703 .chapter "The pipe transport" "CHAPpipetransport"
24704 .scindex IIDpiptra1 "transports" "&(pipe)&"
24705 .scindex IIDpiptra2 "&(pipe)& transport"
24706 The &(pipe)& transport is used to deliver messages via a pipe to a command
24707 running in another process. One example is the use of &(pipe)& as a
24708 pseudo-remote transport for passing messages to some other delivery mechanism
24709 (such as UUCP). Another is the use by individual users to automatically process
24710 their incoming messages. The &(pipe)& transport can be used in one of the
24711 following ways:
24712
24713 .ilist
24714 .vindex "&$local_part$&"
24715 A router routes one address to a transport in the normal way, and the
24716 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24717 contains the local part of the address (as usual), and the command that is run
24718 is specified by the &%command%& option on the transport.
24719 .next
24720 .vindex "&$pipe_addresses$&"
24721 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24722 transport can handle more than one address in a single run. In this case, when
24723 more than one address is routed to the transport, &$local_part$& is not set
24724 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24725 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24726 that are routed to the transport.
24727 .next
24728 .vindex "&$address_pipe$&"
24729 A router redirects an address directly to a pipe command (for example, from an
24730 alias or forward file). In this case, &$address_pipe$& contains the text of the
24731 pipe command, and the &%command%& option on the transport is ignored unless
24732 &%force_command%& is set. If only one address is being transported
24733 (&%batch_max%& is not greater than one, or only one address was redirected to
24734 this pipe command), &$local_part$& contains the local part that was redirected.
24735 .endlist
24736
24737
24738 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24739 deliver messages over pipes using the LMTP interactive protocol. This is
24740 implemented by the &(lmtp)& transport.
24741
24742 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24743 &_.forward_& file, the command runs under the uid and gid of that user. In
24744 other cases, the uid and gid have to be specified explicitly, either on the
24745 transport or on the router that handles the address. Current and &"home"&
24746 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24747 details of the local delivery environment and chapter &<<CHAPbatching>>&
24748 for a discussion of local delivery batching.
24749
24750 .cindex "tainted data" "in pipe command"
24751 .cindex pipe "tainted data"
24752 Tainted data may not be used for the command name.
24753
24754
24755 .section "Concurrent delivery" "SECID140"
24756 If two messages arrive at almost the same time, and both are routed to a pipe
24757 delivery, the two pipe transports may be run concurrently. You must ensure that
24758 any pipe commands you set up are robust against this happening. If the commands
24759 write to a file, the &%exim_lock%& utility might be of use.
24760 Alternatively the &%max_parallel%& option could be used with a value
24761 of "1" to enforce serialization.
24762
24763
24764
24765
24766 .section "Returned status and data" "SECID141"
24767 .cindex "&(pipe)& transport" "returned data"
24768 If the command exits with a non-zero return code, the delivery is deemed to
24769 have failed, unless either the &%ignore_status%& option is set (in which case
24770 the return code is treated as zero), or the return code is one of those listed
24771 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24772 later"&. In this case, delivery is deferred. Details of a permanent failure are
24773 logged, but are not included in the bounce message, which merely contains
24774 &"local delivery failed"&.
24775
24776 If the command exits on a signal and the &%freeze_signal%& option is set then
24777 the message will be frozen in the queue. If that option is not set, a bounce
24778 will be sent as normal.
24779
24780 If the return code is greater than 128 and the command being run is a shell
24781 script, it normally means that the script was terminated by a signal whose
24782 value is the return code minus 128. The &%freeze_signal%& option does not
24783 apply in this case.
24784
24785 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24786 return code is set to 127. This is the value that a shell returns if it is
24787 asked to run a non-existent command. The wording for the log line suggests that
24788 a non-existent command may be the problem.
24789
24790 The &%return_output%& option can affect the result of a pipe delivery. If it is
24791 set and the command produces any output on its standard output or standard
24792 error streams, the command is considered to have failed, even if it gave a zero
24793 return code or if &%ignore_status%& is set. The output from the command is
24794 included as part of the bounce message. The &%return_fail_output%& option is
24795 similar, except that output is returned only when the command exits with a
24796 failure return code, that is, a value other than zero or a code that matches
24797 &%temp_errors%&.
24798
24799
24800
24801 .section "How the command is run" "SECThowcommandrun"
24802 .cindex "&(pipe)& transport" "path for command"
24803 The command line is (by default) broken down into a command name and arguments
24804 by the &(pipe)& transport itself. The &%allow_commands%& and
24805 &%restrict_to_path%& options can be used to restrict the commands that may be
24806 run.
24807
24808 .cindex "quoting" "in pipe command"
24809 Unquoted arguments are delimited by white space. If an argument appears in
24810 double quotes, backslash is interpreted as an escape character in the usual
24811 way. If an argument appears in single quotes, no escaping is done.
24812
24813 String expansion is applied to the command line except when it comes from a
24814 traditional &_.forward_& file (commands from a filter file are expanded). The
24815 expansion is applied to each argument in turn rather than to the whole line.
24816 For this reason, any string expansion item that contains white space must be
24817 quoted so as to be contained within a single argument. A setting such as
24818 .code
24819 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24820 .endd
24821 will not work, because the expansion item gets split between several
24822 arguments. You have to write
24823 .code
24824 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24825 .endd
24826 to ensure that it is all in one argument. The expansion is done in this way,
24827 argument by argument, so that the number of arguments cannot be changed as a
24828 result of expansion, and quotes or backslashes in inserted variables do not
24829 interact with external quoting. However, this leads to problems if you want to
24830 generate multiple arguments (or the command name plus arguments) from a single
24831 expansion. In this situation, the simplest solution is to use a shell. For
24832 example:
24833 .code
24834 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24835 .endd
24836
24837 .cindex "transport" "filter"
24838 .cindex "filter" "transport filter"
24839 .vindex "&$pipe_addresses$&"
24840 Special handling takes place when an argument consists of precisely the text
24841 &`$pipe_addresses`& (no quotes).
24842 This is not a general expansion variable; the only
24843 place this string is recognized is when it appears as an argument for a pipe or
24844 transport filter command. It causes each address that is being handled to be
24845 inserted in the argument list at that point &'as a separate argument'&. This
24846 avoids any problems with spaces or shell metacharacters, and is of use when a
24847 &(pipe)& transport is handling groups of addresses in a batch.
24848
24849 If &%force_command%& is enabled on the transport, special handling takes place
24850 for an argument that consists of precisely the text &`$address_pipe`&.  It
24851 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24852 argument is inserted in the argument list at that point
24853 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24854 the only item in the argument; in fact, if it were then &%force_command%&
24855 should behave as a no-op.  Rather, it should be used to adjust the command
24856 run while preserving the argument vector separation.
24857
24858 After splitting up into arguments and expansion, the resulting command is run
24859 in a subprocess directly from the transport, &'not'& under a shell. The
24860 message that is being delivered is supplied on the standard input, and the
24861 standard output and standard error are both connected to a single pipe that is
24862 read by Exim. The &%max_output%& option controls how much output the command
24863 may produce, and the &%return_output%& and &%return_fail_output%& options
24864 control what is done with it.
24865
24866 Not running the command under a shell (by default) lessens the security risks
24867 in cases when a command from a user's filter file is built out of data that was
24868 taken from an incoming message. If a shell is required, it can of course be
24869 explicitly specified as the command to be run. However, there are circumstances
24870 where existing commands (for example, in &_.forward_& files) expect to be run
24871 under a shell and cannot easily be modified. To allow for these cases, there is
24872 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24873 works. Instead of breaking up the command line as just described, it expands it
24874 as a single string and passes the result to &_/bin/sh_&. The
24875 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24876 with &%use_shell%&, and the whole mechanism is inherently less secure.
24877
24878
24879
24880 .section "Environment variables" "SECTpipeenv"
24881 .cindex "&(pipe)& transport" "environment for command"
24882 .cindex "environment" "&(pipe)& transport"
24883 The environment variables listed below are set up when the command is invoked.
24884 This list is a compromise for maximum compatibility with other MTAs. Note that
24885 the &%environment%& option can be used to add additional variables to this
24886 environment. The environment for the &(pipe)& transport is not subject
24887 to the &%add_environment%& and &%keep_environment%& main config options.
24888 &*Note*&: Using enviroment variables loses track of tainted data.
24889 Writers of &(pipe)& transport commands should be wary of data supplied
24890 by potential attackers.
24891 .display
24892 &`DOMAIN            `&   the domain of the address
24893 &`HOME              `&   the home directory, if set
24894 &`HOST              `&   the host name when called from a router (see below)
24895 &`LOCAL_PART        `&   see below
24896 &`LOCAL_PART_PREFIX `&   see below
24897 &`LOCAL_PART_SUFFIX `&   see below
24898 &`LOGNAME           `&   see below
24899 &`MESSAGE_ID        `&   Exim's local ID for the message
24900 &`PATH              `&   as specified by the &%path%& option below
24901 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24902 &`RECIPIENT         `&   the complete recipient address
24903 &`SENDER            `&   the sender of the message (empty if a bounce)
24904 &`SHELL             `&   &`/bin/sh`&
24905 &`TZ                `&   the value of the &%timezone%& option, if set
24906 &`USER              `&   see below
24907 .endd
24908 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24909 router, LOCAL_PART is set to the local part of the address. When it is
24910 called as a result of a forward or alias expansion, LOCAL_PART is set to
24911 the local part of the address that was expanded. In both cases, any affixes are
24912 removed from the local part, and made available in LOCAL_PART_PREFIX and
24913 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24914 same value as LOCAL_PART for compatibility with other MTAs.
24915
24916 .cindex "HOST"
24917 HOST is set only when a &(pipe)& transport is called from a router that
24918 associates hosts with an address, typically when using &(pipe)& as a
24919 pseudo-remote transport. HOST is set to the first host name specified by
24920 the router.
24921
24922 .cindex "HOME"
24923 If the transport's generic &%home_directory%& option is set, its value is used
24924 for the HOME environment variable. Otherwise, a home directory may be set
24925 by the router's &%transport_home_directory%& option, which defaults to the
24926 user's home directory if &%check_local_user%& is set.
24927
24928
24929 .section "Private options for pipe" "SECID142"
24930 .cindex "options" "&(pipe)& transport"
24931
24932
24933
24934 .option allow_commands pipe "string list&!!" unset
24935 .cindex "&(pipe)& transport" "permitted commands"
24936 The string is expanded, and is then interpreted as a colon-separated list of
24937 permitted commands. If &%restrict_to_path%& is not set, the only commands
24938 permitted are those in the &%allow_commands%& list. They need not be absolute
24939 paths; the &%path%& option is still used for relative paths. If
24940 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24941 in the &%allow_commands%& list, or a name without any slashes that is found on
24942 the path. In other words, if neither &%allow_commands%& nor
24943 &%restrict_to_path%& is set, there is no restriction on the command, but
24944 otherwise only commands that are permitted by one or the other are allowed. For
24945 example, if
24946 .code
24947 allow_commands = /usr/bin/vacation
24948 .endd
24949 and &%restrict_to_path%& is not set, the only permitted command is
24950 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24951 &%use_shell%& is set.
24952
24953
24954 .option batch_id pipe string&!! unset
24955 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24956
24957
24958 .option batch_max pipe integer 1
24959 This limits the number of addresses that can be handled in a single delivery.
24960 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24961
24962
24963 .option check_string pipe string unset
24964 As &(pipe)& writes the message, the start of each line is tested for matching
24965 &%check_string%&, and if it does, the initial matching characters are replaced
24966 by the contents of &%escape_string%&, provided both are set. The value of
24967 &%check_string%& is a literal string, not a regular expression, and the case of
24968 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24969 of &%check_string%& and &%escape_string%& are forced to values that implement
24970 the SMTP escaping protocol. Any settings made in the configuration file are
24971 ignored.
24972
24973
24974 .option command pipe string&!! unset
24975 This option need not be set when &(pipe)& is being used to deliver to pipes
24976 obtained directly from address redirections. In other cases, the option must be
24977 set, to provide a command to be run. It need not yield an absolute path (see
24978 the &%path%& option below). The command is split up into separate arguments by
24979 Exim, and each argument is separately expanded, as described in section
24980 &<<SECThowcommandrun>>& above.
24981
24982 .cindex "tainted data"
24983 No part of the resulting command may be tainted.
24984
24985
24986 .option environment pipe "string list&!!" unset
24987 .cindex "&(pipe)& transport" "environment for command"
24988 .cindex "environment" "&(pipe)& transport"
24989 This option is used to add additional variables to the environment in which the
24990 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24991 a string which is expanded, and then interpreted as a colon-separated list of
24992 environment settings of the form <&'name'&>=<&'value'&>.
24993
24994
24995 .option escape_string pipe string unset
24996 See &%check_string%& above.
24997
24998
24999 .option freeze_exec_fail pipe boolean false
25000 .cindex "exec failure"
25001 .cindex "failure of exec"
25002 .cindex "&(pipe)& transport" "failure of exec"
25003 Failure to exec the command in a pipe transport is by default treated like
25004 any other failure while running the command. However, if &%freeze_exec_fail%&
25005 is set, failure to exec is treated specially, and causes the message to be
25006 frozen, whatever the setting of &%ignore_status%&.
25007
25008
25009 .option freeze_signal pipe boolean false
25010 .cindex "signal exit"
25011 .cindex "&(pipe)& transport", "signal exit"
25012 Normally if the process run by a command in a pipe transport exits on a signal,
25013 a bounce message is sent. If &%freeze_signal%& is set, the message will be
25014 frozen in Exim's queue instead.
25015
25016
25017 .option force_command pipe boolean false
25018 .cindex "force command"
25019 .cindex "&(pipe)& transport", "force command"
25020 Normally when a router redirects an address directly to a pipe command
25021 the &%command%& option on the transport is ignored.  If &%force_command%&
25022 is set, the &%command%& option will used. This is especially
25023 useful for forcing a wrapper or additional argument to be added to the
25024 command. For example:
25025 .code
25026 command = /usr/bin/remote_exec myhost -- $address_pipe
25027 force_command
25028 .endd
25029
25030 Note that &$address_pipe$& is handled specially in &%command%& when
25031 &%force_command%& is set, expanding out to the original argument vector as
25032 separate items, similarly to a Unix shell &`"$@"`& construct.
25033
25034
25035 .option ignore_status pipe boolean false
25036 If this option is true, the status returned by the subprocess that is set up to
25037 run the command is ignored, and Exim behaves as if zero had been returned.
25038 Otherwise, a non-zero status or termination by signal causes an error return
25039 from the transport unless the status value is one of those listed in
25040 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
25041
25042 &*Note*&: This option does not apply to timeouts, which do not return a status.
25043 See the &%timeout_defer%& option for how timeouts are handled.
25044
25045
25046 .option log_defer_output pipe boolean false
25047 .cindex "&(pipe)& transport" "logging output"
25048 If this option is set, and the status returned by the command is
25049 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
25050 and any output was produced on stdout or stderr, the first line of it is
25051 written to the main log.
25052
25053
25054 .option log_fail_output pipe boolean false
25055 If this option is set, and the command returns any output on stdout or
25056 stderr, and also ends with a return code that is neither zero nor one of
25057 the return codes listed in &%temp_errors%& (that is, the delivery
25058 failed), the first line of output is written to the main log. This
25059 option and &%log_output%& are mutually exclusive.  Only one of them may
25060 be set.
25061
25062
25063 .option log_output pipe boolean false
25064 If this option is set and the command returns any output on stdout or
25065 stderr, the first line of output is written to the main log, whatever
25066 the return code. This option and &%log_fail_output%& are mutually
25067 exclusive. Only one of them may be set.
25068
25069
25070 .option max_output pipe integer 20K
25071 This specifies the maximum amount of output that the command may produce on its
25072 standard output and standard error file combined. If the limit is exceeded, the
25073 process running the command is killed. This is intended as a safety measure to
25074 catch runaway processes. The limit is applied independently of the settings of
25075 the options that control what is done with such output (for example,
25076 &%return_output%&). Because of buffering effects, the amount of output may
25077 exceed the limit by a small amount before Exim notices.
25078
25079
25080 .option message_prefix pipe string&!! "see below"
25081 The string specified here is expanded and output at the start of every message.
25082 The default is unset if &%use_bsmtp%& is set. Otherwise it is
25083 .code
25084 message_prefix = \
25085   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
25086   ${tod_bsdinbox}\n
25087 .endd
25088 .cindex "Cyrus"
25089 .cindex "&%tmail%&"
25090 .cindex "&""From""& line"
25091 This is required by the commonly used &_/usr/bin/vacation_& program.
25092 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
25093 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
25094 setting
25095 .code
25096 message_prefix =
25097 .endd
25098 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
25099 &`\n`& to &`\r\n`& in &%message_prefix%&.
25100
25101
25102 .option message_suffix pipe string&!! "see below"
25103 The string specified here is expanded and output at the end of every message.
25104 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
25105 The suffix can be suppressed by setting
25106 .code
25107 message_suffix =
25108 .endd
25109 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
25110 &`\n`& to &`\r\n`& in &%message_suffix%&.
25111
25112
25113 .option path pipe string&!! "/bin:/usr/bin"
25114 This option is expanded and
25115 specifies the string that is set up in the PATH environment
25116 variable of the subprocess.
25117 If the &%command%& option does not yield an absolute path name, the command is
25118 sought in the PATH directories, in the usual way. &*Warning*&: This does not
25119 apply to a command specified as a transport filter.
25120
25121
25122 .option permit_coredump pipe boolean false
25123 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
25124 a core-dump of a pipe command, enable this command.  This enables core-dumps
25125 during delivery and affects both the Exim binary and the pipe command run.
25126 It is recommended that this option remain off unless and until you have a need
25127 for it and that this only be enabled when needed, as the risk of excessive
25128 resource consumption can be quite high.  Note also that Exim is typically
25129 installed as a setuid binary and most operating systems will inhibit coredumps
25130 of these by default, so further OS-specific action may be required.
25131
25132
25133 .option pipe_as_creator pipe boolean false
25134 .cindex "uid (user id)" "local delivery"
25135 If the generic &%user%& option is not set and this option is true, the delivery
25136 process is run under the uid that was in force when Exim was originally called
25137 to accept the message. If the group id is not otherwise set (via the generic
25138 &%group%& option), the gid that was in force when Exim was originally called to
25139 accept the message is used.
25140
25141
25142 .option restrict_to_path pipe boolean false
25143 When this option is set, any command name not listed in &%allow_commands%& must
25144 contain no slashes. The command is searched for only in the directories listed
25145 in the &%path%& option. This option is intended for use in the case when a pipe
25146 command has been generated from a user's &_.forward_& file. This is usually
25147 handled by a &(pipe)& transport called &%address_pipe%&.
25148
25149
25150 .option return_fail_output pipe boolean false
25151 If this option is true, and the command produced any output and ended with a
25152 return code other than zero or one of the codes listed in &%temp_errors%& (that
25153 is, the delivery failed), the output is returned in the bounce message.
25154 However, if the message has a null sender (that is, it is itself a bounce
25155 message), output from the command is discarded. This option and
25156 &%return_output%& are mutually exclusive. Only one of them may be set.
25157
25158
25159
25160 .option return_output pipe boolean false
25161 If this option is true, and the command produced any output, the delivery is
25162 deemed to have failed whatever the return code from the command, and the output
25163 is returned in the bounce message. Otherwise, the output is just discarded.
25164 However, if the message has a null sender (that is, it is a bounce message),
25165 output from the command is always discarded, whatever the setting of this
25166 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25167 of them may be set.
25168
25169
25170
25171 .option temp_errors pipe "string list" "see below"
25172 .cindex "&(pipe)& transport" "temporary failure"
25173 This option contains either a colon-separated list of numbers, or a single
25174 asterisk. If &%ignore_status%& is false
25175 and &%return_output%& is not set,
25176 and the command exits with a non-zero return code, the failure is treated as
25177 temporary and the delivery is deferred if the return code matches one of the
25178 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25179 codes are treated as permanent errors. The default setting contains the codes
25180 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25181 compiled on a system that does not define these macros, it assumes values of 75
25182 and 73, respectively.
25183
25184
25185 .option timeout pipe time 1h
25186 If the command fails to complete within this time, it is killed. This normally
25187 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25188 specifies no timeout. In order to ensure that any subprocesses created by the
25189 command are also killed, Exim makes the initial process a process group leader,
25190 and kills the whole process group on a timeout. However, this can be defeated
25191 if one of the processes starts a new process group.
25192
25193 .option timeout_defer pipe boolean false
25194 A timeout in a &(pipe)& transport, either in the command that the transport
25195 runs, or in a transport filter that is associated with it, is by default
25196 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25197 is set true, both kinds of timeout become temporary errors, causing the
25198 delivery to be deferred.
25199
25200 .option umask pipe "octal integer" 022
25201 This specifies the umask setting for the subprocess that runs the command.
25202
25203
25204 .option use_bsmtp pipe boolean false
25205 .cindex "envelope sender"
25206 If this option is set true, the &(pipe)& transport writes messages in &"batch
25207 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25208 commands. If you want to include a leading HELO command with such messages,
25209 you can do so by setting the &%message_prefix%& option. See section
25210 &<<SECTbatchSMTP>>& for details of batch SMTP.
25211
25212 .option use_classresources pipe boolean false
25213 .cindex "class resources (BSD)"
25214 This option is available only when Exim is running on FreeBSD, NetBSD, or
25215 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25216 resource limits when a &(pipe)& transport is run to perform a delivery. The
25217 limits for the uid under which the pipe is to run are obtained from the login
25218 class database.
25219
25220
25221 .option use_crlf pipe boolean false
25222 .cindex "carriage return"
25223 .cindex "linefeed"
25224 This option causes lines to be terminated with the two-character CRLF sequence
25225 (carriage return, linefeed) instead of just a linefeed character. In the case
25226 of batched SMTP, the byte sequence written to the pipe is then an exact image
25227 of what would be sent down a real SMTP connection.
25228
25229 The contents of the &%message_prefix%& and &%message_suffix%& options are
25230 written verbatim, so must contain their own carriage return characters if these
25231 are needed. When &%use_bsmtp%& is not set, the default values for both
25232 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25233 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25234
25235
25236 .option use_shell pipe boolean false
25237 .vindex "&$pipe_addresses$&"
25238 If this option is set, it causes the command to be passed to &_/bin/sh_&
25239 instead of being run directly from the transport, as described in section
25240 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25241 where the command is expected to be run under a shell and cannot easily be
25242 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25243 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25244 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25245 its &%-c%& option.
25246
25247
25248
25249 .section "Using an external local delivery agent" "SECID143"
25250 .cindex "local delivery" "using an external agent"
25251 .cindex "&'procmail'&"
25252 .cindex "external local delivery"
25253 .cindex "delivery" "&'procmail'&"
25254 .cindex "delivery" "by external agent"
25255 The &(pipe)& transport can be used to pass all messages that require local
25256 delivery to a separate local delivery agent such as &%procmail%&. When doing
25257 this, care must be taken to ensure that the pipe is run under an appropriate
25258 uid and gid. In some configurations one wants this to be a uid that is trusted
25259 by the delivery agent to supply the correct sender of the message. It may be
25260 necessary to recompile or reconfigure the delivery agent so that it trusts an
25261 appropriate user. The following is an example transport and router
25262 configuration for &%procmail%&:
25263 .code
25264 # transport
25265 procmail_pipe:
25266   driver = pipe
25267   command = /usr/local/bin/procmail -d $local_part_data
25268   return_path_add
25269   delivery_date_add
25270   envelope_to_add
25271   check_string = "From "
25272   escape_string = ">From "
25273   umask = 077
25274   user = $local_part_data
25275   group = mail
25276
25277 # router
25278 procmail:
25279   driver = accept
25280   check_local_user
25281   transport = procmail_pipe
25282 .endd
25283 In this example, the pipe is run as the local user, but with the group set to
25284 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25285 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25286 user to supply a correct sender address. If you do not specify either a
25287 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25288 home directory is the user's home directory by default.
25289
25290 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25291 .code
25292 IFS=" "
25293 .endd
25294 as shown in some &%procmail%& documentation, because Exim does not by default
25295 use a shell to run pipe commands.
25296
25297 .cindex "Cyrus"
25298 The next example shows a transport and a router for a system where local
25299 deliveries are handled by the Cyrus IMAP server.
25300 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25301 . but that suffix is tainted so cannot be used in a command arg
25302 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25303 .code
25304 # transport
25305 local_delivery_cyrus:
25306   driver = pipe
25307   command = /usr/cyrus/bin/deliver \
25308             -- $local_part_data
25309   user = cyrus
25310   group = mail
25311   return_output
25312   log_output
25313   message_prefix =
25314   message_suffix =
25315
25316 # router
25317 local_user_cyrus:
25318   driver = accept
25319   check_local_user
25320   transport = local_delivery_cyrus
25321 .endd
25322 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25323 &%return_output%& to cause any text written by Cyrus to be returned to the
25324 sender.
25325 .ecindex IIDpiptra1
25326 .ecindex IIDpiptra2
25327
25328
25329 . ////////////////////////////////////////////////////////////////////////////
25330 . ////////////////////////////////////////////////////////////////////////////
25331
25332 .chapter "The smtp transport" "CHAPsmtptrans"
25333 .scindex IIDsmttra1 "transports" "&(smtp)&"
25334 .scindex IIDsmttra2 "&(smtp)& transport"
25335 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25336 or LMTP protocol. The list of hosts to try can either be taken from the address
25337 that is being processed (having been set up by the router), or specified
25338 explicitly for the transport. Timeout and retry processing (see chapter
25339 &<<CHAPretry>>&) is applied to each IP address independently.
25340
25341
25342 .section "Multiple messages on a single connection" "SECID144"
25343 The sending of multiple messages over a single TCP/IP connection can arise in
25344 two ways:
25345
25346 .ilist
25347 If a message contains more than &%max_rcpt%& (see below) addresses that are
25348 routed to the same host, more than one copy of the message has to be sent to
25349 that host. In this situation, multiple copies may be sent in a single run of
25350 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25351 does when it has too many addresses to send in one message also depends on the
25352 value of the global &%remote_max_parallel%& option. Details are given in
25353 section &<<SECToutSMTPTCP>>&.)
25354 .next
25355 .cindex "hints database" "remembering routing"
25356 When a message has been successfully delivered over a TCP/IP connection, Exim
25357 looks in its hints database to see if there are any other messages awaiting a
25358 connection to the same host. If there are, a new delivery process is started
25359 for one of them, and the current TCP/IP connection is passed on to it. The new
25360 process may in turn send multiple copies and possibly create yet another
25361 process.
25362 .endlist
25363
25364
25365 For each copy sent over the same TCP/IP connection, a sequence counter is
25366 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25367 no further messages are sent over that connection.
25368
25369
25370
25371 .section "Use of the $host and $host_address variables" "SECID145"
25372 .vindex "&$host$&"
25373 .vindex "&$host_address$&"
25374 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25375 &$host_address$& are the name and IP address of the first host on the host list
25376 passed by the router. However, when the transport is about to connect to a
25377 specific host, and while it is connected to that host, &$host$& and
25378 &$host_address$& are set to the values for that host. These are the values
25379 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25380 &%serialize_hosts%&, and the various TLS options are expanded.
25381
25382
25383 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25384 .vindex &$tls_bits$&
25385 .vindex &$tls_cipher$&
25386 .vindex &$tls_peerdn$&
25387 .vindex &$tls_sni$&
25388 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25389 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25390 are the values that were set when the message was received.
25391 These are the values that are used for options that are expanded before any
25392 SMTP connections are made. Just before each connection is made, these four
25393 variables are emptied. If TLS is subsequently started, they are set to the
25394 appropriate values for the outgoing connection, and these are the values that
25395 are in force when any authenticators are run and when the
25396 &%authenticated_sender%& option is expanded.
25397
25398 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25399 and will be removed in a future release.
25400
25401
25402 .section "Private options for smtp" "SECID146"
25403 .cindex "options" "&(smtp)& transport"
25404 The private options of the &(smtp)& transport are as follows:
25405
25406
25407 .option address_retry_include_sender smtp boolean true
25408 .cindex "4&'xx'& responses" "retrying after"
25409 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25410 is the combination of sender and recipient that is delayed in subsequent queue
25411 runs until the retry time is reached. You can delay the recipient without
25412 reference to the sender (which is what earlier versions of Exim did), by
25413 setting &%address_retry_include_sender%& false. However, this can lead to
25414 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25415
25416 .option allow_localhost smtp boolean false
25417 .cindex "local host" "sending to"
25418 .cindex "fallback" "hosts specified on transport"
25419 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25420 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25421 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25422 the delivery anyway. This should be used only in special cases when the
25423 configuration ensures that no looping will result (for example, a differently
25424 configured Exim is listening on the port to which the message is sent).
25425
25426
25427 .option authenticated_sender smtp string&!! unset
25428 .cindex "Cyrus"
25429 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25430 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25431 overriding any existing authenticated sender value. If the string expansion is
25432 forced to fail, the option is ignored. Other expansion failures cause delivery
25433 to be deferred. If the result of expansion is an empty string, that is also
25434 ignored.
25435
25436 The expansion happens after the outgoing connection has been made and TLS
25437 started, if required. This means that the &$host$&, &$host_address$&,
25438 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25439 particular connection.
25440
25441 If the SMTP session is not authenticated, the expansion of
25442 &%authenticated_sender%& still happens (and can cause the delivery to be
25443 deferred if it fails), but no AUTH= item is added to MAIL commands
25444 unless &%authenticated_sender_force%& is true.
25445
25446 This option allows you to use the &(smtp)& transport in LMTP mode to
25447 deliver mail to Cyrus IMAP and provide the proper local part as the
25448 &"authenticated sender"&, via a setting such as:
25449 .code
25450 authenticated_sender = $local_part
25451 .endd
25452 This removes the need for IMAP subfolders to be assigned special ACLs to
25453 allow direct delivery to those subfolders.
25454
25455 Because of expected uses such as that just described for Cyrus (when no
25456 domain is involved), there is no checking on the syntax of the provided
25457 value.
25458
25459
25460 .option authenticated_sender_force smtp boolean false
25461 If this option is set true, the &%authenticated_sender%& option's value
25462 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25463 authenticated as a client.
25464
25465
25466 .option command_timeout smtp time 5m
25467 .cindex timeout "smtp transport command"
25468 This sets a timeout for receiving a response to an SMTP command that has been
25469 sent out. It is also used when waiting for the initial banner line from the
25470 remote host. Its value must not be zero.
25471
25472
25473 .option connect_timeout smtp time 5m
25474 .cindex timeout "smtp transport connect"
25475 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25476 to a remote host. A setting of zero allows the system timeout (typically
25477 several minutes) to act. To have any effect, the value of this option must be
25478 less than the system timeout. However, it has been observed that on some
25479 systems there is no system timeout, which is why the default value for this
25480 option is 5 minutes, a value recommended by RFC 1123.
25481
25482
25483 .option connection_max_messages smtp integer 500
25484 .cindex "SMTP" "passed connection"
25485 .cindex "SMTP" "multiple deliveries"
25486 .cindex "multiple SMTP deliveries"
25487 This controls the maximum number of separate message deliveries that are sent
25488 over a single TCP/IP connection. If the value is zero, there is no limit.
25489 For testing purposes, this value can be overridden by the &%-oB%& command line
25490 option.
25491
25492 .cindex "ESMTP extensions" LIMITS
25493 If the peer advertises a LIMITS extension with a MAILMAX value,
25494 and either TLSS is in use or was not advertised,
25495 that value also constrains the result of this option.
25496
25497
25498 .option dane_require_tls_ciphers smtp string&!! unset
25499 .cindex "TLS" "requiring specific ciphers for DANE"
25500 .cindex "cipher" "requiring specific"
25501 .cindex DANE "TLS ciphers"
25502 This option may be used to override &%tls_require_ciphers%& for connections
25503 where DANE has been determined to be in effect.
25504 If not set, then &%tls_require_ciphers%& will be used.
25505 Normal SMTP delivery is not able to make strong demands of TLS cipher
25506 configuration, because delivery will fall back to plaintext.  Once DANE has
25507 been determined to be in effect, there is no plaintext fallback and making the
25508 TLS cipherlist configuration stronger will increase security, rather than
25509 counter-intuitively decreasing it.
25510 If the option expands to be empty or is forced to fail, then it will
25511 be treated as unset and &%tls_require_ciphers%& will be used instead.
25512
25513
25514 .option data_timeout smtp time 5m
25515 .cindex timeout "for transmitted SMTP data blocks"
25516 This sets a timeout for the transmission of each block in the data portion of
25517 the message. As a result, the overall timeout for a message depends on the size
25518 of the message. Its value must not be zero. See also &%final_timeout%&.
25519
25520
25521 .option dkim_canon smtp string&!! unset
25522 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25523 .option dkim_domain smtp "string list&!!" unset
25524 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25525 .option dkim_hash smtp string&!! sha256
25526 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25527 .option dkim_identity smtp string&!! unset
25528 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25529 .option dkim_private_key smtp string&!! unset
25530 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25531 .option dkim_selector smtp string&!! unset
25532 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25533 .option dkim_strict smtp string&!! unset
25534 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25535 .option dkim_sign_headers smtp string&!! "per RFC"
25536 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25537 .option dkim_timestamps smtp string&!! unset
25538 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25539
25540
25541 .option delay_after_cutoff smtp boolean true
25542 .cindex "final cutoff" "retries, controlling"
25543 .cindex retry "final cutoff"
25544 This option controls what happens when all remote IP addresses for a given
25545 domain have been inaccessible for so long that they have passed their retry
25546 cutoff times.
25547
25548 In the default state, if the next retry time has not been reached for any of
25549 them, the address is bounced without trying any deliveries. In other words,
25550 Exim delays retrying an IP address after the final cutoff time until a new
25551 retry time is reached, and can therefore bounce an address without ever trying
25552 a delivery, when machines have been down for a long time. Some people are
25553 unhappy at this prospect, so...
25554
25555 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25556 addresses are past their final cutoff time, Exim tries to deliver to those
25557 IP addresses that have not been tried since the message arrived. If there are
25558 none, of if they all fail, the address is bounced. In other words, it does not
25559 delay when a new message arrives, but immediately tries those expired IP
25560 addresses that haven't been tried since the message arrived. If there is a
25561 continuous stream of messages for the dead hosts, unsetting
25562 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25563 to them.
25564
25565
25566 .option dns_qualify_single smtp boolean true
25567 If the &%hosts%& or &%fallback_hosts%& option is being used,
25568 and the &%gethostbyname%& option is false,
25569 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25570 in chapter &<<CHAPdnslookup>>& for more details.
25571
25572
25573 .option dns_search_parents smtp boolean false
25574 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25575 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25576 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25577 details.
25578
25579
25580 .option dnssec_request_domains smtp "domain list&!!" *
25581 .cindex "MX record" "security"
25582 .cindex "DNSSEC" "MX lookup"
25583 .cindex "security" "MX lookup"
25584 .cindex "DNS" "DNSSEC"
25585 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25586 the DNSSEC request bit set. Setting this transport option is only useful if the
25587 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25588 router option.
25589
25590
25591
25592 .option dnssec_require_domains smtp "domain list&!!" unset
25593 .cindex "MX record" "security"
25594 .cindex "DNSSEC" "MX lookup"
25595 .cindex "security" "MX lookup"
25596 .cindex "DNS" "DNSSEC"
25597 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25598 the DNSSEC request bit set.  Setting this transport option is only
25599 useful if the transport overrides or sets the host names. See the
25600 &%dnssec_require_domains%& router option.
25601
25602
25603
25604 .option dscp smtp string&!! unset
25605 .cindex "DCSP" "outbound"
25606 This option causes the DSCP value associated with a socket to be set to one
25607 of a number of fixed strings or to numeric value.
25608 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25609 Common values include &`throughput`&, &`mincost`&, and on newer systems
25610 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25611
25612 The outbound packets from Exim will be marked with this value in the header
25613 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25614 that these values will have any effect, not be stripped by networking
25615 equipment, or do much of anything without cooperation with your Network
25616 Engineer and those of all network operators between the source and destination.
25617
25618
25619 .option fallback_hosts smtp "string list" unset
25620 .cindex "fallback" "hosts specified on transport"
25621 String expansion is not applied to this option. The argument must be a
25622 colon-separated list of host names or IP addresses, optionally also including
25623 port numbers, though the separator can be changed, as described in section
25624 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25625 item in a &%route_list%& setting for the &(manualroute)& router, as described
25626 in section &<<SECTformatonehostitem>>&.
25627
25628 Fallback hosts can also be specified on routers, which associate them with the
25629 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25630 &%fallback_hosts%& specified on the transport is used only if the address does
25631 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25632 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25633 However, &%hosts_randomize%& does apply to fallback host lists.
25634
25635 If Exim is unable to deliver to any of the hosts for a particular address, and
25636 the errors are not permanent rejections, the address is put on a separate
25637 transport queue with its host list replaced by the fallback hosts, unless the
25638 address was routed via MX records and the current host was in the original MX
25639 list. In that situation, the fallback host list is not used.
25640
25641 Once normal deliveries are complete, the fallback queue is delivered by
25642 re-running the same transports with the new host lists. If several failing
25643 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25644 copy of the message is sent.
25645
25646 The resolution of the host names on the fallback list is controlled by the
25647 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25648 both to cases when the host list comes with the address and when it is taken
25649 from &%hosts%&. This option provides a &"use a smart host only if delivery
25650 fails"& facility.
25651
25652
25653 .option final_timeout smtp time 10m
25654 .cindex timeout "for transmitted SMTP data accept"
25655 This is the timeout that applies while waiting for the response to the final
25656 line containing just &"."& that terminates a message. Its value must not be
25657 zero.
25658
25659 .option gethostbyname smtp boolean false
25660 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25661 being used, names are looked up using &[gethostbyname()]&
25662 (or &[getipnodebyname()]& when available)
25663 instead of using the DNS. Of course, that function may in fact use the DNS, but
25664 it may also consult other sources of information such as &_/etc/hosts_&.
25665
25666 .option gnutls_compat_mode smtp boolean unset
25667 This option controls whether GnuTLS is used in compatibility mode in an Exim
25668 server. This reduces security slightly, but improves interworking with older
25669 implementations of TLS.
25670
25671 .option helo_data smtp string&!! "see below"
25672 .cindex "HELO" "argument, setting"
25673 .cindex "EHLO" "argument, setting"
25674 .cindex "LHLO argument setting"
25675 The value of this option is expanded after a connection to a another host has
25676 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25677 command that starts the outgoing SMTP or LMTP session. The default value of the
25678 option is:
25679 .code
25680 $primary_hostname
25681 .endd
25682 During the expansion, the variables &$host$& and &$host_address$& are set to
25683 the identity of the remote host, and the variables &$sending_ip_address$& and
25684 &$sending_port$& are set to the local IP address and port number that are being
25685 used. These variables can be used to generate different values for different
25686 servers or different local IP addresses. For example, if you want the string
25687 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25688 interface address, you could use this:
25689 .code
25690 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25691   {${listextract{1}{<\n $value}}} \
25692   {$primary_hostname}}
25693 .endd
25694 The use of &%helo_data%& applies both to sending messages and when doing
25695 callouts.
25696
25697 .option host_name_extract smtp "string list&!!" "see below"
25698 .cindex "load balancer" "hosts behind"
25699 .cindex TLS resumption
25700 Some mail-accepting sites
25701 (notably Microsoft)
25702 operate many servers behind a network load-balancer.  When this is done,
25703 with separated TLS session caches, TLS session resuption becomes problematic.
25704 It will only succeed when the same server happens to be selected by the
25705 load-balancer, matching the session stored in the client's cache.
25706
25707 Exim can pull out a server name, if there is one, from the response to the
25708 client's SMTP EHLO command.
25709 For normal STARTTLS use, the default value of this option:
25710 .code
25711     ${if and { {match {$host} {.outlook.com\$}} \
25712                {match {$item} {\N^250-([\w.]+)\s\N}} \
25713              } {$1}}
25714 .endd
25715 suffices for one known case.
25716
25717 During the expansion of this option the &$item$& variable will have the
25718 server's EHLO response.
25719
25720 For TLS-on-connect connections we do not have an EHLO
25721 response to use. Because of this the default value of this option is
25722 set to a static string for those cases, meaning that resumption will
25723 always be attempted if permitted by the &%tls_resumption_hosts%& option.
25724
25725 The result of the option expansion is included in the key used to store and
25726 retrieve the TLS session, for session resumption.
25727
25728 Operators of high-load sites may wish to evaluate their logs for indications
25729 of other destination sites operating load-balancers, and develop a suitable
25730 expression for this option.
25731 The smtp:ehlo event and the &$tls_out_resumption$& variable
25732 will be useful for such work.
25733
25734 .option hosts smtp "string list&!!" unset
25735 Hosts are associated with an address by a router such as &(dnslookup)&, which
25736 finds the hosts by looking up the address domain in the DNS, or by
25737 &(manualroute)&, which has lists of hosts in its configuration. However,
25738 email addresses can be passed to the &(smtp)& transport by any router, and not
25739 all of them can provide an associated list of hosts.
25740
25741 The &%hosts%& option specifies a list of hosts to be used if the address being
25742 processed does not have any hosts associated with it. The hosts specified by
25743 &%hosts%& are also used, whether or not the address has its own hosts, if
25744 &%hosts_override%& is set.
25745
25746 The string is first expanded, before being interpreted as a colon-separated
25747 list of host names or IP addresses, possibly including port numbers. The
25748 separator may be changed to something other than colon, as described in section
25749 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25750 item in a &%route_list%& setting for the &(manualroute)& router, as described
25751 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25752 of the &(manualroute)& router is not available here.
25753
25754 If the expansion fails, delivery is deferred. Unless the failure was caused by
25755 the inability to complete a lookup, the error is logged to the panic log as
25756 well as the main log. Host names are looked up either by searching directly for
25757 address records in the DNS or by calling &[gethostbyname()]& (or
25758 &[getipnodebyname()]& when available), depending on the setting of the
25759 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25760 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25761 address are used.
25762
25763 During delivery, the hosts are tried in order, subject to their retry status,
25764 unless &%hosts_randomize%& is set.
25765
25766
25767 .option hosts_avoid_esmtp smtp "host list&!!" unset
25768 .cindex "ESMTP, avoiding use of"
25769 .cindex "HELO" "forcing use of"
25770 .cindex "EHLO" "avoiding use of"
25771 .cindex "PIPELINING" "avoiding the use of"
25772 This option is for use with broken hosts that announce ESMTP facilities (for
25773 example, PIPELINING) and then fail to implement them properly. When a host
25774 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25775 start of the SMTP session. This means that it cannot use any of the ESMTP
25776 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25777
25778
25779 .option hosts_avoid_pipelining smtp "host list&!!" unset
25780 .cindex "PIPELINING" "avoiding the use of"
25781 .cindex "ESMTP extensions" PIPELINING
25782 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25783 that matches this list, even if the server host advertises PIPELINING support.
25784
25785 .option hosts_pipe_connect smtp "host list&!!" unset
25786 .cindex "pipelining" "early connection"
25787 .cindex "pipelining" PIPECONNECT
25788 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25789 this option controls which to hosts the facility watched for
25790 and recorded, and used for subsequent connections.
25791
25792 The retry hints database is used for the record,
25793 and records are subject to the &%retry_data_expire%& option.
25794 When used, the pipelining saves on roundtrip times.
25795 It also turns SMTP into a client-first protocol
25796 so combines well with TCP Fast Open.
25797
25798 See also the &%pipelining_connect_advertise_hosts%& main option.
25799
25800 Note:
25801 When the facility is used, if the transport &%interface%& option is unset
25802 the &%helo_data%& option
25803 will be expanded before the &$sending_ip_address$& variable
25804 is filled in.
25805 A check is made for the use of that variable, without the
25806 presence of a &"def:"& test on it, but suitably complex coding
25807 can avoid the check and produce unexpected results.
25808 You have been warned.
25809
25810
25811 .option hosts_avoid_tls smtp "host list&!!" unset
25812 .cindex "TLS" "avoiding for certain hosts"
25813 Exim will not try to start a TLS session when delivering to any host that
25814 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25815
25816 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25817 .cindex "TLS" "avoiding for certain hosts"
25818 Exim will not try to start a TLS session for a verify callout,
25819 or when delivering in cutthrough mode,
25820 to any host that matches this list.
25821
25822
25823 .option hosts_max_try smtp integer 5
25824 .cindex "host" "maximum number to try"
25825 .cindex "limit" "number of hosts tried"
25826 .cindex "limit" "number of MX tried"
25827 .cindex "MX record" "maximum tried"
25828 This option limits the number of IP addresses that are tried for any one
25829 delivery in cases where there are temporary delivery errors. Section
25830 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25831
25832
25833 .option hosts_max_try_hardlimit smtp integer 50
25834 This is an additional check on the maximum number of IP addresses that Exim
25835 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25836 why it exists.
25837
25838
25839
25840 .option hosts_nopass_tls smtp "host list&!!" unset
25841 .cindex "TLS" "passing connection"
25842 .cindex "multiple SMTP deliveries"
25843 .cindex "TLS" "multiple message deliveries"
25844 For any host that matches this list, a connection on which a TLS session has
25845 been started will not be passed to a new delivery process for sending another
25846 message on the same connection. See section &<<SECTmulmessam>>& for an
25847 explanation of when this might be needed.
25848
25849 .option hosts_noproxy_tls smtp "host list&!!" unset
25850 .cindex "TLS" "passing connection"
25851 .cindex "multiple SMTP deliveries"
25852 .cindex "TLS" "multiple message deliveries"
25853 For any host that matches this list, a TLS session which has
25854 been started will not be passed to a new delivery process for sending another
25855 message on the same session.
25856
25857 The traditional implementation closes down TLS and re-starts it in the new
25858 process, on the same open TCP connection, for each successive message
25859 sent.  If permitted by this option a pipe to to the new process is set up
25860 instead, and the original process maintains the TLS connection and proxies
25861 the SMTP connection from and to the new process and any subsequents.
25862 The new process has no access to TLS information, so cannot include it in
25863 logging.
25864
25865
25866
25867 .option hosts_override smtp boolean false
25868 If this option is set and the &%hosts%& option is also set, any hosts that are
25869 attached to the address are ignored, and instead the hosts specified by the
25870 &%hosts%& option are always used. This option does not apply to
25871 &%fallback_hosts%&.
25872
25873
25874 .option hosts_randomize smtp boolean false
25875 .cindex "randomized host list"
25876 .cindex "host" "list of; randomized"
25877 .cindex "fallback" "randomized hosts"
25878 If this option is set, and either the list of hosts is taken from the
25879 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25880 were not obtained from MX records (this includes fallback hosts from the
25881 router), and were not randomized by the router, the order of trying the hosts
25882 is randomized each time the transport runs. Randomizing the order of a host
25883 list can be used to do crude load sharing.
25884
25885 When &%hosts_randomize%& is true, a host list may be split into groups whose
25886 order is separately randomized. This makes it possible to set up MX-like
25887 behaviour. The boundaries between groups are indicated by an item that is just
25888 &`+`& in the host list. For example:
25889 .code
25890 hosts = host1:host2:host3:+:host4:host5
25891 .endd
25892 The order of the first three hosts and the order of the last two hosts is
25893 randomized for each use, but the first three always end up before the last two.
25894 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25895
25896 .option hosts_require_auth smtp "host list&!!" unset
25897 .cindex "authentication" "required by client"
25898 This option provides a list of servers for which authentication must succeed
25899 before Exim will try to transfer a message. If authentication fails for
25900 servers which are not in this list, Exim tries to send unauthenticated. If
25901 authentication fails for one of these servers, delivery is deferred. This
25902 temporary error is detectable in the retry rules, so it can be turned into a
25903 hard failure if required. See also &%hosts_try_auth%&, and chapter
25904 &<<CHAPSMTPAUTH>>& for details of authentication.
25905
25906
25907 .option hosts_request_ocsp smtp "host list&!!" "see below"
25908 .cindex "TLS" "requiring for certain servers"
25909 Exim will request a Certificate Status on a
25910 TLS session for any host that matches this list.
25911 &%tls_verify_certificates%& should also be set for the transport.
25912
25913 The default is &"**"& if DANE is not in use for the connection,
25914 or if DANE-TA us used.
25915 It is empty if DANE-EE is used.
25916
25917 .option hosts_require_alpn smtp "host list&!!" unset
25918 .cindex ALPN "require negotiation in client"
25919 .cindex TLS ALPN
25920 .cindex TLS "Application Layer Protocol Names"
25921 If the TLS library supports ALPN
25922 then a successful negotiation of ALPN will be required for any host
25923 matching the list, for TLS to be used.
25924 See also the &%tls_alpn%& option.
25925
25926 &*Note*&: prevention of fallback to in-clear connection is not
25927 managed by this option; see &%hosts_require_tls%&.
25928
25929 .option hosts_require_dane smtp "host list&!!" unset
25930 .cindex DANE "transport options"
25931 .cindex DANE "requiring for certain servers"
25932 If built with DANE support, Exim  will require that a DNSSEC-validated
25933 TLSA record is present for any host matching the list,
25934 and that a DANE-verified TLS connection is made.
25935 There will be no fallback to in-clear communication.
25936 See the &%dnssec_request_domains%& router and transport options.
25937 See section &<<SECDANE>>&.
25938
25939 .option hosts_require_ocsp smtp "host list&!!" unset
25940 .cindex "TLS" "requiring for certain servers"
25941 Exim will request, and check for a valid Certificate Status being given, on a
25942 TLS session for any host that matches this list.
25943 &%tls_verify_certificates%& should also be set for the transport.
25944
25945 .option hosts_require_tls smtp "host list&!!" unset
25946 .cindex "TLS" "requiring for certain servers"
25947 Exim will insist on using a TLS session when delivering to any host that
25948 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25949 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25950 incoming messages, use an appropriate ACL.
25951
25952 .option hosts_try_auth smtp "host list&!!" unset
25953 .cindex "authentication" "optional in client"
25954 This option provides a list of servers to which, provided they announce
25955 authentication support, Exim will attempt to authenticate as a client when it
25956 connects. If authentication fails
25957 and &%hosts_require_auth%& permits,
25958 Exim will try to transfer the message unauthenticated.
25959 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25960
25961 .option hosts_try_chunking smtp "host list&!!" *
25962 .cindex CHUNKING "enabling, in client"
25963 .cindex BDAT "SMTP command"
25964 .cindex "RFC 3030" "CHUNKING"
25965 This option provides a list of servers to which, provided they announce
25966 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25967 Unless DKIM signing is being done,
25968 BDAT will not be used in conjunction with a transport filter.
25969
25970 .option hosts_try_dane smtp "host list&!!" *
25971 .cindex DANE "transport options"
25972 .cindex DANE "attempting for certain servers"
25973 If built with DANE support, Exim  will look up a
25974 TLSA record for any host matching the list,
25975 If one is found and that lookup was DNSSEC-validated,
25976 then Exim requires that a DANE-verified TLS connection is made for that host;
25977 there will be no fallback to in-clear communication.
25978 See the &%dnssec_request_domains%& router and transport options.
25979 See section &<<SECDANE>>&.
25980
25981 .option hosts_try_fastopen smtp "host list&!!" *
25982 .cindex "fast open, TCP" "enabling, in client"
25983 .cindex "TCP Fast Open" "enabling, in client"
25984 .cindex "RFC 7413" "TCP Fast Open"
25985 This option provides a list of servers to which, provided
25986 the facility is supported by this system, Exim will attempt to
25987 perform a TCP Fast Open.
25988 No data is sent on the SYN segment but, if the remote server also
25989 supports the facility, it can send its SMTP banner immediately after
25990 the SYN,ACK segment.  This can save up to one round-trip time.
25991
25992 The facility is only active for previously-contacted servers,
25993 as the initiator must present a cookie in the SYN segment.
25994
25995 On (at least some) current Linux distributions the facility must be enabled
25996 in the kernel by the sysadmin before the support is usable.
25997 There is no option for control of the server side; if the system supports
25998 it it is always enabled.  Note that lengthy operations in the connect ACL,
25999 such as DNSBL lookups, will still delay the emission of the SMTP banner.
26000
26001 .option hosts_try_prdr smtp "host list&!!" *
26002 .cindex "PRDR" "enabling, optional in client"
26003 .cindex "ESMTP extensions" PRDR
26004 This option provides a list of servers to which, provided they announce
26005 PRDR support, Exim will attempt to negotiate PRDR
26006 for multi-recipient messages.
26007 The option can usually be left as default.
26008
26009 .option interface smtp "string list&!!" unset
26010 .cindex "bind IP address"
26011 .cindex "IP address" "binding"
26012 .vindex "&$host$&"
26013 .vindex "&$host_address$&"
26014 This option specifies which interface to bind to when making an outgoing SMTP
26015 call. The value is an IP address, not an interface name such as
26016 &`eth0`&. Do not confuse this with the interface address that was used when a
26017 message was received, which is in &$received_ip_address$&, formerly known as
26018 &$interface_address$&. The name was changed to minimize confusion with the
26019 outgoing interface address. There is no variable that contains an outgoing
26020 interface address because, unless it is set by this option, its value is
26021 unknown.
26022
26023 During the expansion of the &%interface%& option the variables &$host$& and
26024 &$host_address$& refer to the host to which a connection is about to be made
26025 during the expansion of the string. Forced expansion failure, or an empty
26026 string result causes the option to be ignored. Otherwise, after expansion, the
26027 string must be a list of IP addresses, colon-separated by default, but the
26028 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
26029 For example:
26030 .code
26031 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
26032 .endd
26033 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
26034 connection. If none of them are the correct type, the option is ignored. If
26035 &%interface%& is not set, or is ignored, the system's IP functions choose which
26036 interface to use if the host has more than one.
26037
26038
26039 .option keepalive smtp boolean true
26040 .cindex "keepalive" "on outgoing connection"
26041 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
26042 connections. When set, it causes the kernel to probe idle connections
26043 periodically, by sending packets with &"old"& sequence numbers. The other end
26044 of the connection should send a acknowledgment if the connection is still okay
26045 or a reset if the connection has been aborted. The reason for doing this is
26046 that it has the beneficial effect of freeing up certain types of connection
26047 that can get stuck when the remote host is disconnected without tidying up the
26048 TCP/IP call properly. The keepalive mechanism takes several hours to detect
26049 unreachable hosts.
26050
26051
26052 .option lmtp_ignore_quota smtp boolean false
26053 .cindex "LMTP" "ignoring quota errors"
26054 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
26055 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
26056 has advertised support for IGNOREQUOTA in its response to the LHLO command.
26057
26058 .option max_rcpt smtp integer&!! 100
26059 .cindex "RCPT" "maximum number of outgoing"
26060 This option,
26061 after expansion,
26062 limits the number of RCPT commands that are sent in a single
26063 SMTP message transaction.
26064 A value setting of zero disables the limit.
26065
26066 If a constant is given,
26067 each set of addresses is treated independently, and
26068 so can cause parallel connections to the same host if &%remote_max_parallel%&
26069 permits this.
26070
26071 .cindex "ESMTP extensions" LIMITS
26072 If the peer advertises a LIMITS extension with a RCPTMAX value,
26073 and either TLSS is in use or was not advertised,
26074 that value also constrains the result of this option
26075 and no parallel connections will be caused on meeting the RCPTMAX limit.
26076
26077
26078 .option message_linelength_limit smtp integer 998
26079 .cindex "line length" limit
26080 This option sets the maximum line length, in bytes, that the transport
26081 will send.  Any messages with lines exceeding the given value
26082 (before a transport filter, if any)
26083 will fail and a failure-DSN ("bounce") message will if possible be returned
26084 to the sender.
26085 The default value is that defined by the SMTP standards.
26086
26087 It is generally wise to also check in the data ACL so that messages
26088 received via SMTP can be refused without producing a bounce.
26089
26090
26091 .option multi_domain smtp boolean&!! true
26092 .vindex "&$domain$&"
26093 When this option is set, the &(smtp)& transport can handle a number of
26094 addresses containing a mixture of different domains provided they all resolve
26095 to the same list of hosts. Turning the option off restricts the transport to
26096 handling only one domain at a time. This is useful if you want to use
26097 &$domain$& in an expansion for the transport, because it is set only when there
26098 is a single domain involved in a remote delivery.
26099
26100 It is expanded per-address and can depend on any of
26101 &$address_data$&, &$domain_data$&, &$local_part_data$&,
26102 &$host$&, &$host_address$& and &$host_port$&.
26103
26104 If the connection is DANE-enabled then this option is ignored;
26105 only messages having the domain used for the DANE TLSA lookup are
26106 sent on the connection.
26107
26108 .cindex "ESMTP extensions" LIMITS
26109 If the peer advertises a LIMITS extension with a RCPTDOMAINMAX value,
26110 and either TLSS is in use or was not advertised,
26111 this option is regarded as being false.
26112
26113
26114 .option port smtp string&!! "see below"
26115 .cindex "port" "sending TCP/IP"
26116 .cindex "TCP/IP" "setting outgoing port"
26117 This option specifies the TCP/IP port on the server to which Exim connects.
26118 &*Note:*& Do not confuse this with the port that was used when a message was
26119 received, which is in &$received_port$&, formerly known as &$interface_port$&.
26120 The name was changed to minimize confusion with the outgoing port. There is no
26121 variable that contains an outgoing port.
26122
26123 If the value of this option begins with a digit it is taken as a port number;
26124 otherwise it is looked up using &[getservbyname()]&. The default value is
26125 normally &"smtp"&,
26126 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
26127 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
26128 If the expansion fails, or if a port number cannot be found, delivery
26129 is deferred.
26130
26131 Note that at least one Linux distribution has been seen failing
26132 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
26133
26134
26135
26136 .option protocol smtp string smtp
26137 .cindex "LMTP" "over TCP/IP"
26138 .cindex "ssmtp protocol" "outbound"
26139 .cindex "TLS" "SSL-on-connect outbound"
26140 .vindex "&$port$&"
26141 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
26142 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
26143 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
26144 deliveries into closed message stores. Exim also has support for running LMTP
26145 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
26146
26147 &*Note*&: When using LMTP it should be considered whether the default values
26148 for some other features, such as DANE, are appropriate.
26149
26150 If this option is set to &"smtps"&, the default value for the &%port%& option
26151 changes to &"smtps"&, and the transport initiates TLS immediately after
26152 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
26153 The Internet standards bodies used to strongly discourage use of this mode,
26154 but as of RFC 8314 it is preferred over STARTTLS for message submission
26155 (as distinct from MTA-MTA communication).
26156
26157
26158 .option retry_include_ip_address smtp boolean&!! true
26159 Exim normally includes both the host name and the IP address in the key it
26160 constructs for indexing retry data after a temporary delivery failure. This
26161 means that when one of several IP addresses for a host is failing, it gets
26162 tried periodically (controlled by the retry rules), but use of the other IP
26163 addresses is not affected.
26164
26165 However, in some dialup environments hosts are assigned a different IP address
26166 each time they connect. In this situation the use of the IP address as part of
26167 the retry key leads to undesirable behaviour. Setting this option false causes
26168 Exim to use only the host name.
26169 Since it is expanded it can be made to depend on the host or domain.
26170
26171
26172 .option serialize_hosts smtp "host list&!!" unset
26173 .cindex "serializing connections"
26174 .cindex "host" "serializing connections"
26175 Because Exim operates in a distributed manner, if several messages for the same
26176 host arrive at around the same time, more than one simultaneous connection to
26177 the remote host can occur. This is not usually a problem except when there is a
26178 slow link between the hosts. In that situation it may be helpful to restrict
26179 Exim to one connection at a time. This can be done by setting
26180 &%serialize_hosts%& to match the relevant hosts.
26181
26182 .cindex "hints database" "serializing deliveries to a host"
26183 Exim implements serialization by means of a hints database in which a record is
26184 written whenever a process connects to one of the restricted hosts. The record
26185 is deleted when the connection is completed. Obviously there is scope for
26186 records to get left lying around if there is a system or program crash. To
26187 guard against this, Exim ignores any records that are more than six hours old.
26188
26189 If you set up this kind of serialization, you should also arrange to delete the
26190 relevant hints database whenever your system reboots. The names of the files
26191 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26192 may be one or two files, depending on the type of DBM in use. The same files
26193 are used for ETRN serialization.
26194
26195 See also the &%max_parallel%& generic transport option.
26196
26197
26198 .option size_addition smtp integer 1024
26199 .cindex "SIZE" "ESMTP extension"
26200 .cindex "message" "size issue for transport filter"
26201 .cindex "size" "of message"
26202 .cindex "transport" "filter"
26203 .cindex "filter" "transport filter"
26204 If a remote SMTP server indicates that it supports the SIZE option of the
26205 MAIL command, Exim uses this to pass over the message size at the start of
26206 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26207 sends, to allow for headers and other text that may be added during delivery by
26208 configuration options or in a transport filter. It may be necessary to increase
26209 this if a lot of text is added to messages.
26210
26211 Alternatively, if the value of &%size_addition%& is set negative, it disables
26212 the use of the SIZE option altogether.
26213
26214
26215 .option socks_proxy smtp string&!! unset
26216 .cindex proxy SOCKS
26217 This option enables use of SOCKS proxies for connections made by the
26218 transport.  For details see section &<<SECTproxySOCKS>>&.
26219
26220
26221 .option tls_alpn smtp string&!! unset
26222 .cindex TLS "Application Layer Protocol Names"
26223 .cindex TLS ALPN
26224 .cindex ALPN "set name in client"
26225 If this option is set
26226 and the TLS library supports ALPN,
26227 the value given is used.
26228
26229 As of writing no value has been standardised for email use.
26230 The authors suggest using &"smtp"&.
26231
26232
26233
26234 .option tls_certificate smtp string&!! unset
26235 .cindex "TLS" "client certificate, location of"
26236 .cindex "certificate" "client, location of"
26237 .vindex "&$host$&"
26238 .vindex "&$host_address$&"
26239 The value of this option must be the absolute path to a file which contains the
26240 client's certificate, for possible use when sending a message over an encrypted
26241 connection. The values of &$host$& and &$host_address$& are set to the name and
26242 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26243 details of TLS.
26244
26245 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26246 certificate when sending messages as a client. The global option of the same
26247 name specifies the certificate for Exim as a server; it is not automatically
26248 assumed that the same certificate should be used when Exim is operating as a
26249 client.
26250
26251
26252 .option tls_crl smtp string&!! unset
26253 .cindex "TLS" "client certificate revocation list"
26254 .cindex "certificate" "revocation list for client"
26255 This option specifies a certificate revocation list. The expanded value must
26256 be the name of a file that contains a CRL in PEM format.
26257
26258
26259 .option tls_dh_min_bits smtp integer 1024
26260 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26261 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26262 key agreement is negotiated, the server will provide a large prime number
26263 for use.  This option establishes the minimum acceptable size of that number.
26264 If the parameter offered by the server is too small, then the TLS handshake
26265 will fail.
26266
26267 Only supported when using GnuTLS.
26268
26269
26270 .option tls_privatekey smtp string&!! unset
26271 .cindex "TLS" "client private key, location of"
26272 .vindex "&$host$&"
26273 .vindex "&$host_address$&"
26274 The value of this option must be the absolute path to a file which contains the
26275 client's private key. This is used when sending a message over an encrypted
26276 connection using a client certificate. The values of &$host$& and
26277 &$host_address$& are set to the name and address of the server during the
26278 expansion. If this option is unset, or the expansion is forced to fail, or the
26279 result is an empty string, the private key is assumed to be in the same file as
26280 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26281
26282
26283 .option tls_require_ciphers smtp string&!! unset
26284 .cindex "TLS" "requiring specific ciphers"
26285 .cindex "cipher" "requiring specific"
26286 .vindex "&$host$&"
26287 .vindex "&$host_address$&"
26288 The value of this option must be a list of permitted cipher suites, for use
26289 when setting up an outgoing encrypted connection. (There is a global option of
26290 the same name for controlling incoming connections.) The values of &$host$& and
26291 &$host_address$& are set to the name and address of the server during the
26292 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26293 is used in different ways by OpenSSL and GnuTLS (see sections
26294 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26295 ciphers is a preference order.
26296
26297
26298 .option tls_resumption_hosts smtp "host list&!!" unset
26299 .cindex TLS resumption
26300 This option controls which connections to use the TLS resumption feature.
26301 See &<<SECTresumption>>& for details.
26302
26303
26304
26305 .option tls_sni smtp string&!! unset
26306 .cindex "TLS" "Server Name Indication"
26307 .cindex "TLS" SNI
26308 .cindex SNI "setting in client"
26309 .vindex "&$tls_sni$&"
26310 If this option is set
26311 and the connection is not DANE-validated
26312 then it sets the $tls_out_sni variable and causes any
26313 TLS session to pass this value as the Server Name Indication extension to
26314 the remote side, which can be used by the remote side to select an appropriate
26315 certificate and private key for the session.
26316
26317 See &<<SECTtlssni>>& for more information.
26318
26319 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26320 TLS extensions.
26321
26322
26323
26324
26325 .option tls_tempfail_tryclear smtp boolean true
26326 .cindex "4&'xx'& responses" "to STARTTLS"
26327 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26328 setting up a TLS session, this option determines whether or not Exim should try
26329 to deliver the message unencrypted. If it is set false, delivery to the
26330 current host is deferred; if there are other hosts, they are tried. If this
26331 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26332 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26333 TLS negotiation fails, Exim closes the current connection (because it is in an
26334 unknown state), opens a new one to the same host, and then tries the delivery
26335 in clear.
26336
26337
26338 .option tls_try_verify_hosts smtp "host list&!!" *
26339 .cindex "TLS" "server certificate verification"
26340 .cindex "certificate" "verification of server"
26341 This option gives a list of hosts for which, on encrypted connections,
26342 certificate verification will be tried but need not succeed.
26343 The &%tls_verify_certificates%& option must also be set.
26344 Note that unless the host is in this list
26345 TLS connections will be denied to hosts using self-signed certificates
26346 when &%tls_verify_certificates%& is matched.
26347 The &$tls_out_certificate_verified$& variable is set when
26348 certificate verification succeeds.
26349
26350
26351 .option tls_verify_cert_hostnames smtp "host list&!!" *
26352 .cindex "TLS" "server certificate hostname verification"
26353 .cindex "certificate" "verification of server"
26354 This option give a list of hosts for which,
26355 while verifying the server certificate,
26356 checks will be included on the host name
26357 (note that this will generally be the result of a DNS MX lookup)
26358 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26359 Wildcard names are permitted,
26360 limited to being the initial component of a 3-or-more component FQDN.
26361
26362 There is no equivalent checking on client certificates.
26363
26364
26365 .option tls_verify_certificates smtp string&!! system
26366 .cindex "TLS" "server certificate verification"
26367 .cindex "certificate" "verification of server"
26368 .vindex "&$host$&"
26369 .vindex "&$host_address$&"
26370 The value of this option must be either the
26371 word "system"
26372 or the absolute path to
26373 a file or directory containing permitted certificates for servers,
26374 for use when setting up an encrypted connection.
26375
26376 The "system" value for the option will use a location compiled into the SSL library.
26377 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26378 is taken as empty and an explicit location
26379 must be specified.
26380
26381 The use of a directory for the option value is not available for GnuTLS versions
26382 preceding 3.3.6 and a single file must be used.
26383
26384 With OpenSSL the certificates specified
26385 explicitly
26386 either by file or directory
26387 are added to those given by the system default location.
26388
26389 The values of &$host$& and
26390 &$host_address$& are set to the name and address of the server during the
26391 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26392
26393 For back-compatibility,
26394 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26395 (a single-colon empty list counts as being set)
26396 and certificate verification fails the TLS connection is closed.
26397
26398
26399 .option tls_verify_hosts smtp "host list&!!" unset
26400 .cindex "TLS" "server certificate verification"
26401 .cindex "certificate" "verification of server"
26402 This option gives a list of hosts for which, on encrypted connections,
26403 certificate verification must succeed.
26404 The &%tls_verify_certificates%& option must also be set.
26405 If both this option and &%tls_try_verify_hosts%& are unset
26406 operation is as if this option selected all hosts.
26407 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26408 that connections use TLS.
26409 Fallback to in-clear communication will be done unless restricted by
26410 the &%hosts_require_tls%& option.
26411
26412 .option utf8_downconvert smtp integer&!! -1
26413 .cindex utf8 "address downconversion"
26414 .cindex i18n "utf8 address downconversion"
26415 If built with internationalization support,
26416 this option controls conversion of UTF-8 in message envelope addresses
26417 to a-label form.
26418 If, after expansion, the value is 1, 0, or -1 then this value overrides
26419 any value previously set for the message.  Otherwise, any previously
26420 set value is used.  To permit use of a previous value,
26421 set this option to an empty string.
26422 For details on the values see section &<<SECTi18nMTA>>&.
26423
26424
26425
26426
26427 .section "How the limits for the number of hosts to try are used" &&&
26428          "SECTvalhosmax"
26429 .cindex "host" "maximum number to try"
26430 .cindex "limit" "hosts; maximum number tried"
26431 There are two options that are concerned with the number of hosts that are
26432 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26433 &%hosts_max_try_hardlimit%&.
26434
26435
26436 The &%hosts_max_try%& option limits the number of hosts that are tried
26437 for a single delivery. However, despite the term &"host"& in its name, the
26438 option actually applies to each IP address independently. In other words, a
26439 multihomed host is treated as several independent hosts, just as it is for
26440 retrying.
26441
26442 Many of the larger ISPs have multiple MX records which often point to
26443 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26444 created as a result of routing one of these domains.
26445
26446 Trying every single IP address on such a long list does not seem sensible; if
26447 several at the top of the list fail, it is reasonable to assume there is some
26448 problem that is likely to affect all of them. Roughly speaking, the value of
26449 &%hosts_max_try%& is the maximum number that are tried before deferring the
26450 delivery. However, the logic cannot be quite that simple.
26451
26452 Firstly, IP addresses that are skipped because their retry times have not
26453 arrived do not count, and in addition, addresses that are past their retry
26454 limits are also not counted, even when they are tried. This means that when
26455 some IP addresses are past their retry limits, more than the value of
26456 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26457 that all IP addresses are considered before timing out an email address (but
26458 see below for an exception).
26459
26460 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26461 list to see if there is a subsequent host with a different (higher valued) MX.
26462 If there is, that host is considered next, and the current IP address is used
26463 but not counted. This behaviour helps in the case of a domain with a retry rule
26464 that hardly ever delays any hosts, as is now explained:
26465
26466 Consider the case of a long list of hosts with one MX value, and a few with a
26467 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26468 hosts at the top of the list are tried at first. With the default retry rule,
26469 which specifies increasing retry times, the higher MX hosts are eventually
26470 tried when those at the top of the list are skipped because they have not
26471 reached their retry times.
26472
26473 However, it is common practice to put a fixed short retry time on domains for
26474 large ISPs, on the grounds that their servers are rarely down for very long.
26475 Unfortunately, these are exactly the domains that tend to resolve to long lists
26476 of hosts. The short retry time means that the lowest MX hosts are tried every
26477 time. The attempts may be in a different order because of random sorting, but
26478 without the special MX check, the higher MX hosts would never be tried until
26479 all the lower MX hosts had timed out (which might be several days), because
26480 there are always some lower MX hosts that have reached their retry times. With
26481 the special check, Exim considers at least one IP address from each MX value at
26482 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26483 reached.
26484
26485 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26486 particular, Exim normally eventually tries all the IP addresses before timing
26487 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26488 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26489 been set up with hundreds of IP addresses for some domains. It can
26490 take a very long time indeed for an address to time out in these cases.
26491
26492 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26493 Exim never tries more than this number of IP addresses; if it hits this limit
26494 and they are all timed out, the email address is bounced, even though not all
26495 possible IP addresses have been tried.
26496 .ecindex IIDsmttra1
26497 .ecindex IIDsmttra2
26498
26499
26500
26501
26502
26503 . ////////////////////////////////////////////////////////////////////////////
26504 . ////////////////////////////////////////////////////////////////////////////
26505
26506 .chapter "Address rewriting" "CHAPrewrite"
26507 .scindex IIDaddrew "rewriting" "addresses"
26508 There are some circumstances in which Exim automatically rewrites domains in
26509 addresses. The two most common are when an address is given without a domain
26510 (referred to as an &"unqualified address"&) or when an address contains an
26511 abbreviated domain that is expanded by DNS lookup.
26512
26513 Unqualified envelope addresses are accepted only for locally submitted
26514 messages, or for messages that are received from hosts matching
26515 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26516 appropriate. Unqualified addresses in header lines are qualified if they are in
26517 locally submitted messages, or messages from hosts that are permitted to send
26518 unqualified envelope addresses. Otherwise, unqualified addresses in header
26519 lines are neither qualified nor rewritten.
26520
26521 One situation in which Exim does &'not'& automatically rewrite a domain is
26522 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26523 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26524 do this. The new RFCs do not contain this suggestion.
26525
26526
26527 .section "Explicitly configured address rewriting" "SECID147"
26528 This chapter describes the rewriting rules that can be used in the
26529 main rewrite section of the configuration file, and also in the generic
26530 &%headers_rewrite%& option that can be set on any transport.
26531
26532 Some people believe that configured address rewriting is a Mortal Sin.
26533 Others believe that life is not possible without it. Exim provides the
26534 facility; you do not have to use it.
26535
26536 The main rewriting rules that appear in the &"rewrite"& section of the
26537 configuration file are applied to addresses in incoming messages, both envelope
26538 addresses and addresses in header lines. Each rule specifies the types of
26539 address to which it applies.
26540
26541 Whether or not addresses in header lines are rewritten depends on the origin of
26542 the headers and the type of rewriting. Global rewriting, that is, rewriting
26543 rules from the rewrite section of the configuration file, is applied only to
26544 those headers that were received with the message. Header lines that are added
26545 by ACLs or by a system filter or by individual routers or transports (which
26546 are specific to individual recipient addresses) are not rewritten by the global
26547 rules.
26548
26549 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26550 applies all headers except those added by routers and transports. That is, as
26551 well as the headers that were received with the message, it also applies to
26552 headers that were added by an ACL or a system filter.
26553
26554
26555 In general, rewriting addresses from your own system or domain has some
26556 legitimacy. Rewriting other addresses should be done only with great care and
26557 in special circumstances. The author of Exim believes that rewriting should be
26558 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26559 Although it can sometimes be used as a routing tool, this is very strongly
26560 discouraged.
26561
26562 There are two commonly encountered circumstances where rewriting is used, as
26563 illustrated by these examples:
26564
26565 .ilist
26566 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26567 exchange mail with each other behind a firewall, but there is only a single
26568 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26569 &'hitch.fict.example'& when sending mail off-site.
26570 .next
26571 A host rewrites the local parts of its own users so that, for example,
26572 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26573 .endlist
26574
26575
26576
26577 .section "When does rewriting happen?" "SECID148"
26578 .cindex "rewriting" "timing of"
26579 .cindex "&ACL;" "rewriting addresses in"
26580 Configured address rewriting can take place at several different stages of a
26581 message's processing.
26582
26583 .vindex "&$sender_address$&"
26584 At the start of an ACL for MAIL, the sender address may have been rewritten
26585 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26586 ordinary rewrite rules have yet been applied. If, however, the sender address
26587 is verified in the ACL, it is rewritten before verification, and remains
26588 rewritten thereafter. The subsequent value of &$sender_address$& is the
26589 rewritten address. This also applies if sender verification happens in a
26590 RCPT ACL. Otherwise, when the sender address is not verified, it is
26591 rewritten as soon as a message's header lines have been received.
26592
26593 .vindex "&$domain$&"
26594 .vindex "&$local_part$&"
26595 Similarly, at the start of an ACL for RCPT, the current recipient's address
26596 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26597 rewrite rules have yet been applied to it. However, the behaviour is different
26598 from the sender address when a recipient is verified. The address is rewritten
26599 for the verification, but the rewriting is not remembered at this stage. The
26600 value of &$local_part$& and &$domain$& after verification are always the same
26601 as they were before (that is, they contain the unrewritten &-- except for
26602 SMTP-time rewriting &-- address).
26603
26604 As soon as a message's header lines have been received, all the envelope
26605 recipient addresses are permanently rewritten, and rewriting is also applied to
26606 the addresses in the header lines (if configured). This happens before adding
26607 any header lines that were specified in MAIL or RCPT ACLs, and
26608 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26609 before the DATA ACL and &[local_scan()]& functions are run.
26610
26611 When an address is being routed, either for delivery or for verification,
26612 rewriting is applied immediately to child addresses that are generated by
26613 redirection, unless &%no_rewrite%& is set on the router.
26614
26615 .cindex "envelope from"
26616 .cindex "envelope sender" "rewriting at transport time"
26617 .cindex "rewriting" "at transport time"
26618 .cindex "header lines" "rewriting at transport time"
26619 At transport time, additional rewriting of addresses in header lines can be
26620 specified by setting the generic &%headers_rewrite%& option on a transport.
26621 This option contains rules that are identical in form to those in the rewrite
26622 section of the configuration file. They are applied to the original message
26623 header lines and any that were added by ACLs or a system filter. They are not
26624 applied to header lines that are added by routers or the transport.
26625
26626 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26627 transport option. However, it is not possible to rewrite envelope recipients at
26628 transport time.
26629
26630
26631
26632
26633 .section "Testing the rewriting rules that apply on input" "SECID149"
26634 .cindex "rewriting" "testing"
26635 .cindex "testing" "rewriting"
26636 Exim's input rewriting configuration appears in a part of the runtime
26637 configuration file headed by &"begin rewrite"&. It can be tested by the
26638 &%-brw%& command line option. This takes an address (which can be a full RFC
26639 2822 address) as its argument. The output is a list of how the address would be
26640 transformed by the rewriting rules for each of the different places it might
26641 appear in an incoming message, that is, for each different header and for the
26642 envelope sender and recipient fields. For example,
26643 .code
26644 exim -brw ph10@exim.workshop.example
26645 .endd
26646 might produce the output
26647 .code
26648 sender: Philip.Hazel@exim.workshop.example
26649 from: Philip.Hazel@exim.workshop.example
26650 to: ph10@exim.workshop.example
26651 cc: ph10@exim.workshop.example
26652 bcc: ph10@exim.workshop.example
26653 reply-to: Philip.Hazel@exim.workshop.example
26654 env-from: Philip.Hazel@exim.workshop.example
26655 env-to: ph10@exim.workshop.example
26656 .endd
26657 which shows that rewriting has been set up for that address when used in any of
26658 the source fields, but not when it appears as a recipient address. At the
26659 present time, there is no equivalent way of testing rewriting rules that are
26660 set for a particular transport.
26661
26662
26663 .section "Rewriting rules" "SECID150"
26664 .cindex "rewriting" "rules"
26665 The rewrite section of the configuration file consists of lines of rewriting
26666 rules in the form
26667 .display
26668 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26669 .endd
26670 Rewriting rules that are specified for the &%headers_rewrite%& generic
26671 transport option are given as a colon-separated list. Each item in the list
26672 takes the same form as a line in the main rewriting configuration (except that
26673 any colons must be doubled, of course).
26674
26675 The formats of source patterns and replacement strings are described below.
26676 Each is terminated by white space, unless enclosed in double quotes, in which
26677 case normal quoting conventions apply inside the quotes. The flags are single
26678 characters which may appear in any order. Spaces and tabs between them are
26679 ignored.
26680
26681 For each address that could potentially be rewritten, the rules are scanned in
26682 order, and replacements for the address from earlier rules can themselves be
26683 replaced by later rules (but see the &"q"& and &"R"& flags).
26684
26685 The order in which addresses are rewritten is undefined, may change between
26686 releases, and must not be relied on, with one exception: when a message is
26687 received, the envelope sender is always rewritten first, before any header
26688 lines are rewritten. For example, the replacement string for a rewrite of an
26689 address in &'To:'& must not assume that the message's address in &'From:'& has
26690 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26691 that the envelope sender has already been rewritten.
26692
26693 .vindex "&$domain$&"
26694 .vindex "&$local_part$&"
26695 The variables &$local_part$& and &$domain$& can be used in the replacement
26696 string to refer to the address that is being rewritten. Note that lookup-driven
26697 rewriting can be done by a rule of the form
26698 .code
26699 *@*   ${lookup ...
26700 .endd
26701 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26702 refer to the address that is being rewritten.
26703
26704
26705 .section "Rewriting patterns" "SECID151"
26706 .cindex "rewriting" "patterns"
26707 .cindex "address list" "in a rewriting pattern"
26708 The source pattern in a rewriting rule is any item which may appear in an
26709 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26710 single-item address list, which means that it is expanded before being tested
26711 against the address. As always, if you use a regular expression as a pattern,
26712 you must take care to escape dollar and backslash characters, or use the &`\N`&
26713 facility to suppress string expansion within the regular expression.
26714
26715 Domains in patterns should be given in lower case. Local parts in patterns are
26716 case-sensitive. If you want to do case-insensitive matching of local parts, you
26717 can use a regular expression that starts with &`^(?i)`&.
26718
26719 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26720 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26721 depending on the type of match which occurred. These can be used in the
26722 replacement string to insert portions of the incoming address. &$0$& always
26723 refers to the complete incoming address. When a regular expression is used, the
26724 numerical variables are set from its capturing subexpressions. For other types
26725 of pattern they are set as follows:
26726
26727 .ilist
26728 If a local part or domain starts with an asterisk, the numerical variables
26729 refer to the character strings matched by asterisks, with &$1$& associated with
26730 the first asterisk, and &$2$& with the second, if present. For example, if the
26731 pattern
26732 .code
26733 *queen@*.fict.example
26734 .endd
26735 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26736 .code
26737 $0 = hearts-queen@wonderland.fict.example
26738 $1 = hearts-
26739 $2 = wonderland
26740 .endd
26741 Note that if the local part does not start with an asterisk, but the domain
26742 does, it is &$1$& that contains the wild part of the domain.
26743
26744 .next
26745 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26746 of the domain are placed in the next available numerical variables. Suppose,
26747 for example, that the address &'foo@bar.baz.example'& is processed by a
26748 rewriting rule of the form
26749 .display
26750 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26751 .endd
26752 and the key in the file that matches the domain is &`*.baz.example`&. Then
26753 .code
26754 $1 = foo
26755 $2 = bar
26756 $3 = baz.example
26757 .endd
26758 If the address &'foo@baz.example'& is looked up, this matches the same
26759 wildcard file entry, and in this case &$2$& is set to the empty string, but
26760 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26761 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26762 whole domain. For non-partial domain lookups, no numerical variables are set.
26763 .endlist
26764
26765
26766 .section "Rewriting replacements" "SECID152"
26767 .cindex "rewriting" "replacements"
26768 If the replacement string for a rule is a single asterisk, addresses that
26769 match the pattern and the flags are &'not'& rewritten, and no subsequent
26770 rewriting rules are scanned. For example,
26771 .code
26772 hatta@lookingglass.fict.example  *  f
26773 .endd
26774 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26775 &'From:'& headers.
26776
26777 .vindex "&$domain$&"
26778 .vindex "&$local_part$&"
26779 If the replacement string is not a single asterisk, it is expanded, and must
26780 yield a fully qualified address. Within the expansion, the variables
26781 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26782 Any letters they contain retain their original case &-- they are not lower
26783 cased. The numerical variables are set up according to the type of pattern that
26784 matched the address, as described above. If the expansion is forced to fail by
26785 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26786 current rule is abandoned, but subsequent rules may take effect. Any other
26787 expansion failure causes the entire rewriting operation to be abandoned, and an
26788 entry written to the panic log.
26789
26790
26791
26792 .subsection "Rewriting flags" "SSECID153"
26793 There are three different kinds of flag that may appear on rewriting rules:
26794
26795 .ilist
26796 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26797 c, f, h, r, s, t.
26798 .next
26799 A flag that specifies rewriting at SMTP time: S.
26800 .next
26801 Flags that control the rewriting process: Q, q, R, w.
26802 .endlist
26803
26804 For rules that are part of the &%headers_rewrite%& generic transport option,
26805 E, F, T, and S are not permitted.
26806
26807
26808
26809 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26810          "SSECID154"
26811 .cindex rewriting flags
26812 If none of the following flag letters, nor the &"S"& flag (see section
26813 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26814 and to both the sender and recipient fields of the envelope, whereas a
26815 transport-time rewriting rule just applies to all headers. Otherwise, the
26816 rewriting rule is skipped unless the relevant addresses are being processed.
26817 .display
26818 &`E`&       rewrite all envelope fields
26819 &`F`&       rewrite the envelope From field
26820 &`T`&       rewrite the envelope To field
26821 &`b`&       rewrite the &'Bcc:'& header
26822 &`c`&       rewrite the &'Cc:'& header
26823 &`f`&       rewrite the &'From:'& header
26824 &`h`&       rewrite all headers
26825 &`r`&       rewrite the &'Reply-To:'& header
26826 &`s`&       rewrite the &'Sender:'& header
26827 &`t`&       rewrite the &'To:'& header
26828 .endd
26829 "All headers" means all of the headers listed above that can be selected
26830 individually, plus their &'Resent-'& versions. It does not include
26831 other headers such as &'Subject:'& etc.
26832
26833 You should be particularly careful about rewriting &'Sender:'& headers, and
26834 restrict this to special known cases in your own domains.
26835
26836
26837 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26838 .cindex SMTP "rewriting malformed addresses"
26839 .cindex RCPT "rewriting argument of"
26840 .cindex MAIL "rewriting argument of"
26841 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26842 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26843 before any other processing; even before syntax checking. The pattern is
26844 required to be a regular expression, and it is matched against the whole of the
26845 data for the command, including any surrounding angle brackets.
26846
26847 .vindex "&$domain$&"
26848 .vindex "&$local_part$&"
26849 This form of rewrite rule allows for the handling of addresses that are not
26850 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26851 input). Because the input is not required to be a syntactically valid address,
26852 the variables &$local_part$& and &$domain$& are not available during the
26853 expansion of the replacement string. The result of rewriting replaces the
26854 original address in the MAIL or RCPT command.
26855
26856
26857 .subsection "Flags controlling the rewriting process" SSECID155
26858 There are four flags which control the way the rewriting process works. These
26859 take effect only when a rule is invoked, that is, when the address is of the
26860 correct type (matches the flags) and matches the pattern:
26861
26862 .ilist
26863 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26864 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26865 absence of &"Q"& the rewritten address must always include a domain.
26866 .next
26867 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26868 even if no rewriting actually takes place because of a &"fail"& in the
26869 expansion. The &"q"& flag is not effective if the address is of the wrong type
26870 (does not match the flags) or does not match the pattern.
26871 .next
26872 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26873 address, up to ten times. It can be combined with the &"q"& flag, to stop
26874 rewriting once it fails to match (after at least one successful rewrite).
26875 .next
26876 .cindex "rewriting" "whole addresses"
26877 When an address in a header is rewritten, the rewriting normally applies only
26878 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26879 left unchanged. For example, rewriting might change
26880 .code
26881 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26882 .endd
26883 into
26884 .code
26885 From: Ford Prefect <prefectf@hitch.fict.example>
26886 .endd
26887 .cindex "RFC 2047"
26888 Sometimes there is a need to replace the whole address item, and this can be
26889 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26890 causes an address in a header line to be rewritten, the entire address is
26891 replaced, not just the working part. The replacement must be a complete RFC
26892 2822 address, including the angle brackets if necessary. If text outside angle
26893 brackets contains a character whose value is greater than 126 or less than 32
26894 (except for tab), the text is encoded according to RFC 2047. The character set
26895 is taken from &%headers_charset%&, which gets its default at build time.
26896
26897 When the &"w"& flag is set on a rule that causes an envelope address to be
26898 rewritten, all but the working part of the replacement address is discarded.
26899 .endlist
26900
26901
26902 .section "Rewriting examples" "SECID156"
26903 Here is an example of the two common rewriting paradigms:
26904 .code
26905 *@*.hitch.fict.example  $1@hitch.fict.example
26906 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26907                      {$value}fail}@hitch.fict.example bctfrF
26908 .endd
26909 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26910 the string expansion to fail if the lookup does not succeed. In this context it
26911 has the effect of leaving the original address unchanged, but Exim goes on to
26912 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26913 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26914 explicitly, which would cause the rewritten address to be the same as before,
26915 at the cost of a small bit of processing. Not supplying either of these is an
26916 error, since the rewritten address would then contain no local part.
26917
26918 The first example above replaces the domain with a superior, more general
26919 domain. This may not be desirable for certain local parts. If the rule
26920 .code
26921 root@*.hitch.fict.example  *
26922 .endd
26923 were inserted before the first rule, rewriting would be suppressed for the
26924 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26925
26926 Rewriting can be made conditional on a number of tests, by making use of
26927 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26928 messages that originate outside the local host:
26929 .code
26930 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26931                          {$1@hitch.fict.example}fail}"
26932 .endd
26933 The replacement string is quoted in this example because it contains white
26934 space.
26935
26936 .cindex "rewriting" "bang paths"
26937 .cindex "bang paths" "rewriting"
26938 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26939 an address it treats it as an unqualified local part which it qualifies with
26940 the local qualification domain (if the source of the message is local or if the
26941 remote host is permitted to send unqualified addresses). Rewriting can
26942 sometimes be used to handle simple bang paths with a fixed number of
26943 components. For example, the rule
26944 .code
26945 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26946 .endd
26947 rewrites a two-component bang path &'host.name!user'& as the domain address
26948 &'user@host.name'&. However, there is a security implication in using this as
26949 a global rewriting rule for envelope addresses. It can provide a backdoor
26950 method for using your system as a relay, because the incoming addresses appear
26951 to be local. If the bang path addresses are received via SMTP, it is safer to
26952 use the &"S"& flag to rewrite them as they are received, so that relay checking
26953 can be done on the rewritten addresses.
26954 .ecindex IIDaddrew
26955
26956
26957
26958
26959
26960 . ////////////////////////////////////////////////////////////////////////////
26961 . ////////////////////////////////////////////////////////////////////////////
26962
26963 .chapter "Retry configuration" "CHAPretry"
26964 .scindex IIDretconf1 "retry" "configuration, description of"
26965 .scindex IIDregconf2 "configuration file" "retry section"
26966 The &"retry"& section of the runtime configuration file contains a list of
26967 retry rules that control how often Exim tries to deliver messages that cannot
26968 be delivered at the first attempt. If there are no retry rules (the section is
26969 empty or not present), there are no retries. In this situation, temporary
26970 errors are treated as permanent. The default configuration contains a single,
26971 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26972 line option can be used to test which retry rule will be used for a given
26973 address, domain and error.
26974
26975 The most common cause of retries is temporary failure to deliver to a remote
26976 host because the host is down, or inaccessible because of a network problem.
26977 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26978 address) basis, not on a per-message basis. Thus, if one message has recently
26979 been delayed, delivery of a new message to the same host is not immediately
26980 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26981 log selector is set, the message
26982 .cindex "retry" "time not reached"
26983 &"retry time not reached"& is written to the main log whenever a delivery is
26984 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26985 the handling of errors during remote deliveries.
26986
26987 Retry processing applies to routing as well as to delivering, except as covered
26988 in the next paragraph. The retry rules do not distinguish between these
26989 actions. It is not possible, for example, to specify different behaviour for
26990 failures to route the domain &'snark.fict.example'& and failures to deliver to
26991 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26992 added complication, so did not implement it. However, although they share the
26993 same retry rule, the actual retry times for routing and transporting a given
26994 domain are maintained independently.
26995
26996 When a delivery is not part of a queue run (typically an immediate delivery on
26997 receipt of a message), the routers are always run, and local deliveries are
26998 always attempted, even if retry times are set for them. This makes for better
26999 behaviour if one particular message is causing problems (for example, causing
27000 quota overflow, or provoking an error in a filter file). If such a delivery
27001 suffers a temporary failure, the retry data is updated as normal, and
27002 subsequent delivery attempts from queue runs occur only when the retry time for
27003 the local address is reached.
27004
27005 .section "Changing retry rules" "SECID157"
27006 If you change the retry rules in your configuration, you should consider
27007 whether or not to delete the retry data that is stored in Exim's spool area in
27008 files with names like &_db/retry_&. Deleting any of Exim's hints files is
27009 always safe; that is why they are called &"hints"&.
27010
27011 The hints retry data contains suggested retry times based on the previous
27012 rules. In the case of a long-running problem with a remote host, it might
27013 record the fact that the host has timed out. If your new rules increase the
27014 timeout time for such a host, you should definitely remove the old retry data
27015 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
27016 messages that it should now be retaining.
27017
27018
27019
27020 .section "Format of retry rules" "SECID158"
27021 .cindex "retry" "rules"
27022 Each retry rule occupies one line and consists of three or four parts,
27023 separated by white space: a pattern, an error name, an optional list of sender
27024 addresses, and a list of retry parameters. The pattern and sender lists must be
27025 enclosed in double quotes if they contain white space. The rules are searched
27026 in order until one is found where the pattern, error name, and sender list (if
27027 present) match the failing host or address, the error that occurred, and the
27028 message's sender, respectively.
27029
27030
27031 The pattern is any single item that may appear in an address list (see section
27032 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
27033 which means that it is expanded before being tested against the address that
27034 has been delayed. A negated address list item is permitted. Address
27035 list processing treats a plain domain name as if it were preceded by &"*@"&,
27036 which makes it possible for many retry rules to start with just a domain. For
27037 example,
27038 .code
27039 lookingglass.fict.example        *  F,24h,30m;
27040 .endd
27041 provides a rule for any address in the &'lookingglass.fict.example'& domain,
27042 whereas
27043 .code
27044 alice@lookingglass.fict.example  *  F,24h,30m;
27045 .endd
27046 applies only to temporary failures involving the local part &%alice%&.
27047 In practice, almost all rules start with a domain name pattern without a local
27048 part.
27049
27050 .cindex "regular expressions" "in retry rules"
27051 &*Warning*&: If you use a regular expression in a retry rule pattern, it
27052 must match a complete address, not just a domain, because that is how regular
27053 expressions work in address lists.
27054 .display
27055 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
27056 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
27057 .endd
27058
27059
27060 .section "Choosing which retry rule to use for address errors" "SECID159"
27061 When Exim is looking for a retry rule after a routing attempt has failed (for
27062 example, after a DNS timeout), each line in the retry configuration is tested
27063 against the complete address only if &%retry_use_local_part%& is set for the
27064 router. Otherwise, only the domain is used, except when matching against a
27065 regular expression, when the local part of the address is replaced with &"*"&.
27066 A domain on its own can match a domain pattern, or a pattern that starts with
27067 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
27068 &%check_local_user%& is true, and false for other routers.
27069
27070 Similarly, when Exim is looking for a retry rule after a local delivery has
27071 failed (for example, after a mailbox full error), each line in the retry
27072 configuration is tested against the complete address only if
27073 &%retry_use_local_part%& is set for the transport (it defaults true for all
27074 local transports).
27075
27076 .cindex "4&'xx'& responses" "retry rules for"
27077 However, when Exim is looking for a retry rule after a remote delivery attempt
27078 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
27079 whole address is always used as the key when searching the retry rules. The
27080 rule that is found is used to create a retry time for the combination of the
27081 failing address and the message's sender. It is the combination of sender and
27082 recipient that is delayed in subsequent queue runs until its retry time is
27083 reached. You can delay the recipient without regard to the sender by setting
27084 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
27085 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
27086 commands.
27087
27088
27089
27090 .section "Choosing which retry rule to use for host and message errors" &&&
27091          "SECID160"
27092 For a temporary error that is not related to an individual address (for
27093 example, a connection timeout), each line in the retry configuration is checked
27094 twice. First, the name of the remote host is used as a domain name (preceded by
27095 &"*@"& when matching a regular expression). If this does not match the line,
27096 the domain from the email address is tried in a similar fashion. For example,
27097 suppose the MX records for &'a.b.c.example'& are
27098 .code
27099 a.b.c.example  MX  5  x.y.z.example
27100                MX  6  p.q.r.example
27101                MX  7  m.n.o.example
27102 .endd
27103 and the retry rules are
27104 .code
27105 p.q.r.example    *      F,24h,30m;
27106 a.b.c.example    *      F,4d,45m;
27107 .endd
27108 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
27109 first rule matches neither the host nor the domain, so Exim looks at the second
27110 rule. This does not match the host, but it does match the domain, so it is used
27111 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
27112 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
27113 first retry rule is used, because it matches the host.
27114
27115 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
27116 first rule to determine retry times, but for all the other hosts for the domain
27117 &'a.b.c.example'&, the second rule is used. The second rule is also used if
27118 routing to &'a.b.c.example'& suffers a temporary failure.
27119
27120 &*Note*&: The host name is used when matching the patterns, not its IP address.
27121 However, if a message is routed directly to an IP address without the use of a
27122 host name, for example, if a &(manualroute)& router contains a setting such as:
27123 .code
27124 route_list = *.a.example  192.168.34.23
27125 .endd
27126 then the &"host name"& that is used when searching for a retry rule is the
27127 textual form of the IP address.
27128
27129 .section "Retry rules for specific errors" "SECID161"
27130 .cindex "retry" "specific errors; specifying"
27131 The second field in a retry rule is the name of a particular error, or an
27132 asterisk, which matches any error. The errors that can be tested for are:
27133
27134 .vlist
27135 .vitem &%auth_failed%&
27136 Authentication failed when trying to send to a host in the
27137 &%hosts_require_auth%& list in an &(smtp)& transport.
27138
27139 .vitem &%data_4xx%&
27140 A 4&'xx'& error was received for an outgoing DATA command, either immediately
27141 after the command, or after sending the message's data.
27142
27143 .vitem &%mail_4xx%&
27144 A 4&'xx'& error was received for an outgoing MAIL command.
27145
27146 .vitem &%rcpt_4xx%&
27147 A 4&'xx'& error was received for an outgoing RCPT command.
27148 .endlist
27149
27150 For the three 4&'xx'& errors, either the first or both of the x's can be given
27151 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
27152 recognize 452 errors given to RCPT commands for addresses in a certain domain,
27153 and have retries every ten minutes with a one-hour timeout, you could set up a
27154 retry rule of this form:
27155 .code
27156 the.domain.name  rcpt_452   F,1h,10m
27157 .endd
27158 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
27159 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
27160
27161 .vlist
27162 .vitem &%lost_connection%&
27163 A server unexpectedly closed the SMTP connection. There may, of course,
27164 legitimate reasons for this (host died, network died), but if it repeats a lot
27165 for the same host, it indicates something odd.
27166
27167 .vitem &%lookup%&
27168 A DNS lookup for a host failed.
27169 Note that a &%dnslookup%& router will need to have matched
27170 its &%fail_defer_domains%& option for this retry type to be usable.
27171 Also note that a &%manualroute%& router will probably need
27172 its &%host_find_failed%& option set to &%defer%&.
27173
27174 .vitem &%refused_MX%&
27175 A connection to a host obtained from an MX record was refused.
27176
27177 .vitem &%refused_A%&
27178 A connection to a host not obtained from an MX record was refused.
27179
27180 .vitem &%refused%&
27181 A connection was refused.
27182
27183 .vitem &%timeout_connect_MX%&
27184 A connection attempt to a host obtained from an MX record timed out.
27185
27186 .vitem &%timeout_connect_A%&
27187 A connection attempt to a host not obtained from an MX record timed out.
27188
27189 .vitem &%timeout_connect%&
27190 A connection attempt timed out.
27191
27192 .vitem &%timeout_MX%&
27193 There was a timeout while connecting or during an SMTP session with a host
27194 obtained from an MX record.
27195
27196 .vitem &%timeout_A%&
27197 There was a timeout while connecting or during an SMTP session with a host not
27198 obtained from an MX record.
27199
27200 .vitem &%timeout%&
27201 There was a timeout while connecting or during an SMTP session.
27202
27203 .vitem &%tls_required%&
27204 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27205 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27206 to STARTTLS, or there was a problem setting up the TLS connection.
27207
27208 .vitem &%quota%&
27209 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27210 transport.
27211
27212 .vitem &%quota_%&<&'time'&>
27213 .cindex "quota" "error testing in retry rule"
27214 .cindex "retry" "quota error testing"
27215 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27216 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27217 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27218 for four days.
27219 .endlist
27220
27221 .cindex "mailbox" "time of last read"
27222 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27223 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27224 it should be based on the last time that the user accessed the mailbox.
27225 However, it is not always possible to determine this. Exim uses the following
27226 heuristic rules:
27227
27228 .ilist
27229 If the mailbox is a single file, the time of last access (the &"atime"&) is
27230 used. As no new messages are being delivered (because the mailbox is over
27231 quota), Exim does not access the file, so this is the time of last user access.
27232 .next
27233 .cindex "maildir format" "time of last read"
27234 For a maildir delivery, the time of last modification of the &_new_&
27235 subdirectory is used. As the mailbox is over quota, no new files are created in
27236 the &_new_& subdirectory, because no new messages are being delivered. Any
27237 change to the &_new_& subdirectory is therefore assumed to be the result of an
27238 MUA moving a new message to the &_cur_& directory when it is first read. The
27239 time that is used is therefore the last time that the user read a new message.
27240 .next
27241 For other kinds of multi-file mailbox, the time of last access cannot be
27242 obtained, so a retry rule that uses this type of error field is never matched.
27243 .endlist
27244
27245 The quota errors apply both to system-enforced quotas and to Exim's own quota
27246 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27247 when a local delivery is deferred because a partition is full (the ENOSPC
27248 error).
27249
27250
27251
27252 .section "Retry rules for specified senders" "SECID162"
27253 .cindex "retry" "rules; sender-specific"
27254 You can specify retry rules that apply only when the failing message has a
27255 specific sender. In particular, this can be used to define retry rules that
27256 apply only to bounce messages. The third item in a retry rule can be of this
27257 form:
27258 .display
27259 &`senders=`&<&'address list'&>
27260 .endd
27261 The retry timings themselves are then the fourth item. For example:
27262 .code
27263 *   rcpt_4xx   senders=:   F,1h,30m
27264 .endd
27265 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27266 host. If the address list contains white space, it must be enclosed in quotes.
27267 For example:
27268 .code
27269 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27270 .endd
27271 &*Warning*&: This facility can be unhelpful if it is used for host errors
27272 (which do not depend on the recipient). The reason is that the sender is used
27273 only to match the retry rule. Once the rule has been found for a host error,
27274 its contents are used to set a retry time for the host, and this will apply to
27275 all messages, not just those with specific senders.
27276
27277 When testing retry rules using &%-brt%&, you can supply a sender using the
27278 &%-f%& command line option, like this:
27279 .code
27280 exim -f "" -brt user@dom.ain
27281 .endd
27282 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27283 list is never matched.
27284
27285
27286
27287
27288
27289 .section "Retry parameters" "SECID163"
27290 .cindex "retry" "parameters in rules"
27291 The third (or fourth, if a senders list is present) field in a retry rule is a
27292 sequence of retry parameter sets, separated by semicolons. Each set consists of
27293 .display
27294 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27295 .endd
27296 The letter identifies the algorithm for computing a new retry time; the cutoff
27297 time is the time beyond which this algorithm no longer applies, and the
27298 arguments vary the algorithm's action. The cutoff time is measured from the
27299 time that the first failure for the domain (combined with the local part if
27300 relevant) was detected, not from the time the message was received.
27301
27302 .cindex "retry" "algorithms"
27303 .cindex "retry" "fixed intervals"
27304 .cindex "retry" "increasing intervals"
27305 .cindex "retry" "random intervals"
27306 The available algorithms are:
27307
27308 .ilist
27309 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27310 the interval.
27311 .next
27312 &'G'&: retry at geometrically increasing intervals. The first argument
27313 specifies a starting value for the interval, and the second a multiplier, which
27314 is used to increase the size of the interval at each retry.
27315 .next
27316 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27317 retry, the previous interval is multiplied by the factor in order to get a
27318 maximum for the next interval. The minimum interval is the first argument of
27319 the parameter, and an actual interval is chosen randomly between them. Such a
27320 rule has been found to be helpful in cluster configurations when all the
27321 members of the cluster restart at once, and may therefore synchronize their
27322 queue processing times.
27323 .endlist
27324
27325 When computing the next retry time, the algorithm definitions are scanned in
27326 order until one whose cutoff time has not yet passed is reached. This is then
27327 used to compute a new retry time that is later than the current time. In the
27328 case of fixed interval retries, this simply means adding the interval to the
27329 current time. For geometrically increasing intervals, retry intervals are
27330 computed from the rule's parameters until one that is greater than the previous
27331 interval is found. The main configuration variable
27332 .cindex "limit" "retry interval"
27333 .cindex "retry" "interval, maximum"
27334 .oindex "&%retry_interval_max%&"
27335 &%retry_interval_max%& limits the maximum interval between retries. It
27336 cannot be set greater than &`24h`&, which is its default value.
27337
27338 A single remote domain may have a number of hosts associated with it, and each
27339 host may have more than one IP address. Retry algorithms are selected on the
27340 basis of the domain name, but are applied to each IP address independently. If,
27341 for example, a host has two IP addresses and one is unusable, Exim will
27342 generate retry times for it and will not try to use it until its next retry
27343 time comes. Thus the good IP address is likely to be tried first most of the
27344 time.
27345
27346 .cindex "hints database" "use for retrying"
27347 Retry times are hints rather than promises. Exim does not make any attempt to
27348 run deliveries exactly at the computed times. Instead, a queue runner process
27349 starts delivery processes for delayed messages periodically, and these attempt
27350 new deliveries only for those addresses that have passed their next retry time.
27351 If a new message arrives for a deferred address, an immediate delivery attempt
27352 occurs only if the address has passed its retry time. In the absence of new
27353 messages, the minimum time between retries is the interval between queue runner
27354 processes. There is not much point in setting retry times of five minutes if
27355 your queue runners happen only once an hour, unless there are a significant
27356 number of incoming messages (which might be the case on a system that is
27357 sending everything to a smart host, for example).
27358
27359 The data in the retry hints database can be inspected by using the
27360 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27361 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27362 &'exinext'& utility script can be used to find out what the next retry times
27363 are for the hosts associated with a particular mail domain, and also for local
27364 deliveries that have been deferred.
27365
27366
27367 .section "Retry rule examples" "SECID164"
27368 Here are some example retry rules:
27369 .code
27370 alice@wonderland.fict.example quota_5d  F,7d,3h
27371 wonderland.fict.example       quota_5d
27372 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27373 lookingglass.fict.example     *         F,24h,30m;
27374 *                 refused_A   F,2h,20m;
27375 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27376 .endd
27377 The first rule sets up special handling for mail to
27378 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27379 mailbox has not been read for at least 5 days. Retries continue every three
27380 hours for 7 days. The second rule handles over-quota errors for all other local
27381 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27382 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27383 fail are bounced immediately if the mailbox has not been read for at least 5
27384 days.
27385
27386 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27387 happen every 15 minutes for an hour, then with geometrically increasing
27388 intervals until two days have passed since a delivery first failed. After the
27389 first hour there is a delay of one hour, then two hours, then four hours, and
27390 so on (this is a rather extreme example).
27391
27392 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27393 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27394 all other domains, with special action for connection refusal from hosts that
27395 were not obtained from an MX record.
27396
27397 The final rule in a retry configuration should always have asterisks in the
27398 first two fields so as to provide a general catch-all for any addresses that do
27399 not have their own special handling. This example tries every 15 minutes for 2
27400 hours, then with intervals starting at one hour and increasing by a factor of
27401 1.5 up to 16 hours, then every 8 hours up to 5 days.
27402
27403
27404
27405 .section "Timeout of retry data" "SECID165"
27406 .cindex "timeout" "of retry data"
27407 .oindex "&%retry_data_expire%&"
27408 .cindex "hints database" "data expiry"
27409 .cindex "retry" "timeout of data"
27410 Exim timestamps the data that it writes to its retry hints database. When it
27411 consults the data during a delivery it ignores any that is older than the value
27412 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27413 been tried for 7 days, Exim will try to deliver to it immediately a message
27414 arrives, and if that fails, it will calculate a retry time as if it were
27415 failing for the first time.
27416
27417 This improves the behaviour for messages routed to rarely-used hosts such as MX
27418 backups. If such a host was down at one time, and happens to be down again when
27419 Exim tries a month later, using the old retry data would imply that it had been
27420 down all the time, which is not a justified assumption.
27421
27422 If a host really is permanently dead, this behaviour causes a burst of retries
27423 every now and again, but only if messages routed to it are rare. If there is a
27424 message at least once every 7 days the retry data never expires.
27425
27426
27427
27428
27429 .section "Long-term failures" "SECID166"
27430 .cindex "delivery failure, long-term"
27431 .cindex "retry" "after long-term failure"
27432 Special processing happens when an email address has been failing for so long
27433 that the cutoff time for the last algorithm is reached. For example, using the
27434 default retry rule:
27435 .code
27436 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27437 .endd
27438 the cutoff time is four days. Reaching the retry cutoff is independent of how
27439 long any specific message has been failing; it is the length of continuous
27440 failure for the recipient address that counts.
27441
27442 When the cutoff time is reached for a local delivery, or for all the IP
27443 addresses associated with a remote delivery, a subsequent delivery failure
27444 causes Exim to give up on the address, and a bounce message is generated.
27445 In order to cater for new messages that use the failing address, a next retry
27446 time is still computed from the final algorithm, and is used as follows:
27447
27448 For local deliveries, one delivery attempt is always made for any subsequent
27449 messages. If this delivery fails, the address fails immediately. The
27450 post-cutoff retry time is not used.
27451
27452 .cindex "final cutoff" "retries, controlling"
27453 .cindex retry "final cutoff"
27454 If the delivery is remote, there are two possibilities, controlled by the
27455 .oindex "&%delay_after_cutoff%&"
27456 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27457 default. Until the post-cutoff retry time for one of the IP addresses,
27458 as set by the &%retry_data_expire%& option, is
27459 reached, the failing email address is bounced immediately, without a delivery
27460 attempt taking place. After that time, one new delivery attempt is made to
27461 those IP addresses that are past their retry times, and if that still fails,
27462 the address is bounced and new retry times are computed.
27463
27464 In other words, when all the hosts for a given email address have been failing
27465 for a long time, Exim bounces rather then defers until one of the hosts' retry
27466 times is reached. Then it tries once, and bounces if that attempt fails. This
27467 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27468 to a broken destination, but if the host does recover, Exim will eventually
27469 notice.
27470
27471 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27472 addresses are past their final cutoff time, Exim tries to deliver to those IP
27473 addresses that have not been tried since the message arrived. If there are
27474 no suitable IP addresses, or if they all fail, the address is bounced. In other
27475 words, it does not delay when a new message arrives, but tries the expired
27476 addresses immediately, unless they have been tried since the message arrived.
27477 If there is a continuous stream of messages for the failing domains, setting
27478 &%delay_after_cutoff%& false means that there will be many more attempts to
27479 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27480 true.
27481
27482 .section "Deliveries that work intermittently" "SECID167"
27483 .cindex "retry" "intermittently working deliveries"
27484 Some additional logic is needed to cope with cases where a host is
27485 intermittently available, or when a message has some attribute that prevents
27486 its delivery when others to the same address get through. In this situation,
27487 because some messages are successfully delivered, the &"retry clock"& for the
27488 host or address keeps getting reset by the successful deliveries, and so
27489 failing messages remain in the queue for ever because the cutoff time is never
27490 reached.
27491
27492 Two exceptional actions are applied to prevent this happening. The first
27493 applies to errors that are related to a message rather than a remote host.
27494 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27495 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27496 commands, and quota failures. For this type of error, if a message's arrival
27497 time is earlier than the &"first failed"& time for the error, the earlier time
27498 is used when scanning the retry rules to decide when to try next and when to
27499 time out the address.
27500
27501 The exceptional second action applies in all cases. If a message has been on
27502 the queue for longer than the cutoff time of any applicable retry rule for a
27503 given address, a delivery is attempted for that address, even if it is not yet
27504 time, and if this delivery fails, the address is timed out. A new retry time is
27505 not computed in this case, so that other messages for the same address are
27506 considered immediately.
27507 .ecindex IIDretconf1
27508 .ecindex IIDregconf2
27509
27510
27511
27512
27513
27514
27515 . ////////////////////////////////////////////////////////////////////////////
27516 . ////////////////////////////////////////////////////////////////////////////
27517
27518 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27519 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27520 .scindex IIDauthconf2 "authentication"
27521 The &"authenticators"& section of Exim's runtime configuration is concerned
27522 with SMTP authentication. This facility is an extension to the SMTP protocol,
27523 described in RFC 2554, which allows a client SMTP host to authenticate itself
27524 to a server. This is a common way for a server to recognize clients that are
27525 permitted to use it as a relay. SMTP authentication is not of relevance to the
27526 transfer of mail between servers that have no managerial connection with each
27527 other.
27528
27529 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27530 prior to Exim 4.95 names would be silently truncated at this length, but now
27531 it is enforced.
27532
27533 .cindex "AUTH" "description of"
27534 .cindex "ESMTP extensions" AUTH
27535 Very briefly, the way SMTP authentication works is as follows:
27536
27537 .olist
27538 The server advertises a number of authentication &'mechanisms'& in response to
27539 the client's EHLO command.
27540 .next
27541 The client issues an AUTH command, naming a specific mechanism. The command
27542 may, optionally, contain some authentication data.
27543 .next
27544 The server may issue one or more &'challenges'&, to which the client must send
27545 appropriate responses. In simple authentication mechanisms, the challenges are
27546 just prompts for user names and passwords. The server does not have to issue
27547 any challenges &-- in some mechanisms the relevant data may all be transmitted
27548 with the AUTH command.
27549 .next
27550 The server either accepts or denies authentication.
27551 .next
27552 If authentication succeeds, the client may optionally make use of the AUTH
27553 option on the MAIL command to pass an authenticated sender in subsequent
27554 mail transactions. Authentication lasts for the remainder of the SMTP
27555 connection.
27556 .next
27557 If authentication fails, the client may give up, or it may try a different
27558 authentication mechanism, or it may try transferring mail over the
27559 unauthenticated connection.
27560 .endlist
27561
27562 If you are setting up a client, and want to know which authentication
27563 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27564 SMTP port) on the server, and issue an EHLO command. The response to this
27565 includes the list of supported mechanisms. For example:
27566 .display
27567 &`$ `&&*&`telnet server.example 25`&*&
27568 &`Trying 192.168.34.25...`&
27569 &`Connected to server.example.`&
27570 &`Escape character is &#x0027;^]&#x0027;.`&
27571 &`220 server.example ESMTP Exim 4.20 ...`&
27572 &*&`ehlo client.example`&*&
27573 &`250-server.example Hello client.example [10.8.4.5]`&
27574 &`250-SIZE 52428800`&
27575 &`250-PIPELINING`&
27576 &`250-AUTH PLAIN`&
27577 &`250 HELP`&
27578 .endd
27579 The second-last line of this example output shows that the server supports
27580 authentication using the PLAIN mechanism. In Exim, the different authentication
27581 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27582 routers and transports, which authenticators are included in the binary is
27583 controlled by build-time definitions. The following are currently available,
27584 included by setting
27585 .code
27586 AUTH_CRAM_MD5=yes
27587 AUTH_CYRUS_SASL=yes
27588 AUTH_DOVECOT=yes
27589 AUTH_EXTERNAL=yes
27590 AUTH_GSASL=yes
27591 AUTH_HEIMDAL_GSSAPI=yes
27592 AUTH_PLAINTEXT=yes
27593 AUTH_SPA=yes
27594 AUTH_TLS=yes
27595 .endd
27596 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27597 authentication mechanism (RFC 2195), and the second provides an interface to
27598 the Cyrus SASL authentication library.
27599 The third is an interface to Dovecot's authentication system, delegating the
27600 work via a socket interface.
27601 The fourth provides for negotiation of authentication done via non-SMTP means,
27602 as defined by RFC 4422 Appendix A.
27603 The fifth provides an interface to the GNU SASL authentication library, which
27604 provides mechanisms but typically not data sources.
27605 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27606 supporting setting a server keytab.
27607 The seventh can be configured to support
27608 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27609 not formally documented, but used by several MUAs.
27610 The eighth authenticator
27611 supports Microsoft's &'Secure Password Authentication'& mechanism.
27612 The last is an Exim authenticator but not an SMTP one;
27613 instead it can use information from a TLS negotiation.
27614
27615 The authenticators are configured using the same syntax as other drivers (see
27616 section &<<SECTfordricon>>&). If no authenticators are required, no
27617 authentication section need be present in the configuration file. Each
27618 authenticator can in principle have both server and client functions. When Exim
27619 is receiving SMTP mail, it is acting as a server; when it is sending out
27620 messages over SMTP, it is acting as a client. Authenticator configuration
27621 options are provided for use in both these circumstances.
27622
27623 To make it clear which options apply to which situation, the prefixes
27624 &%server_%& and &%client_%& are used on option names that are specific to
27625 either the server or the client function, respectively. Server and client
27626 functions are disabled if none of their options are set. If an authenticator is
27627 to be used for both server and client functions, a single definition, using
27628 both sets of options, is required. For example:
27629 .code
27630 cram:
27631   driver = cram_md5
27632   public_name = CRAM-MD5
27633   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27634   client_name = ph10
27635   client_secret = secret2
27636 .endd
27637 The &%server_%& option is used when Exim is acting as a server, and the
27638 &%client_%& options when it is acting as a client.
27639
27640 Descriptions of the individual authenticators are given in subsequent chapters.
27641 The remainder of this chapter covers the generic options for the
27642 authenticators, followed by general discussion of the way authentication works
27643 in Exim.
27644
27645 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27646 per-mechanism basis.  Please read carefully to determine which variables hold
27647 account labels such as usercodes and which hold passwords or other
27648 authenticating data.
27649
27650 Note that some mechanisms support two different identifiers for accounts: the
27651 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27652 and &'authz'& are commonly encountered.  The American spelling is standard here.
27653 Conceptually, authentication data such as passwords are tied to the identifier
27654 used to authenticate; servers may have rules to permit one user to act as a
27655 second user, so that after login the session is treated as though that second
27656 user had logged in.  That second user is the &'authorization id'&.  A robust
27657 configuration might confirm that the &'authz'& field is empty or matches the
27658 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27659 as verified data, the &'authz'& as an unverified request which the server might
27660 choose to honour.
27661
27662 A &'realm'& is a text string, typically a domain name, presented by a server
27663 to a client to help it select an account and credentials to use.  In some
27664 mechanisms, the client and server provably agree on the realm, but clients
27665 typically can not treat the realm as secure data to be blindly trusted.
27666
27667
27668
27669 .section "Generic options for authenticators" "SECID168"
27670 .cindex "authentication" "generic options"
27671 .cindex "options" "generic; for authenticators"
27672
27673 .option client_condition authenticators string&!! unset
27674 When Exim is authenticating as a client, it skips any authenticator whose
27675 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27676 used, for example, to skip plain text authenticators when the connection is not
27677 encrypted by a setting such as:
27678 .code
27679 client_condition = ${if !eq{$tls_out_cipher}{}}
27680 .endd
27681
27682
27683 .option client_set_id authenticators string&!! unset
27684 When client authentication succeeds, this condition is expanded; the
27685 result is used in the log lines for outbound messages.
27686 Typically it will be the user name used for authentication.
27687
27688
27689 .option driver authenticators string unset
27690 This option must always be set. It specifies which of the available
27691 authenticators is to be used.
27692
27693
27694 .option public_name authenticators string unset
27695 This option specifies the name of the authentication mechanism that the driver
27696 implements, and by which it is known to the outside world. These names should
27697 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27698 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27699 defaults to the driver's instance name.
27700
27701
27702 .option server_advertise_condition authenticators string&!! unset
27703 When a server is about to advertise an authentication mechanism, the condition
27704 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27705 mechanism is not advertised.
27706 If the expansion fails, the mechanism is not advertised. If the failure was not
27707 forced, and was not caused by a lookup defer, the incident is logged.
27708 See section &<<SECTauthexiser>>& below for further discussion.
27709
27710
27711 .option server_condition authenticators string&!! unset
27712 This option must be set for a &%plaintext%& server authenticator, where it
27713 is used directly to control authentication. See section &<<SECTplainserver>>&
27714 for details.
27715
27716 For the &(gsasl)& authenticator, this option is required for various
27717 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27718
27719 For the other authenticators, &%server_condition%& can be used as an additional
27720 authentication or authorization mechanism that is applied after the other
27721 authenticator conditions succeed. If it is set, it is expanded when the
27722 authenticator would otherwise return a success code. If the expansion is forced
27723 to fail, authentication fails. Any other expansion failure causes a temporary
27724 error code to be returned. If the result of a successful expansion is an empty
27725 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27726 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27727 other result, a temporary error code is returned, with the expanded string as
27728 the error text.
27729
27730
27731 .option server_debug_print authenticators string&!! unset
27732 If this option is set and authentication debugging is enabled (see the &%-d%&
27733 command line option), the string is expanded and included in the debugging
27734 output when the authenticator is run as a server. This can help with checking
27735 out the values of variables.
27736 If expansion of the string fails, the error message is written to the debugging
27737 output, and Exim carries on processing.
27738
27739
27740 .option server_set_id authenticators string&!! unset
27741 .vindex "&$authenticated_id$&"
27742 .vindex "&$authenticated_fail_id$&"
27743 When an Exim server successfully authenticates a client, this string is
27744 expanded using data from the authentication, and preserved for any incoming
27745 messages in the variable &$authenticated_id$&. It is also included in the log
27746 lines for incoming messages. For example, a user/password authenticator
27747 configuration might preserve the user name that was used to authenticate, and
27748 refer to it subsequently during delivery of the message.
27749 On a failing authentication the expansion result is instead saved in
27750 the &$authenticated_fail_id$& variable.
27751 If expansion fails, the option is ignored.
27752
27753
27754 .option server_mail_auth_condition authenticators string&!! unset
27755 This option allows a server to discard authenticated sender addresses supplied
27756 as part of MAIL commands in SMTP connections that are authenticated by the
27757 driver on which &%server_mail_auth_condition%& is set. The option is not used
27758 as part of the authentication process; instead its (unexpanded) value is
27759 remembered for later use.
27760 How it is used is described in the following section.
27761
27762
27763
27764
27765
27766 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27767 .cindex "authentication" "sender; authenticated"
27768 .cindex "AUTH" "on MAIL command"
27769 When a client supplied an AUTH= item on a MAIL command, Exim applies
27770 the following checks before accepting it as the authenticated sender of the
27771 message:
27772
27773 .ilist
27774 If the connection is not using extended SMTP (that is, HELO was used rather
27775 than EHLO), the use of AUTH= is a syntax error.
27776 .next
27777 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27778 .next
27779 .vindex "&$authenticated_sender$&"
27780 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27781 running, the value of &$authenticated_sender$& is set to the value obtained
27782 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27783 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27784 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27785 given for the MAIL command.
27786 .next
27787 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27788 is accepted and placed in &$authenticated_sender$& only if the client has
27789 authenticated.
27790 .next
27791 If the AUTH= value was accepted by either of the two previous rules, and
27792 the client has authenticated, and the authenticator has a setting for the
27793 &%server_mail_auth_condition%&, the condition is checked at this point. The
27794 valued that was saved from the authenticator is expanded. If the expansion
27795 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27796 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27797 the value of &$authenticated_sender$& is retained and passed on with the
27798 message.
27799 .endlist
27800
27801
27802 When &$authenticated_sender$& is set for a message, it is passed on to other
27803 hosts to which Exim authenticates as a client. Do not confuse this value with
27804 &$authenticated_id$&, which is a string obtained from the authentication
27805 process, and which is not usually a complete email address.
27806
27807 .vindex "&$sender_address$&"
27808 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27809 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27810 therefore make use of &$authenticated_sender$&. The converse is not true: the
27811 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27812 ACL is run.
27813
27814
27815
27816 .section "Authentication on an Exim server" "SECTauthexiser"
27817 .cindex "authentication" "on an Exim server"
27818 When Exim receives an EHLO command, it advertises the public names of those
27819 authenticators that are configured as servers, subject to the following
27820 conditions:
27821
27822 .ilist
27823 The client host must match &%auth_advertise_hosts%& (default *).
27824 .next
27825 If the &%server_advertise_condition%& option is set, its expansion must not
27826 yield the empty string, &"0"&, &"no"&, or &"false"&.
27827 .endlist
27828
27829 The order in which the authenticators are defined controls the order in which
27830 the mechanisms are advertised.
27831
27832 Some mail clients (for example, some versions of Netscape) require the user to
27833 provide a name and password for authentication whenever AUTH is advertised,
27834 even though authentication may not in fact be needed (for example, Exim may be
27835 set up to allow unconditional relaying from the client by an IP address check).
27836 You can make such clients more friendly by not advertising AUTH to them.
27837 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27838 that runs for RCPT) to relay without authentication, you should set
27839 .code
27840 auth_advertise_hosts = ! 10.9.8.0/24
27841 .endd
27842 so that no authentication mechanisms are advertised to them.
27843
27844 The &%server_advertise_condition%& controls the advertisement of individual
27845 authentication mechanisms. For example, it can be used to restrict the
27846 advertisement of a particular mechanism to encrypted connections, by a setting
27847 such as:
27848 .code
27849 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27850 .endd
27851 .vindex "&$tls_in_cipher$&"
27852 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27853 yields &"yes"&, which allows the advertisement to happen.
27854
27855 When an Exim server receives an AUTH command from a client, it rejects it
27856 immediately if AUTH was not advertised in response to an earlier EHLO
27857 command. This is the case if
27858
27859 .ilist
27860 The client host does not match &%auth_advertise_hosts%&; or
27861 .next
27862 No authenticators are configured with server options; or
27863 .next
27864 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27865 server authenticators.
27866 .endlist
27867
27868
27869 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27870 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27871 AUTH is accepted from any client host.
27872
27873 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27874 server authentication mechanism that was advertised in response to EHLO and
27875 that matches the one named in the AUTH command. If it finds one, it runs
27876 the appropriate authentication protocol, and authentication either succeeds or
27877 fails. If there is no matching advertised mechanism, the AUTH command is
27878 rejected with a 504 error.
27879
27880 .vindex "&$received_protocol$&"
27881 .vindex "&$sender_host_authenticated$&"
27882 When a message is received from an authenticated host, the value of
27883 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27884 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27885 public name) of the authenticator driver that successfully authenticated the
27886 client from which the message was received. This variable is empty if there was
27887 no successful authentication.
27888
27889 .cindex authentication "expansion item"
27890 Successful authentication sets up information used by the
27891 &%authresults%& expansion item.
27892
27893 .cindex authentication "failure event, server"
27894 If an authenticator is run and does not succeed,
27895 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27896 While the event is being processed the variables
27897 &$sender_host_authenticated$& (with the authenticator name)
27898 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27899 will be valid.
27900 If the event is serviced and a string is returned then the string will be logged
27901 instead of the default log line.
27902 See <<CHAPevents>> for details on events.
27903
27904
27905 .section "Testing server authentication" "SECID169"
27906 .cindex "authentication" "testing a server"
27907 .cindex "AUTH" "testing a server"
27908 .cindex "base64 encoding" "creating authentication test data"
27909 Exim's &%-bh%& option can be useful for testing server authentication
27910 configurations. The data for the AUTH command has to be sent using base64
27911 encoding. A quick way to produce such data for testing is the following Perl
27912 script:
27913 .code
27914 use MIME::Base64;
27915 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27916 .endd
27917 .cindex "binary zero" "in authentication data"
27918 This interprets its argument as a Perl string, and then encodes it. The
27919 interpretation as a Perl string allows binary zeros, which are required for
27920 some kinds of authentication, to be included in the data. For example, a
27921 command line to run this script on such data might be
27922 .code
27923 encode '\0user\0password'
27924 .endd
27925 Note the use of single quotes to prevent the shell interpreting the
27926 backslashes, so that they can be interpreted by Perl to specify characters
27927 whose code value is zero.
27928
27929 &*Warning 1*&: If either of the user or password strings starts with an octal
27930 digit, you must use three zeros instead of one after the leading backslash. If
27931 you do not, the octal digit that starts your string will be incorrectly
27932 interpreted as part of the code for the first character.
27933
27934 &*Warning 2*&: If there are characters in the strings that Perl interprets
27935 specially, you must use a Perl escape to prevent them being misinterpreted. For
27936 example, a command such as
27937 .code
27938 encode '\0user@domain.com\0pas$$word'
27939 .endd
27940 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27941
27942 If you have the &%mimencode%& command installed, another way to produce
27943 base64-encoded strings is to run the command
27944 .code
27945 echo -e -n `\0user\0password' | mimencode
27946 .endd
27947 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27948 in the argument, and the &%-n%& option specifies no newline at the end of its
27949 output. However, not all versions of &%echo%& recognize these options, so you
27950 should check your version before relying on this suggestion.
27951
27952
27953
27954 .section "Authentication by an Exim client" "SECID170"
27955 .cindex "authentication" "on an Exim client"
27956 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27957 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27958 announces support for authentication, and the host matches an entry in either
27959 of these options, Exim (as a client) tries to authenticate as follows:
27960
27961 .ilist
27962 For each authenticator that is configured as a client, in the order in which
27963 they are defined in the configuration, it searches the authentication
27964 mechanisms announced by the server for one whose name matches the public name
27965 of the authenticator.
27966 .next
27967 .vindex "&$host$&"
27968 .vindex "&$host_address$&"
27969 When it finds one that matches, it runs the authenticator's client code. The
27970 variables &$host$& and &$host_address$& are available for any string expansions
27971 that the client might do. They are set to the server's name and IP address. If
27972 any expansion is forced to fail, the authentication attempt is abandoned, and
27973 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27974 delivery to be deferred.
27975 .next
27976 If the result of the authentication attempt is a temporary error or a timeout,
27977 Exim abandons trying to send the message to the host for the moment. It will
27978 try again later. If there are any backup hosts available, they are tried in the
27979 usual way.
27980
27981 .next
27982 .cindex authentication "failure event, client"
27983 If the response to authentication is a permanent error (5&'xx'& code),
27984 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27985 While the event is being processed the variable
27986 &$sender_host_authenticated$& (with the authenticator name)
27987 will be valid.
27988 If the event is serviced and a string is returned then the string will be logged.
27989 See <<CHAPevents>> for details on events.
27990
27991 .next
27992 If the response to authentication is a permanent error (5&'xx'& code), Exim
27993 carries on searching the list of authenticators and tries another one if
27994 possible. If all authentication attempts give permanent errors, or if there are
27995 no attempts because no mechanisms match (or option expansions force failure),
27996 what happens depends on whether the host matches &%hosts_require_auth%& or
27997 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27998 delivery is deferred. The error can be detected in the retry rules, and thereby
27999 turned into a permanent error if you wish. In the second case, Exim tries to
28000 deliver the message unauthenticated.
28001 .endlist
28002
28003 Note that the hostlist test for whether to do authentication can be
28004 confused if name-IP lookups change between the time the peer is decided
28005 upon and the time that the transport runs.  For example, with a manualroute
28006 router given a host name, and with DNS "round-robin" used by that name: if
28007 the local resolver cache times out between the router and the transport
28008 running, the transport may get an IP for the name for its authentication
28009 check which does not match the connection peer IP.
28010 No authentication will then be done, despite the names being identical.
28011
28012 For such cases use a separate transport which always authenticates.
28013
28014 .cindex "AUTH" "on MAIL command"
28015 When Exim has authenticated itself to a remote server, it adds the AUTH
28016 parameter to the MAIL commands it sends, if it has an authenticated sender for
28017 the message. If the message came from a remote host, the authenticated sender
28018 is the one that was receiving on an incoming MAIL command, provided that the
28019 incoming connection was authenticated and the &%server_mail_auth%& condition
28020 allowed the authenticated sender to be retained. If a local process calls Exim
28021 to send a message, the sender address that is built from the login name and
28022 &%qualify_domain%& is treated as authenticated. However, if the
28023 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
28024 the authenticated sender that was received with the message.
28025 .ecindex IIDauthconf1
28026 .ecindex IIDauthconf2
28027
28028
28029
28030
28031
28032
28033 . ////////////////////////////////////////////////////////////////////////////
28034 . ////////////////////////////////////////////////////////////////////////////
28035
28036 .chapter "The plaintext authenticator" "CHAPplaintext"
28037 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
28038 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
28039 The &(plaintext)& authenticator can be configured to support the PLAIN and
28040 LOGIN authentication mechanisms, both of which transfer authentication data as
28041 plain (unencrypted) text (though base64 encoded). The use of plain text is a
28042 security risk; you are strongly advised to insist on the use of SMTP encryption
28043 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
28044 use unencrypted plain text, you should not use the same passwords for SMTP
28045 connections as you do for login accounts.
28046
28047 .section "Avoiding cleartext use" "SECTplain_TLS"
28048 The following generic option settings will disable &(plaintext)& authenticators when
28049 TLS is not being used:
28050 .code
28051   server_advertise_condition = ${if def:tls_in_cipher }
28052   client_condition =           ${if def:tls_out_cipher}
28053 .endd
28054
28055 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
28056 but is still vulnerable to a Man In The Middle attack unless certificates
28057 (including their names) have been properly verified.
28058
28059 .section "Plaintext server options" "SECID171"
28060 .cindex "options" "&(plaintext)& authenticator (server)"
28061 When configured as a server, &(plaintext)& uses the following options:
28062
28063 .option server_condition authenticators string&!! unset
28064 This is actually a global authentication option, but it must be set in order to
28065 configure the &(plaintext)& driver as a server. Its use is described below.
28066
28067 .option server_prompts plaintext "string list&!!" unset
28068 The contents of this option, after expansion, must be a colon-separated list of
28069 prompt strings. If expansion fails, a temporary authentication rejection is
28070 given.
28071
28072 .section "Using plaintext in a server" "SECTplainserver"
28073 .cindex "AUTH" "in &(plaintext)& authenticator"
28074 .cindex "binary zero" "in &(plaintext)& authenticator"
28075 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28076         "in &(plaintext)& authenticator"
28077 .vindex "&$auth1$&, &$auth2$&, etc"
28078 .cindex "base64 encoding" "in &(plaintext)& authenticator"
28079
28080 When running as a server, &(plaintext)& performs the authentication test by
28081 expanding a string. The data sent by the client with the AUTH command, or in
28082 response to subsequent prompts, is base64 encoded, and so may contain any byte
28083 values when decoded. If any data is supplied with the command, it is treated as
28084 a list of strings, separated by NULs (binary zeros), the first three of which
28085 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
28086 (neither LOGIN nor PLAIN uses more than three strings).
28087
28088 For compatibility with previous releases of Exim, the values are also placed in
28089 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
28090 variables for this purpose is now deprecated, as it can lead to confusion in
28091 string expansions that also use them for other things.
28092
28093 If there are more strings in &%server_prompts%& than the number of strings
28094 supplied with the AUTH command, the remaining prompts are used to obtain more
28095 data. Each response from the client may be a list of NUL-separated strings.
28096
28097 .vindex "&$authenticated_id$&"
28098 Once a sufficient number of data strings have been received,
28099 &%server_condition%& is expanded. If the expansion is forced to fail,
28100 authentication fails. Any other expansion failure causes a temporary error code
28101 to be returned. If the result of a successful expansion is an empty string,
28102 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28103 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28104 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28105 For any other result, a temporary error code is returned, with the expanded
28106 string as the error text.
28107
28108 &*Warning*&: If you use a lookup in the expansion to find the user's
28109 password, be sure to make the authentication fail if the user is unknown.
28110 There are good and bad examples at the end of the next section.
28111
28112
28113
28114 .section "The PLAIN authentication mechanism" "SECID172"
28115 .cindex "PLAIN authentication mechanism"
28116 .cindex authentication PLAIN
28117 .cindex "binary zero" "in &(plaintext)& authenticator"
28118 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
28119 sent as one item of data (that is, one combined string containing two NUL
28120 separators). The data is sent either as part of the AUTH command, or
28121 subsequently in response to an empty prompt from the server.
28122
28123 The second and third strings are a user name and a corresponding password.
28124 Using a single fixed user name and password as an example, this could be
28125 configured as follows:
28126 .code
28127 fixed_plain:
28128   driver = plaintext
28129   public_name = PLAIN
28130   server_prompts = :
28131   server_condition = \
28132     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
28133   server_set_id = $auth2
28134 .endd
28135 Note that the default result strings from &%if%& (&"true"& or an empty string)
28136 are exactly what we want here, so they need not be specified. Obviously, if the
28137 password contains expansion-significant characters such as dollar, backslash,
28138 or closing brace, they have to be escaped.
28139
28140 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
28141 the end of a string list are ignored). If all the data comes as part of the
28142 AUTH command, as is commonly the case, the prompt is not used. This
28143 authenticator is advertised in the response to EHLO as
28144 .code
28145 250-AUTH PLAIN
28146 .endd
28147 and a client host can authenticate itself by sending the command
28148 .code
28149 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
28150 .endd
28151 As this contains three strings (more than the number of prompts), no further
28152 data is required from the client. Alternatively, the client may just send
28153 .code
28154 AUTH PLAIN
28155 .endd
28156 to initiate authentication, in which case the server replies with an empty
28157 prompt. The client must respond with the combined data string.
28158
28159 The data string is base64 encoded, as required by the RFC. This example,
28160 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
28161 represents a zero byte. This is split up into three strings, the first of which
28162 is empty. The &%server_condition%& option in the authenticator checks that the
28163 second two are &`username`& and &`mysecret`& respectively.
28164
28165 Having just one fixed user name and password, as in this example, is not very
28166 realistic, though for a small organization with only a handful of
28167 authenticating clients it could make sense.
28168
28169 A more sophisticated instance of this authenticator could use the user name in
28170 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
28171 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
28172 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
28173 This is an incorrect example:
28174 .code
28175 server_condition = \
28176   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28177 .endd
28178 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28179 which it then compares to the supplied password (&$auth3$&). Why is this example
28180 incorrect? It works fine for existing users, but consider what happens if a
28181 non-existent user name is given. The lookup fails, but as no success/failure
28182 strings are given for the lookup, it yields an empty string. Thus, to defeat
28183 the authentication, all a client has to do is to supply a non-existent user
28184 name and an empty password. The correct way of writing this test is:
28185 .code
28186 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28187   {${if eq{$value}{$auth3}}} {false}}
28188 .endd
28189 In this case, if the lookup succeeds, the result is checked; if the lookup
28190 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28191 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28192 always fails if its second argument is empty. However, the second way of
28193 writing the test makes the logic clearer.
28194
28195
28196 .section "The LOGIN authentication mechanism" "SECID173"
28197 .cindex "LOGIN authentication mechanism"
28198 .cindex authentication LOGIN
28199 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28200 in a number of programs. No data is sent with the AUTH command. Instead, a
28201 user name and password are supplied separately, in response to prompts. The
28202 plaintext authenticator can be configured to support this as in this example:
28203 .code
28204 fixed_login:
28205   driver = plaintext
28206   public_name = LOGIN
28207   server_prompts = User Name : Password
28208   server_condition = \
28209     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28210   server_set_id = $auth1
28211 .endd
28212 Because of the way plaintext operates, this authenticator accepts data supplied
28213 with the AUTH command (in contravention of the specification of LOGIN), but
28214 if the client does not supply it (as is the case for LOGIN clients), the prompt
28215 strings are used to obtain two data items.
28216
28217 Some clients are very particular about the precise text of the prompts. For
28218 example, Outlook Express is reported to recognize only &"Username:"& and
28219 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28220 strings. It uses the &%ldapauth%& expansion condition to check the user
28221 name and password by binding to an LDAP server:
28222 .code
28223 login:
28224   driver = plaintext
28225   public_name = LOGIN
28226   server_prompts = Username:: : Password::
28227   server_condition = ${if and{{ \
28228     !eq{}{$auth1} }{ \
28229     ldapauth{\
28230       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28231       pass=${quote:$auth2} \
28232       ldap://ldap.example.org/} }} }
28233   server_set_id = uid=$auth1,ou=people,o=example.org
28234 .endd
28235 We have to check that the username is not empty before using it, because LDAP
28236 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28237 operator to correctly quote the DN for authentication. However, the basic
28238 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28239 correct one to use for the password, because quoting is needed only to make
28240 the password conform to the Exim syntax. At the LDAP level, the password is an
28241 uninterpreted string.
28242
28243
28244 .section "Support for different kinds of authentication" "SECID174"
28245 A number of string expansion features are provided for the purpose of
28246 interfacing to different ways of user authentication. These include checking
28247 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28248 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28249 &<<SECTexpcond>>&.
28250
28251
28252
28253
28254 .section "Using plaintext in a client" "SECID175"
28255 .cindex "options" "&(plaintext)& authenticator (client)"
28256 The &(plaintext)& authenticator has two client options:
28257
28258 .option client_ignore_invalid_base64 plaintext boolean false
28259 If the client receives a server prompt that is not a valid base64 string,
28260 authentication is abandoned by default. However, if this option is set true,
28261 the error in the challenge is ignored and the client sends the response as
28262 usual.
28263
28264 .option client_send plaintext string&!! unset
28265 The string is a colon-separated list of authentication data strings. Each
28266 string is independently expanded before being sent to the server. The first
28267 string is sent with the AUTH command; any more strings are sent in response
28268 to prompts from the server. Before each string is expanded, the value of the
28269 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28270 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28271 way. Thus, the prompt that is received in response to sending the first string
28272 (with the AUTH command) can be used in the expansion of the second string, and
28273 so on. If an invalid base64 string is received when
28274 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28275 &$auth$&<&'n'&> variable.
28276
28277 &*Note*&: You cannot use expansion to create multiple strings, because
28278 splitting takes priority and happens first.
28279
28280 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28281 the data, further processing is applied to each string before it is sent. If
28282 there are any single circumflex characters in the string, they are converted to
28283 NULs. Should an actual circumflex be required as data, it must be doubled in
28284 the string.
28285
28286 This is an example of a client configuration that implements the PLAIN
28287 authentication mechanism with a fixed user name and password:
28288 .code
28289 fixed_plain:
28290   driver = plaintext
28291   public_name = PLAIN
28292   client_send = ^username^mysecret
28293 .endd
28294 The lack of colons means that the entire text is sent with the AUTH
28295 command, with the circumflex characters converted to NULs.
28296 Note that due to the ambiguity of parsing three consectutive circumflex characters
28297 there is no way to provide a password having a leading circumflex.
28298
28299
28300 A similar example
28301 that uses the LOGIN mechanism is:
28302 .code
28303 fixed_login:
28304   driver = plaintext
28305   public_name = LOGIN
28306   client_send = : username : mysecret
28307 .endd
28308 The initial colon means that the first string is empty, so no data is sent with
28309 the AUTH command itself. The remaining strings are sent in response to
28310 prompts.
28311 .ecindex IIDplaiauth1
28312 .ecindex IIDplaiauth2
28313
28314
28315
28316
28317 . ////////////////////////////////////////////////////////////////////////////
28318 . ////////////////////////////////////////////////////////////////////////////
28319
28320 .chapter "The cram_md5 authenticator" "CHID9"
28321 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28322 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28323 .cindex "CRAM-MD5 authentication mechanism"
28324 .cindex authentication CRAM-MD5
28325 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28326 sends a challenge string to the client, and the response consists of a user
28327 name and the CRAM-MD5 digest of the challenge string combined with a secret
28328 string (password) which is known to both server and client. Thus, the secret
28329 is not sent over the network as plain text, which makes this authenticator more
28330 secure than &(plaintext)&. However, the downside is that the secret has to be
28331 available in plain text at either end.
28332
28333
28334 .section "Using cram_md5 as a server" "SECID176"
28335 .cindex "options" "&(cram_md5)& authenticator (server)"
28336 This authenticator has one server option, which must be set to configure the
28337 authenticator as a server:
28338
28339 .option server_secret cram_md5 string&!! unset
28340 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28341 When the server receives the client's response, the user name is placed in
28342 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28343 obtain the password for that user. The server then computes the CRAM-MD5 digest
28344 that the client should have sent, and checks that it received the correct
28345 string. If the expansion of &%server_secret%& is forced to fail, authentication
28346 fails. If the expansion fails for some other reason, a temporary error code is
28347 returned to the client.
28348
28349 For compatibility with previous releases of Exim, the user name is also placed
28350 in &$1$&. However, the use of this variables for this purpose is now
28351 deprecated, as it can lead to confusion in string expansions that also use
28352 numeric variables for other things.
28353
28354 For example, the following authenticator checks that the user name given by the
28355 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28356 user name, authentication fails.
28357 .code
28358 fixed_cram:
28359   driver = cram_md5
28360   public_name = CRAM-MD5
28361   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28362   server_set_id = $auth1
28363 .endd
28364 .vindex "&$authenticated_id$&"
28365 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28366 name in &$authenticated_id$&. A more typical configuration might look up the
28367 secret string in a file, using the user name as the key. For example:
28368 .code
28369 lookup_cram:
28370   driver = cram_md5
28371   public_name = CRAM-MD5
28372   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28373                   {$value}fail}
28374   server_set_id = $auth1
28375 .endd
28376 Note that this expansion explicitly forces failure if the lookup fails
28377 because &$auth1$& contains an unknown user name.
28378
28379 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28380 using the relevant libraries, you need to know the realm to specify in the
28381 lookup and then ask for the &"userPassword"& attribute for that user in that
28382 realm, with:
28383 .code
28384 cyrusless_crammd5:
28385   driver = cram_md5
28386   public_name = CRAM-MD5
28387   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28388                   dbmjz{/etc/sasldb2}{$value}fail}
28389   server_set_id = $auth1
28390 .endd
28391
28392 .section "Using cram_md5 as a client" "SECID177"
28393 .cindex "options" "&(cram_md5)& authenticator (client)"
28394 When used as a client, the &(cram_md5)& authenticator has two options:
28395
28396
28397
28398 .option client_name cram_md5 string&!! "the primary host name"
28399 This string is expanded, and the result used as the user name data when
28400 computing the response to the server's challenge.
28401
28402
28403 .option client_secret cram_md5 string&!! unset
28404 This option must be set for the authenticator to work as a client. Its value is
28405 expanded and the result used as the secret string when computing the response.
28406
28407
28408 .vindex "&$host$&"
28409 .vindex "&$host_address$&"
28410 Different user names and secrets can be used for different servers by referring
28411 to &$host$& or &$host_address$& in the options. Forced failure of either
28412 expansion string is treated as an indication that this authenticator is not
28413 prepared to handle this case. Exim moves on to the next configured client
28414 authenticator. Any other expansion failure causes Exim to give up trying to
28415 send the message to the current server.
28416
28417 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28418 strings, is:
28419 .code
28420 fixed_cram:
28421   driver = cram_md5
28422   public_name = CRAM-MD5
28423   client_name = ph10
28424   client_secret = secret
28425 .endd
28426 .ecindex IIDcramauth1
28427 .ecindex IIDcramauth2
28428
28429
28430
28431 . ////////////////////////////////////////////////////////////////////////////
28432 . ////////////////////////////////////////////////////////////////////////////
28433
28434 .chapter "The cyrus_sasl authenticator" "CHID10"
28435 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28436 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28437 .cindex "Cyrus" "SASL library"
28438 .cindex "Kerberos"
28439 The code for this authenticator was provided by Matthew Byng-Maddick while
28440 at A L Digital Ltd.
28441
28442 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28443 library implementation of the RFC 2222 (&"Simple Authentication and Security
28444 Layer"&). This library supports a number of authentication mechanisms,
28445 including PLAIN and LOGIN, but also several others that Exim does not support
28446 directly. In particular, there is support for Kerberos authentication.
28447
28448 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28449 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28450 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28451 name of the driver to determine which mechanism to support.
28452
28453 Where access to some kind of secret file is required, for example, in GSSAPI
28454 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28455 user, and that the Cyrus SASL library has no way of escalating privileges
28456 by default. You may also find you need to set environment variables,
28457 depending on the driver you are using.
28458
28459 The application name provided by Exim is &"exim"&, so various SASL options may
28460 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28461 Kerberos, note that because of limitations in the GSSAPI interface,
28462 changing the server keytab might need to be communicated down to the Kerberos
28463 layer independently. The mechanism for doing so is dependent upon the Kerberos
28464 implementation.
28465
28466 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28467 may be set to point to an alternative keytab file. Exim will pass this
28468 variable through from its own inherited environment when started as root or the
28469 Exim user. The keytab file needs to be readable by the Exim user.
28470 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28471 environment variable.  In practice, for those releases, the Cyrus authenticator
28472 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28473 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28474
28475
28476 .section "Using cyrus_sasl as a server" "SECID178"
28477 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28478 (on a successful authentication) into &$auth1$&. For compatibility with
28479 previous releases of Exim, the username is also placed in &$1$&. However, the
28480 use of this variable for this purpose is now deprecated, as it can lead to
28481 confusion in string expansions that also use numeric variables for other
28482 things.
28483
28484
28485 .option server_hostname cyrus_sasl string&!! "see below"
28486 This option selects the hostname that is used when communicating with the
28487 library. The default value is &`$primary_hostname`&. It is up to the underlying
28488 SASL plug-in what it does with this data.
28489
28490
28491 .option server_mech cyrus_sasl string "see below"
28492 This option selects the authentication mechanism this driver should use. The
28493 default is the value of the generic &%public_name%& option. This option allows
28494 you to use a different underlying mechanism from the advertised name. For
28495 example:
28496 .code
28497 sasl:
28498   driver = cyrus_sasl
28499   public_name = X-ANYTHING
28500   server_mech = CRAM-MD5
28501   server_set_id = $auth1
28502 .endd
28503
28504 .option server_realm cyrus_sasl string&!! unset
28505 This specifies the SASL realm that the server claims to be in.
28506
28507
28508 .option server_service cyrus_sasl string &`smtp`&
28509 This is the SASL service that the server claims to implement.
28510
28511
28512 For straightforward cases, you do not need to set any of the authenticator's
28513 private options. All you need to do is to specify an appropriate mechanism as
28514 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28515 PLAIN, you could have two authenticators as follows:
28516 .code
28517 sasl_cram_md5:
28518   driver = cyrus_sasl
28519   public_name = CRAM-MD5
28520   server_set_id = $auth1
28521
28522 sasl_plain:
28523   driver = cyrus_sasl
28524   public_name = PLAIN
28525   server_set_id = $auth2
28526 .endd
28527 Cyrus SASL does implement the LOGIN authentication method, even though it is
28528 not a standard method. It is disabled by default in the source distribution,
28529 but it is present in many binary distributions.
28530 .ecindex IIDcyrauth1
28531 .ecindex IIDcyrauth2
28532
28533
28534
28535
28536 . ////////////////////////////////////////////////////////////////////////////
28537 . ////////////////////////////////////////////////////////////////////////////
28538 .chapter "The dovecot authenticator" "CHAPdovecot"
28539 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28540 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28541 This authenticator is an interface to the authentication facility of the
28542 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28543 Note that Dovecot must be configured to use auth-client not auth-userdb.
28544 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28545 to use the same mechanisms for SMTP authentication. This is a server
28546 authenticator only. There is only one non-generic option:
28547
28548 .option server_socket dovecot string unset
28549
28550 This option must specify the UNIX socket that is the interface to Dovecot
28551 authentication. The &%public_name%& option must specify an authentication
28552 mechanism that Dovecot is configured to support. You can have several
28553 authenticators for different mechanisms. For example:
28554 .code
28555 dovecot_plain:
28556   driver = dovecot
28557   public_name = PLAIN
28558   server_advertise_condition = ${if def:tls_in_cipher}
28559   server_socket = /var/run/dovecot/auth-client
28560   server_set_id = $auth1
28561
28562 dovecot_ntlm:
28563   driver = dovecot
28564   public_name = NTLM
28565   server_socket = /var/run/dovecot/auth-client
28566   server_set_id = $auth1
28567 .endd
28568
28569 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28570 should not be advertised on cleartext SMTP connections.
28571 See the discussion in section &<<SECTplain_TLS>>&.
28572
28573 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28574 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28575 option is passed in the Dovecot authentication command. If, for a TLS
28576 connection, a client certificate has been verified, the &"valid-client-cert"&
28577 option is passed. When authentication succeeds, the identity of the user
28578 who authenticated is placed in &$auth1$&.
28579
28580 The Dovecot configuration to match the above will look
28581 something like:
28582 .code
28583 conf.d/10-master.conf :-
28584
28585 service auth {
28586 ...
28587 #SASL
28588   unix_listener auth-client {
28589     mode = 0660
28590     user = mail
28591   }
28592 ...
28593 }
28594
28595 conf.d/10-auth.conf :-
28596
28597 auth_mechanisms = plain login ntlm
28598 .endd
28599
28600 .ecindex IIDdcotauth1
28601 .ecindex IIDdcotauth2
28602
28603
28604 . ////////////////////////////////////////////////////////////////////////////
28605 . ////////////////////////////////////////////////////////////////////////////
28606 .chapter "The gsasl authenticator" "CHAPgsasl"
28607 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28608 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28609 .cindex "authentication" "GNU SASL"
28610 .cindex "authentication" "SASL"
28611 .cindex "authentication" "EXTERNAL"
28612 .cindex "authentication" "ANONYMOUS"
28613 .cindex "authentication" "PLAIN"
28614 .cindex "authentication" "LOGIN"
28615 .cindex "authentication" "DIGEST-MD5"
28616 .cindex "authentication" "CRAM-MD5"
28617 .cindex "authentication" "SCRAM family"
28618 The &(gsasl)& authenticator provides integration for the GNU SASL
28619 library and the mechanisms it provides.  This is new as of the 4.80 release
28620 and there are a few areas where the library does not let Exim smoothly
28621 scale to handle future authentication mechanisms, so no guarantee can be
28622 made that any particular new authentication mechanism will be supported
28623 without code changes in Exim.
28624
28625 The library is expected to add support in an upcoming
28626 realease for the SCRAM-SHA-256 method.
28627 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28628 when this happens.
28629
28630 To see the list of mechanisms supported by the library run Exim with "auth" debug
28631 enabled and look for a line containing "GNU SASL supports".
28632 Note however that some may not have been tested from Exim.
28633
28634
28635 .option client_authz gsasl string&!! unset
28636 This option can be used to supply an &'authorization id'&
28637 which is different to the &'authentication_id'& provided
28638 by &%client_username%& option.
28639 If unset or (after expansion) empty it is not used,
28640 which is the common case.
28641
28642 .option client_channelbinding gsasl boolean false
28643 See &%server_channelbinding%& below.
28644
28645 .option client_password gsasl string&!! unset
28646 This option is exapanded before use, and should result in
28647 the password to be used, in clear.
28648
28649 .option client_username gsasl string&!! unset
28650 This option is exapanded before use, and should result in
28651 the account name to be used.
28652
28653
28654 .option client_spassword gsasl string&!! unset
28655 This option is only supported for library versions 1.9.1 and greater.
28656 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28657
28658 If a SCRAM mechanism is being used and this option is set
28659 and correctly sized
28660 it is used in preference to &%client_password%&.
28661 The value after expansion should be
28662 a 40 (for SHA-1) or 64 (for SHA-256) character string
28663 with the PBKDF2-prepared password, hex-encoded.
28664
28665 Note that this value will depend on the salt and iteration-count
28666 supplied by the server.
28667 The option is expanded before use.
28668 During the expansion &$auth1$& is set with the client username,
28669 &$auth2$& with the iteration count, and
28670 &$auth3$& with the salt.
28671
28672 The intent of this option
28673 is to support clients that can cache thes salted password
28674 to save on recalculation costs.
28675 The cache lookup should return an unusable value
28676 (eg. an empty string)
28677 if the salt or iteration count has changed
28678
28679 If the authentication succeeds then the above variables are set,
28680 .vindex "&$auth4$&"
28681 plus the calculated salted password value value in &$auth4$&,
28682 during the expansion of the &%client_set_id%& option.
28683 A side-effect of this expansion can be used to prime the cache.
28684
28685
28686 .option server_channelbinding gsasl boolean false
28687 Some authentication mechanisms are able to use external context at both ends
28688 of the session to bind the authentication to that context, and fail the
28689 authentication process if that context differs.  Specifically, some TLS
28690 ciphersuites can provide identifying information about the cryptographic
28691 context.
28692
28693 This should have meant that certificate identity and verification becomes a
28694 non-issue, as a man-in-the-middle attack will cause the correct client and
28695 server to see different identifiers and authentication will fail.
28696
28697 This is
28698 only usable by mechanisms which support "channel binding"; at time of
28699 writing, that's the SCRAM family.
28700 When using this feature the "-PLUS" variants of the method names need to be used.
28701
28702 This defaults off to ensure smooth upgrade across Exim releases, in case
28703 this option causes some clients to start failing.  Some future release
28704 of Exim might have switched the default to be true.
28705
28706 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28707 . Do not plan to rely upon this feature for security, ever, without consulting
28708 . with a subject matter expert (a cryptographic engineer).
28709
28710 This option was deprecated in previous releases due to doubts over
28711 the "Triple Handshake" vulnerability.
28712 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28713 Session Resumption was used) for safety.
28714
28715
28716 .option server_hostname gsasl string&!! "see below"
28717 This option selects the hostname that is used when communicating with the
28718 library. The default value is &`$primary_hostname`&.
28719 Some mechanisms will use this data.
28720
28721
28722 .option server_mech gsasl string "see below"
28723 This option selects the authentication mechanism this driver should use. The
28724 default is the value of the generic &%public_name%& option. This option allows
28725 you to use a different underlying mechanism from the advertised name. For
28726 example:
28727 .code
28728 sasl:
28729   driver = gsasl
28730   public_name = X-ANYTHING
28731   server_mech = CRAM-MD5
28732   server_set_id = $auth1
28733 .endd
28734
28735
28736 .option server_password gsasl string&!! unset
28737 Various mechanisms need access to the cleartext password on the server, so
28738 that proof-of-possession can be demonstrated on the wire, without sending
28739 the password itself.
28740
28741 The data available for lookup varies per mechanism.
28742 In all cases, &$auth1$& is set to the &'authentication id'&.
28743 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28744 if available, else the empty string.
28745 The &$auth3$& variable will always be the &'realm'& if available,
28746 else the empty string.
28747
28748 A forced failure will cause authentication to defer.
28749
28750 If using this option, it may make sense to set the &%server_condition%&
28751 option to be simply "true".
28752
28753
28754 .option server_realm gsasl string&!! unset
28755 This specifies the SASL realm that the server claims to be in.
28756 Some mechanisms will use this data.
28757
28758
28759 .option server_scram_iter gsasl string&!! 4096
28760 This option provides data for the SCRAM family of mechanisms.
28761 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28762 when this option is expanded.
28763
28764 The result of expansion should be a decimal number,
28765 and represents both a lower-bound on the security, and
28766 a compute cost factor imposed on the client
28767 (if it does not cache results, or the server changes
28768 either the iteration count or the salt).
28769 A minimum value of 4096 is required by the standards
28770 for all current SCRAM mechanism variants.
28771
28772 .option server_scram_salt gsasl string&!! unset
28773 This option provides data for the SCRAM family of mechanisms.
28774 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28775 when this option is expanded.
28776 The value should be a base64-encoded string,
28777 of random data typically 4-to-16 bytes long.
28778 If unset or empty after expansion the library will provides a value for the
28779 protocol conversation.
28780
28781
28782 .option server_key gsasl string&!! unset
28783 .option server_skey gsasl string&!! unset
28784 These options can be used for the SCRAM family of mechanisms
28785 to provide stored information related to a password,
28786 the storage of which is preferable to plaintext.
28787
28788 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28789 &%server_skey%& is StoredKey.
28790
28791 They are only available for version 1.9.0 (or later) of the gsasl library.
28792 When this is so, the macros
28793 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28794 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28795 will be defined.
28796
28797 The &$authN$& variables are available when these options are expanded.
28798
28799 If set, the results of expansion should for each
28800 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28801 of base64-coded data, and will be used in preference to the
28802 &%server_password%& option.
28803 If unset or not of the right length, &%server_password%& will be used.
28804
28805 The libgsasl library release includes a utility &'gsasl'& which can be used
28806 to generate these values.
28807
28808
28809 .option server_service gsasl string &`smtp`&
28810 This is the SASL service that the server claims to implement.
28811 Some mechanisms will use this data.
28812
28813
28814 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28815 .vindex "&$auth1$&, &$auth2$&, etc"
28816 These may be set when evaluating specific options, as detailed above.
28817 They will also be set when evaluating &%server_condition%&.
28818
28819 Unless otherwise stated below, the &(gsasl)& integration will use the following
28820 meanings for these variables:
28821
28822 .ilist
28823 .vindex "&$auth1$&"
28824 &$auth1$&: the &'authentication id'&
28825 .next
28826 .vindex "&$auth2$&"
28827 &$auth2$&: the &'authorization id'&
28828 .next
28829 .vindex "&$auth3$&"
28830 &$auth3$&: the &'realm'&
28831 .endlist
28832
28833 On a per-mechanism basis:
28834
28835 .ilist
28836 .cindex "authentication" "EXTERNAL"
28837 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28838 the &%server_condition%& option must be present.
28839 .next
28840 .cindex "authentication" "ANONYMOUS"
28841 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28842 the &%server_condition%& option must be present.
28843 .next
28844 .cindex "authentication" "GSSAPI"
28845 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28846 &$auth2$& will be set to the &'authorization id'&,
28847 the &%server_condition%& option must be present.
28848 .endlist
28849
28850 An &'anonymous token'& is something passed along as an unauthenticated
28851 identifier; this is analogous to FTP anonymous authentication passing an
28852 email address, or software-identifier@, as the "password".
28853
28854
28855 An example showing the password having the realm specified in the callback
28856 and demonstrating a Cyrus SASL to GSASL migration approach is:
28857 .code
28858 gsasl_cyrusless_crammd5:
28859   driver = gsasl
28860   public_name = CRAM-MD5
28861   server_realm = imap.example.org
28862   server_password = ${lookup{$auth1:$auth3:userPassword}\
28863                     dbmjz{/etc/sasldb2}{$value}fail}
28864   server_set_id = ${quote:$auth1}
28865   server_condition = yes
28866 .endd
28867
28868
28869 . ////////////////////////////////////////////////////////////////////////////
28870 . ////////////////////////////////////////////////////////////////////////////
28871
28872 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28873 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28874 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28875 .cindex "authentication" "GSSAPI"
28876 .cindex "authentication" "Kerberos"
28877 The &(heimdal_gssapi)& authenticator provides server integration for the
28878 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28879 reliably.
28880
28881 .option server_hostname heimdal_gssapi string&!! "see below"
28882 This option selects the hostname that is used, with &%server_service%&,
28883 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28884 identifier.  The default value is &`$primary_hostname`&.
28885
28886 .option server_keytab heimdal_gssapi string&!! unset
28887 If set, then Heimdal will not use the system default keytab (typically
28888 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28889 The value should be a pathname, with no &"file:"& prefix.
28890
28891 .option server_service heimdal_gssapi string&!! "smtp"
28892 This option specifies the service identifier used, in conjunction with
28893 &%server_hostname%&, for building the identifier for finding credentials
28894 from the keytab.
28895
28896
28897 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28898 Beware that these variables will typically include a realm, thus will appear
28899 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28900 not verified, so a malicious client can set it to anything.
28901
28902 The &$auth1$& field should be safely trustable as a value from the Key
28903 Distribution Center.  Note that these are not quite email addresses.
28904 Each identifier is for a role, and so the left-hand-side may include a
28905 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28906
28907 .vindex "&$auth1$&, &$auth2$&, etc"
28908 .ilist
28909 .vindex "&$auth1$&"
28910 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28911 .next
28912 .vindex "&$auth2$&"
28913 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28914 authentication.  If that was empty, this will also be set to the
28915 GSS Display Name.
28916 .endlist
28917
28918
28919 . ////////////////////////////////////////////////////////////////////////////
28920 . ////////////////////////////////////////////////////////////////////////////
28921
28922 .chapter "The spa authenticator" "CHAPspa"
28923 .scindex IIDspaauth1 "&(spa)& authenticator"
28924 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28925 .cindex "authentication" "Microsoft Secure Password"
28926 .cindex "authentication" "NTLM"
28927 .cindex "Microsoft Secure Password Authentication"
28928 .cindex "NTLM authentication"
28929 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28930 Password Authentication'& mechanism,
28931 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28932 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28933 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28934 server side was subsequently contributed by Tom Kistner. The mechanism works as
28935 follows:
28936
28937 .ilist
28938 After the AUTH command has been accepted, the client sends an SPA
28939 authentication request based on the user name and optional domain.
28940 .next
28941 The server sends back a challenge.
28942 .next
28943 The client builds a challenge response which makes use of the user's password
28944 and sends it to the server, which then accepts or rejects it.
28945 .endlist
28946
28947 Encryption is used to protect the password in transit.
28948
28949
28950
28951 .section "Using spa as a server" "SECID179"
28952 .cindex "options" "&(spa)& authenticator (server)"
28953 The &(spa)& authenticator has just one server option:
28954
28955 .option server_password spa string&!! unset
28956 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28957 This option is expanded, and the result must be the cleartext password for the
28958 authenticating user, whose name is at this point in &$auth1$&. For
28959 compatibility with previous releases of Exim, the user name is also placed in
28960 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28961 it can lead to confusion in string expansions that also use numeric variables
28962 for other things. For example:
28963 .code
28964 spa:
28965   driver = spa
28966   public_name = NTLM
28967   server_password = \
28968     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28969 .endd
28970 If the expansion is forced to fail, authentication fails. Any other expansion
28971 failure causes a temporary error code to be returned.
28972
28973
28974
28975
28976
28977 .section "Using spa as a client" "SECID180"
28978 .cindex "options" "&(spa)& authenticator (client)"
28979 The &(spa)& authenticator has the following client options:
28980
28981
28982
28983 .option client_domain spa string&!! unset
28984 This option specifies an optional domain for the authentication.
28985
28986
28987 .option client_password spa string&!! unset
28988 This option specifies the user's password, and must be set.
28989
28990
28991 .option client_username spa string&!! unset
28992 This option specifies the user name, and must be set. Here is an example of a
28993 configuration of this authenticator for use with the mail servers at
28994 &'msn.com'&:
28995 .code
28996 msn:
28997   driver = spa
28998   public_name = MSN
28999   client_username = msn/msn_username
29000   client_password = msn_plaintext_password
29001   client_domain = DOMAIN_OR_UNSET
29002 .endd
29003 .ecindex IIDspaauth1
29004 .ecindex IIDspaauth2
29005
29006
29007
29008
29009
29010 . ////////////////////////////////////////////////////////////////////////////
29011 . ////////////////////////////////////////////////////////////////////////////
29012
29013 .chapter "The external authenticator" "CHAPexternauth"
29014 .scindex IIDexternauth1 "&(external)& authenticator"
29015 .scindex IIDexternauth2 "authenticators" "&(external)&"
29016 .cindex "authentication" "Client Certificate"
29017 .cindex "authentication" "X509"
29018 .cindex "Certificate-based authentication"
29019 The &(external)& authenticator provides support for
29020 authentication based on non-SMTP information.
29021 The specification is in RFC 4422 Appendix A
29022 (&url(https://tools.ietf.org/html/rfc4422)).
29023 It is only a transport and negotiation mechanism;
29024 the process of authentication is entirely controlled
29025 by the server configuration.
29026
29027 The client presents an identity in-clear.
29028 It is probably wise for a server to only advertise,
29029 and for clients to only attempt,
29030 this authentication method on a secure (eg. under TLS) connection.
29031
29032 One possible use, compatible with the
29033 K-9 Mail Android client (&url(https://k9mail.github.io/)),
29034 is for using X509 client certificates.
29035
29036 It thus overlaps in function with the TLS authenticator
29037 (see &<<CHAPtlsauth>>&)
29038 but is a full SMTP SASL authenticator
29039 rather than being implicit for TLS-connection carried
29040 client certificates only.
29041
29042 The examples and discussion in this chapter assume that
29043 client-certificate authentication is being done.
29044
29045 The client must present a certificate,
29046 for which it must have been requested via the
29047 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29048 (see &<<CHAPTLS>>&).
29049 For authentication to be effective the certificate should be
29050 verifiable against a trust-anchor certificate known to the server.
29051
29052 .section "External options" "SECTexternsoptions"
29053 .cindex "options" "&(external)& authenticator (server)"
29054 The &(external)& authenticator has two server options:
29055
29056 .option server_param2 external string&!! unset
29057 .option server_param3 external string&!! unset
29058 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
29059 These options are expanded before the &%server_condition%& option
29060 and the result are placed in &$auth2$& and &$auth3$& resectively.
29061 If the expansion is forced to fail, authentication fails. Any other expansion
29062 failure causes a temporary error code to be returned.
29063
29064 They can be used to clarify the coding of a complex &%server_condition%&.
29065
29066 .section "Using external in a server" "SECTexternserver"
29067 .cindex "AUTH" "in &(external)& authenticator"
29068 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
29069         "in &(external)& authenticator"
29070 .vindex "&$auth1$&, &$auth2$&, etc"
29071 .cindex "base64 encoding" "in &(external)& authenticator"
29072
29073 When running as a server, &(external)& performs the authentication test by
29074 expanding a string. The data sent by the client with the AUTH command, or in
29075 response to subsequent prompts, is base64 encoded, and so may contain any byte
29076 values when decoded. The decoded value is treated as
29077 an identity for authentication and
29078 placed in the expansion variable &$auth1$&.
29079
29080 For compatibility with previous releases of Exim, the value is also placed in
29081 the expansion variable &$1$&. However, the use of this
29082 variable for this purpose is now deprecated, as it can lead to confusion in
29083 string expansions that also use them for other things.
29084
29085 .vindex "&$authenticated_id$&"
29086 Once an identity has been received,
29087 &%server_condition%& is expanded. If the expansion is forced to fail,
29088 authentication fails. Any other expansion failure causes a temporary error code
29089 to be returned. If the result of a successful expansion is an empty string,
29090 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
29091 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
29092 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
29093 For any other result, a temporary error code is returned, with the expanded
29094 string as the error text.
29095
29096 Example:
29097 .code
29098 ext_ccert_san_mail:
29099   driver =            external
29100   public_name =       EXTERNAL
29101
29102   server_advertise_condition = $tls_in_certificate_verified
29103   server_param2 =     ${certextract {subj_altname,mail,>:} \
29104                                     {$tls_in_peercert}}
29105   server_condition =  ${if forany {$auth2} \
29106                             {eq {$item}{$auth1}}}
29107   server_set_id =     $auth1
29108 .endd
29109 This accepts a client certificate that is verifiable against any
29110 of your configured trust-anchors
29111 (which usually means the full set of public CAs)
29112 and which has a mail-SAN matching the claimed identity sent by the client.
29113
29114 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
29115 The account name is therefore guessable by an opponent.
29116 TLS 1.3 protects both server and client certificates, and is not vulnerable
29117 in this way.
29118
29119
29120 .section "Using external in a client" "SECTexternclient"
29121 .cindex "options" "&(external)& authenticator (client)"
29122 The &(external)& authenticator has one client option:
29123
29124 .option client_send external string&!! unset
29125 This option is expanded and sent with the AUTH command as the
29126 identity being asserted.
29127
29128 Example:
29129 .code
29130 ext_ccert:
29131   driver =      external
29132   public_name = EXTERNAL
29133
29134   client_condition = ${if !eq{$tls_out_cipher}{}}
29135   client_send = myaccount@smarthost.example.net
29136 .endd
29137
29138
29139 .ecindex IIDexternauth1
29140 .ecindex IIDexternauth2
29141
29142
29143
29144
29145
29146 . ////////////////////////////////////////////////////////////////////////////
29147 . ////////////////////////////////////////////////////////////////////////////
29148
29149 .chapter "The tls authenticator" "CHAPtlsauth"
29150 .scindex IIDtlsauth1 "&(tls)& authenticator"
29151 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
29152 .cindex "authentication" "Client Certificate"
29153 .cindex "authentication" "X509"
29154 .cindex "Certificate-based authentication"
29155 The &(tls)& authenticator provides server support for
29156 authentication based on client certificates.
29157
29158 It is not an SMTP authentication mechanism and is not
29159 advertised by the server as part of the SMTP EHLO response.
29160 It is an Exim authenticator in the sense that it affects
29161 the protocol element of the log line, can be tested for
29162 by the &%authenticated%& ACL condition, and can set
29163 the &$authenticated_id$& variable.
29164
29165 The client must present a verifiable certificate,
29166 for which it must have been requested via the
29167 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29168 (see &<<CHAPTLS>>&).
29169
29170 If an authenticator of this type is configured it is
29171 run immediately after a TLS connection being negotiated
29172 (due to either STARTTLS or TLS-on-connect)
29173 and can authenticate the connection.
29174 If it does, SMTP authentication is not subsequently offered.
29175
29176 A maximum of one authenticator of this type may be present.
29177
29178
29179 .cindex "options" "&(tls)& authenticator (server)"
29180 The &(tls)& authenticator has three server options:
29181
29182 .option server_param1 tls string&!! unset
29183 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29184 This option is expanded after the TLS negotiation and
29185 the result is placed in &$auth1$&.
29186 If the expansion is forced to fail, authentication fails. Any other expansion
29187 failure causes a temporary error code to be returned.
29188
29189 .option server_param2 tls string&!! unset
29190 .option server_param3 tls string&!! unset
29191 As above, for &$auth2$& and &$auth3$&.
29192
29193 &%server_param1%& may also be spelled &%server_param%&.
29194
29195
29196 Example:
29197 .code
29198 tls:
29199   driver = tls
29200   server_param1 =     ${certextract {subj_altname,mail,>:} \
29201                                     {$tls_in_peercert}}
29202   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29203                                  {forany {$auth1} \
29204                             {!= {0} \
29205                                 {${lookup ldap{ldap:///\
29206                          mailname=${quote_ldap_dn:${lc:$item}},\
29207                          ou=users,LDAP_DC?mailid} {$value}{0} \
29208                        }    }  } }}}
29209   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29210 .endd
29211 This accepts a client certificate that is verifiable against any
29212 of your configured trust-anchors
29213 (which usually means the full set of public CAs)
29214 and which has a SAN with a good account name.
29215
29216 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29217 The account name is therefore guessable by an opponent.
29218 TLS 1.3 protects both server and client certificates, and is not vulnerable
29219 in this way.
29220 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29221
29222 . An alternative might use
29223 . .code
29224 .   server_param1 = ${sha256:$tls_in_peercert}
29225 . .endd
29226 . to require one of a set of specific certs that define a given account
29227 . (the verification is still required, but mostly irrelevant).
29228 . This would help for per-device use.
29229 .
29230 . However, for the future we really need support for checking a
29231 . user cert in LDAP - which probably wants a base-64 DER.
29232
29233 .ecindex IIDtlsauth1
29234 .ecindex IIDtlsauth2
29235
29236
29237 Note that because authentication is traditionally an SMTP operation,
29238 the &%authenticated%& ACL condition cannot be used in
29239 a connect- or helo-ACL.
29240
29241
29242
29243 . ////////////////////////////////////////////////////////////////////////////
29244 . ////////////////////////////////////////////////////////////////////////////
29245
29246 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29247          "Encrypted SMTP connections"
29248 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29249 .scindex IIDencsmtp2 "SMTP" "encryption"
29250 .cindex "TLS" "on SMTP connection"
29251 .cindex "OpenSSL"
29252 .cindex "GnuTLS"
29253 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29254 Sockets Layer), is implemented by making use of the OpenSSL library or the
29255 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29256 cryptographic code in the Exim distribution itself for implementing TLS. In
29257 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29258 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29259 You also need to understand the basic concepts of encryption at a managerial
29260 level, and in particular, the way that public keys, private keys, and
29261 certificates are used.
29262
29263 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29264 connection is established, the client issues a STARTTLS command. If the
29265 server accepts this, the client and the server negotiate an encryption
29266 mechanism. If the negotiation succeeds, the data that subsequently passes
29267 between them is encrypted.
29268
29269 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29270 and if so, what cipher suite is in use, whether the client supplied a
29271 certificate, and whether or not that certificate was verified. This makes it
29272 possible for an Exim server to deny or accept certain commands based on the
29273 encryption state.
29274
29275 &*Warning*&: Certain types of firewall and certain anti-virus products can
29276 disrupt TLS connections. You need to turn off SMTP scanning for these products
29277 in order to get TLS to work.
29278
29279
29280
29281 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29282          "SECID284"
29283 .cindex "submissions protocol"
29284 .cindex "ssmtp protocol"
29285 .cindex "smtps protocol"
29286 .cindex "SMTP" "submissions protocol"
29287 .cindex "SMTP" "ssmtp protocol"
29288 .cindex "SMTP" "smtps protocol"
29289 The history of port numbers for TLS in SMTP is a little messy and has been
29290 contentious.  As of RFC 8314, the common practice of using the historically
29291 allocated port 465 for "email submission but with TLS immediately upon connect
29292 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29293 by them in preference to STARTTLS.
29294
29295 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29296 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29297 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29298
29299 This approach was, for a while, officially abandoned when encrypted SMTP was
29300 standardized, but many clients kept using it, even as the TCP port number was
29301 reassigned for other use.
29302 Thus you may encounter guidance claiming that you shouldn't enable use of
29303 this port.
29304 In practice, a number of mail-clients have only ever supported submissions,
29305 not submission with STARTTLS upgrade.
29306 Ideally, offer both submission (587) and submissions (465) service.
29307
29308 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29309 global option. Its value must be a list of port numbers;
29310 the most common use is expected to be:
29311 .code
29312 tls_on_connect_ports = 465
29313 .endd
29314 The port numbers specified by this option apply to all SMTP connections, both
29315 via the daemon and via &'inetd'&. You still need to specify all the ports that
29316 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29317 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29318 an extra port &-- rather, it specifies different behaviour on a port that is
29319 defined elsewhere.
29320
29321 There is also a &%-tls-on-connect%& command line option. This overrides
29322 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29323
29324
29325
29326
29327
29328
29329 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29330 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29331 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29332 To build Exim to use OpenSSL you need to set
29333 .code
29334 USE_OPENSSL=yes
29335 .endd
29336 in Local/Makefile.
29337
29338 To build Exim to use GnuTLS, you need to set
29339 .code
29340 USE_GNUTLS=yes
29341 .endd
29342 in Local/Makefile.
29343
29344 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29345 include files and libraries for GnuTLS can be found.
29346
29347 There are some differences in usage when using GnuTLS instead of OpenSSL:
29348
29349 .ilist
29350 The &%tls_verify_certificates%& option
29351 cannot be the path of a directory
29352 for GnuTLS versions before 3.3.6
29353 (for later versions, or OpenSSL, it can be either).
29354 .next
29355 The default value for &%tls_dhparam%& differs for historical reasons.
29356 .next
29357 .vindex "&$tls_in_peerdn$&"
29358 .vindex "&$tls_out_peerdn$&"
29359 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29360 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29361 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29362 .next
29363 OpenSSL identifies cipher suites using hyphens as separators, for example:
29364 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29365 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29366 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29367 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29368 to handle its own older variants) when processing lists of cipher suites in the
29369 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29370 option).
29371 .next
29372 The &%tls_require_ciphers%& options operate differently, as described in the
29373 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29374 .next
29375 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29376 When using OpenSSL, this option is ignored.
29377 (If an API is found to let OpenSSL be configured in this way,
29378 let the Exim Maintainers know and we'll likely use it).
29379 .next
29380 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option,
29381 it must be ordered to match the &%tls_certificate%& list.
29382 .next
29383 Some other recently added features may only be available in one or the other.
29384 This should be documented with the feature.  If the documentation does not
29385 explicitly state that the feature is infeasible in the other TLS
29386 implementation, then patches are welcome.
29387 .next
29388 The output from "exim -bV" will show which (if any) support was included
29389 in the build.
29390 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29391 .endlist
29392
29393
29394 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29395 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29396 an explicit path; if the latter, then the text about generation still applies,
29397 but not the chosen filename.
29398 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29399 See the documentation of &%tls_dhparam%& for more information.
29400
29401 GnuTLS uses D-H parameters that may take a substantial amount of time
29402 to compute. It is unreasonable to re-compute them for every TLS session.
29403 Therefore, Exim keeps this data in a file in its spool directory, called
29404 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29405 of bits requested.
29406 The file is owned by the Exim user and is readable only by
29407 its owner. Every Exim process that start up GnuTLS reads the D-H
29408 parameters from this file. If the file does not exist, the first Exim process
29409 that needs it computes the data and writes it to a temporary file which is
29410 renamed once it is complete. It does not matter if several Exim processes do
29411 this simultaneously (apart from wasting a few resources). Once a file is in
29412 place, new Exim processes immediately start using it.
29413
29414 For maximum security, the parameters that are stored in this file should be
29415 recalculated periodically, the frequency depending on your paranoia level.
29416 If you are avoiding using the fixed D-H primes published in RFCs, then you
29417 are concerned about some advanced attacks and will wish to do this; if you do
29418 not regenerate then you might as well stick to the standard primes.
29419
29420 Arranging this is easy in principle; just delete the file when you want new
29421 values to be computed. However, there may be a problem. The calculation of new
29422 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29423 If the system is not very active, &_/dev/random_& may delay returning data
29424 until enough randomness (entropy) is available. This may cause Exim to hang for
29425 a substantial amount of time, causing timeouts on incoming connections.
29426
29427 The solution is to generate the parameters externally to Exim. They are stored
29428 in &_gnutls-params-N_& in PEM format, which means that they can be
29429 generated externally using the &(certtool)& command that is part of GnuTLS.
29430
29431 To replace the parameters with new ones, instead of deleting the file
29432 and letting Exim re-create it, you can generate new parameters using
29433 &(certtool)& and, when this has been done, replace Exim's cache file by
29434 renaming. The relevant commands are something like this:
29435 .code
29436 # ls
29437 [ look for file; assume gnutls-params-2236 is the most recent ]
29438 # rm -f new-params
29439 # touch new-params
29440 # chown exim:exim new-params
29441 # chmod 0600 new-params
29442 # certtool --generate-dh-params --bits 2236 >>new-params
29443 # openssl dhparam -noout -text -in new-params | head
29444 [ check the first line, make sure it's not more than 2236;
29445   if it is, then go back to the start ("rm") and repeat
29446   until the size generated is at most the size requested ]
29447 # chmod 0400 new-params
29448 # mv new-params gnutls-params-2236
29449 .endd
29450 If Exim never has to generate the parameters itself, the possibility of
29451 stalling is removed.
29452
29453 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29454 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29455 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29456 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29457 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29458 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29459 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29460 which applies to all D-H usage, client or server.  If the value returned by
29461 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29462 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29463 limit, which is still much higher than Exim historically used.
29464
29465 The filename and bits used will change as the GnuTLS maintainers change the
29466 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29467 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29468 2432 bits, while NSS is limited to 2236 bits.
29469
29470 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29471 increase the chance of the generated prime actually being within acceptable
29472 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29473 procedure above.  There is no sane procedure available to Exim to double-check
29474 the size of the generated prime, so it might still be too large.
29475
29476
29477 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29478 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29479 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29480 There is a function in the OpenSSL library that can be passed a list of cipher
29481 suites before the cipher negotiation takes place. This specifies which ciphers
29482 are acceptable for TLS versions prior to 1.3.
29483 The list is colon separated and may contain names like
29484 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29485 directly to this function call.
29486 Many systems will install the OpenSSL manual-pages, so you may have
29487 &'ciphers(1)'& available to you.
29488 The following quotation from the OpenSSL
29489 documentation specifies what forms of item are allowed in the cipher string:
29490
29491 .ilist
29492 It can consist of a single cipher suite such as RC4-SHA.
29493 .next
29494 It can represent a list of cipher suites containing a certain algorithm,
29495 or cipher suites of a certain type. For example SHA1 represents all
29496 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29497 SSL v3 algorithms.
29498 .next
29499 Lists of cipher suites can be combined in a single cipher string using
29500 the + character. This is used as a logical and operation. For example
29501 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29502 algorithms.
29503 .endlist
29504
29505 Each cipher string can be optionally preceded by one of the characters &`!`&,
29506 &`-`& or &`+`&.
29507 .ilist
29508 If &`!`& is used, the ciphers are permanently deleted from the list. The
29509 ciphers deleted can never reappear in the list even if they are explicitly
29510 stated.
29511 .next
29512 If &`-`& is used, the ciphers are deleted from the list, but some or all
29513 of the ciphers can be added again by later options.
29514 .next
29515 If &`+`& is used, the ciphers are moved to the end of the list. This
29516 option does not add any new ciphers; it just moves matching existing ones.
29517 .endlist
29518
29519 If none of these characters is present, the string is interpreted as
29520 a list of ciphers to be appended to the current preference list. If the list
29521 includes any ciphers already present they will be ignored: that is, they will
29522 not be moved to the end of the list.
29523 .endlist
29524
29525 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29526 string:
29527 .code
29528 # note single-quotes to get ! past any shell history expansion
29529 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29530 .endd
29531
29532 This example will let the library defaults be permitted on the MX port, where
29533 there's probably no identity verification anyway, but ups the ante on the
29534 submission ports where the administrator might have some influence on the
29535 choice of clients used:
29536 .code
29537 # OpenSSL variant; see man ciphers(1)
29538 tls_require_ciphers = ${if =={$received_port}{25}\
29539                            {DEFAULT}\
29540                            {HIGH:!MD5:!SHA1}}
29541 .endd
29542
29543 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29544 .code
29545 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29546 .endd
29547
29548 For TLS version 1.3 the control available is less fine-grained
29549 and Exim does not provide access to it at present.
29550 The value of the &%tls_require_ciphers%& option is ignored when
29551 TLS version 1.3 is negotiated.
29552
29553 As of writing the library default cipher suite list for TLSv1.3 is
29554 .code
29555 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29556 .endd
29557
29558
29559 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29560          "SECTreqciphgnu"
29561 .cindex "GnuTLS" "specifying parameters for"
29562 .cindex "TLS" "specifying ciphers (GnuTLS)"
29563 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29564 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29565 .cindex "TLS" "specifying protocols (GnuTLS)"
29566 .cindex "TLS" "specifying priority string (GnuTLS)"
29567 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29568 The GnuTLS library allows the caller to provide a "priority string", documented
29569 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29570 ciphersuite specification in OpenSSL.
29571
29572 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29573 and controls both protocols and ciphers.
29574
29575 The &%tls_require_ciphers%& option is available both as an global option,
29576 controlling how Exim behaves as a server, and also as an option of the
29577 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29578 the value is string expanded.  The resulting string is not an Exim list and
29579 the string is given to the GnuTLS library, so that Exim does not need to be
29580 aware of future feature enhancements of GnuTLS.
29581
29582 Documentation of the strings accepted may be found in the GnuTLS manual, under
29583 "Priority strings".  This is online as
29584 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29585 but beware that this relates to GnuTLS 3, which may be newer than the version
29586 installed on your system.  If you are using GnuTLS 3,
29587 then the example code
29588 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29589 on that site can be used to test a given string.
29590
29591 For example:
29592 .code
29593 # Disable older versions of protocols
29594 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29595 .endd
29596
29597 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29598 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29599 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29600
29601 This example will let the library defaults be permitted on the MX port, where
29602 there's probably no identity verification anyway, and lowers security further
29603 by increasing compatibility; but this ups the ante on the submission ports
29604 where the administrator might have some influence on the choice of clients
29605 used:
29606 .code
29607 # GnuTLS variant
29608 tls_require_ciphers = ${if =={$received_port}{25}\
29609                            {NORMAL:%COMPAT}\
29610                            {SECURE128}}
29611 .endd
29612
29613
29614 .section "Configuring an Exim server to use TLS" "SECID182"
29615 .cindex "TLS" "configuring an Exim server"
29616 .cindex "ESMTP extensions" STARTTLS
29617 When Exim has been built with TLS support, it advertises the availability of
29618 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29619 but not to any others. The default value of this option is *, which means
29620 that STARTTLS is always advertised.  Set it to blank to never advertise;
29621 this is reasonable for systems that want to use TLS only as a client.
29622
29623 If STARTTLS is to be used you
29624 need to set some other options in order to make TLS available.
29625
29626 If a client issues a STARTTLS command and there is some configuration
29627 problem in the server, the command is rejected with a 454 error. If the client
29628 persists in trying to issue SMTP commands, all except QUIT are rejected
29629 with the error
29630 .code
29631 554 Security failure
29632 .endd
29633 If a STARTTLS command is issued within an existing TLS session, it is
29634 rejected with a 554 error code.
29635
29636 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29637 must be set to match some hosts. The default is * which matches all hosts.
29638
29639 If this is all you do, TLS encryption will be enabled but not authentication -
29640 meaning that the peer has no assurance it is actually you he is talking to.
29641 You gain protection from a passive sniffer listening on the wire but not
29642 from someone able to intercept the communication.
29643
29644 Further protection requires some further configuration at the server end.
29645
29646 To make TLS work you need to set, in the server,
29647 .code
29648 tls_certificate = /some/file/name
29649 tls_privatekey = /some/file/name
29650 .endd
29651 These options are, in fact, expanded strings, so you can make them depend on
29652 the identity of the client that is connected if you wish. The first file
29653 contains the server's X509 certificate, and the second contains the private key
29654 that goes with it. These files need to be
29655 PEM format and readable by the Exim user, and must
29656 always be given as full path names.
29657 The key must not be password-protected.
29658 They can be the same file if both the
29659 certificate and the key are contained within it. If &%tls_privatekey%& is not
29660 set, or if its expansion is forced to fail or results in an empty string, this
29661 is assumed to be the case. The certificate file may also contain intermediate
29662 certificates that need to be sent to the client to enable it to authenticate
29663 the server's certificate.
29664
29665 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29666 colon-separated lists of file paths.  Ciphers using given authentication
29667 algorithms require the presence of a suitable certificate to supply the
29668 public-key.  The server selects among the certificates to present to the
29669 client depending on the selected cipher, hence the priority ordering for
29670 ciphers will affect which certificate is used.
29671
29672 If you do not understand about certificates and keys, please try to find a
29673 source of this background information, which is not Exim-specific. (There are a
29674 few comments below in section &<<SECTcerandall>>&.)
29675
29676 &*Note*&: These options do not apply when Exim is operating as a client &--
29677 they apply only in the case of a server. If you need to use a certificate in an
29678 Exim client, you must set the options of the same names in an &(smtp)&
29679 transport.
29680
29681 With just these options, an Exim server will be able to use TLS. It does not
29682 require the client to have a certificate (but see below for how to insist on
29683 this). There is one other option that may be needed in other situations. If
29684 .code
29685 tls_dhparam = /some/file/name
29686 .endd
29687 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29688 with the parameters contained in the file.
29689 Set this to &`none`& to disable use of DH entirely, by making no prime
29690 available:
29691 .code
29692 tls_dhparam = none
29693 .endd
29694 This may also be set to a string identifying a standard prime to be used for
29695 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29696 used is &`ike23`&.  There are a few standard primes available, see the
29697 documentation for &%tls_dhparam%& for the complete list.
29698
29699 See the command
29700 .code
29701 openssl dhparam
29702 .endd
29703 for a way of generating file data.
29704
29705 The strings supplied for these three options are expanded every time a client
29706 host connects. It is therefore possible to use different certificates and keys
29707 for different hosts, if you so wish, by making use of the client's IP address
29708 in &$sender_host_address$& to control the expansion. If a string expansion is
29709 forced to fail, Exim behaves as if the option is not set.
29710
29711 .cindex "cipher" "logging"
29712 .cindex "log" "TLS cipher"
29713 .vindex "&$tls_in_cipher$&"
29714 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29715 an incoming TLS connection. It is included in the &'Received:'& header of an
29716 incoming message (by default &-- you can, of course, change this), and it is
29717 also included in the log line that records a message's arrival, keyed by
29718 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29719 condition can be used to test for specific cipher suites in ACLs.
29720
29721 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29722 can check the name of the cipher suite and vary their actions accordingly. The
29723 cipher suite names vary, depending on which TLS library is being used. For
29724 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29725 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29726 documentation for more details.
29727
29728 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29729 (again depending on the &%tls_cipher%& log selector).
29730
29731
29732 .subsection "Requesting and verifying client certificates"
29733 .cindex "certificate" "verification of client"
29734 .cindex "TLS" "client certificate verification"
29735 If you want an Exim server to request a certificate when negotiating a TLS
29736 session with a client, you must set either &%tls_verify_hosts%& or
29737 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29738 apply to all TLS connections. For any host that matches one of these options,
29739 Exim requests a certificate as part of the setup of the TLS session. The
29740 contents of the certificate are verified by comparing it with a list of
29741 expected trust-anchors or certificates.
29742 These may be the system default set (depending on library version),
29743 an explicit file or,
29744 depending on library version, a directory, identified by
29745 &%tls_verify_certificates%&.
29746
29747 A file can contain multiple certificates, concatenated end to end. If a
29748 directory is used
29749 (OpenSSL only),
29750 each certificate must be in a separate file, with a name (or a symbolic link)
29751 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29752 certificate. You can compute the relevant hash by running the command
29753 .code
29754 openssl x509 -hash -noout -in /cert/file
29755 .endd
29756 where &_/cert/file_& contains a single certificate.
29757
29758 There is no checking of names of the client against the certificate
29759 Subject Name or Subject Alternate Names.
29760
29761 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29762 what happens if the client does not supply a certificate, or if the certificate
29763 does not match any of the certificates in the collection named by
29764 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29765 attempt to set up a TLS session is aborted, and the incoming connection is
29766 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29767 session continues. ACLs that run for subsequent SMTP commands can detect the
29768 fact that no certificate was verified, and vary their actions accordingly. For
29769 example, you can insist on a certificate before accepting a message for
29770 relaying, but not when the message is destined for local delivery.
29771
29772 .vindex "&$tls_in_peerdn$&"
29773 When a client supplies a certificate (whether it verifies or not), the value of
29774 the Distinguished Name of the certificate is made available in the variable
29775 &$tls_in_peerdn$& during subsequent processing of the message.
29776
29777 .cindex "log" "distinguished name"
29778 Because it is often a long text string, it is not included in the log line or
29779 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29780 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29781 &%received_header_text%& to change the &'Received:'& header. When no
29782 certificate is supplied, &$tls_in_peerdn$& is empty.
29783
29784
29785 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29786 .cindex certificate caching
29787 .cindex privatekey caching
29788 .cindex crl caching
29789 .cindex ocsp caching
29790 .cindex ciphers caching
29791 .cindex "CA bundle" caching
29792 .cindex "certificate authorities" caching
29793 .cindex tls_certificate caching
29794 .cindex tls_privatekey caching
29795 .cindex tls_crl caching
29796 .cindex tls_ocsp_file caching
29797 .cindex tls_require_ciphers caching
29798 .cindex tls_verify_certificate caching
29799 .cindex caching certificate
29800 .cindex caching privatekey
29801 .cindex caching crl
29802 .cindex caching ocsp
29803 .cindex caching ciphers
29804 .cindex caching "certificate authorities
29805 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29806 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29807 expandable elements,
29808 then the associated information is loaded at daemon startup.
29809 It is made available
29810 to child processes forked for handling received SMTP connections.
29811
29812 This caching is currently only supported under Linux and FreeBSD.
29813
29814 If caching is not possible, for example if an item has to be dependent
29815 on the peer host so contains a &$sender_host_name$& expansion, the load
29816 of the associated information is done at the startup of the TLS connection.
29817
29818 The cache is invalidated and reloaded after any changes to the directories
29819 containing files specified by these options.
29820
29821 The information specified by the main option &%tls_verify_certificates%&
29822 is similarly cached so long as it specifies files explicitly
29823 or (under GnuTLS) is the string &"system,cache"&.
29824 The latter case is not automatically invalidated;
29825 it is the operator's responsibility to arrange for a daemon restart
29826 any time the system certificate authority bundle is updated.
29827 A HUP signal is sufficient for this.
29828 The value &"system"& results in no caching under GnuTLS.
29829
29830 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29831 is acceptable in configurations for the Exim executable.
29832
29833 Caching of the system Certificate Authorities bundle can
29834 save significant time and processing on every TLS connection
29835 accepted by Exim.
29836
29837
29838
29839
29840 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29841 .cindex "cipher" "logging"
29842 .cindex "log" "TLS cipher"
29843 .cindex "log" "distinguished name"
29844 .cindex "TLS" "configuring an Exim client"
29845 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29846 deliveries as well as to incoming, the latter one causing logging of the
29847 server certificate's DN. The remaining client configuration for TLS is all
29848 within the &(smtp)& transport.
29849
29850 .cindex "ESMTP extensions" STARTTLS
29851 It is not necessary to set any options to have TLS work in the &(smtp)&
29852 transport. If Exim is built with TLS support, and TLS is advertised by a
29853 server, the &(smtp)& transport always tries to start a TLS session. However,
29854 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29855 transport) to a list of server hosts for which TLS should not be used.
29856
29857 If you do not want Exim to attempt to send messages unencrypted when an attempt
29858 to set up an encrypted connection fails in any way, you can set
29859 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29860 those hosts, delivery is always deferred if an encrypted connection cannot be
29861 set up. If there are any other hosts for the address, they are tried in the
29862 usual way.
29863
29864 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29865 the message unencrypted. It always does this if the response to STARTTLS is
29866 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29867 session after a success response code, what happens is controlled by the
29868 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29869 delivery to this host is deferred, and other hosts (if available) are tried. If
29870 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29871 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29872 negotiation fails, Exim closes the current connection (because it is in an
29873 unknown state), opens a new one to the same host, and then tries the delivery
29874 unencrypted.
29875
29876 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29877 transport provide the client with a certificate, which is passed to the server
29878 if it requests it.
29879 This is an optional thing for TLS connections, although either end
29880 may insist on it.
29881 If the server is Exim, it will request a certificate only if
29882 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29883
29884 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29885 for client use (they are usable for server use).
29886 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29887 in failed connections.
29888
29889 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29890 specifies a collection of expected server certificates.
29891 These may be
29892 the system default set (depending on library version),
29893 a file,
29894 or (depending on library version) a directory.
29895 The client verifies the server's certificate
29896 against this collection, taking into account any revoked certificates that are
29897 in the list defined by &%tls_crl%&.
29898 Failure to verify fails the TLS connection unless either of the
29899 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29900
29901 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29902 certificate verification to the listed servers.  Verification either must
29903 or need not succeed respectively.
29904
29905 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29906 name checks are made on the server certificate.
29907 The match against this list is, as per other Exim usage, the
29908 IP for the host.  That is most closely associated with the
29909 name on the DNS A (or AAAA) record for the host.
29910 However, the name that needs to be in the certificate
29911 is the one at the head of any CNAME chain leading to the A record.
29912 The option defaults to always checking.
29913
29914 The &(smtp)& transport has two OCSP-related options:
29915 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29916 is requested and required for the connection to proceed.  The default
29917 value is empty.
29918 &%hosts_request_ocsp%&; a host-list for which (additionally)
29919 a Certificate Status is requested (but not necessarily verified).  The default
29920 value is "*" meaning that requests are made unless configured
29921 otherwise.
29922
29923 The host(s) should also be in &%hosts_require_tls%&, and
29924 &%tls_verify_certificates%& configured for the transport,
29925 for OCSP to be relevant.
29926
29927 If
29928 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29929 list of permitted cipher suites. If either of these checks fails, delivery to
29930 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29931 alternative hosts, if any.
29932
29933  &*Note*&:
29934 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29935 is operating as a client. Exim does not assume that a server certificate (set
29936 by the global options of the same name) should also be used when operating as a
29937 client.
29938
29939 .vindex "&$host$&"
29940 .vindex "&$host_address$&"
29941 All the TLS options in the &(smtp)& transport are expanded before use, with
29942 &$host$& and &$host_address$& containing the name and address of the server to
29943 which the client is connected. Forced failure of an expansion causes Exim to
29944 behave as if the relevant option were unset.
29945
29946 .vindex &$tls_out_bits$&
29947 .vindex &$tls_out_cipher$&
29948 .vindex &$tls_out_peerdn$&
29949 .vindex &$tls_out_sni$&
29950 Before an SMTP connection is established, the
29951 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29952 variables are emptied. (Until the first connection, they contain the values
29953 that were set when the message was received.) If STARTTLS is subsequently
29954 successfully obeyed, these variables are set to the relevant values for the
29955 outgoing connection.
29956
29957
29958
29959 .subsection "Caching of static client configuration items" SECTclientTLScache
29960 .cindex certificate caching
29961 .cindex privatekey caching
29962 .cindex crl caching
29963 .cindex ciphers caching
29964 .cindex "CA bundle" caching
29965 .cindex "certificate authorities" caching
29966 .cindex tls_certificate caching
29967 .cindex tls_privatekey caching
29968 .cindex tls_crl caching
29969 .cindex tls_require_ciphers caching
29970 .cindex tls_verify_certificate caching
29971 .cindex caching certificate
29972 .cindex caching privatekey
29973 .cindex caching crl
29974 .cindex caching ciphers
29975 .cindex caching "certificate authorities
29976 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29977 and &%tls_crl%& have values with no
29978 expandable elements,
29979 then the associated information is loaded per smtp transport
29980 at daemon startup, at the start of a queue run, or on a
29981 command-line specified message delivery.
29982 It is made available
29983 to child processes forked for handling making SMTP connections.
29984
29985 This caching is currently only supported under Linux.
29986
29987 If caching is not possible, the load
29988 of the associated information is done at the startup of the TLS connection.
29989
29990 The cache is invalidated in the daemon
29991 and reloaded after any changes to the directories
29992 containing files specified by these options.
29993
29994 The information specified by the main option &%tls_verify_certificates%&
29995 is similarly cached so long as it specifies files explicitly
29996 or (under GnuTLS) is the string &"system,cache"&.
29997 The latter case is not automatically invaludated;
29998 it is the operator's responsibility to arrange for a daemon restart
29999 any time the system certificate authority bundle is updated.
30000 A HUP signal is sufficient for this.
30001 The value &"system"& results in no caching under GnuTLS.
30002
30003 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
30004 is acceptable in configurations for the Exim executable.
30005
30006 Caching of the system Certificate Authorities bundle can
30007 save significant time and processing on every TLS connection
30008 initiated by Exim.
30009
30010
30011
30012
30013 .section "Use of TLS Server Name Indication" "SECTtlssni"
30014 .cindex "TLS" "Server Name Indication"
30015 .cindex "TLS" SNI
30016 .cindex SNI
30017 .vindex "&$tls_in_sni$&"
30018 .oindex "&%tls_in_sni%&"
30019 With TLS1.0 or above, there is an extension mechanism by which extra
30020 information can be included at various points in the protocol.  One of these
30021 extensions, documented in RFC 6066 (and before that RFC 4366) is
30022 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
30023 client in the initial handshake, so that the server can examine the servername
30024 within and possibly choose to use different certificates and keys (and more)
30025 for this session.
30026
30027 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
30028 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
30029 address.
30030
30031 With SMTP to MX, there are the same problems here as in choosing the identity
30032 against which to validate a certificate: you can't rely on insecure DNS to
30033 provide the identity which you then cryptographically verify.  So this will
30034 be of limited use in that environment.
30035
30036 With SMTP to Submission, there is a well-defined hostname which clients are
30037 connecting to and can validate certificates against.  Thus clients &*can*&
30038 choose to include this information in the TLS negotiation.  If this becomes
30039 wide-spread, then hosters can choose to present different certificates to
30040 different clients.  Or even negotiate different cipher suites.
30041
30042 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
30043 if not empty, will be sent on a TLS session as part of the handshake.  There's
30044 nothing more to it.  Choosing a sensible value not derived insecurely is the
30045 only point of caution.  The &$tls_out_sni$& variable will be set to this string
30046 for the lifetime of the client connection (including during authentication).
30047
30048 If DANE validated the connection attempt then the value of the &%tls_sni%& option
30049 is forced to the name of the destination host, after any MX- or CNAME-following.
30050
30051 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
30052 received from a client.
30053 It can be logged with the &%log_selector%& item &`+tls_sni`&.
30054
30055 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
30056 option (prior to expansion) then the following options will be re-expanded
30057 during TLS session handshake, to permit alternative values to be chosen:
30058
30059 .ilist
30060 &%tls_certificate%&
30061 .next
30062 &%tls_crl%&
30063 .next
30064 &%tls_privatekey%&
30065 .next
30066 &%tls_verify_certificates%&
30067 .next
30068 &%tls_ocsp_file%&
30069 .endlist
30070
30071 Great care should be taken to deal with matters of case, various injection
30072 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
30073 can always be referenced; it is important to remember that &$tls_in_sni$& is
30074 arbitrary unverified data provided prior to authentication.
30075 Further, the initial certificate is loaded before SNI has arrived, so
30076 an expansion for &%tls_certificate%& must have a default which is used
30077 when &$tls_in_sni$& is empty.
30078
30079 The Exim developers are proceeding cautiously and so far no other TLS options
30080 are re-expanded.
30081
30082 When Exim is built against OpenSSL, OpenSSL must have been built with support
30083 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
30084 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
30085 see &`-servername`& in the output, then OpenSSL has support.
30086
30087 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
30088 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
30089 built, then you have SNI support).
30090
30091 .subsection ALPN
30092 .cindex TLS ALPN
30093 .cindex ALPN "general information"
30094 .cindex TLS "Application Layer Protocol Names"
30095 There is a TLS feature related to SNI
30096 called Application Layer Protocol Name (ALPN).
30097 This is intended to declare, or select, what protocol layer will be using a TLS
30098 connection.
30099 The client for the connection proposes a set of protocol names, and
30100 the server responds with a selected one.
30101 It is not, as of 2021, commonly used for SMTP connections.
30102 However, to guard against misdirected or malicious use of web clients
30103 (which often do use ALPN) against MTA ports, Exim by default check that
30104 there is no incompatible ALPN specified by a client for a TLS connection.
30105 If there is, the connection is rejected.
30106
30107 As a client Exim does not supply ALPN by default.
30108 The behaviour of both client and server can be configured using the options
30109 &%tls_alpn%& and &%hosts_require_alpn%&.
30110 There are no variables providing observability.
30111 Some feature-specific logging may appear on denied connections, but this
30112 depends on the behaviour of the peer
30113 (not all peers can send a feature-specific TLS Alert).
30114
30115 This feature is available when Exim is built with
30116 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
30117 the macro _HAVE_TLS_ALPN will be defined when this is so.
30118
30119
30120
30121 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
30122          "SECTmulmessam"
30123 .cindex "multiple SMTP deliveries with TLS"
30124 .cindex "TLS" "multiple message deliveries"
30125 Exim sends multiple messages down the same TCP/IP connection by starting up
30126 an entirely new delivery process for each message, passing the socket from
30127 one process to the next. This implementation does not fit well with the use
30128 of TLS, because there is quite a lot of state information associated with a TLS
30129 connection, not just a socket identification. Passing all the state information
30130 to a new process is not feasible. Consequently, for sending using TLS Exim
30131 starts an additional proxy process for handling the encryption, piping the
30132 unencrypted data stream from and to the delivery processes.
30133
30134 An older mode of operation can be enabled on a per-host basis by the
30135 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
30136 this list the proxy process described above is not used; instead Exim
30137 shuts down an existing TLS session being run by the delivery process
30138 before passing the socket to a new process. The new process may then
30139 try to start a new TLS session, and if successful, may try to re-authenticate
30140 if AUTH is in use, before sending the next message.
30141
30142 The RFC is not clear as to whether or not an SMTP session continues in clear
30143 after TLS has been shut down, or whether TLS may be restarted again later, as
30144 just described. However, if the server is Exim, this shutdown and
30145 reinitialization works. It is not known which (if any) other servers operate
30146 successfully if the client closes a TLS session and continues with unencrypted
30147 SMTP, but there are certainly some that do not work. For such servers, Exim
30148 should not pass the socket to another process, because the failure of the
30149 subsequent attempt to use it would cause Exim to record a temporary host error,
30150 and delay other deliveries to that host.
30151
30152 To test for this case, Exim sends an EHLO command to the server after
30153 closing down the TLS session. If this fails in any way, the connection is
30154 closed instead of being passed to a new delivery process, but no retry
30155 information is recorded.
30156
30157 There is also a manual override; you can set &%hosts_nopass_tls%& on the
30158 &(smtp)& transport to match those hosts for which Exim should not pass
30159 connections to new processes if TLS has been used.
30160
30161
30162
30163
30164 .section "Certificates and all that" "SECTcerandall"
30165 .cindex "certificate" "references to discussion"
30166 In order to understand fully how TLS works, you need to know about
30167 certificates, certificate signing, and certificate authorities.
30168 This is a large topic and an introductory guide is unsuitable for the Exim
30169 reference manual, so instead we provide pointers to existing documentation.
30170
30171 The Apache web-server was for a long time the canonical guide, so their
30172 documentation is a good place to start; their SSL module's Introduction
30173 document is currently at
30174 .display
30175 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30176 .endd
30177 and their FAQ is at
30178 .display
30179 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30180 .endd
30181
30182 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30183 0-201-61598-3) in 2001, contains both introductory and more in-depth
30184 descriptions.
30185 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30186 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30187 Ivan is the author of the popular TLS testing tools at
30188 &url(https://www.ssllabs.com/).
30189
30190
30191 .subsection "Certificate chains" SECID186
30192 A file named by &%tls_certificate%& may contain more than one
30193 certificate. This is useful in the case where the certificate that is being
30194 sent is validated by an intermediate certificate which the other end does
30195 not have. Multiple certificates must be in the correct order in the file.
30196 First the host's certificate itself, then the first intermediate
30197 certificate to validate the issuer of the host certificate, then the next
30198 intermediate certificate to validate the issuer of the first intermediate
30199 certificate, and so on, until finally (optionally) the root certificate.
30200 The root certificate must already be trusted by the recipient for
30201 validation to succeed, of course, but if it's not preinstalled, sending the
30202 root certificate along with the rest makes it available for the user to
30203 install if the receiving end is a client MUA that can interact with a user.
30204
30205 Note that certificates using MD5 are unlikely to work on today's Internet;
30206 even if your libraries allow loading them for use in Exim when acting as a
30207 server, increasingly clients will not accept such certificates.  The error
30208 diagnostics in such a case can be frustratingly vague.
30209
30210
30211
30212 .subsection "Self-signed certificates" SECID187
30213 .cindex "certificate" "self-signed"
30214 You can create a self-signed certificate using the &'req'& command provided
30215 with OpenSSL, like this:
30216 . ==== Do not shorten the duration here without reading and considering
30217 . ==== the text below.  Please leave it at 9999 days.
30218 .code
30219 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30220             -days 9999 -nodes
30221 .endd
30222 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30223 delimited and so can be identified independently. The &%-days%& option
30224 specifies a period for which the certificate is valid. The &%-nodes%& option is
30225 important: if you do not set it, the key is encrypted with a passphrase
30226 that you are prompted for, and any use that is made of the key causes more
30227 prompting for the passphrase. This is not helpful if you are going to use
30228 this certificate and key in an MTA, where prompting is not possible.
30229
30230 . ==== I expect to still be working 26 years from now.  The less technical
30231 . ==== debt I create, in terms of storing up trouble for my later years, the
30232 . ==== happier I will be then.  We really have reached the point where we
30233 . ==== should start, at the very least, provoking thought and making folks
30234 . ==== pause before proceeding, instead of leaving all the fixes until two
30235 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30236 . ==== -pdp, 2012
30237 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30238 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30239 the above command might produce a date in the past.  Think carefully about
30240 the lifetime of the systems you're deploying, and either reduce the duration
30241 of the certificate or reconsider your platform deployment.  (At time of
30242 writing, reducing the duration is the most likely choice, but the inexorable
30243 progression of time takes us steadily towards an era where this will not
30244 be a sensible resolution).
30245
30246 A self-signed certificate made in this way is sufficient for testing, and
30247 may be adequate for all your requirements if you are mainly interested in
30248 encrypting transfers, and not in secure identification.
30249
30250 However, many clients require that the certificate presented by the server be a
30251 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30252 certificate. In this situation, the self-signed certificate described above
30253 must be installed on the client host as a trusted root &'certification
30254 authority'& (CA), and the certificate used by Exim must be a user certificate
30255 signed with that self-signed certificate.
30256
30257 For information on creating self-signed CA certificates and using them to sign
30258 user certificates, see the &'General implementation overview'& chapter of the
30259 Open-source PKI book, available online at
30260 &url(https://sourceforge.net/projects/ospkibook/).
30261
30262
30263 .subsection "Revoked certificates"
30264 .cindex "TLS" "revoked certificates"
30265 .cindex "revocation list"
30266 .cindex "certificate" "revocation list"
30267 .cindex "OCSP" "stapling"
30268 There are three ways for a certificate to be made unusable
30269 before its expiry.
30270
30271 .ilist
30272 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30273 certificates are revoked. If you have such a list, you can pass it to an Exim
30274 server using the global option called &%tls_crl%& and to an Exim client using
30275 an identically named option for the &(smtp)& transport. In each case, the value
30276 of the option is expanded and must then be the name of a file that contains a
30277 CRL in PEM format.
30278 The downside is that clients have to periodically re-download a potentially huge
30279 file from every certificate authority they know of.
30280
30281 .next
30282 The way with most moving parts at query time is Online Certificate
30283 Status Protocol (OCSP), where the client verifies the certificate
30284 against an OCSP server run by the CA.  This lets the CA track all
30285 usage of the certs.  It requires running software with access to the
30286 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30287 is based on HTTP and can be proxied accordingly.
30288
30289 The only widespread OCSP server implementation (known to this writer)
30290 comes as part of OpenSSL and aborts on an invalid request, such as
30291 connecting to the port and then disconnecting.  This requires
30292 re-entering the passphrase each time some random client does this.
30293
30294 .next
30295 The third way is OCSP Stapling; in this, the server using a certificate
30296 issued by the CA periodically requests an OCSP proof of validity from
30297 the OCSP server, then serves it up inline as part of the TLS
30298 negotiation.   This approach adds no extra round trips, does not let the
30299 CA track users, scales well with number of certs issued by the CA and is
30300 resilient to temporary OCSP server failures, as long as the server
30301 starts retrying to fetch an OCSP proof some time before its current
30302 proof expires.  The downside is that it requires server support.
30303
30304 Unless Exim is built with the support disabled,
30305 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30306 support for OCSP stapling is included.
30307
30308 There is a global option called &%tls_ocsp_file%&.
30309 The file specified therein is expected to be in DER format, and contain
30310 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30311 option will be re-expanded for SNI, if the &%tls_certificate%& option
30312 contains &`tls_in_sni`&, as per other TLS options.
30313
30314 Exim does not at this time implement any support for fetching a new OCSP
30315 proof.  The burden is on the administrator to handle this, outside of
30316 Exim.  The file specified should be replaced atomically, so that the
30317 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30318 on each connection, so a new file will be handled transparently on the
30319 next connection.
30320
30321 When built with OpenSSL Exim will check for a valid next update timestamp
30322 in the OCSP proof; if not present, or if the proof has expired, it will be
30323 ignored.
30324
30325 For the client to be able to verify the stapled OCSP the server must
30326 also supply, in its stapled information, any intermediate
30327 certificates for the chain leading to the OCSP proof from the signer
30328 of the server certificate.  There may be zero or one such. These
30329 intermediate certificates should be added to the server OCSP stapling
30330 file named by &%tls_ocsp_file%&.
30331
30332 Note that the proof only covers the terminal server certificate,
30333 not any of the chain from CA to it.
30334
30335 There is no current way to staple a proof for a client certificate.
30336
30337 .code
30338   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30339   OCSP server is supplied.  The server URL may be included in the
30340   server certificate, if the CA is helpful.
30341
30342   One failure mode seen was the OCSP Signer cert expiring before the end
30343   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30344   noted this as invalid overall, but the re-fetch script did not.
30345 .endd
30346 .endlist
30347
30348
30349 .ecindex IIDencsmtp1
30350 .ecindex IIDencsmtp2
30351
30352
30353 .section "TLS Resumption" "SECTresumption"
30354 .cindex TLS resumption
30355 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30356 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30357 (or later).
30358
30359 Session resumption (this is the "stateless" variant) involves the server sending
30360 a "session ticket" to the client on one connection, which can be stored by the
30361 client and used for a later session.  The ticket contains sufficient state for
30362 the server to reconstruct the TLS session, avoiding some expensive crypto
30363 calculation and (on TLS1.2) one full packet roundtrip time.
30364
30365 .ilist
30366 Operational cost/benefit:
30367
30368  The extra data being transmitted costs a minor amount, and the client has
30369  extra costs in storing and retrieving the data.
30370
30371  In the Exim/Gnutls implementation the extra cost on an initial connection
30372  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30373  The saved cost on a subsequent connection is about 4ms; three or more
30374  connections become a net win.  On longer network paths, two or more
30375  connections will have an average lower startup time thanks to the one
30376  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30377  packet roundtrips.
30378
30379 .cindex "hints database" tls
30380  Since a new hints DB is used on the TLS client,
30381  the hints DB maintenance should be updated to additionally handle "tls".
30382
30383 .next
30384 Security aspects:
30385
30386  The session ticket is encrypted, but is obviously an additional security
30387  vulnarability surface.  An attacker able to decrypt it would have access
30388  all connections using the resumed session.
30389  The session ticket encryption key is not committed to storage by the server
30390  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30391  overlap; GnuTLS 6hr but does not specify any overlap).
30392  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30393  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30394
30395  There is a question-mark over the security of the Diffie-Helman parameters
30396  used for session negotiation.
30397
30398 .next
30399 Observability:
30400
30401  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30402  element.
30403
30404  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30405  have bits 0-4 indicating respectively
30406  support built, client requested ticket, client offered session,
30407  server issued ticket, resume used.  A suitable decode list is provided
30408  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30409
30410 .next
30411 Control:
30412
30413 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30414 exim, operating as a server, will offer resumption to clients.
30415 Current best practice is to not offer the feature to MUA connection.
30416 Commonly this can be done like this:
30417 .code
30418 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30419 .endd
30420 If the peer host matches the list after expansion then resumption
30421 is offered and/or accepted.
30422
30423 The &%tls_resumption_hosts%& smtp transport option performs the
30424 equivalent function for operation as a client.
30425 If the peer host matches the list after expansion then resumption
30426 is attempted (if a stored session is available) or the information
30427 stored (if supplied by the peer).
30428
30429
30430 .next
30431 Issues:
30432
30433  In a resumed session:
30434 .ilist
30435   The variables &$tls_{in,out}_cipher$& will have values different
30436  to the original (under GnuTLS).
30437 .next
30438   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30439  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30440 . XXX need to do something with that hosts_require_ocsp
30441 .endlist
30442
30443 .endlist
30444
30445
30446 .section DANE "SECDANE"
30447 .cindex DANE
30448 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30449 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30450 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30451 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30452 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30453 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30454
30455 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30456 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30457 by (a) is thought to be smaller than that of the set of root CAs.
30458
30459 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30460 fail to pass on a server's STARTTLS.
30461
30462 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30463 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30464 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30465
30466 DANE requires a server operator to do three things:
30467 .olist
30468 Run DNSSEC.  This provides assurance to clients
30469 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30470 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30471 DNSSEC.
30472 .next
30473 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30474 .next
30475 Offer a server certificate, or certificate chain, in TLS connections which is anchored by one of the TLSA records.
30476 .endlist
30477
30478 There are no changes to Exim specific to server-side operation of DANE.
30479 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30480 in &_Local/Makefile_&.
30481 If it has been included, the macro "_HAVE_DANE" will be defined.
30482
30483 .subsection "DNS records"
30484 A TLSA record consist of 4 fields, the "Certificate Usage", the
30485 "Selector", the "Matching type", and the "Certificate Association Data".
30486 For a detailed description of the TLSA record see
30487 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30488
30489 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30490 These are the "Trust Anchor" and "End Entity" variants.
30491 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30492 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30493 this is appropriate for a single system, using a self-signed certificate.
30494 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30495 well-known one.
30496 A private CA at simplest is just a self-signed certificate (with certain
30497 attributes) which is used to sign server certificates, but running one securely
30498 does require careful arrangement.
30499 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30500 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30501 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30502 all of which point to a single TLSA record.
30503 DANE-TA and DANE-EE can both be used together.
30504
30505 Our recommendation is to use DANE with a certificate from a public CA,
30506 because this enables a variety of strategies for remote clients to verify
30507 your certificate.
30508 You can then publish information both via DANE and another technology,
30509 "MTA-STS", described below.
30510
30511 When you use DANE-TA to publish trust anchor information, you ask entities
30512 outside your administrative control to trust the Certificate Authority for
30513 connections to you.
30514 If using a private CA then you should expect others to still apply the
30515 technical criteria they'd use for a public CA to your certificates.
30516 In particular, you should probably try to follow current best practices for CA
30517 operation around hash algorithms and key sizes.
30518 Do not expect other organizations to lower their security expectations just
30519 because a particular profile might be reasonable for your own internal use.
30520
30521 When this text was last updated, this in practice means to avoid use of SHA-1
30522 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30523 than 4096, for interoperability); to use keyUsage fields correctly; to use
30524 random serial numbers.
30525 The list of requirements is subject to change as best practices evolve.
30526 If you're not already using a private CA, or it doesn't meet these
30527 requirements, then we encourage you to avoid all these issues and use a public
30528 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30529
30530 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30531 a "Matching Type" (3rd) field of SHA2-512(2).
30532
30533 For the "Certificate Authority Data" (4th) field, commands like
30534
30535 .code
30536   openssl x509 -pubkey -noout <certificate.pem \
30537   | openssl rsa -outform der -pubin 2>/dev/null \
30538   | openssl sha512 \
30539   | awk '{print $2}'
30540 .endd
30541
30542 are workable to create a hash of the certificate's public key.
30543
30544 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30545
30546 .code
30547   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30548 .endd
30549
30550 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30551 is useful for quickly generating TLSA records.
30552
30553
30554 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30555
30556 The Certificate issued by the CA published in the DANE-TA model should be
30557 issued using a strong hash algorithm.
30558 Exim, and importantly various other MTAs sending to you, will not
30559 re-enable hash algorithms which have been disabled by default in TLS
30560 libraries.
30561 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30562 interoperability (and probably the maximum too, in 2018).
30563
30564 .subsection "Interaction with OCSP"
30565 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30566 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30567 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30568
30569 .code
30570   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30571                                  {= {4}{$tls_out_tlsa_usage}} } \
30572                          {*}{}}
30573 .endd
30574
30575 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30576 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30577 found. If the definition of &%hosts_request_ocsp%& includes the
30578 string "tls_out_tlsa_usage", they are re-expanded in time to
30579 control the OCSP request.
30580
30581 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30582 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30583
30584
30585 .subsection "Client configuration"
30586 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30587 and &%dane_require_tls_ciphers%&.
30588 The &"require"& variant will result in failure if the target host is not
30589 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30590 the &%dnssec_request_domains%& router or transport option.
30591
30592 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30593
30594 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30595 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30596 will be required for the host.  If it does not, the host will not
30597 be used; there is no fallback to non-DANE or non-TLS.
30598
30599 If DANE is requested and usable, then the TLS cipher list configuration
30600 prefers to use the option &%dane_require_tls_ciphers%& and falls
30601 back to &%tls_require_ciphers%& only if that is unset.
30602 This lets you configure "decent crypto" for DANE and "better than nothing
30603 crypto" as the default.  Note though that while GnuTLS lets the string control
30604 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30605 limited to ciphersuite constraints.
30606
30607 If DANE is requested and useable (see above) the following transport options are ignored:
30608 .code
30609   hosts_require_tls
30610   tls_verify_hosts
30611   tls_try_verify_hosts
30612   tls_verify_certificates
30613   tls_crl
30614   tls_verify_cert_hostnames
30615   tls_sni
30616 .endd
30617
30618 If DANE is not usable, whether requested or not, and CA-anchored
30619 verification evaluation is wanted, the above variables should be set appropriately.
30620
30621 The router and transport option &%dnssec_request_domains%& must not be
30622 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30623
30624 .subsection Observability
30625 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30626
30627 There is a new variable &$tls_out_dane$& which will have "yes" if
30628 verification succeeded using DANE and "no" otherwise (only useful
30629 in combination with events; see &<<CHAPevents>>&),
30630 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30631
30632 .cindex DANE reporting
30633 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30634 to achieve DANE-verified connection, if one was either requested and offered, or
30635 required.  This is intended to support TLS-reporting as defined in
30636 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30637 The &$event_data$& will be one of the Result Types defined in
30638 Section 4.3 of that document.
30639
30640 .subsection General
30641 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30642
30643 DANE is specified in RFC 6698. It decouples certificate authority trust
30644 selection from a "race to the bottom" of "you must trust everything for mail
30645 to get through".
30646 It does retain the need to trust the assurances provided by the DNSSEC tree.
30647
30648 There is an alternative technology called MTA-STS (RFC 8461), which
30649 instead publishes MX trust anchor information on an HTTPS website.
30650 The discovery of the address for that website does not (per standard)
30651 require DNSSEC, and could be regarded as being less secure than DANE
30652 as a result.
30653
30654 Exim has no support for MTA-STS as a client, but Exim mail server operators
30655 can choose to publish information describing their TLS configuration using
30656 MTA-STS to let those clients who do use that protocol derive trust
30657 information.
30658
30659 The MTA-STS design requires a certificate from a public Certificate Authority
30660 which is recognized by clients sending to you.
30661 That selection of which CAs are trusted by others is outside your control.
30662
30663 The most interoperable course of action is probably to use
30664 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30665 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30666 records for DANE clients (such as Exim and Postfix) and to publish anchor
30667 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30668 domain itself (with caveats around occasionally broken MTA-STS because of
30669 incompatible specification changes prior to reaching RFC status).
30670
30671
30672
30673 . ////////////////////////////////////////////////////////////////////////////
30674 . ////////////////////////////////////////////////////////////////////////////
30675
30676 .chapter "Access control lists" "CHAPACL"
30677 .scindex IIDacl "&ACL;" "description"
30678 .cindex "control of incoming mail"
30679 .cindex "message" "controlling incoming"
30680 .cindex "policy control" "access control lists"
30681 Access Control Lists (ACLs) are defined in a separate section of the runtime
30682 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30683 name, terminated by a colon. Here is a complete ACL section that contains just
30684 one very small ACL:
30685 .code
30686 begin acl
30687 small_acl:
30688   accept   hosts = one.host.only
30689 .endd
30690 You can have as many lists as you like in the ACL section, and the order in
30691 which they appear does not matter. The lists are self-terminating.
30692
30693 The majority of ACLs are used to control Exim's behaviour when it receives
30694 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30695 when a local process submits a message using SMTP by specifying the &%-bs%&
30696 option. The most common use is for controlling which recipients are accepted
30697 in incoming messages. In addition, you can define an ACL that is used to check
30698 local non-SMTP messages. The default configuration file contains an example of
30699 a realistic ACL for checking RCPT commands. This is discussed in chapter
30700 &<<CHAPdefconfil>>&.
30701
30702
30703 .section "Testing ACLs" "SECID188"
30704 The &%-bh%& command line option provides a way of testing your ACL
30705 configuration locally by running a fake SMTP session with which you interact.
30706
30707
30708 .section "Specifying when ACLs are used" "SECID189"
30709 .cindex "&ACL;" "options for specifying"
30710 In order to cause an ACL to be used, you have to name it in one of the relevant
30711 options in the main part of the configuration. These options are:
30712 .cindex "AUTH" "ACL for"
30713 .cindex "DATA" "ACLs for"
30714 .cindex "ETRN" "ACL for"
30715 .cindex "EXPN" "ACL for"
30716 .cindex "HELO" "ACL for"
30717 .cindex "EHLO" "ACL for"
30718 .cindex "DKIM" "ACL for"
30719 .cindex "MAIL" "ACL for"
30720 .cindex "QUIT, ACL for"
30721 .cindex "RCPT" "ACL for"
30722 .cindex "STARTTLS, ACL for"
30723 .cindex "VRFY" "ACL for"
30724 .cindex "WELLKNOWN" "ACL for"
30725 .cindex "SMTP" "connection, ACL for"
30726 .cindex "non-SMTP messages" "ACLs for"
30727 .cindex "MIME content scanning" "ACL for"
30728 .cindex "PRDR" "ACL for"
30729
30730 .table2 140pt
30731 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30732 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30733 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30734 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30735 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30736 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30737 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30738 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30739 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30740 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30741 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30742 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30743 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30744 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30745 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30746 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30747 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30748 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30749 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30750 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30751 .irow &%acl_smtp_wellknown%&   "ACL for WELLKNOWN"
30752 .endtable
30753
30754 For example, if you set
30755 .code
30756 acl_smtp_rcpt = small_acl
30757 .endd
30758 the little ACL defined above is used whenever Exim receives a RCPT command
30759 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30760 done when RCPT commands arrive. A rejection of RCPT should cause the
30761 sending MTA to give up on the recipient address contained in the RCPT
30762 command, whereas rejection at other times may cause the client MTA to keep on
30763 trying to deliver the message. It is therefore recommended that you do as much
30764 testing as possible at RCPT time.
30765
30766
30767 .subsection "The non-SMTP ACLs" SECnonSMTP
30768 .cindex "non-SMTP messages" "ACLs for"
30769 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30770 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30771 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30772 the state of the SMTP connection such as encryption and authentication) are not
30773 relevant and are forbidden in these ACLs. However, the sender and recipients
30774 are known, so the &%senders%& and &%sender_domains%& conditions and the
30775 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30776 &$authenticated_sender$& are also available. You can specify added header lines
30777 in any of these ACLs.
30778
30779 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30780 non-SMTP message, before any of the message has been read. (This is the
30781 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30782 batched SMTP input, it runs after the DATA command has been reached. The
30783 result of this ACL is ignored; it cannot be used to reject a message. If you
30784 really need to, you could set a value in an ACL variable here and reject based
30785 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30786 controls, and in particular, it can be used to set
30787 .code
30788 control = suppress_local_fixups
30789 .endd
30790 This cannot be used in the other non-SMTP ACLs because by the time they are
30791 run, it is too late.
30792
30793 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30794 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30795
30796 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30797 kind of rejection is treated as permanent, because there is no way of sending a
30798 temporary error for these kinds of message.
30799
30800
30801 .subsection "The SMTP connect ACL" SECconnectACL
30802 .cindex "SMTP" "connection, ACL for"
30803 .oindex &%smtp_banner%&
30804 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30805 session, after the test specified by &%host_reject_connection%& (which is now
30806 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30807 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30808 the message override the banner message that is otherwise specified by the
30809 &%smtp_banner%& option.
30810
30811 For tls-on-connect connections, the ACL is run before the TLS connection
30812 is accepted; if the ACL does not accept then the TCP connection is dropped without
30813 any TLS startup attempt and without any SMTP response being transmitted.
30814
30815
30816 .subsection "The EHLO/HELO ACL" SECheloACL
30817 .cindex "EHLO" "ACL for"
30818 .cindex "HELO" "ACL for"
30819 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30820 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30821 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30822 Note that a client may issue more than one EHLO or HELO command in an SMTP
30823 session, and indeed is required to issue a new EHLO or HELO after successfully
30824 setting up encryption following a STARTTLS command.
30825
30826 Note also that a deny neither forces the client to go away nor means that
30827 mail will be refused on the connection.  Consider checking for
30828 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30829
30830 If the command is accepted by an &%accept%& verb that has a &%message%&
30831 modifier, the message may not contain more than one line (it will be truncated
30832 at the first newline and a panic logged if it does). Such a message cannot
30833 affect the EHLO options that are listed on the second and subsequent lines of
30834 an EHLO response.
30835
30836
30837 .subsection "The DATA ACLs" SECdataACLS
30838 .cindex "DATA" "ACLs for"
30839 Two ACLs are associated with the DATA command, because it is two-stage
30840 command, with two responses being sent to the client.
30841 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30842 is obeyed. This gives you control after all the RCPT commands, but before
30843 the message itself is received. It offers the opportunity to give a negative
30844 response to the DATA command before the data is transmitted. Header lines
30845 added by MAIL or RCPT ACLs are not visible at this time, but any that
30846 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30847
30848 You cannot test the contents of the message, for example, to verify addresses
30849 in the headers, at RCPT time or when the DATA command is received. Such
30850 tests have to appear in the ACL that is run after the message itself has been
30851 received, before the final response to the DATA command is sent. This is
30852 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30853 associated with the DATA command.
30854
30855 .cindex CHUNKING "BDAT command"
30856 .cindex BDAT "SMTP command"
30857 .cindex "RFC 3030" CHUNKING
30858 If CHUNKING was advertised and a BDAT command sequence is received,
30859 the &%acl_smtp_predata%& ACL is not run.
30860 . XXX why not?  It should be possible, for the first BDAT.
30861 The &%acl_smtp_data%& is run after the last BDAT command and all of
30862 the data specified is received.
30863
30864 For both of these ACLs, it is not possible to reject individual recipients. An
30865 error response rejects the entire message. Unfortunately, it is known that some
30866 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30867 before or after the data) correctly &-- they keep the message on their queues
30868 and try again later, but that is their problem, though it does waste some of
30869 your resources.
30870
30871 The &%acl_smtp_data%& ACL is run after
30872 the &%acl_smtp_data_prdr%&,
30873 the &%acl_smtp_dkim%&
30874 and the &%acl_smtp_mime%& ACLs.
30875
30876 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30877 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30878 enabled (which is the default).
30879
30880 If, for a specific message, an ACL control
30881 &*dkim_disable_verify*&
30882 has been set, this &%acl_smtp_dkim%& ACL is not called.
30883
30884 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30885 received, and is executed for each DKIM signature found in a message.  If not
30886 otherwise specified, the default action is to accept.
30887
30888 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30889
30890 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30891
30892
30893 .subsection "The SMTP MIME ACL" SECID194
30894 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30895 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30896
30897 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30898
30899
30900 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30901 .cindex "PRDR" "ACL for"
30902 .oindex "&%prdr_enable%&"
30903 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30904 with PRDR support enabled (which is the default).
30905 It becomes active only when the PRDR feature is negotiated between
30906 client and server for a message, and more than one recipient
30907 has been accepted.
30908
30909 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30910 has been received, and is executed once for each recipient of the message
30911 with &$local_part$& and &$domain$& valid.
30912 The test may accept, defer or deny for individual recipients.
30913 The &%acl_smtp_data%& will still be called after this ACL and
30914 can reject the message overall, even if this ACL has accepted it
30915 for some or all recipients.
30916
30917 PRDR may be used to support per-user content filtering.  Without it
30918 one must defer any recipient after the first that has a different
30919 content-filter configuration.  With PRDR, the RCPT-time check
30920 .cindex "PRDR" "variable for"
30921 for this can be disabled when the variable &$prdr_requested$&
30922 is &"yes"&.
30923 Any required difference in behaviour of the main DATA-time
30924 ACL should however depend on the PRDR-time ACL having run, as Exim
30925 will avoid doing so in some situations (e.g. single-recipient mails).
30926
30927 See also the &%prdr_enable%& global option
30928 and the &%hosts_try_prdr%& smtp transport option.
30929
30930 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30931 If the ACL is not defined, processing completes as if
30932 the feature was not requested by the client.
30933
30934 .subsection "The SMTP WELLKNOWN ACL" SECTWELLKNOWNACL
30935 .cindex "WELLKNOWN" "ACL for"
30936 .oindex "&%acl_smtp_wellknown%&"
30937 The &%acl_smtp_wellknown%& ACL is available only when Exim is compiled
30938 with WELLKNOWN support enabled.
30939
30940 The ACL determines the response to an SMTP WELLKNOWN command, using the normal
30941 accept/defer/deny verbs for the response code,
30942 and a new &"control=wellknown"& modifier.
30943 This modifier takes a single option, separated by a '/'
30944 character, which must be the name of a file containing the response
30945 cleartext.  The modifier is expanded before use in the usual way before
30946 it is used.  The configuration is responsible for picking a suitable file
30947 to return and, most importantly, not returning any unexpected file.
30948 The argument for the SMTP verb will be available in the &$smtp_command_argument$&
30949 variable and can be used for building the file path.
30950 If the file path given in the modifier is empty or inacessible, the control will
30951 fail.
30952
30953 For example:
30954 .code
30955  check_wellknown:
30956   accept control = wellknown/\
30957                     ${lookup {${xtextd:$smtp_command_argument}} \
30958                         dsearch,key=path,filter=file,ret=full \
30959                         {$spooldir/wellknown.d}}
30960 .endd
30961 File content will be encoded in &"xtext"& form, and line-wrapping
30962 for line-length limitation will be done before transmission.
30963 A response summary line will be prepended, with the (pre-encoding) file size.
30964
30965 The above example uses the expansion operator ${xtextd:<coded-string>}
30966 which is needed to decode the xtext-encoded key from the SMTP verb.
30967
30968 Under the util directory there is a "mailtest" utility which can be used
30969 to test/retrieve WELLKNOWN items. Syntax is
30970 .code
30971   mailtest -h host.example.com -w security.txt
30972 .endd
30973
30974 WELLKNOWN is a ESMTP extension providing access to extended
30975 information about the server.  It is modelled on the webserver
30976 facilities documented in RFC 8615 and can be used for a security.txt
30977 file and could be used for ACME handshaking (RFC 8555).
30978
30979 Exim will advertise WELLKNOWN support in the EHLO response
30980 .oindex &%wellknown_advertise_hosts%&
30981 (conditional on a new option &%wellknown_advertise_hosts%&)
30982 and service WELLKNOWN smtp verbs having a single parameter
30983 giving a key for an item of "site-wide metadata".
30984 The verb and key are separated by whitespace,
30985 and the key is xtext-encoded (per RFC 3461 section 4).
30986
30987
30988 .subsection "The QUIT ACL" SECTQUITACL
30989 .cindex "QUIT, ACL for"
30990 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30991 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30992 does not in fact control any access.
30993 For this reason, it may only accept
30994 or warn as its final result.
30995
30996 This ACL can be used for tasks such as custom logging at the end of an SMTP
30997 session. For example, you can use ACL variables in other ACLs to count
30998 messages, recipients, etc., and log the totals at QUIT time using one or
30999 more &%logwrite%& modifiers on a &%warn%& verb.
31000
31001 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
31002 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
31003
31004 You do not need to have a final &%accept%&, but if you do, you can use a
31005 &%message%& modifier to specify custom text that is sent as part of the 221
31006 response to QUIT.
31007
31008 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
31009 failure (for example, failure to open a log file, or when Exim is bombing out
31010 because it has detected an unrecoverable error), all SMTP commands from the
31011 client are given temporary error responses until QUIT is received or the
31012 connection is closed. In these special cases, the QUIT ACL does not run.
31013
31014
31015 .subsection "The not-QUIT ACL" SECTNOTQUITACL
31016 .vindex &$acl_smtp_notquit$&
31017 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
31018 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
31019 trouble, such as being unable to write to its log files, this ACL is not run,
31020 because it might try to do things (such as write to log files) that make the
31021 situation even worse.
31022
31023 Like the QUIT ACL, this ACL is provided to make it possible to do customized
31024 logging or to gather statistics, and its outcome is ignored. The &%delay%&
31025 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
31026 and &%warn%&.
31027
31028 .vindex &$smtp_notquit_reason$&
31029 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
31030 to a string that indicates the reason for the termination of the SMTP
31031 connection. The possible values are:
31032 .table2
31033 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
31034 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
31035 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
31036 .irow &`connection-lost`&          "The SMTP connection has been lost"
31037 .irow &`data-timeout`&             "Timeout while reading message data"
31038 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
31039 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
31040 .irow &`signal-exit`&              "SIGTERM or SIGINT"
31041 .irow &`synchronization-error`&    "SMTP synchronization error"
31042 .irow &`tls-failed`&               "TLS failed to start"
31043 .endtable
31044 In most cases when an SMTP connection is closed without having received QUIT,
31045 Exim sends an SMTP response message before actually closing the connection.
31046 With the exception of the &`acl-drop`& case, the default message can be
31047 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
31048 &%drop%& verb in another ACL, it is the message from the other ACL that is
31049 used.
31050
31051
31052 .section "Finding an ACL to use" "SECID195"
31053 .cindex "&ACL;" "finding which to use"
31054 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
31055 you can use different ACLs in different circumstances. For example,
31056 .code
31057 acl_smtp_rcpt = ${if ={25}{$interface_port} \
31058                      {acl_check_rcpt} {acl_check_rcpt_submit} }
31059 .endd
31060 In the default configuration file there are some example settings for
31061 providing an RFC 4409 message &"submission"& service on port 587 and
31062 an RFC 8314 &"submissions"& service on port 465. You can use a string
31063 expansion like this to choose an ACL for MUAs on these ports which is
31064 more appropriate for this purpose than the default ACL on port 25.
31065
31066 The expanded string does not have to be the name of an ACL in the
31067 configuration file; there are other possibilities. Having expanded the
31068 string, Exim searches for an ACL as follows:
31069
31070 .ilist
31071 If the string begins with a slash, Exim uses it as a filename, and reads its
31072 contents as an ACL. The lines are processed in the same way as lines in the
31073 Exim configuration file. In particular, continuation lines are supported, blank
31074 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
31075 If the file does not exist or cannot be read, an error occurs (typically
31076 causing a temporary failure of whatever caused the ACL to be run). For example:
31077 .code
31078 acl_smtp_data = /etc/acls/\
31079   ${lookup{$sender_host_address}lsearch\
31080   {/etc/acllist}{$value}{default}}
31081 .endd
31082 This looks up an ACL file to use on the basis of the host's IP address, falling
31083 back to a default if the lookup fails. If an ACL is successfully read from a
31084 file, it is retained in memory for the duration of the Exim process, so that it
31085 can be re-used without having to re-read the file.
31086 .next
31087 If the string does not start with a slash, and does not contain any spaces,
31088 Exim searches the ACL section of the configuration for an ACL whose name
31089 matches the string.
31090 .next
31091 If no named ACL is found, or if the string contains spaces, Exim parses
31092 the string as an inline ACL. This can save typing in cases where you just
31093 want to have something like
31094 .code
31095 acl_smtp_vrfy = accept
31096 .endd
31097 in order to allow free use of the VRFY command. Such a string may contain
31098 newlines; it is processed in the same way as an ACL that is read from a file.
31099 .endlist
31100
31101
31102
31103
31104 .section "ACL return codes" "SECID196"
31105 .cindex "&ACL;" "return codes"
31106 Except for the QUIT ACL, which does not affect the SMTP return code (see
31107 section &<<SECTQUITACL>>& above), the result of running an ACL is either
31108 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
31109 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
31110 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
31111 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
31112 This also causes a 4&'xx'& return code.
31113
31114 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
31115 &"deny"&, because there is no mechanism for passing temporary errors to the
31116 submitters of non-SMTP messages.
31117
31118
31119 ACLs that are relevant to message reception may also return &"discard"&. This
31120 has the effect of &"accept"&, but causes either the entire message or an
31121 individual recipient address to be discarded. In other words, it is a
31122 blackholing facility. Use it with care.
31123
31124 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
31125 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
31126 RCPT ACL is to discard just the one recipient address. If there are no
31127 recipients left when the message's data is received, the DATA ACL is not
31128 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
31129 remaining recipients. The &"discard"& return is not permitted for the
31130 &%acl_smtp_predata%& ACL.
31131
31132 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
31133 is done on the address and the result determines the SMTP response.
31134
31135
31136 .cindex "&[local_scan()]& function" "when all recipients discarded"
31137 The &[local_scan()]& function is always run, even if there are no remaining
31138 recipients; it may create new recipients.
31139
31140
31141
31142 .section "Unset ACL options" "SECID197"
31143 .cindex "&ACL;" "unset options"
31144 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
31145 all the same. &*Note*&: These defaults apply only when the relevant ACL is
31146 not defined at all. For any defined ACL, the default action when control
31147 reaches the end of the ACL statements is &"deny"&.
31148
31149 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
31150 these two are ACLs that are used only for their side effects. They cannot be
31151 used to accept or reject anything.
31152
31153 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
31154 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
31155 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
31156 when the ACL is not defined is &"accept"&.
31157
31158 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&,
31159 &%acl_smtp_vrfy%&
31160 and &%acl_smtp_wellknown%&),
31161 the action when the ACL
31162 is not defined is &"deny"&.  This means that &%acl_smtp_rcpt%& must be
31163 defined in order to receive any messages over an SMTP connection.
31164 For an example, see the ACL in the default configuration file.
31165
31166
31167
31168 .section "Data for message ACLs" "SECID198"
31169 .cindex "&ACL;" "data for message ACL"
31170 .vindex &$domain$&
31171 .vindex &$local_part$&
31172 .vindex &$sender_address$&
31173 .vindex &$sender_host_address$&
31174 .vindex &$smtp_command$&
31175 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
31176 that contain information about the host and the message's sender (for example,
31177 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
31178 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
31179 &$local_part$& are set from the argument address. The entire SMTP command
31180 is available in &$smtp_command$&.
31181
31182 When an ACL for the AUTH parameter of MAIL is running, the variables that
31183 contain information about the host are set, but &$sender_address$& is not yet
31184 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
31185 how it is used.
31186
31187 .vindex "&$message_size$&"
31188 The &$message_size$& variable is set to the value of the SIZE parameter on
31189 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
31190 that parameter is not given. The value is updated to the true message size by
31191 the time the final DATA ACL is run (after the message data has been
31192 received).
31193
31194 .vindex "&$rcpt_count$&"
31195 .vindex "&$recipients_count$&"
31196 The &$rcpt_count$& variable increases by one for each RCPT command received.
31197 The &$recipients_count$& variable increases by one each time a RCPT command is
31198 accepted, so while an ACL for RCPT is being processed, it contains the number
31199 of previously accepted recipients. At DATA time (for both the DATA ACLs),
31200 &$rcpt_count$& contains the total number of RCPT commands, and
31201 &$recipients_count$& contains the total number of accepted recipients.
31202
31203
31204
31205
31206
31207 .section "Data for non-message ACLs" "SECTdatfornon"
31208 .cindex "&ACL;" "data for non-message ACL"
31209 .vindex &$smtp_command_argument$&
31210 .vindex &$smtp_command$&
31211 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
31212 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
31213 and the entire SMTP command is available in &$smtp_command$&.
31214 These variables can be tested using a &%condition%& condition. For example,
31215 here is an ACL for use with AUTH, which insists that either the session is
31216 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
31217 does not permit authentication methods that use cleartext passwords on
31218 unencrypted connections.
31219 .code
31220 acl_check_auth:
31221   accept encrypted = *
31222   accept condition = ${if eq{${uc:$smtp_command_argument}}\
31223                      {CRAM-MD5}}
31224   deny   message   = TLS encryption or CRAM-MD5 required
31225 .endd
31226 (Another way of applying this restriction is to arrange for the authenticators
31227 that use cleartext passwords not to be advertised when the connection is not
31228 encrypted. You can use the generic &%server_advertise_condition%& authenticator
31229 option to do this.)
31230
31231
31232
31233 .section "Format of an ACL" "SECID199"
31234 .cindex "&ACL;" "format of"
31235 .cindex "&ACL;" "verbs, definition of"
31236 An individual ACL definition consists of a number of statements.
31237 Each statement starts
31238 with a verb, optionally followed by a number of conditions and &"modifiers"&.
31239 Modifiers can change the way the verb operates, define error and log messages,
31240 set variables, insert delays, and vary the processing of accepted messages.
31241
31242 If all the conditions are met, the verb is obeyed. The same condition may be
31243 used (with different arguments) more than once in the same statement. This
31244 provides a means of specifying an &"and"& conjunction between conditions. For
31245 example:
31246 .code
31247 deny  dnslists = list1.example
31248       dnslists = list2.example
31249 .endd
31250 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31251 the conditions and modifiers when it reaches a condition that fails. What
31252 happens then depends on the verb (and in one case, on a special modifier). Not
31253 all the conditions make sense at every testing point. For example, you cannot
31254 test a sender address in the ACL that is run for a VRFY command.
31255
31256 The definition of an ACL ends where another starts,
31257 or a different configuration section starts.
31258
31259
31260 .section "ACL verbs" "SECID200"
31261 The ACL verbs are as follows:
31262
31263 .ilist
31264 .cindex "&%accept%& ACL verb"
31265 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31266 of the conditions are not met, what happens depends on whether &%endpass%&
31267 appears among the conditions (for syntax see below). If the failing condition
31268 is before &%endpass%&, control is passed to the next ACL statement; if it is
31269 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31270 check a RCPT command:
31271 .code
31272 accept domains = +local_domains
31273        endpass
31274        verify = recipient
31275 .endd
31276 If the recipient domain does not match the &%domains%& condition, control
31277 passes to the next statement. If it does match, the recipient is verified, and
31278 the command is accepted if verification succeeds. However, if verification
31279 fails, the ACL yields &"deny"&, because the failing condition is after
31280 &%endpass%&.
31281
31282 The &%endpass%& feature has turned out to be confusing to many people, so its
31283 use is not recommended nowadays. It is always possible to rewrite an ACL so
31284 that &%endpass%& is not needed, and it is no longer used in the default
31285 configuration.
31286
31287 .cindex "&%message%& ACL modifier" "with &%accept%&"
31288 If a &%message%& modifier appears on an &%accept%& statement, its action
31289 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31290 (when an &%accept%& verb either accepts or passes control to the next
31291 statement), &%message%& can be used to vary the message that is sent when an
31292 SMTP command is accepted. For example, in a RCPT ACL you could have:
31293 .display
31294 &`accept  `&<&'some conditions'&>
31295 &`        message = OK, I will allow you through today`&
31296 .endd
31297 You can specify an SMTP response code, optionally followed by an &"extended
31298 response code"& at the start of the message, but the first digit must be the
31299 same as would be sent by default, which is 2 for an &%accept%& verb.
31300
31301 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31302 an error message that is used when access is denied. This behaviour is retained
31303 for backward compatibility, but current &"best practice"& is to avoid the use
31304 of &%endpass%&.
31305
31306
31307 .next
31308 .cindex "&%defer%& ACL verb"
31309 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31310 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31311 &%defer%& is the same as &%deny%&, because there is no way of sending a
31312 temporary error. For a RCPT command, &%defer%& is much the same as using a
31313 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31314 be used in any ACL, and even for a recipient it might be a simpler approach.
31315
31316
31317 .next
31318 .cindex "&%deny%& ACL verb"
31319 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31320 the conditions are not met, control is passed to the next ACL statement. For
31321 example,
31322 .code
31323 deny dnslists = blackholes.mail-abuse.org
31324 .endd
31325 rejects commands from hosts that are on a DNS black list.
31326
31327
31328 .next
31329 .cindex "&%discard%& ACL verb"
31330 &%discard%&: This verb behaves like &%accept%&, except that it returns
31331 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31332 that are concerned with receiving messages. When all the conditions are true,
31333 the sending entity receives a &"success"& response. However, &%discard%& causes
31334 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31335 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31336 message's recipients are discarded. Recipients that are discarded before DATA
31337 do not appear in the log line when the &%received_recipients%& log selector is set.
31338
31339 If the &%log_message%& modifier is set when &%discard%& operates,
31340 its contents are added to the line that is automatically written to the log.
31341 The &%message%& modifier operates exactly as it does for &%accept%&.
31342
31343
31344 .next
31345 .cindex "&%drop%& ACL verb"
31346 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31347 forcibly closed after the 5&'xx'& error message has been sent. For example:
31348 .code
31349 drop   condition = ${if > {$rcpt_count}{20}}
31350        message   = I don't take more than 20 RCPTs
31351 .endd
31352 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31353 The connection is always dropped after sending a 550 response.
31354
31355 .next
31356 .cindex "&%require%& ACL verb"
31357 &%require%&: If all the conditions are met, control is passed to the next ACL
31358 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31359 example, when checking a RCPT command,
31360 .code
31361 require message = Sender did not verify
31362         verify  = sender
31363 .endd
31364 passes control to subsequent statements only if the message's sender can be
31365 verified. Otherwise, it rejects the command. Note the positioning of the
31366 &%message%& modifier, before the &%verify%& condition. The reason for this is
31367 discussed in section &<<SECTcondmodproc>>&.
31368
31369 .next
31370 .cindex "&%warn%& ACL verb"
31371 &%warn%&: If all the conditions are true, a line specified by the
31372 &%log_message%& modifier is written to Exim's main log. Control always passes
31373 to the next ACL statement. If any condition is false, the log line is not
31374 written. If an identical log line is requested several times in the same
31375 message, only one copy is actually written to the log. If you want to force
31376 duplicates to be written, use the &%logwrite%& modifier instead.
31377
31378 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31379 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31380 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31381 first failing condition. There is more about adding header lines in section
31382 &<<SECTaddheadacl>>&.
31383
31384 If any condition on a &%warn%& statement cannot be completed (that is, there is
31385 some sort of defer), the log line specified by &%log_message%& is not written.
31386 This does not include the case of a forced failure from a lookup, which
31387 is considered to be a successful completion. After a defer, no further
31388 conditions or modifiers in the &%warn%& statement are processed. The incident
31389 is logged, and the ACL continues to be processed, from the next statement
31390 onwards.
31391
31392
31393 .vindex "&$acl_verify_message$&"
31394 When one of the &%warn%& conditions is an address verification that fails, the
31395 text of the verification failure message is in &$acl_verify_message$&. If you
31396 want this logged, you must set it up explicitly. For example:
31397 .code
31398 warn   !verify = sender
31399        log_message = sender verify failed: $acl_verify_message
31400 .endd
31401 .endlist
31402
31403 At the end of each ACL there is an implicit unconditional &%deny%&.
31404
31405 As you can see from the examples above, the conditions and modifiers are
31406 written one to a line, with the first one on the same line as the verb, and
31407 subsequent ones on following lines. If you have a very long condition, you can
31408 continue it onto several physical lines by the usual backslash continuation
31409 mechanism. It is conventional to align the conditions vertically.
31410
31411
31412
31413 .section "ACL variables" "SECTaclvariables"
31414 .cindex "&ACL;" "variables"
31415 There are some special variables that can be set during ACL processing. They
31416 can be used to pass information between different ACLs, different invocations
31417 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31418 transports, and filters that are used to deliver a message. The names of these
31419 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31420 an underscore, but the remainder of the name can be any sequence of
31421 alphanumeric characters and underscores that you choose. There is no limit on
31422 the number of ACL variables. The two sets act as follows:
31423 .ilist
31424 The values of those variables whose names begin with &$acl_c$& persist
31425 throughout an SMTP connection. They are never reset. Thus, a value that is set
31426 while receiving one message is still available when receiving the next message
31427 on the same SMTP connection.
31428 .next
31429 The values of those variables whose names begin with &$acl_m$& persist only
31430 while a message is being received. They are reset afterwards. They are also
31431 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31432 .endlist
31433
31434 When a message is accepted, the current values of all the ACL variables are
31435 preserved with the message and are subsequently made available at delivery
31436 time. The ACL variables are set by a modifier called &%set%&. For example:
31437 .code
31438 accept hosts = whatever
31439        set acl_m4 = some value
31440 accept authenticated = *
31441        set acl_c_auth = yes
31442 .endd
31443 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31444 be set. If you want to set a variable without taking any action, you can use a
31445 &%warn%& verb without any other modifiers or conditions.
31446
31447 .oindex &%strict_acl_vars%&
31448 What happens if a syntactically valid but undefined ACL variable is
31449 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31450 false (the default), an empty string is substituted; if it is true, an
31451 error is generated.
31452
31453 Versions of Exim before 4.64 have a limited set of numbered variables, but
31454 their names are compatible, so there is no problem with upgrading.
31455
31456
31457 .section "Condition and modifier processing" "SECTcondmodproc"
31458 .cindex "&ACL;" "conditions; processing"
31459 .cindex "&ACL;" "modifiers; processing"
31460 An exclamation mark preceding a condition negates its result. For example:
31461 .code
31462 deny   domains = *.dom.example
31463       !verify  = recipient
31464 .endd
31465 causes the ACL to return &"deny"& if the recipient domain ends in
31466 &'dom.example'& and the recipient address cannot be verified. Sometimes
31467 negation can be used on the right-hand side of a condition. For example, these
31468 two statements are equivalent:
31469 .code
31470 deny  hosts = !192.168.3.4
31471 deny !hosts =  192.168.3.4
31472 .endd
31473 However, for many conditions (&%verify%& being a good example), only left-hand
31474 side negation of the whole condition is possible.
31475
31476 The arguments of conditions and modifiers are expanded. A forced failure
31477 of an expansion causes a condition to be ignored, that is, it behaves as if the
31478 condition is true. Consider these two statements:
31479 .code
31480 accept  senders = ${lookup{$host_name}lsearch\
31481                   {/some/file}{$value}fail}
31482 accept  senders = ${lookup{$host_name}lsearch\
31483                   {/some/file}{$value}{}}
31484 .endd
31485 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31486 the returned list is searched, but if the lookup fails the behaviour is
31487 different in the two cases. The &%fail%& in the first statement causes the
31488 condition to be ignored, leaving no further conditions. The &%accept%& verb
31489 therefore succeeds. The second statement, however, generates an empty list when
31490 the lookup fails. No sender can match an empty list, so the condition fails,
31491 and therefore the &%accept%& also fails.
31492
31493 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31494 specify actions that are taken as the conditions for a statement are checked;
31495 others specify text for messages that are used when access is denied or a
31496 warning is generated. The &%control%& modifier affects the way an incoming
31497 message is handled.
31498
31499 The positioning of the modifiers in an ACL statement is important, because the
31500 processing of a verb ceases as soon as its outcome is known. Only those
31501 modifiers that have already been encountered will take effect. For example,
31502 consider this use of the &%message%& modifier:
31503 .code
31504 require message = Can't verify sender
31505         verify  = sender
31506         message = Can't verify recipient
31507         verify  = recipient
31508         message = This message cannot be used
31509 .endd
31510 If sender verification fails, Exim knows that the result of the statement is
31511 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31512 so its text is used as the error message. If sender verification succeeds, but
31513 recipient verification fails, the second message is used. If recipient
31514 verification succeeds, the third message becomes &"current"&, but is never used
31515 because there are no more conditions to cause failure.
31516
31517 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31518 modifier that is used, because all the conditions must be true for rejection to
31519 happen. Specifying more than one &%message%& modifier does not make sense, and
31520 the message can even be specified after all the conditions. For example:
31521 .code
31522 deny   hosts = ...
31523       !senders = *@my.domain.example
31524        message = Invalid sender from client host
31525 .endd
31526 The &"deny"& result does not happen until the end of the statement is reached,
31527 by which time Exim has set up the message.
31528
31529
31530
31531 .section "ACL modifiers" "SECTACLmodi"
31532 .cindex "&ACL;" "modifiers; list of"
31533 The ACL modifiers are as follows:
31534
31535 .vlist
31536 .vitem &*add_header*&&~=&~<&'text'&>
31537 This modifier specifies one or more header lines that are to be added to an
31538 incoming message, assuming, of course, that the message is ultimately
31539 accepted. For details, see section &<<SECTaddheadacl>>&.
31540
31541 .vitem &*continue*&&~=&~<&'text'&>
31542 .cindex "&%continue%& ACL modifier"
31543 .cindex "database" "updating in ACL"
31544 This modifier does nothing of itself, and processing of the ACL always
31545 continues with the next condition or modifier. The value of &%continue%& is in
31546 the side effects of expanding its argument. Typically this could be used to
31547 update a database. It is really just a syntactic tidiness, to avoid having to
31548 write rather ugly lines like this:
31549 .display
31550 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31551 .endd
31552 Instead, all you need is
31553 .display
31554 &`continue = `&<&'some expansion'&>
31555 .endd
31556
31557 .vitem &*control*&&~=&~<&'text'&>
31558 .cindex "&%control%& ACL modifier"
31559 This modifier affects the subsequent processing of the SMTP connection or of an
31560 incoming message that is accepted. The effect of the first type of control
31561 lasts for the duration of the connection, whereas the effect of the second type
31562 lasts only until the current message has been received. The message-specific
31563 controls always apply to the whole message, not to individual recipients,
31564 even if the &%control%& modifier appears in a RCPT ACL.
31565
31566 As there are now quite a few controls that can be applied, they are described
31567 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31568 in several different ways. For example:
31569
31570 . ==== As this is a nested list, any displays it contains must be indented
31571 . ==== as otherwise they are too far to the left. That comment applies only
31572 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31573 . ==== way.
31574
31575 .ilist
31576 It can be at the end of an &%accept%& statement:
31577 .code
31578     accept  ...some conditions
31579             control = queue
31580 .endd
31581 In this case, the control is applied when this statement yields &"accept"&, in
31582 other words, when the conditions are all true.
31583
31584 .next
31585 It can be in the middle of an &%accept%& statement:
31586 .code
31587     accept  ...some conditions...
31588             control = queue
31589             ...some more conditions...
31590 .endd
31591 If the first set of conditions are true, the control is applied, even if the
31592 statement does not accept because one of the second set of conditions is false.
31593 In this case, some subsequent statement must yield &"accept"& for the control
31594 to be relevant.
31595
31596 .next
31597 It can be used with &%warn%& to apply the control, leaving the
31598 decision about accepting or denying to a subsequent verb. For
31599 example:
31600 .code
31601     warn    ...some conditions...
31602             control = freeze
31603     accept  ...
31604 .endd
31605 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31606 &%logwrite%&, so it does not add anything to the message and does not write a
31607 log entry.
31608
31609 .next
31610 If you want to apply a control unconditionally, you can use it with a
31611 &%require%& verb. For example:
31612 .code
31613     require  control = no_multiline_responses
31614 .endd
31615 .endlist
31616
31617 .vitem &*delay*&&~=&~<&'time'&>
31618 .cindex "&%delay%& ACL modifier"
31619 .oindex "&%-bh%&"
31620 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31621 the time interval before proceeding. However, when testing Exim using the
31622 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31623 output instead). The time is given in the usual Exim notation, and the delay
31624 happens as soon as the modifier is processed. In an SMTP session, pending
31625 output is flushed before the delay is imposed.
31626
31627 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31628 example:
31629 .code
31630 deny    ...some conditions...
31631         delay = 30s
31632 .endd
31633 The delay happens if all the conditions are true, before the statement returns
31634 &"deny"&. Compare this with:
31635 .code
31636 deny    delay = 30s
31637         ...some conditions...
31638 .endd
31639 which waits for 30s before processing the conditions. The &%delay%& modifier
31640 can also be used with &%warn%& and together with &%control%&:
31641 .code
31642 warn    ...some conditions...
31643         delay = 2m
31644         control = freeze
31645 accept  ...
31646 .endd
31647
31648 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31649 responses to several commands are no longer buffered and sent in one packet (as
31650 they would normally be) because all output is flushed before imposing the
31651 delay. This optimization is disabled so that a number of small delays do not
31652 appear to the client as one large aggregated delay that might provoke an
31653 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31654 using a &%control%& modifier to set &%no_delay_flush%&.
31655
31656
31657 .vitem &*endpass*&
31658 .cindex "&%endpass%& ACL modifier"
31659 This modifier, which has no argument, is recognized only in &%accept%& and
31660 &%discard%& statements. It marks the boundary between the conditions whose
31661 failure causes control to pass to the next statement, and the conditions whose
31662 failure causes the ACL to return &"deny"&. This concept has proved to be
31663 confusing to some people, so the use of &%endpass%& is no longer recommended as
31664 &"best practice"&. See the description of &%accept%& above for more details.
31665
31666
31667 .vitem &*log_message*&&~=&~<&'text'&>
31668 .cindex "&%log_message%& ACL modifier"
31669 This modifier sets up a message that is used as part of the log message if the
31670 ACL denies access or a &%warn%& statement's conditions are true. For example:
31671 .code
31672 require log_message = wrong cipher suite $tls_in_cipher
31673         encrypted   = DES-CBC3-SHA
31674 .endd
31675 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31676 example:
31677 .display
31678 &`discard `&<&'some conditions'&>
31679 &`        log_message = Discarded $local_part@$domain because...`&
31680 .endd
31681 When access is denied, &%log_message%& adds to any underlying error message
31682 that may exist because of a condition failure. For example, while verifying a
31683 recipient address, a &':fail:'& redirection might have already set up a
31684 message.
31685
31686 The message may be defined before the conditions to which it applies, because
31687 the string expansion does not happen until Exim decides that access is to be
31688 denied. This means that any variables that are set by the condition are
31689 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31690 variables are set after a DNS black list lookup succeeds. If the expansion of
31691 &%log_message%& fails, or if the result is an empty string, the modifier is
31692 ignored.
31693
31694 .vindex "&$acl_verify_message$&"
31695 If you want to use a &%warn%& statement to log the result of an address
31696 verification, you can use &$acl_verify_message$& to include the verification
31697 error message.
31698
31699 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31700 the start of the logged message. If the same warning log message is requested
31701 more than once while receiving  a single email message, only one copy is
31702 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31703 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31704 is logged for a successful &%warn%& statement.
31705
31706 If &%log_message%& is not present and there is no underlying error message (for
31707 example, from the failure of address verification), but &%message%& is present,
31708 the &%message%& text is used for logging rejections. However, if any text for
31709 logging contains newlines, only the first line is logged. In the absence of
31710 both &%log_message%& and &%message%&, a default built-in message is used for
31711 logging rejections.
31712
31713
31714 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31715 .cindex "&%log_reject_target%& ACL modifier"
31716 .cindex "logging in ACL" "specifying which log"
31717 This modifier makes it possible to specify which logs are used for messages
31718 about ACL rejections. Its argument is a colon-separated list of words that can
31719 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31720 may be empty, in which case a rejection is not logged at all. For example, this
31721 ACL fragment writes no logging information when access is denied:
31722 .display
31723 &`deny `&<&'some conditions'&>
31724 &`     log_reject_target =`&
31725 .endd
31726 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31727 permanent and temporary rejections. Its effect lasts for the rest of the
31728 current ACL.
31729
31730
31731 .vitem &*logwrite*&&~=&~<&'text'&>
31732 .cindex "&%logwrite%& ACL modifier"
31733 .cindex "logging in ACL" "immediate"
31734 This modifier writes a message to a log file as soon as it is encountered when
31735 processing an ACL. (Compare &%log_message%&, which, except in the case of
31736 &%warn%& and &%discard%&, is used only if the ACL statement denies
31737 access.) The &%logwrite%& modifier can be used to log special incidents in
31738 ACLs. For example:
31739 .display
31740 &`accept `&<&'some special conditions'&>
31741 &`       control  = freeze`&
31742 &`       logwrite = froze message because ...`&
31743 .endd
31744 By default, the message is written to the main log. However, it may begin
31745 with a colon, followed by a comma-separated list of log names, and then
31746 another colon, to specify exactly which logs are to be written. For
31747 example:
31748 .code
31749 logwrite = :main,reject: text for main and reject logs
31750 logwrite = :panic: text for panic log only
31751 .endd
31752
31753
31754 .vitem &*message*&&~=&~<&'text'&>
31755 .cindex "&%message%& ACL modifier"
31756 This modifier sets up a text string that is expanded and used as a response
31757 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31758 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31759 there is some complication if &%endpass%& is involved; see the description of
31760 &%accept%& for details.)
31761
31762 The expansion of the message happens at the time Exim decides that the ACL is
31763 to end, not at the time it processes &%message%&. If the expansion fails, or
31764 generates an empty string, the modifier is ignored. Here is an example where
31765 &%message%& must be specified first, because the ACL ends with a rejection if
31766 the &%hosts%& condition fails:
31767 .code
31768 require  message = Host not recognized
31769          hosts = 10.0.0.0/8
31770 .endd
31771 (Once a condition has failed, no further conditions or modifiers are
31772 processed.)
31773
31774 .cindex "SMTP" "error codes"
31775 .oindex "&%smtp_banner%&
31776 For ACLs that are triggered by SMTP commands, the message is returned as part
31777 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31778 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31779 is accepted. In the case of the connect ACL, accepting with a message modifier
31780 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31781 accept message may not contain more than one line (otherwise it will be
31782 truncated at the first newline and a panic logged), and it cannot affect the
31783 EHLO options.
31784
31785 When SMTP is involved, the message may begin with an overriding response code,
31786 consisting of three digits optionally followed by an &"extended response code"&
31787 of the form &'n.n.n'&, each code being followed by a space. For example:
31788 .code
31789 deny  message = 599 1.2.3 Host not welcome
31790       hosts = 192.168.34.0/24
31791 .endd
31792 The first digit of the supplied response code must be the same as would be sent
31793 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31794 access, but for the predata ACL, note that the default success code is 354, not
31795 2&'xx'&.
31796
31797 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31798 the message modifier cannot override the 221 response code.
31799
31800 The text in a &%message%& modifier is literal; any quotes are taken as
31801 literals, but because the string is expanded, backslash escapes are processed
31802 anyway.
31803 If the message contains newlines, this gives rise to a multi-line SMTP
31804 response.
31805 A long message line will also be split into multi-line SMTP responses,
31806 on word boundaries if possible.
31807
31808 .vindex "&$acl_verify_message$&"
31809 While the text is being expanded, the &$acl_verify_message$& variable
31810 contains any message previously set.
31811 Afterwards, &$acl_verify_message$& is cleared.
31812
31813 If &%message%& is used on a statement that verifies an address, the message
31814 specified overrides any message that is generated by the verification process.
31815 However, the original message is available in the variable
31816 &$acl_verify_message$&, so you can incorporate it into your message if you
31817 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31818 routers to be passed back as part of the SMTP response, you should either not
31819 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31820
31821 For compatibility with previous releases of Exim, a &%message%& modifier that
31822 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31823 modifier, but this usage is now deprecated. However, &%message%& acts only when
31824 all the conditions are true, wherever it appears in an ACL command, whereas
31825 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31826 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31827 effect.
31828
31829
31830 .vitem &*queue*&&~=&~<&'text'&>
31831 .cindex "&%queue%& ACL modifier"
31832 .cindex "named queues" "selecting in ACL"
31833 This modifier specifies the use of a named queue for spool files
31834 for the message.
31835 It can only be used before the message is received (i.e. not in
31836 the DATA ACL).
31837 This could be used, for example, for known high-volume burst sources
31838 of traffic, or for quarantine of messages.
31839 Separate queue-runner processes will be needed for named queues.
31840 If the text after expansion is empty, the default queue is used.
31841
31842
31843 .vitem &*remove_header*&&~=&~<&'text'&>
31844 This modifier specifies one or more header names in a colon-separated list
31845  that are to be removed from an incoming message, assuming, of course, that
31846 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31847
31848
31849 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31850 .cindex "&%set%& ACL modifier"
31851 This modifier puts a value into one of the ACL variables (see section
31852 &<<SECTaclvariables>>&).
31853
31854
31855 .vitem &*udpsend*&&~=&~<&'parameters'&>
31856 .cindex "UDP communications"
31857 This modifier sends a UDP packet, for purposes such as statistics
31858 collection or behaviour monitoring. The parameters are expanded, and
31859 the result of the expansion must be a colon-separated list consisting
31860 of a destination server, port number, and the packet contents. The
31861 server can be specified as a host name or IPv4 or IPv6 address. The
31862 separator can be changed with the usual angle bracket syntax. For
31863 example, you might want to collect information on which hosts connect
31864 when:
31865 .code
31866 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31867              $tod_zulu $sender_host_address
31868 .endd
31869 .endlist
31870
31871
31872
31873
31874 .section "Use of the control modifier" "SECTcontrols"
31875 .cindex "&%control%& ACL modifier"
31876 The &%control%& modifier supports the following settings:
31877
31878 .vlist
31879 .vitem &*control&~=&~allow_auth_unadvertised*&
31880 This modifier allows a client host to use the SMTP AUTH command even when it
31881 has not been advertised in response to EHLO. Furthermore, because there are
31882 apparently some really broken clients that do this, Exim will accept AUTH after
31883 HELO (rather than EHLO) when this control is set. It should be used only if you
31884 really need it, and you should limit its use to those broken clients that do
31885 not work without it. For example:
31886 .code
31887 warn hosts   = 192.168.34.25
31888      control = allow_auth_unadvertised
31889 .endd
31890 Normally, when an Exim server receives an AUTH command, it checks the name of
31891 the authentication mechanism that is given in the command to ensure that it
31892 matches an advertised mechanism. When this control is set, the check that a
31893 mechanism has been advertised is bypassed. Any configured mechanism can be used
31894 by the client. This control is permitted only in the connection and HELO ACLs.
31895
31896
31897 .vitem &*control&~=&~caseful_local_part*& &&&
31898        &*control&~=&~caselower_local_part*&
31899 .cindex "&ACL;" "case of local part in"
31900 .cindex "case of local parts"
31901 .vindex "&$local_part$&"
31902 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31903 (that is, during RCPT processing). By default, the contents of &$local_part$&
31904 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31905 any uppercase letters in the original local part are restored in &$local_part$&
31906 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31907 is encountered.
31908
31909 These controls affect only the current recipient. Moreover, they apply only to
31910 local part handling that takes place directly in the ACL (for example, as a key
31911 in lookups). If a test to verify the recipient is obeyed, the case-related
31912 handling of the local part during the verification is controlled by the router
31913 configuration (see the &%caseful_local_part%& generic router option).
31914
31915 This facility could be used, for example, to add a spam score to local parts
31916 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31917 spam score:
31918 .code
31919 warn  control = caseful_local_part
31920       set acl_m4 = ${eval:\
31921                      $acl_m4 + \
31922                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31923                     }
31924       control = caselower_local_part
31925 .endd
31926 Notice that we put back the lower cased version afterwards, assuming that
31927 is what is wanted for subsequent tests.
31928
31929
31930 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31931 .cindex "&ACL;" "cutthrough routing"
31932 .cindex "cutthrough" "requesting"
31933 This option requests delivery be attempted while the item is being received.
31934
31935 The option is usable in the RCPT ACL.
31936 If enabled for a message received via smtp and routed to an smtp transport,
31937 and only one transport, interface, destination host and port combination
31938 is used for all recipients of the message,
31939 then the delivery connection is made while the receiving connection is open
31940 and data is copied from one to the other.
31941
31942 An attempt to set this option for any recipient but the first
31943 for a mail will be quietly ignored.
31944 If a recipient-verify callout
31945 (with use_sender)
31946 connection is subsequently
31947 requested in the same ACL it is held open and used for
31948 any subsequent recipients and the data,
31949 otherwise one is made after the initial RCPT ACL completes.
31950
31951 Note that routers are used in verify mode,
31952 and cannot depend on content of received headers.
31953 Note also that headers cannot be
31954 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31955 Headers may be modified by routers (subject to the above) and transports.
31956 The &'Received-By:'& header is generated as soon as the body reception starts,
31957 rather than the traditional time after the full message is received;
31958 this will affect the timestamp.
31959
31960 All the usual ACLs are called; if one results in the message being
31961 rejected, all effort spent in delivery (including the costs on
31962 the ultimate destination) will be wasted.
31963 Note that in the case of data-time ACLs this includes the entire
31964 message body.
31965
31966 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31967 of outgoing messages is done, because it sends data to the ultimate destination
31968 before the entire message has been received from the source.
31969 It is not supported for messages received with the SMTP PRDR
31970 or CHUNKING
31971 options in use.
31972
31973 Should the ultimate destination system positively accept or reject the mail,
31974 a corresponding indication is given to the source system and nothing is queued.
31975 If the item is successfully delivered in cutthrough mode
31976 the delivery log lines are tagged with ">>" rather than "=>" and appear
31977 before the acceptance "<=" line.
31978
31979 If there is a temporary error the item is queued for later delivery in the
31980 usual fashion.
31981 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31982 to the control; the default value is &"spool"& and the alternate value
31983 &"pass"& copies an SMTP defer response from the target back to the initiator
31984 and does not queue the message.
31985 Note that this is independent of any recipient verify conditions in the ACL.
31986
31987 Delivery in this mode avoids the generation of a bounce mail to a
31988 (possibly faked)
31989 sender when the destination system is doing content-scan based rejection.
31990
31991
31992 .vitem &*control&~=&~debug/*&<&'options'&>
31993 .cindex "&ACL;" "enabling debug logging"
31994 .cindex "debugging" "enabling from an ACL"
31995 This control turns on debug logging, almost as though Exim had been invoked
31996 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31997 by default called &'debuglog'&.
31998
31999 Logging set up by the control will be maintained across spool residency.
32000
32001 Options are a slash-separated list.
32002 If an option takes an argument, the option name and argument are separated by
32003 an equals character.
32004 Several options are supported:
32005 .display
32006 tag=<&'suffix'&>         The filename can be adjusted with thise option.
32007                      The argument, which may access any variables already defined,
32008                      is appended to the default name.
32009
32010 opts=<&'debug&~options'&> The argument specififes what is to be logged,
32011                      using the same values as the &`-d`& command-line option.
32012
32013 stop                 Logging started with this control may be
32014                      stopped by using this option.
32015
32016 kill                 Logging started with this control may be
32017                      stopped by using this option.
32018                      Additionally the debug file will be removed,
32019                      providing one means for speculative debug tracing.
32020
32021 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
32022                      for pre-trigger debug capture.
32023                      Debug lines are recorded in the buffer until
32024                      and if) a trigger occurs; at which time they are
32025                      dumped to the debug file.  Newer lines displace the
32026                      oldest if the buffer is full.  After a trigger,
32027                      immediate writes to file are done as normal.
32028
32029 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
32030                      see above) to be copied to file.  A reason of &*now*&
32031                      take effect immediately; one of &*paniclog*& triggers
32032                      on a write to the panic log.
32033 .endd
32034
32035 Some examples (which depend on variables that don't exist in all
32036 contexts):
32037 .code
32038       control = debug
32039       control = debug/tag=.$sender_host_address
32040       control = debug/opts=+expand+acl
32041       control = debug/tag=.$message_exim_id/opts=+expand
32042       control = debug/kill
32043       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
32044       control = debug/trigger=now
32045 .endd
32046
32047
32048 .vitem &*control&~=&~dkim_disable_verify*&
32049 .cindex "disable DKIM verify"
32050 .cindex "DKIM" "disable verify"
32051 This control turns off DKIM verification processing entirely.  For details on
32052 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
32053
32054
32055 .vitem &*control&~=&~dmarc_disable_verify*&
32056 .cindex "disable DMARC verify"
32057 .cindex "DMARC" "disable verify"
32058 This control turns off DMARC verification processing entirely.  For details on
32059 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
32060
32061
32062 .vitem &*control&~=&~dscp/*&<&'value'&>
32063 .cindex "&ACL;" "setting DSCP value"
32064 .cindex "DSCP" "inbound"
32065 This option causes the DSCP value associated with the socket for the inbound
32066 connection to be adjusted to a given value, given as one of a number of fixed
32067 strings or to numeric value.
32068 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
32069 Common values include &`throughput`&, &`mincost`&, and on newer systems
32070 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
32071
32072 The outbound packets from Exim will be marked with this value in the header
32073 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
32074 that these values will have any effect, not be stripped by networking
32075 equipment, or do much of anything without cooperation with your Network
32076 Engineer and those of all network operators between the source and destination.
32077
32078
32079 .vitem &*control&~=&~enforce_sync*& &&&
32080        &*control&~=&~no_enforce_sync*&
32081 .cindex "SMTP" "synchronization checking"
32082 .cindex "synchronization checking in SMTP"
32083 These controls make it possible to be selective about when SMTP synchronization
32084 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
32085 state of the switch (it is true by default). See the description of this option
32086 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
32087
32088 The effect of these two controls lasts for the remainder of the SMTP
32089 connection. They can appear in any ACL except the one for the non-SMTP
32090 messages. The most straightforward place to put them is in the ACL defined by
32091 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
32092 before the first synchronization check. The expected use is to turn off the
32093 synchronization checks for badly-behaved hosts that you nevertheless need to
32094 work with.
32095
32096
32097 .vitem &*control&~=&~fakedefer/*&<&'message'&>
32098 .cindex "fake defer"
32099 .cindex "defer, fake"
32100 .cindex fakedefer
32101 This control works in exactly the same way as &%fakereject%& (described below)
32102 except that it causes an SMTP 450 response after the message data instead of a
32103 550 response. You must take care when using &%fakedefer%& because it causes the
32104 messages to be duplicated when the sender retries. Therefore, you should not
32105 use &%fakedefer%& if the message is to be delivered normally.
32106
32107 .vitem &*control&~=&~fakereject/*&<&'message'&>
32108 .cindex "fake rejection"
32109 .cindex "rejection, fake"
32110 .cindex fakereject
32111 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
32112 words, only when an SMTP message is being received. If Exim accepts the
32113 message, instead the final 250 response, a 550 rejection message is sent.
32114 However, Exim proceeds to deliver the message as normal. The control applies
32115 only to the current message, not to any subsequent ones that may be received in
32116 the same SMTP connection.
32117
32118 The text for the 550 response is taken from the &%control%& modifier. If no
32119 message is supplied, the following is used:
32120 .code
32121 550-Your message has been rejected but is being
32122 550-kept for evaluation.
32123 550-If it was a legitimate message, it may still be
32124 550 delivered to the target recipient(s).
32125 .endd
32126 This facility should be used with extreme caution.
32127
32128 .vitem &*control&~=&~freeze*&
32129 .cindex "frozen messages" "forcing in ACL"
32130 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
32131 other words, only when a message is being received. If the message is accepted,
32132 it is placed on Exim's queue and frozen. The control applies only to the
32133 current message, not to any subsequent ones that may be received in the same
32134 SMTP connection.
32135
32136 This modifier can optionally be followed by &`/no_tell`&. If the global option
32137 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
32138 is told about the freezing), provided all the &*control=freeze*& modifiers that
32139 are obeyed for the current message have the &`/no_tell`& option.
32140
32141 .vitem &*control&~=&~no_delay_flush*&
32142 .cindex "SMTP" "output flushing, disabling for delay"
32143 Exim normally flushes SMTP output before implementing a delay in an ACL, to
32144 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
32145 use. This control, as long as it is encountered before the &%delay%& modifier,
32146 disables such output flushing.
32147
32148 .vitem &*control&~=&~no_callout_flush*&
32149 .cindex "SMTP" "output flushing, disabling for callout"
32150 Exim normally flushes SMTP output before performing a callout in an ACL, to
32151 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
32152 use. This control, as long as it is encountered before the &%verify%& condition
32153 that causes the callout, disables such output flushing.
32154
32155 .vitem &*control&~=&~no_mbox_unspool*&
32156 This control is available when Exim is compiled with the content scanning
32157 extension. Content scanning may require a copy of the current message, or parts
32158 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
32159 or spam scanner. Normally, such copies are deleted when they are no longer
32160 needed. If this control is set, the copies are not deleted. The control applies
32161 only to the current message, not to any subsequent ones that may be received in
32162 the same SMTP connection. It is provided for debugging purposes and is unlikely
32163 to be useful in production.
32164
32165 .vitem &*control&~=&~no_multiline_responses*&
32166 .cindex "multiline responses, suppressing"
32167 This control is permitted for any ACL except the one for non-SMTP messages.
32168 It seems that there are broken clients in use that cannot handle multiline
32169 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
32170
32171 If this control is set, multiline SMTP responses from ACL rejections are
32172 suppressed. One way of doing this would have been to put out these responses as
32173 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
32174 (&"use multiline responses for more"& it says &-- ha!), and some of the
32175 responses might get close to that. So this facility, which is after all only a
32176 sop to broken clients, is implemented by doing two very easy things:
32177
32178 .ilist
32179 Extra information that is normally output as part of a rejection caused by
32180 sender verification failure is omitted. Only the final line (typically &"sender
32181 verification failed"&) is sent.
32182 .next
32183 If a &%message%& modifier supplies a multiline response, only the first
32184 line is output.
32185 .endlist
32186
32187 The setting of the switch can, of course, be made conditional on the
32188 calling host. Its effect lasts until the end of the SMTP connection.
32189
32190 .vitem &*control&~=&~no_pipelining*&
32191 .cindex "PIPELINING" "suppressing advertising"
32192 .cindex "ESMTP extensions" PIPELINING
32193 This control turns off the advertising of the PIPELINING extension to SMTP in
32194 the current session. To be useful, it must be obeyed before Exim sends its
32195 response to an EHLO command. Therefore, it should normally appear in an ACL
32196 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
32197 &%pipelining_advertise_hosts%&.
32198
32199 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
32200        &*control&~=&~queue_only*&
32201 .oindex "&%queue%&"
32202 .oindex "&%queue_only%&"
32203 .cindex "queueing incoming messages"
32204 .cindex queueing "forcing in ACL"
32205 .cindex "first pass routing"
32206 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
32207 other words, only when a message is being received. If the message is accepted,
32208 it is placed on Exim's queue and left there for delivery by a subsequent queue
32209 runner.
32210 If used with no options set,
32211 no immediate delivery process is started. In other words, it has the
32212 effect as the &%queue_only%& global option or &'-odq'& command-line option.
32213
32214 If the &'first_pass_route'& option is given then
32215 the behaviour is like the command-line &'-oqds'& option;
32216 a delivery process is started which stops short of making
32217 any SMTP delivery.  The benefit is that the hints database will be updated for
32218 the message being waiting for a specific host, and a later queue run will be
32219 able to send all such messages on a single connection.
32220
32221 The control only applies to the current message, not to any subsequent ones that
32222  may be received in the same SMTP connection.
32223
32224 .vitem &*control&~=&~submission/*&<&'options'&>
32225 .cindex "message" "submission"
32226 .cindex "submission mode"
32227 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
32228 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
32229 the current message is a submission from a local MUA. In this case, Exim
32230 operates in &"submission mode"&, and applies certain fixups to the message if
32231 necessary. For example, it adds a &'Date:'& header line if one is not present.
32232 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
32233 late (the message has already been created).
32234
32235 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
32236 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
32237 submission mode; the available options for this control are described there.
32238 The control applies only to the current message, not to any subsequent ones
32239 that may be received in the same SMTP connection.
32240
32241 .vitem &*control&~=&~suppress_local_fixups*&
32242 .cindex "submission fixups, suppressing"
32243 This control applies to locally submitted (non TCP/IP) messages, and is the
32244 complement of &`control = submission`&. It disables the fixups that are
32245 normally applied to locally-submitted messages. Specifically:
32246
32247 .ilist
32248 Any &'Sender:'& header line is left alone (in this respect, it is a
32249 dynamic version of &%local_sender_retain%&).
32250 .next
32251 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32252 .next
32253 There is no check that &'From:'& corresponds to the actual sender.
32254 .endlist ilist
32255
32256 This control may be useful when a remotely-originated message is accepted,
32257 passed to some scanning program, and then re-submitted for delivery. It can be
32258 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32259 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32260 data is read.
32261
32262 &*Note:*& This control applies only to the current message, not to any others
32263 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32264
32265 .vitem &*control&~=&~utf8_downconvert*&
32266 This control enables conversion of UTF-8 in message envelope addresses
32267 to a-label form.
32268 For details see section &<<SECTi18nMTA>>&.
32269
32270 .vitem &*control&~=&~wellknown*&
32271 This control sets up a response data file for a WELLKNOWN SMTP command.
32272 It may only be used in an ACL servicing that command.
32273 For details see section &<<SECTWELLKNOWNACL>>&.
32274 .endlist vlist
32275
32276
32277 .section "Summary of message fixup control" "SECTsummesfix"
32278 All four possibilities for message fixups can be specified:
32279
32280 .ilist
32281 Locally submitted, fixups applied: the default.
32282 .next
32283 Locally submitted, no fixups applied: use
32284 &`control = suppress_local_fixups`&.
32285 .next
32286 Remotely submitted, no fixups applied: the default.
32287 .next
32288 Remotely submitted, fixups applied: use &`control = submission`&.
32289 .endlist
32290
32291
32292
32293 .section "Adding header lines in ACLs" "SECTaddheadacl"
32294 .cindex "header lines" "adding in an ACL"
32295 .cindex "header lines" "position of added lines"
32296 .cindex "&%add_header%& ACL modifier"
32297 The &%add_header%& modifier can be used to add one or more extra header lines
32298 to an incoming message, as in this example:
32299 .code
32300 warn dnslists = sbl.spamhaus.org : \
32301                 dialup.mail-abuse.org
32302      add_header = X-blacklisted-at: $dnslist_domain
32303 .endd
32304 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32305 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32306 receiving a message). The message must ultimately be accepted for
32307 &%add_header%& to have any significant effect. You can use &%add_header%& with
32308 any ACL verb, including &%deny%& (though this is potentially useful only in a
32309 RCPT ACL).
32310
32311 Headers will not be added to the message if the modifier is used in
32312 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32313
32314 Leading and trailing newlines are removed from
32315 the data for the &%add_header%& modifier; if it then
32316 contains one or more newlines that
32317 are not followed by a space or a tab, it is assumed to contain multiple header
32318 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32319 front of any line that is not a valid header line.
32320
32321 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32322 They are added to the message before processing the DATA and MIME ACLs.
32323 However, if an identical header line is requested more than once, only one copy
32324 is actually added to the message. Further header lines may be accumulated
32325 during the DATA and MIME ACLs, after which they are added to the message, again
32326 with duplicates suppressed. Thus, it is possible to add two identical header
32327 lines to an SMTP message, but only if one is added before DATA and one after.
32328 In the case of non-SMTP messages, new headers are accumulated during the
32329 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32330 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32331 are included in the entry that is written to the reject log.
32332
32333 .cindex "header lines" "added; visibility of"
32334 Header lines are not visible in string expansions
32335 of message headers
32336 until they are added to the
32337 message. It follows that header lines defined in the MAIL, RCPT, and predata
32338 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32339 header lines that are added by the DATA or MIME ACLs are not visible in those
32340 ACLs. Because of this restriction, you cannot use header lines as a way of
32341 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32342 this, you can use ACL variables, as described in section
32343 &<<SECTaclvariables>>&.
32344
32345 The list of headers yet to be added is given by the &%$headers_added%& variable.
32346
32347 The &%add_header%& modifier acts immediately as it is encountered during the
32348 processing of an ACL. Notice the difference between these two cases:
32349 .display
32350 &`accept add_header = ADDED: some text`&
32351 &`       `&<&'some condition'&>
32352
32353 &`accept `&<&'some condition'&>
32354 &`       add_header = ADDED: some text`&
32355 .endd
32356 In the first case, the header line is always added, whether or not the
32357 condition is true. In the second case, the header line is added only if the
32358 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32359 ACL statement. All those that are encountered before a condition fails are
32360 honoured.
32361
32362 .cindex "&%warn%& ACL verb"
32363 For compatibility with previous versions of Exim, a &%message%& modifier for a
32364 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32365 effect only if all the conditions are true, even if it appears before some of
32366 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32367 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32368 are present on a &%warn%& verb, both are processed according to their
32369 specifications.
32370
32371 By default, new header lines are added to a message at the end of the existing
32372 header lines. However, you can specify that any particular header line should
32373 be added right at the start (before all the &'Received:'& lines), immediately
32374 after the first block of &'Received:'& lines, or immediately before any line
32375 that is not a &'Received:'& or &'Resent-something:'& header.
32376
32377 This is done by specifying &":at_start:"&, &":after_received:"&, or
32378 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32379 header line, respectively. (Header text cannot start with a colon, as there has
32380 to be a header name first.) For example:
32381 .code
32382 warn add_header = \
32383        :after_received:X-My-Header: something or other...
32384 .endd
32385 If more than one header line is supplied in a single &%add_header%& modifier,
32386 each one is treated independently and can therefore be placed differently. If
32387 you add more than one line at the start, or after the Received: block, they end
32388 up in reverse order.
32389
32390 &*Warning*&: This facility currently applies only to header lines that are
32391 added in an ACL. It does NOT work for header lines that are added in a
32392 system filter or in a router or transport.
32393
32394
32395
32396 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32397 .cindex "header lines" "removing in an ACL"
32398 .cindex "header lines" "position of removed lines"
32399 .cindex "&%remove_header%& ACL modifier"
32400 The &%remove_header%& modifier can be used to remove one or more header lines
32401 from an incoming message, as in this example:
32402 .code
32403 warn   message        = Remove internal headers
32404        remove_header  = x-route-mail1 : x-route-mail2
32405 .endd
32406 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32407 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32408 receiving a message). The message must ultimately be accepted for
32409 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32410 with any ACL verb, including &%deny%&, though this is really not useful for
32411 any verb that doesn't result in a delivered message.
32412
32413 Headers will not be removed from the message if the modifier is used in
32414 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32415
32416 More than one header can be removed at the same time by using a colon separated
32417 list of header specifiers.
32418 If a specifier does not start with a circumflex (^)
32419 then it is treated as a header name.
32420 The header name matching is case insensitive.
32421 If it does, then it is treated as a (front-anchored)
32422 regular expression applied to the whole header.
32423
32424 &*Note*&: The colon terminating a header name will need to be doubled
32425 if used in an RE, and there can legitimately be whitepace before it.
32426
32427 Example:
32428 .code
32429 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32430 .endd
32431
32432 List expansion is not performed, so you cannot use hostlists to
32433 create a list of headers, however both connection and message variable expansion
32434 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32435 .code
32436 warn   hosts           = +internal_hosts
32437        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32438 warn   message         = Remove internal headers
32439        remove_header   = $acl_c_ihdrs
32440 .endd
32441 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32442 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32443 If multiple header lines match, all are removed.
32444 There is no harm in attempting to remove the same header twice nor in removing
32445 a non-existent header. Further header specifiers for removal may be accumulated
32446 during the DATA and MIME ACLs, after which matching headers are removed
32447 if present. In the case of non-SMTP messages, remove specifiers are
32448 accumulated during the non-SMTP ACLs, and are acted on after
32449 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32450 ACL, there really is no effect because there is no logging of what headers
32451 would have been removed.
32452
32453 .cindex "header lines" "removed; visibility of"
32454 Header lines are not visible in string expansions until the DATA phase when it
32455 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32456 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32457 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32458 this restriction, you cannot use header lines as a way of controlling data
32459 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32460 you should instead use ACL variables, as described in section
32461 &<<SECTaclvariables>>&.
32462
32463 The &%remove_header%& modifier acts immediately as it is encountered during the
32464 processing of an ACL. Notice the difference between these two cases:
32465 .display
32466 &`accept remove_header = X-Internal`&
32467 &`       `&<&'some condition'&>
32468
32469 &`accept `&<&'some condition'&>
32470 &`       remove_header = X-Internal`&
32471 .endd
32472 In the first case, the header line is always removed, whether or not the
32473 condition is true. In the second case, the header line is removed only if the
32474 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32475 same ACL statement. All those that are encountered before a condition fails
32476 are honoured.
32477
32478 &*Warning*&: This facility currently applies only to header lines that are
32479 present during ACL processing. It does NOT remove header lines that are added
32480 in a system filter or in a router or transport.
32481
32482
32483
32484
32485 .section "ACL conditions" "SECTaclconditions"
32486 .cindex "&ACL;" "conditions; list of"
32487 Some of the conditions listed in this section are available only when Exim is
32488 compiled with the content-scanning extension. They are included here briefly
32489 for completeness. More detailed descriptions can be found in the discussion on
32490 content scanning in chapter &<<CHAPexiscan>>&.
32491
32492 Not all conditions are relevant in all circumstances. For example, testing
32493 senders and recipients does not make sense in an ACL that is being run as the
32494 result of the arrival of an ETRN command, and checks on message headers can be
32495 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32496 can use the same condition (with different parameters) more than once in the
32497 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32498 The conditions are as follows:
32499
32500
32501 .vlist
32502 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32503 .cindex "&ACL;" "nested"
32504 .cindex "&ACL;" "indirect"
32505 .cindex "&ACL;" "arguments"
32506 .cindex "&%acl%& ACL condition"
32507 The possible values of the argument are the same as for the
32508 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32509 &"accept"& the condition is true; if it returns &"deny"& the condition is
32510 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32511 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32512 condition false. This means that further processing of the &%warn%& verb
32513 ceases, but processing of the ACL continues.
32514
32515 If the argument is a named ACL, up to nine space-separated optional values
32516 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32517 and $acl_narg is set to the count of values.
32518 Previous values of these variables are restored after the call returns.
32519 The name and values are expanded separately.
32520 Note that spaces in complex expansions which are used as arguments
32521 will act as argument separators.
32522
32523 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32524 the connection is dropped. If it returns &"discard"&, the verb must be
32525 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32526 conditions are tested.
32527
32528 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32529 loops. This condition allows you to use different ACLs in different
32530 circumstances. For example, different ACLs can be used to handle RCPT commands
32531 for different local users or different local domains.
32532
32533 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32534 .cindex "&%authenticated%& ACL condition"
32535 .cindex "authentication" "ACL checking"
32536 .cindex "&ACL;" "testing for authentication"
32537 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32538 the name of the authenticator is tested against the list. To test for
32539 authentication by any authenticator, you can set
32540 .code
32541 authenticated = *
32542 .endd
32543
32544 .vitem &*condition&~=&~*&<&'string'&>
32545 .cindex "&%condition%& ACL condition"
32546 .cindex "customizing" "ACL condition"
32547 .cindex "&ACL;" "customized test"
32548 .cindex "&ACL;" "testing, customized"
32549 This feature allows you to make up custom conditions. If the result of
32550 expanding the string is an empty string, the number zero, or one of the strings
32551 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32552 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32553 any other value, some error is assumed to have occurred, and the ACL returns
32554 &"defer"&. However, if the expansion is forced to fail, the condition is
32555 ignored. The effect is to treat it as true, whether it is positive or
32556 negative.
32557
32558 .vitem &*decode&~=&~*&<&'location'&>
32559 .cindex "&%decode%& ACL condition"
32560 This condition is available only when Exim is compiled with the
32561 content-scanning extension, and it is allowed only in the ACL defined by
32562 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32563 If all goes well, the condition is true. It is false only if there are
32564 problems such as a syntax error or a memory shortage. For more details, see
32565 chapter &<<CHAPexiscan>>&.
32566
32567 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32568 .cindex "&%dnslists%& ACL condition"
32569 .cindex "DNS list" "in ACL"
32570 .cindex "black list (DNS)"
32571 .cindex "&ACL;" "testing a DNS list"
32572 This condition checks for entries in DNS black lists. These are also known as
32573 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32574 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32575 different variants of this condition to describe briefly here. See sections
32576 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32577
32578 .vitem &*domains&~=&~*&<&'domain&~list'&>
32579 .cindex "&%domains%& ACL condition"
32580 .cindex "domain" "ACL checking"
32581 .cindex "&ACL;" "testing a recipient domain"
32582 .vindex "&$domain_data$&"
32583 This condition is relevant only in a RCPT ACL. It checks that the domain
32584 of the recipient address is in the domain list. If percent-hack processing is
32585 enabled, it is done before this test is done. If the check succeeds with a
32586 lookup, the result of the lookup is placed in &$domain_data$& until the next
32587 &%domains%& test.
32588
32589 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32590 use &%domains%& in a DATA ACL.
32591
32592
32593 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32594 .cindex "&%encrypted%& ACL condition"
32595 .cindex "encryption" "checking in an ACL"
32596 .cindex "&ACL;" "testing for encryption"
32597 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32598 name of the cipher suite in use is tested against the list. To test for
32599 encryption without testing for any specific cipher suite(s), set
32600 .code
32601 encrypted = *
32602 .endd
32603
32604
32605 .vitem &*hosts&~=&~*&<&'host&~list'&>
32606 .cindex "&%hosts%& ACL condition"
32607 .cindex "host" "ACL checking"
32608 .cindex "&ACL;" "testing the client host"
32609 This condition tests that the calling host matches the host list. If you have
32610 name lookups or wildcarded host names and IP addresses in the same host list,
32611 you should normally put the IP addresses first. For example, you could have:
32612 .code
32613 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32614 .endd
32615 The lookup in this example uses the host name for its key. This is implied by
32616 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32617 and it wouldn't matter which way round you had these two items.)
32618
32619 The reason for the problem with host names lies in the left-to-right way that
32620 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32621 but when it reaches an item that requires a host name, it fails if it cannot
32622 find a host name to compare with the pattern. If the above list is given in the
32623 opposite order, the &%accept%& statement fails for a host whose name cannot be
32624 found, even if its IP address is 10.9.8.7.
32625
32626 If you really do want to do the name check first, and still recognize the IP
32627 address even if the name lookup fails, you can rewrite the ACL like this:
32628 .code
32629 accept hosts = dbm;/etc/friendly/hosts
32630 accept hosts = 10.9.8.7
32631 .endd
32632 The default action on failing to find the host name is to assume that the host
32633 is not in the list, so the first &%accept%& statement fails. The second
32634 statement can then check the IP address.
32635
32636 .vindex "&$host_data$&"
32637 If a &%hosts%& condition is satisfied by means of a lookup, the result
32638 of the lookup is made available in the &$host_data$& variable. This
32639 allows you, for example, to set up a statement like this:
32640 .code
32641 deny  hosts = net-lsearch;/some/file
32642       message = $host_data
32643 .endd
32644 which gives a custom error message for each denied host.
32645
32646 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32647 .cindex "&%local_parts%& ACL condition"
32648 .cindex "local part" "ACL checking"
32649 .cindex "&ACL;" "testing a local part"
32650 .vindex "&$local_part_data$&"
32651 This condition is relevant only in a RCPT ACL. It checks that the local
32652 part of the recipient address is in the list. If percent-hack processing is
32653 enabled, it is done before this test. If the check succeeds with a lookup, the
32654 result of the lookup is placed in &$local_part_data$&, which remains set until
32655 the next &%local_parts%& test.
32656
32657 .vitem &*malware&~=&~*&<&'option'&>
32658 .cindex "&%malware%& ACL condition"
32659 .cindex "&ACL;" "virus scanning"
32660 .cindex "&ACL;" "scanning for viruses"
32661 This condition is available only when Exim is compiled with the
32662 content-scanning extension
32663 and only after a DATA command.
32664 It causes the incoming message to be scanned for
32665 viruses. For details, see chapter &<<CHAPexiscan>>&.
32666
32667 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32668 .cindex "&%mime_regex%& ACL condition"
32669 .cindex "&ACL;" "testing by regex matching"
32670 This condition is available only when Exim is compiled with the
32671 content-scanning extension, and it is allowed only in the ACL defined by
32672 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32673 with any of the regular expressions. For details, see chapter
32674 &<<CHAPexiscan>>&.
32675
32676 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32677 .cindex "rate limiting"
32678 This condition can be used to limit the rate at which a user or host submits
32679 messages. Details are given in section &<<SECTratelimiting>>&.
32680
32681 .vitem &*recipients&~=&~*&<&'address&~list'&>
32682 .cindex "&%recipients%& ACL condition"
32683 .cindex "recipient" "ACL checking"
32684 .cindex "&ACL;" "testing a recipient"
32685 This condition is relevant only in a RCPT ACL. It checks the entire
32686 recipient address against a list of recipients.
32687
32688 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32689 .cindex "&%regex%& ACL condition"
32690 .cindex "&ACL;" "testing by regex matching"
32691 This condition is available only when Exim is compiled with the
32692 content-scanning extension, and is available only in the DATA, MIME, and
32693 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32694 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32695
32696 .vitem &*seen&~=&~*&<&'parameters'&>
32697 .cindex "&%seen%& ACL condition"
32698 This condition can be used to test if a situation has been previously met,
32699 for example for greylisting.
32700 Details are given in section &<<SECTseen>>&.
32701
32702 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32703 .cindex "&%sender_domains%& ACL condition"
32704 .cindex "sender" "ACL checking"
32705 .cindex "&ACL;" "testing a sender domain"
32706 .vindex "&$domain$&"
32707 .vindex "&$sender_address_domain$&"
32708 This condition tests the domain of the sender of the message against the given
32709 domain list. &*Note*&: The domain of the sender address is in
32710 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32711 of this condition. This is an exception to the general rule for testing domain
32712 lists. It is done this way so that, if this condition is used in an ACL for a
32713 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32714 influence the sender checking.
32715
32716 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32717 relaying, because sender addresses are easily, and commonly, forged.
32718
32719 .vitem &*senders&~=&~*&<&'address&~list'&>
32720 .cindex "&%senders%& ACL condition"
32721 .cindex "sender" "ACL checking"
32722 .cindex "&ACL;" "testing a sender"
32723 This condition tests the sender of the message against the given list. To test
32724 for a bounce message, which has an empty sender, set
32725 .code
32726 senders = :
32727 .endd
32728 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32729 relaying, because sender addresses are easily, and commonly, forged.
32730
32731 .vitem &*spam&~=&~*&<&'username'&>
32732 .cindex "&%spam%& ACL condition"
32733 .cindex "&ACL;" "scanning for spam"
32734 This condition is available only when Exim is compiled with the
32735 content-scanning extension. It causes the incoming message to be scanned by
32736 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32737
32738 .vitem &*verify&~=&~certificate*&
32739 .cindex "&%verify%& ACL condition"
32740 .cindex "TLS" "client certificate verification"
32741 .cindex "certificate" "verification of client"
32742 .cindex "&ACL;" "certificate verification"
32743 .cindex "&ACL;" "testing a TLS certificate"
32744 This condition is true in an SMTP session if the session is encrypted, and a
32745 certificate was received from the client, and the certificate was verified. The
32746 server requests a certificate only if the client matches &%tls_verify_hosts%&
32747 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32748
32749 .vitem &*verify&~=&~csa*&
32750 .cindex "CSA verification"
32751 This condition checks whether the sending host (the client) is authorized to
32752 send email. Details of how this works are given in section
32753 &<<SECTverifyCSA>>&.
32754
32755 .vitem &*verify&~=&~header_names_ascii*&
32756 .cindex "&%verify%& ACL condition"
32757 .cindex "&ACL;" "verifying header names only ASCII"
32758 .cindex "header lines" "verifying header names only ASCII"
32759 .cindex "verifying" "header names only ASCII"
32760 This condition is relevant only in an ACL that is run after a message has been
32761 received.
32762 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32763 It checks all header names (not the content) to make sure
32764 there are no non-ASCII characters, also excluding control characters.  The
32765 allowable characters are decimal ASCII values 33 through 126.
32766
32767 Exim itself will handle headers with non-ASCII characters, but it can cause
32768 problems for downstream applications, so this option will allow their
32769 detection and rejection in the DATA ACL's.
32770
32771 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32772 .cindex "&%verify%& ACL condition"
32773 .cindex "&ACL;" "verifying sender in the header"
32774 .cindex "header lines" "verifying the sender in"
32775 .cindex "sender" "verifying in header"
32776 .cindex "verifying" "sender in header"
32777 This condition is relevant only in an ACL that is run after a message has been
32778 received, that is, in an ACL specified by &%acl_smtp_data%& or
32779 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32780 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32781 is loosely thought of as a &"sender"& address (hence the name of the test).
32782 However, an address that appears in one of these headers need not be an address
32783 that accepts bounce messages; only sender addresses in envelopes are required
32784 to accept bounces. Therefore, if you use the callout option on this check, you
32785 might want to arrange for a non-empty address in the MAIL command.
32786
32787 Details of address verification and the options are given later, starting at
32788 section &<<SECTaddressverification>>& (callouts are described in section
32789 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32790 condition to restrict it to bounce messages only:
32791 .code
32792 deny    senders = :
32793        !verify  = header_sender
32794         message = A valid sender header is required for bounces
32795 .endd
32796
32797 .vitem &*verify&~=&~header_syntax*&
32798 .cindex "&%verify%& ACL condition"
32799 .cindex "&ACL;" "verifying header syntax"
32800 .cindex "header lines" "verifying syntax"
32801 .cindex "verifying" "header syntax"
32802 This condition is relevant only in an ACL that is run after a message has been
32803 received, that is, in an ACL specified by &%acl_smtp_data%& or
32804 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32805 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32806 and &'Bcc:'&), returning true if there are no problems.
32807 Unqualified addresses (local parts without domains) are
32808 permitted only in locally generated messages and from hosts that match
32809 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32810 appropriate.
32811
32812 Note that this condition is a syntax check only. However, a common spamming
32813 ploy used to be to send syntactically invalid headers such as
32814 .code
32815 To: @
32816 .endd
32817 and this condition can be used to reject such messages, though they are not as
32818 common as they used to be.
32819
32820 .vitem &*verify&~=&~helo*&
32821 .cindex "&%verify%& ACL condition"
32822 .cindex "&ACL;" "verifying HELO/EHLO"
32823 .cindex "HELO" "verifying"
32824 .cindex "EHLO" "verifying"
32825 .cindex "verifying" "EHLO"
32826 .cindex "verifying" "HELO"
32827 This condition is true if a HELO or EHLO command has been received from the
32828 client host, and its contents have been verified. If there has been no previous
32829 attempt to verify the HELO/EHLO contents, it is carried out when this
32830 condition is encountered. See the description of the &%helo_verify_hosts%& and
32831 &%helo_try_verify_hosts%& options for details of how to request verification
32832 independently of this condition, and for detail of the verification.
32833
32834 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32835 option), this condition is always true.
32836
32837
32838 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32839 .cindex "verifying" "not blind"
32840 .cindex "bcc recipients, verifying none"
32841 This condition checks that there are no blind (bcc) recipients in the message.
32842 Every envelope recipient must appear either in a &'To:'& header line or in a
32843 &'Cc:'& header line for this condition to be true. Local parts are checked
32844 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32845 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32846 used only in a DATA or non-SMTP ACL.
32847
32848 There is one possible option, &`case_insensitive`&.  If this is present then
32849 local parts are checked case-insensitively.
32850
32851 There are, of course, many legitimate messages that make use of blind (bcc)
32852 recipients. This check should not be used on its own for blocking messages.
32853
32854
32855 .vitem &*verify&~=&~recipient/*&<&'options'&>
32856 .cindex "&%verify%& ACL condition"
32857 .cindex "&ACL;" "verifying recipient"
32858 .cindex "recipient" "verifying"
32859 .cindex "verifying" "recipient"
32860 .vindex "&$address_data$&"
32861 This condition is relevant only after a RCPT command. It verifies the current
32862 recipient. Details of address verification are given later, starting at section
32863 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32864 of &$address_data$& is the last value that was set while routing the address.
32865 This applies even if the verification fails. When an address that is being
32866 verified is redirected to a single address, verification continues with the new
32867 address, and in that case, the subsequent value of &$address_data$& is the
32868 value for the child address.
32869
32870 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32871 .cindex "&%verify%& ACL condition"
32872 .cindex "&ACL;" "verifying host reverse lookup"
32873 .cindex "host" "verifying reverse lookup"
32874 This condition ensures that a verified host name has been looked up from the IP
32875 address of the client host. (This may have happened already if the host name
32876 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32877 Verification ensures that the host name obtained from a reverse DNS lookup, or
32878 one of its aliases, does, when it is itself looked up in the DNS, yield the
32879 original IP address.
32880
32881 There is one possible option, &`defer_ok`&.  If this is present and a
32882 DNS operation returns a temporary error, the verify condition succeeds.
32883
32884 If this condition is used for a locally generated message (that is, when there
32885 is no client host involved), it always succeeds.
32886
32887 .vitem &*verify&~=&~sender/*&<&'options'&>
32888 .cindex "&%verify%& ACL condition"
32889 .cindex "&ACL;" "verifying sender"
32890 .cindex "sender" "verifying"
32891 .cindex "verifying" "sender"
32892 This condition is relevant only after a MAIL or RCPT command, or after a
32893 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32894 the message's sender is empty (that is, this is a bounce message), the
32895 condition is true. Otherwise, the sender address is verified.
32896
32897 .vindex "&$address_data$&"
32898 .vindex "&$sender_address_data$&"
32899 If there is data in the &$address_data$& variable at the end of routing, its
32900 value is placed in &$sender_address_data$& at the end of verification. This
32901 value can be used in subsequent conditions and modifiers in the same ACL
32902 statement. It does not persist after the end of the current statement. If you
32903 want to preserve the value for longer, you can save it in an ACL variable.
32904
32905 Details of verification are given later, starting at section
32906 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32907 to avoid doing it more than once per message.
32908
32909 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32910 .cindex "&%verify%& ACL condition"
32911 This is a variation of the previous option, in which a modified address is
32912 verified as a sender.
32913
32914 Note that '/' is legal in local-parts; if the address may have such
32915 (eg. is generated from the received message)
32916 they must be protected from the options parsing by doubling:
32917 .code
32918 verify = sender=${listquote{/}{${address:$h_sender:}}}
32919 .endd
32920 .endlist
32921
32922
32923
32924 .section "Using DNS lists" "SECTmorednslists"
32925 .cindex "DNS list" "in ACL"
32926 .cindex "black list (DNS)"
32927 .cindex "&ACL;" "testing a DNS list"
32928 In its simplest form, the &%dnslists%& condition tests whether the calling host
32929 is on at least one of a number of DNS lists by looking up the inverted IP
32930 address in one or more DNS domains. (Note that DNS list domains are not mail
32931 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32932 special options instead.) For example, if the calling host's IP
32933 address is 192.168.62.43, and the ACL statement is
32934 .code
32935 deny dnslists = blackholes.mail-abuse.org : \
32936                 dialups.mail-abuse.org
32937 .endd
32938 the following records are looked up:
32939 .code
32940 43.62.168.192.blackholes.mail-abuse.org
32941 43.62.168.192.dialups.mail-abuse.org
32942 .endd
32943 As soon as Exim finds an existing DNS record, processing of the list stops.
32944 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32945 to test that a host is on more than one list (an &"and"& conjunction), you can
32946 use two separate conditions:
32947 .code
32948 deny dnslists = blackholes.mail-abuse.org
32949      dnslists = dialups.mail-abuse.org
32950 .endd
32951 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32952 behaves as if the host does not match the list item, that is, as if the DNS
32953 record does not exist. If there are further items in the DNS list, they are
32954 processed.
32955
32956 This is usually the required action when &%dnslists%& is used with &%deny%&
32957 (which is the most common usage), because it prevents a DNS failure from
32958 blocking mail. However, you can change this behaviour by putting one of the
32959 following special items in the list:
32960 .itable none 0 0 2 25* left 75* left
32961 .irow "+include_unknown"   "behave as if the item is on the list"
32962 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32963 .irow "+defer_unknown  "   "give a temporary error"
32964 .endtable
32965 .cindex "&`+include_unknown`&"
32966 .cindex "&`+exclude_unknown`&"
32967 .cindex "&`+defer_unknown`&"
32968 Each of these applies to any subsequent items on the list. For example:
32969 .code
32970 deny dnslists = +defer_unknown : foo.bar.example
32971 .endd
32972 Testing the list of domains stops as soon as a match is found. If you want to
32973 warn for one list and block for another, you can use two different statements:
32974 .code
32975 deny  dnslists = blackholes.mail-abuse.org
32976 warn  dnslists = dialups.mail-abuse.org
32977       message  = X-Warn: sending host is on dialups list
32978 .endd
32979 .cindex caching "of dns lookup"
32980 .cindex DNS TTL
32981 DNS list lookups are cached by Exim for the duration of the SMTP session
32982 (but limited by the DNS return TTL value),
32983 so a lookup based on the IP address is done at most once for any incoming
32984 connection (assuming long-enough TTL).
32985 Exim does not share information between multiple incoming
32986 connections (but your local name server cache should be active).
32987
32988 There are a number of DNS lists to choose from, some commercial, some free,
32989 or free for small deployments.  An overview can be found at
32990 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32991
32992
32993
32994 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32995 .cindex "DNS list" "keyed by explicit IP address"
32996 By default, the IP address that is used in a DNS list lookup is the IP address
32997 of the calling host. However, you can specify another IP address by listing it
32998 after the domain name, introduced by a slash. For example:
32999 .code
33000 deny dnslists = black.list.tld/192.168.1.2
33001 .endd
33002 This feature is not very helpful with explicit IP addresses; it is intended for
33003 use with IP addresses that are looked up, for example, the IP addresses of the
33004 MX hosts or nameservers of an email sender address. For an example, see section
33005 &<<SECTmulkeyfor>>& below.
33006
33007
33008
33009
33010 .subsection "DNS lists keyed on domain names" SECID202
33011 .cindex "DNS list" "keyed by domain name"
33012 There are some lists that are keyed on domain names rather than inverted IP
33013 addresses (see, e.g., the &'domain based zones'& link at
33014 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
33015 with these lists. You can change the name that is looked up in a DNS list by
33016 listing it after the domain name, introduced by a slash. For example,
33017 .code
33018 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
33019       message  = Sender's domain is listed at $dnslist_domain
33020 .endd
33021 This particular example is useful only in ACLs that are obeyed after the
33022 RCPT or DATA commands, when a sender address is available. If (for
33023 example) the message's sender is &'user@tld.example'& the name that is looked
33024 up by this example is
33025 .code
33026 tld.example.dsn.rfc-ignorant.org
33027 .endd
33028 A single &%dnslists%& condition can contain entries for both names and IP
33029 addresses. For example:
33030 .code
33031 deny dnslists = sbl.spamhaus.org : \
33032                 dsn.rfc-ignorant.org/$sender_address_domain
33033 .endd
33034 The first item checks the sending host's IP address; the second checks a domain
33035 name. The whole condition is true if either of the DNS lookups succeeds.
33036
33037
33038
33039
33040 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
33041 .cindex "DNS list" "multiple keys for"
33042 The syntax described above for looking up explicitly-defined values (either
33043 names or IP addresses) in a DNS blacklist is a simplification. After the domain
33044 name for the DNS list, what follows the slash can in fact be a list of items.
33045 As with all lists in Exim, the default separator is a colon. However, because
33046 this is a sublist within the list of DNS blacklist domains, it is necessary
33047 either to double the separators like this:
33048 .code
33049 dnslists = black.list.tld/name.1::name.2
33050 .endd
33051 or to change the separator character, like this:
33052 .code
33053 dnslists = black.list.tld/<;name.1;name.2
33054 .endd
33055 If an item in the list is an IP address, it is inverted before the DNS
33056 blacklist domain is appended. If it is not an IP address, no inversion
33057 occurs. Consider this condition:
33058 .code
33059 dnslists = black.list.tld/<;192.168.1.2;a.domain
33060 .endd
33061 The DNS lookups that occur are:
33062 .code
33063 2.1.168.192.black.list.tld
33064 a.domain.black.list.tld
33065 .endd
33066 Once a DNS record has been found (that matches a specific IP return
33067 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
33068 are done. If there is a temporary DNS error, the rest of the sublist of domains
33069 or IP addresses is tried. A temporary error for the whole dnslists item occurs
33070 only if no other DNS lookup in this sublist succeeds. In other words, a
33071 successful lookup for any of the items in the sublist overrides a temporary
33072 error for a previous item.
33073
33074 The ability to supply a list of items after the slash is in some sense just a
33075 syntactic convenience. These two examples have the same effect:
33076 .code
33077 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
33078 dnslists = black.list.tld/a.domain::b.domain
33079 .endd
33080 However, when the data for the list is obtained from a lookup, the second form
33081 is usually much more convenient. Consider this example:
33082 .code
33083 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
33084                                    ${lookup dnsdb {>|mxh=\
33085                                    $sender_address_domain} }} }
33086      message  = The mail servers for the domain \
33087                 $sender_address_domain \
33088                 are listed at $dnslist_domain ($dnslist_value); \
33089                 see $dnslist_text.
33090 .endd
33091 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
33092 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
33093 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
33094 of expanding the condition might be something like this:
33095 .code
33096 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
33097 .endd
33098 Thus, this example checks whether or not the IP addresses of the sender
33099 domain's mail servers are on the Spamhaus black list.
33100
33101 The key that was used for a successful DNS list lookup is put into the variable
33102 &$dnslist_matched$& (see section &<<SECID204>>&).
33103
33104
33105
33106
33107 .subsection "Data returned by DNS lists" SECID203
33108 .cindex "DNS list" "data returned from"
33109 DNS lists are constructed using address records in the DNS. The original RBL
33110 just used the address 127.0.0.1 on the right hand side of each record, but the
33111 RBL+ list and some other lists use a number of values with different meanings.
33112 The values used on the RBL+ list are:
33113 .itable none 0 0 2 20* left 80* left
33114 .irow 127.1.0.1  "RBL"
33115 .irow 127.1.0.2  "DUL"
33116 .irow 127.1.0.3  "DUL and RBL"
33117 .irow 127.1.0.4  "RSS"
33118 .irow 127.1.0.5  "RSS and RBL"
33119 .irow 127.1.0.6  "RSS and DUL"
33120 .irow 127.1.0.7  "RSS and DUL and RBL"
33121 .endtable
33122 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
33123 different values. Some DNS lists may return more than one address record;
33124 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
33125
33126 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
33127 range. If a DNSBL operator loses control of the domain, lookups on it
33128 may start returning other addresses.  Because of this, Exim now ignores
33129 returned values outside the 127/8 region.
33130
33131
33132 .subsection "Variables set from DNS lists" SECID204
33133 .cindex "expansion" "variables, set from DNS list"
33134 .cindex "DNS list" "variables set from"
33135 .vindex "&$dnslist_domain$&"
33136 .vindex "&$dnslist_matched$&"
33137 .vindex "&$dnslist_text$&"
33138 .vindex "&$dnslist_value$&"
33139 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
33140 the name of the overall domain that matched (for example,
33141 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
33142 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
33143 the DNS record. When the key is an IP address, it is not reversed in
33144 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
33145 cases, for example:
33146 .code
33147 deny dnslists = spamhaus.example
33148 .endd
33149 the key is also available in another variable (in this case,
33150 &$sender_host_address$&). In more complicated cases, however, this is not true.
33151 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
33152 might generate a dnslists lookup like this:
33153 .code
33154 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
33155 .endd
33156 If this condition succeeds, the value in &$dnslist_matched$& might be
33157 &`192.168.6.7`& (for example).
33158
33159 If more than one address record is returned by the DNS lookup, all the IP
33160 addresses are included in &$dnslist_value$&, separated by commas and spaces.
33161 The variable &$dnslist_text$& contains the contents of any associated TXT
33162 record. For lists such as RBL+ the TXT record for a merged entry is often not
33163 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
33164 information.
33165
33166 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
33167 &-- even if these appear before the condition in the ACL, they are not
33168 expanded until after it has failed. For example:
33169 .code
33170 deny    hosts = !+local_networks
33171         message = $sender_host_address is listed \
33172                   at $dnslist_domain
33173         dnslists = rbl-plus.mail-abuse.example
33174 .endd
33175
33176
33177
33178 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
33179 .cindex "DNS list" "matching specific returned data"
33180 You can add an equals sign and an IP address after a &%dnslists%& domain name
33181 in order to restrict its action to DNS records with a matching right hand side.
33182 For example,
33183 .code
33184 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
33185 .endd
33186 rejects only those hosts that yield 127.0.0.2. Without this additional data,
33187 any address record is considered to be a match. For the moment, we assume
33188 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
33189 describes how multiple records are handled.
33190
33191 More than one IP address may be given for checking, using a comma as a
33192 separator. These are alternatives &-- if any one of them matches, the
33193 &%dnslists%& condition is true. For example:
33194 .code
33195 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
33196 .endd
33197 If you want to specify a constraining address list and also specify names or IP
33198 addresses to be looked up, the constraining address list must be specified
33199 first. For example:
33200 .code
33201 deny dnslists = dsn.rfc-ignorant.org\
33202                 =127.0.0.2/$sender_address_domain
33203 .endd
33204
33205 If the character &`&&`& is used instead of &`=`&, the comparison for each
33206 listed IP address is done by a bitwise &"and"& instead of by an equality test.
33207 In other words, the listed addresses are used as bit masks. The comparison is
33208 true if all the bits in the mask are present in the address that is being
33209 tested. For example:
33210 .code
33211 dnslists = a.b.c&0.0.0.3
33212 .endd
33213 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
33214 want to test whether one bit or another bit is present (as opposed to both
33215 being present), you must use multiple values. For example:
33216 .code
33217 dnslists = a.b.c&0.0.0.1,0.0.0.2
33218 .endd
33219 matches if the final component of the address is an odd number or two times
33220 an odd number.
33221
33222
33223
33224 .subsection "Negated DNS matching conditions" SECID205
33225 You can supply a negative list of IP addresses as part of a &%dnslists%&
33226 condition. Whereas
33227 .code
33228 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
33229 .endd
33230 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33231 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
33232 .code
33233 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
33234 .endd
33235 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33236 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
33237 words, the result of the test is inverted if an exclamation mark appears before
33238 the &`=`& (or the &`&&`&) sign.
33239
33240 &*Note*&: This kind of negation is not the same as negation in a domain,
33241 host, or address list (which is why the syntax is different).
33242
33243 If you are using just one list, the negation syntax does not gain you much. The
33244 previous example is precisely equivalent to
33245 .code
33246 deny  dnslists = a.b.c
33247      !dnslists = a.b.c=127.0.0.2,127.0.0.3
33248 .endd
33249 However, if you are using multiple lists, the negation syntax is clearer.
33250 Consider this example:
33251 .code
33252 deny  dnslists = sbl.spamhaus.org : \
33253                  list.dsbl.org : \
33254                  dnsbl.njabl.org!=127.0.0.3 : \
33255                  relays.ordb.org
33256 .endd
33257 Using only positive lists, this would have to be:
33258 .code
33259 deny  dnslists = sbl.spamhaus.org : \
33260                  list.dsbl.org
33261 deny  dnslists = dnsbl.njabl.org
33262      !dnslists = dnsbl.njabl.org=127.0.0.3
33263 deny  dnslists = relays.ordb.org
33264 .endd
33265 which is less clear, and harder to maintain.
33266
33267 Negation can also be used with a bitwise-and restriction.
33268 The dnslists condition with only be trus if a result is returned
33269 by the lookup which, anded with the restriction, is all zeroes.
33270 For example:
33271 .code
33272 deny dnslists = zen.spamhaus.org!&0.255.255.0
33273 .endd
33274
33275
33276
33277
33278 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33279 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33280 thereby providing more than one IP address. When an item in a &%dnslists%& list
33281 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33282 the match to specific results from the DNS lookup, there are two ways in which
33283 the checking can be handled. For example, consider the condition:
33284 .code
33285 dnslists = a.b.c=127.0.0.1
33286 .endd
33287 What happens if the DNS lookup for the incoming IP address yields both
33288 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33289 condition true because at least one given value was found, or is it false
33290 because at least one of the found values was not listed? And how does this
33291 affect negated conditions? Both possibilities are provided for with the help of
33292 additional separators &`==`& and &`=&&`&.
33293
33294 .ilist
33295 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33296 IP addresses matches one of the listed addresses. For the example above, the
33297 condition is true because 127.0.0.1 matches.
33298 .next
33299 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33300 looked up IP addresses matches one of the listed addresses. If the condition is
33301 changed to:
33302 .code
33303 dnslists = a.b.c==127.0.0.1
33304 .endd
33305 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33306 false because 127.0.0.2 is not listed. You would need to have:
33307 .code
33308 dnslists = a.b.c==127.0.0.1,127.0.0.2
33309 .endd
33310 for the condition to be true.
33311 .endlist
33312
33313 When &`!`& is used to negate IP address matching, it inverts the result, giving
33314 the precise opposite of the behaviour above. Thus:
33315 .ilist
33316 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33317 addresses matches one of the listed addresses. Consider:
33318 .code
33319 dnslists = a.b.c!&0.0.0.1
33320 .endd
33321 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33322 false because 127.0.0.1 matches.
33323 .next
33324 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33325 looked up IP address that does not match. Consider:
33326 .code
33327 dnslists = a.b.c!=&0.0.0.1
33328 .endd
33329 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33330 true, because 127.0.0.2 does not match. You would need to have:
33331 .code
33332 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33333 .endd
33334 for the condition to be false.
33335 .endlist
33336 When the DNS lookup yields only a single IP address, there is no difference
33337 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33338
33339
33340
33341
33342 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33343 .cindex "DNS list" "information from merged"
33344 When the facility for restricting the matching IP values in a DNS list is used,
33345 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33346 the true reason for rejection. This happens when lists are merged and the IP
33347 address in the A record is used to distinguish them; unfortunately there is
33348 only one TXT record. One way round this is not to use merged lists, but that
33349 can be inefficient because it requires multiple DNS lookups where one would do
33350 in the vast majority of cases when the host of interest is not on any of the
33351 lists.
33352
33353 A less inefficient way of solving this problem is available. If
33354 two domain names, comma-separated, are given, the second is used first to
33355 do an initial check, making use of any IP value restrictions that are set.
33356 If there is a match, the first domain is used, without any IP value
33357 restrictions, to get the TXT record. As a byproduct of this, there is also
33358 a check that the IP being tested is indeed on the first list. The first
33359 domain is the one that is put in &$dnslist_domain$&. For example:
33360 .code
33361 deny   dnslists = \
33362          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33363          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33364        message  = \
33365          rejected because $sender_host_address is blacklisted \
33366          at $dnslist_domain\n$dnslist_text
33367 .endd
33368 For the first blacklist item, this starts by doing a lookup in
33369 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33370 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33371 value, and as long as something is found, it looks for the corresponding TXT
33372 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33373 The second blacklist item is processed similarly.
33374
33375 If you are interested in more than one merged list, the same list must be
33376 given several times, but because the results of the DNS lookups are cached,
33377 the DNS calls themselves are not repeated. For example:
33378 .code
33379 deny dnslists = \
33380          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33381          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33382          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33383          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33384 .endd
33385 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33386 values matches (or if no record is found), this is the only lookup that is
33387 done. Only if there is a match is one of the more specific lists consulted.
33388
33389
33390
33391 .subsection "DNS lists and IPv6" SECTmorednslistslast
33392 .cindex "IPv6" "DNS black lists"
33393 .cindex "DNS list" "IPv6 usage"
33394 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33395 nibble by nibble. For example, if the calling host's IP address is
33396 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33397 .code
33398 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33399   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33400 .endd
33401 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33402 lists contain wildcard records, intended for IPv4, that interact badly with
33403 IPv6. For example, the DNS entry
33404 .code
33405 *.3.some.list.example.    A    127.0.0.1
33406 .endd
33407 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33408 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33409
33410 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33411 &%condition%& condition, as in this example:
33412 .code
33413 deny   condition = ${if isip4{$sender_host_address}}
33414        dnslists  = some.list.example
33415 .endd
33416
33417 If an explicit key is being used for a DNS lookup and it may be an IPv6
33418 address you should specify alternate list separators for both the outer
33419 (DNS list name) list and inner (lookup keys) list:
33420 .code
33421        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33422 .endd
33423
33424
33425 .section "Previously seen user and hosts" "SECTseen"
33426 .cindex "&%seen%& ACL condition"
33427 .cindex greylisting
33428 The &%seen%& ACL condition can be used to test whether a
33429 situation has been previously met.
33430 It uses a hints database to record a timestamp against a key.
33431 The syntax of the condition is:
33432 .display
33433 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33434 .endd
33435
33436 For example,
33437 .code
33438 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33439 .endd
33440 in a RCPT ACL will implement simple greylisting.
33441
33442 The parameters for the condition are
33443 a possible minus sign,
33444 then an interval,
33445 then, slash-separated, a list of options.
33446 The interval is taken as an offset before the current time,
33447 and used for the test.
33448 If the interval is preceded by a minus sign then the condition returns
33449 whether a record is found which is before the test time.
33450 Otherwise, the condition returns whether one is found which is since the
33451 test time.
33452
33453 Options are read in order with later ones overriding earlier ones.
33454
33455 The default key is &$sender_host_address$&.
33456 An explicit key can be set using a &%key=value%& option.
33457
33458 If a &%readonly%& option is given then
33459 no record create or update is done.
33460 If a &%write%& option is given then
33461 a record create or update is always done.
33462 An update is done if the test is for &"since"&.
33463 If none of those hold and there was no existing record,
33464 a record is created.
33465
33466 Creates and updates are marked with the current time.
33467
33468 Finally, a &"before"& test which succeeds, and for which the record
33469 is old enough, will be refreshed with a timestamp of the test time.
33470 This can prevent tidying of the database from removing the entry.
33471 The interval for this is, by default, 10 days.
33472 An explicit interval can be set using a
33473 &%refresh=value%& option.
33474
33475 Note that &"seen"& should be added to the list of hints databases
33476 for maintenance if this ACL condition is used.
33477
33478
33479 .section "Rate limiting incoming messages" "SECTratelimiting"
33480 .cindex "rate limiting" "client sending"
33481 .cindex "limiting client sending rates"
33482 .oindex "&%smtp_ratelimit_*%&"
33483 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33484 which clients can send email. This is more powerful than the
33485 &%smtp_ratelimit_*%& options, because those options control the rate of
33486 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33487 works across all connections (concurrent and sequential) from the same client
33488 host. The syntax of the &%ratelimit%& condition is:
33489 .display
33490 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33491 .endd
33492 If the average client sending rate is less than &'m'& messages per time
33493 period &'p'& then the condition is false; otherwise it is true.
33494
33495 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33496 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33497 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33498 of &'p'&.
33499
33500 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33501 time interval, for example, &`8h`& for eight hours. A larger time constant
33502 means that it takes Exim longer to forget a client's past behaviour. The
33503 parameter &'m'& is the maximum number of messages that a client is permitted to
33504 send in each time interval. It also specifies the number of messages permitted
33505 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33506 constant, you can allow a client to send more messages in a burst without
33507 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33508 both small, messages must be sent at an even rate.
33509
33510 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33511 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33512 when deploying the &%ratelimit%& ACL condition. The script prints usage
33513 instructions when it is run with no arguments.
33514
33515 The key is used to look up the data for calculating the client's average
33516 sending rate. This data is stored in Exim's spool directory, alongside the
33517 retry and other hints databases. The default key is &$sender_host_address$&,
33518 which means Exim computes the sending rate of each client host IP address.
33519 By changing the key you can change how Exim identifies clients for the purpose
33520 of ratelimiting. For example, to limit the sending rate of each authenticated
33521 user, independent of the computer they are sending from, set the key to
33522 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33523 example, &$authenticated_id$& is only meaningful if the client has
33524 authenticated (which you can check with the &%authenticated%& ACL condition).
33525
33526 The lookup key does not have to identify clients: If you want to limit the
33527 rate at which a recipient receives messages, you can use the key
33528 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33529 ACL.
33530
33531 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33532 specifies what Exim measures the rate of, for example, messages or recipients
33533 or bytes. You can adjust the measurement using the &%unique=%& and/or
33534 &%count=%& options. You can also control when Exim updates the recorded rate
33535 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33536 separated by a slash, like the other parameters. They may appear in any order.
33537
33538 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33539 any options that alter the meaning of the stored data. The limit &'m'& is not
33540 stored, so you can alter the configured maximum rate and Exim will still
33541 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33542 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33543 behaviour. The lookup key is not affected by changes to the update mode and
33544 the &%count=%& option.
33545
33546
33547 .subsection "Ratelimit options for what is being measured" ratoptmea
33548 .cindex "rate limiting" "per_* options"
33549 .vlist
33550 .vitem per_conn
33551 .cindex "rate limiting" per_conn
33552 This option limits the client's connection rate. It is not
33553 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33554 &%acl_not_smtp_start%& ACLs.
33555
33556 .vitem per_mail
33557 .cindex "rate limiting" per_conn
33558 This option limits the client's rate of sending messages. This is
33559 the default if none of the &%per_*%& options is specified. It can be used in
33560 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33561 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33562
33563 .vitem per_byte
33564 .cindex "rate limiting" per_conn
33565 This option limits the sender's email bandwidth. It can be used in
33566 the same ACLs as the &%per_mail%& option, though it is best to use this option
33567 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33568 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33569 in its MAIL command, which may be inaccurate or completely missing. You can
33570 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33571 in kilobytes, megabytes, or gigabytes, respectively.
33572
33573 .vitem per_rcpt
33574 .cindex "rate limiting" per_rcpt
33575 This option causes Exim to limit the rate at which recipients are
33576 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33577 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33578 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33579 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33580 in either case the rate limiting engine will see a message with many
33581 recipients as a large high-speed burst.
33582
33583 .vitem per_addr
33584 .cindex "rate limiting" per_addr
33585 This option is like the &%per_rcpt%& option, except it counts the
33586 number of different recipients that the client has sent messages to in the
33587 last time period. That is, if the client repeatedly sends messages to the same
33588 recipient, its measured rate is not increased. This option can only be used in
33589 &%acl_smtp_rcpt%&.
33590
33591 .vitem per_cmd
33592 .cindex "rate limiting" per_cmd
33593 This option causes Exim to recompute the rate every time the
33594 condition is processed. This can be used to limit the rate of any SMTP
33595 command. If it is used in multiple ACLs it can limit the aggregate rate of
33596 multiple different commands.
33597
33598 .vitem count
33599 .cindex "rate limiting" count
33600 This option can be used to alter how much Exim adds to the client's
33601 measured rate.
33602 A value is required, after an equals sign.
33603 For example, the &%per_byte%& option is equivalent to
33604 &`per_mail/count=$message_size`&.
33605 If there is no &%count=%& option, Exim
33606 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33607 other than &%acl_smtp_rcpt%&).
33608 The count does not have to be an integer.
33609
33610 .vitem unique
33611 .cindex "rate limiting" unique
33612 This option is described in section &<<ratoptuniq>>& below.
33613 .endlist
33614
33615
33616 .subsection "Ratelimit update modes" ratoptupd
33617 .cindex "rate limiting" "reading data without updating"
33618 You can specify one of three options with the &%ratelimit%& condition to
33619 control when its database is updated. This section describes the &%readonly%&
33620 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33621
33622 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33623 previously-computed rate to check against the limit.
33624
33625 For example, you can test the client's sending rate and deny it access (when
33626 it is too fast) in the connect ACL. If the client passes this check then it
33627 can go on to send a message, in which case its recorded rate will be updated
33628 in the MAIL ACL. Subsequent connections from the same client will check this
33629 new rate.
33630 .code
33631 acl_check_connect:
33632  deny ratelimit = 100 / 5m / readonly
33633       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33634                   (max $sender_rate_limit)
33635 # ...
33636 acl_check_mail:
33637  warn ratelimit = 100 / 5m / strict
33638       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33639                   (max $sender_rate_limit)
33640 .endd
33641
33642 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33643 processing a message then it may increase the client's measured rate more than
33644 it should. For example, this will happen if you check the &%per_rcpt%& option
33645 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33646 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33647 multiple update problems by using the &%readonly%& option on later ratelimit
33648 checks.
33649
33650 The &%per_*%& options described above do not make sense in some ACLs. If you
33651 use a &%per_*%& option in an ACL where it is not normally permitted then the
33652 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33653 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33654 next section) so you must specify the &%readonly%& option explicitly.
33655
33656
33657 .subsection "Ratelimit options for handling fast clients" ratoptfast
33658 .cindex "rate limiting" "strict and leaky modes"
33659 If a client's average rate is greater than the maximum, the rate limiting
33660 engine can react in two possible ways, depending on the presence of the
33661 &%strict%& or &%leaky%& update modes. This is independent of the other
33662 counter-measures (such as rejecting the message) that may be specified by the
33663 rest of the ACL.
33664
33665 The &%leaky%& (default) option means that the client's recorded rate is not
33666 updated if it is above the limit. The effect of this is that Exim measures the
33667 client's average rate of successfully sent email,
33668 up to the given limit.
33669 This is appropriate if the countermeasure when the condition is true
33670 consists of refusing the message, and
33671 is generally the better choice if you have clients that retry automatically.
33672 If the action when true is anything more complex then this option is
33673 likely not what is wanted.
33674
33675 The &%strict%& option means that the client's recorded rate is always
33676 updated. The effect of this is that Exim measures the client's average rate
33677 of attempts to send email, which can be much higher than the maximum it is
33678 actually allowed. If the client is over the limit it may be subjected to
33679 counter-measures by the ACL. It must slow down and allow sufficient time to
33680 pass that its computed rate falls below the maximum before it can send email
33681 again. The time (the number of smoothing periods) it must wait and not
33682 attempt to send mail can be calculated with this formula:
33683 .code
33684         ln(peakrate/maxrate)
33685 .endd
33686
33687
33688 .subsection "Limiting the rate of different events" ratoptuniq
33689 .cindex "rate limiting" "counting unique events"
33690 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33691 rate of different events. For example, the &%per_addr%& option uses this
33692 mechanism to count the number of different recipients that the client has
33693 sent messages to in the last time period; it is equivalent to
33694 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33695 measure the rate that a client uses different sender addresses with the
33696 options &`per_mail/unique=$sender_address`&.
33697
33698 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33699 has seen for that key. The whole set is thrown away when it is older than the
33700 rate smoothing period &'p'&, so each different event is counted at most once
33701 per period. In the &%leaky%& update mode, an event that causes the client to
33702 go over the limit is not added to the set, in the same way that the client's
33703 recorded rate is not updated in the same situation.
33704
33705 When you combine the &%unique=%& and &%readonly%& options, the specific
33706 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33707 rate.
33708
33709 The &%unique=%& mechanism needs more space in the ratelimit database than the
33710 other &%ratelimit%& options in order to store the event set. The number of
33711 unique values is potentially as large as the rate limit, so the extra space
33712 required increases with larger limits.
33713
33714 The uniqueification is not perfect: there is a small probability that Exim
33715 will think a new event has happened before. If the sender's rate is less than
33716 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33717 the measured rate can go above the limit, in which case Exim may under-count
33718 events by a significant margin. Fortunately, if the rate is high enough (2.7
33719 times the limit) that the false positive rate goes above 9%, then Exim will
33720 throw away the over-full event set before the measured rate falls below the
33721 limit. Therefore the only harm should be that exceptionally high sending rates
33722 are logged incorrectly; any countermeasures you configure will be as effective
33723 as intended.
33724
33725
33726 .subsection "Using rate limiting" useratlim
33727 Exim's other ACL facilities are used to define what counter-measures are taken
33728 when the rate limit is exceeded. This might be anything from logging a warning
33729 (for example, while measuring existing sending rates in order to define
33730 policy), through time delays to slow down fast senders, up to rejecting the
33731 message. For example:
33732 .code
33733 # Log all senders' rates
33734 warn ratelimit = 0 / 1h / strict
33735      log_message = Sender rate $sender_rate / $sender_rate_period
33736
33737 # Slow down fast senders; note the need to truncate $sender_rate
33738 # at the decimal point.
33739 warn ratelimit = 100 / 1h / per_rcpt / strict
33740      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33741                    $sender_rate_limit }s
33742
33743 # Keep authenticated users under control
33744 deny authenticated = *
33745      ratelimit = 100 / 1d / strict / $authenticated_id
33746
33747 # System-wide rate limit
33748 defer ratelimit = 10 / 1s / $primary_hostname
33749       message = Sorry, too busy. Try again later.
33750
33751 # Restrict incoming rate from each host, with a default
33752 # set using a macro and special cases looked up in a table.
33753 defer ratelimit = ${lookup {$sender_host_address} \
33754                    cdb {DB/ratelimits.cdb} \
33755                    {$value} {RATELIMIT} }
33756       message = Sender rate exceeds $sender_rate_limit \
33757                messages per $sender_rate_period
33758 .endd
33759 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33760 especially with the &%per_rcpt%& option, you may suffer from a performance
33761 bottleneck caused by locking on the ratelimit hints database. Apart from
33762 making your ACLs less complicated, you can reduce the problem by using a
33763 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33764 this means that Exim will lose its hints data after a reboot (including retry
33765 hints, the callout cache, and ratelimit data).
33766
33767
33768
33769 .section "Address verification" "SECTaddressverification"
33770 .cindex "verifying address" "options for"
33771 .cindex "policy control" "address verification"
33772 Several of the &%verify%& conditions described in section
33773 &<<SECTaclconditions>>& cause addresses to be verified. Section
33774 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33775 The verification conditions can be followed by options that modify the
33776 verification process. The options are separated from the keyword and from each
33777 other by slashes, and some of them contain parameters. For example:
33778 .code
33779 verify = sender/callout
33780 verify = recipient/defer_ok/callout=10s,defer_ok
33781 .endd
33782 The first stage of address verification, which always happens, is to run the
33783 address through the routers, in &"verify mode"&. Routers can detect the
33784 difference between verification and routing for delivery, and their actions can
33785 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33786 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33787 The available options are as follows:
33788
33789 .ilist
33790 If the &%callout%& option is specified, successful routing to one or more
33791 remote hosts is followed by a &"callout"& to those hosts as an additional
33792 check. Callouts and their sub-options are discussed in the next section.
33793 .next
33794 If there is a defer error while doing verification routing, the ACL
33795 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33796 options, the condition is forced to be true instead. Note that this is a main
33797 verification option as well as a suboption for callouts.
33798 .next
33799 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33800 discusses the reporting of sender address verification failures.
33801 .next
33802 The &%success_on_redirect%& option causes verification always to succeed
33803 immediately after a successful redirection. By default, if a redirection
33804 generates just one address, that address is also verified. See further
33805 discussion in section &<<SECTredirwhilveri>>&.
33806 .next
33807 If the &%quota%& option is specified for recipient verify,
33808 successful routing to an appendfile transport is followed by a call into
33809 the transport to evaluate the quota status for the recipient.
33810 No actual delivery is done, but verification will succeed if the quota
33811 is sufficient for the message (if the sender gave a message size) or
33812 not already exceeded (otherwise).
33813 .endlist
33814
33815 .cindex "verifying address" "differentiating failures"
33816 .vindex "&$recipient_verify_failure$&"
33817 .vindex "&$sender_verify_failure$&"
33818 .vindex "&$acl_verify_message$&"
33819 After an address verification failure, &$acl_verify_message$& contains the
33820 error message that is associated with the failure. It can be preserved by
33821 coding like this:
33822 .code
33823 warn  !verify = sender
33824        set acl_m0 = $acl_verify_message
33825 .endd
33826 If you are writing your own custom rejection message or log message when
33827 denying access, you can use this variable to include information about the
33828 verification failure.
33829 This variable is cleared at the end of processing the ACL verb.
33830
33831 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33832 appropriate) contains one of the following words:
33833
33834 .ilist
33835 &%qualify%&: The address was unqualified (no domain), and the message
33836 was neither local nor came from an exempted host.
33837 .next
33838 &%route%&: Routing failed.
33839 .next
33840 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33841 occurred at or before the MAIL command (that is, on initial
33842 connection, HELO, or MAIL).
33843 .next
33844 &%recipient%&: The RCPT command in a callout was rejected.
33845 .next
33846 &%postmaster%&: The postmaster check in a callout was rejected.
33847 .next
33848 &%quota%&: The quota check for a local recipient did non pass.
33849 .endlist
33850
33851 The main use of these variables is expected to be to distinguish between
33852 rejections of MAIL and rejections of RCPT in callouts.
33853
33854 The above variables may also be set after a &*successful*&
33855 address verification to:
33856
33857 .ilist
33858 &%random%&: A random local-part callout succeeded
33859 .endlist
33860
33861
33862
33863
33864 .section "Callout verification" "SECTcallver"
33865 .cindex "verifying address" "by callout"
33866 .cindex "callout" "verification"
33867 .cindex "SMTP" "callout verification"
33868 For non-local addresses, routing verifies the domain, but is unable to do any
33869 checking of the local part. There are situations where some means of verifying
33870 the local part is desirable. One way this can be done is to make an SMTP
33871 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33872 a subsequent host for a recipient address, to see if the host accepts the
33873 address. We use the term &'callout'& to cover both cases. Note that for a
33874 sender address, the callback is not to the client host that is trying to
33875 deliver the message, but to one of the hosts that accepts incoming mail for the
33876 sender's domain.
33877
33878 Exim does not do callouts by default. If you want them to happen, you must
33879 request them by setting appropriate options on the &%verify%& condition, as
33880 described below. This facility should be used with care, because it can add a
33881 lot of resource usage to the cost of verifying an address. However, Exim does
33882 cache the results of callouts, which helps to reduce the cost. Details of
33883 caching are in section &<<SECTcallvercache>>&.
33884
33885 Recipient callouts are usually used only between hosts that are controlled by
33886 the same administration. For example, a corporate gateway host could use
33887 callouts to check for valid recipients on an internal mailserver. A successful
33888 callout does not guarantee that a real delivery to the address would succeed;
33889 on the other hand, a failing callout does guarantee that a delivery would fail.
33890
33891 If the &%callout%& option is present on a condition that verifies an address, a
33892 second stage of verification occurs if the address is successfully routed to
33893 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33894 &(manualroute)& router, where the router specifies the hosts. However, if a
33895 router that does not set up hosts routes to an &(smtp)& transport with a
33896 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33897 &%hosts_override%& set, its hosts are always used, whether or not the router
33898 supplies a host list.
33899 Callouts are only supported on &(smtp)& transports.
33900
33901 The port that is used is taken from the transport, if it is specified and is a
33902 remote transport. (For routers that do verification only, no transport need be
33903 specified.) Otherwise, the default SMTP port is used. If a remote transport
33904 specifies an outgoing interface, this is used; otherwise the interface is not
33905 specified. Likewise, the text that is used for the HELO command is taken from
33906 the transport's &%helo_data%& option; if there is no transport, the value of
33907 &$smtp_active_hostname$& is used.
33908
33909 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33910 test whether a bounce message could be delivered to the sender address. The
33911 following SMTP commands are sent:
33912 .display
33913 &`HELO `&<&'local host name'&>
33914 &`MAIL FROM:<>`&
33915 &`RCPT TO:`&<&'the address to be tested'&>
33916 &`QUIT`&
33917 .endd
33918 LHLO is used instead of HELO if the transport's &%protocol%& option is
33919 set to &"lmtp"&.
33920
33921 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33922 settings.
33923
33924 A recipient callout check is similar. By default, it also uses an empty address
33925 for the sender. This default is chosen because most hosts do not make use of
33926 the sender address when verifying a recipient. Using the same address means
33927 that a single cache entry can be used for each recipient. Some sites, however,
33928 do make use of the sender address when verifying. These are catered for by the
33929 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33930
33931 If the response to the RCPT command is a 2&'xx'& code, the verification
33932 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33933 Exim tries the next host, if any. If there is a problem with all the remote
33934 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33935 &%callout%& option is given, in which case the condition is forced to succeed.
33936
33937 .cindex "SMTP" "output flushing, disabling for callout"
33938 A callout may take a little time. For this reason, Exim normally flushes SMTP
33939 output before performing a callout in an ACL, to avoid unexpected timeouts in
33940 clients when the SMTP PIPELINING extension is in use. The flushing can be
33941 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33942
33943 .cindex "tainted data" "de-tainting"
33944 .cindex "de-tainting" "using recipient verify"
33945 A recipient callout which gets a 2&'xx'& code
33946 will assign untainted values to the
33947 &$domain_data$& and &$local_part_data$& variables,
33948 corresponding to the domain and local parts of the recipient address.
33949
33950
33951
33952
33953 .subsection "Additional parameters for callouts" CALLaddparcall
33954 .cindex "callout" "additional parameters for"
33955 The &%callout%& option can be followed by an equals sign and a number of
33956 optional parameters, separated by commas. For example:
33957 .code
33958 verify = recipient/callout=10s,defer_ok
33959 .endd
33960 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33961 separate verify options, is retained for backwards compatibility, but is now
33962 deprecated. The additional parameters for &%callout%& are as follows:
33963
33964
33965 .vlist
33966 .vitem <&'a&~time&~interval'&>
33967 .cindex "callout" "timeout, specifying"
33968 This specifies the timeout that applies for the callout attempt to each host.
33969 For example:
33970 .code
33971 verify = sender/callout=5s
33972 .endd
33973 The default is 30 seconds. The timeout is used for each response from the
33974 remote host. It is also used for the initial connection, unless overridden by
33975 the &%connect%& parameter.
33976
33977
33978 .vitem &*connect&~=&~*&<&'time&~interval'&>
33979 .cindex "callout" "connection timeout, specifying"
33980 This parameter makes it possible to set a different (usually smaller) timeout
33981 for making the SMTP connection. For example:
33982 .code
33983 verify = sender/callout=5s,connect=1s
33984 .endd
33985 If not specified, this timeout defaults to the general timeout value.
33986
33987 .vitem &*defer_ok*&
33988 .cindex "callout" "defer, action on"
33989 When this parameter is present, failure to contact any host, or any other kind
33990 of temporary error, is treated as success by the ACL. However, the cache is not
33991 updated in this circumstance.
33992
33993 .vitem &*fullpostmaster*&
33994 .cindex "callout" "full postmaster check"
33995 This operates like the &%postmaster%& option (see below), but if the check for
33996 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33997 accordance with the specification in RFC 2821. The RFC states that the
33998 unqualified address &'postmaster'& should be accepted.
33999
34000
34001 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
34002 .cindex "callout" "sender when verifying header"
34003 When verifying addresses in header lines using the &%header_sender%&
34004 verification option, Exim behaves by default as if the addresses are envelope
34005 sender addresses from a message. Callout verification therefore tests to see
34006 whether a bounce message could be delivered, by using an empty address in the
34007 MAIL command. However, it is arguable that these addresses might never be used
34008 as envelope senders, and could therefore justifiably reject bounce messages
34009 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
34010 address to use in the MAIL command. For example:
34011 .code
34012 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
34013 .endd
34014 This parameter is available only for the &%header_sender%& verification option.
34015
34016
34017 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
34018 .cindex "callout" "overall timeout, specifying"
34019 This parameter sets an overall timeout for performing a callout verification.
34020 For example:
34021 .code
34022 verify = sender/callout=5s,maxwait=30s
34023 .endd
34024 This timeout defaults to four times the callout timeout for individual SMTP
34025 commands. The overall timeout applies when there is more than one host that can
34026 be tried. The timeout is checked before trying the next host. This prevents
34027 very long delays if there are a large number of hosts and all are timing out
34028 (for example, when network connections are timing out).
34029
34030
34031 .vitem &*no_cache*&
34032 .cindex "callout" "cache, suppressing"
34033 .cindex "caching callout, suppressing"
34034 When this parameter is given, the callout cache is neither read nor updated.
34035
34036 .vitem &*postmaster*&
34037 .cindex "callout" "postmaster; checking"
34038 When this parameter is set, a successful callout check is followed by a similar
34039 check for the local part &'postmaster'& at the same domain. If this address is
34040 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
34041 the postmaster check is recorded in a cache record; if it is a failure, this is
34042 used to fail subsequent callouts for the domain without a connection being
34043 made, until the cache record expires.
34044
34045 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
34046 The postmaster check uses an empty sender in the MAIL command by default.
34047 You can use this parameter to do a postmaster check using a different address.
34048 For example:
34049 .code
34050 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
34051 .endd
34052 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
34053 one overrides. The &%postmaster%& parameter is equivalent to this example:
34054 .code
34055 require  verify = sender/callout=postmaster_mailfrom=
34056 .endd
34057 &*Warning*&: The caching arrangements for postmaster checking do not take
34058 account of the sender address. It is assumed that either the empty address or
34059 a fixed non-empty address will be used. All that Exim remembers is that the
34060 postmaster check for the domain succeeded or failed.
34061
34062
34063 .vitem &*random*&
34064 .cindex "callout" "&""random""& check"
34065 When this parameter is set, before doing the normal callout check, Exim does a
34066 check for a &"random"& local part at the same domain. The local part is not
34067 really random &-- it is defined by the expansion of the option
34068 &%callout_random_local_part%&, which defaults to
34069 .code
34070 $primary_hostname-$tod_epoch-testing
34071 .endd
34072 The idea here is to try to determine whether the remote host accepts all local
34073 parts without checking. If it does, there is no point in doing callouts for
34074 specific local parts. If the &"random"& check succeeds, the result is saved in
34075 a cache record, and used to force the current and subsequent callout checks to
34076 succeed without a connection being made, until the cache record expires.
34077
34078 .vitem &*use_postmaster*&
34079 .cindex "callout" "sender for recipient check"
34080 This parameter applies to recipient callouts only. For example:
34081 .code
34082 deny  !verify = recipient/callout=use_postmaster
34083 .endd
34084 .vindex "&$qualify_domain$&"
34085 It causes a non-empty postmaster address to be used in the MAIL command when
34086 performing the callout for the recipient, and also for a &"random"& check if
34087 that is configured. The local part of the address is &`postmaster`& and the
34088 domain is the contents of &$qualify_domain$&.
34089
34090 .vitem &*use_sender*&
34091 This option applies to recipient callouts only. For example:
34092 .code
34093 require  verify = recipient/callout=use_sender
34094 .endd
34095 It causes the message's actual sender address to be used in the MAIL
34096 command when performing the callout, instead of an empty address. There is no
34097 need to use this option unless you know that the called hosts make use of the
34098 sender when checking recipients. If used indiscriminately, it reduces the
34099 usefulness of callout caching.
34100
34101 .vitem &*hold*&
34102 This option applies to recipient callouts only. For example:
34103 .code
34104 require  verify = recipient/callout=use_sender,hold
34105 .endd
34106 It causes the connection to be held open and used for any further recipients
34107 and for eventual delivery (should that be done quickly).
34108 Doing this saves on TCP and SMTP startup costs, and TLS costs also
34109 when that is used for the connections.
34110 The advantage is only gained if there are no callout cache hits
34111 (which could be enforced by the no_cache option),
34112 if the use_sender option is used,
34113 if neither the random nor the use_postmaster option is used,
34114 and if no other callouts intervene.
34115 .endlist
34116
34117 If you use any of the parameters that set a non-empty sender for the MAIL
34118 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
34119 &%use_sender%&), you should think about possible loops. Recipient checking is
34120 usually done between two hosts that are under the same management, and the host
34121 that receives the callouts is not normally configured to do callouts itself.
34122 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
34123 these circumstances.
34124
34125 However, if you use a non-empty sender address for a callout to an arbitrary
34126 host, there is the likelihood that the remote host will itself initiate a
34127 callout check back to your host. As it is checking what appears to be a message
34128 sender, it is likely to use an empty address in MAIL, thus avoiding a
34129 callout loop. However, to be on the safe side it would be best to set up your
34130 own ACLs so that they do not do sender verification checks when the recipient
34131 is the address you use for header sender or postmaster callout checking.
34132
34133 Another issue to think about when using non-empty senders for callouts is
34134 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
34135 by the sender/recipient combination; thus, for any given recipient, many more
34136 actual callouts are performed than when an empty sender or postmaster is used.
34137
34138
34139
34140
34141 .subsection "Callout caching" SECTcallvercache
34142 .cindex "hints database" "callout cache"
34143 .cindex "callout" "cache, description of"
34144 .cindex "caching" "callout"
34145 Exim caches the results of callouts in order to reduce the amount of resources
34146 used, unless you specify the &%no_cache%& parameter with the &%callout%&
34147 option. A hints database called &"callout"& is used for the cache. Two
34148 different record types are used: one records the result of a callout check for
34149 a specific address, and the other records information that applies to the
34150 entire domain (for example, that it accepts the local part &'postmaster'&).
34151
34152 When an original callout fails, a detailed SMTP error message is given about
34153 the failure. However, for subsequent failures that use the cache data, this message
34154 is not available.
34155
34156 The expiry times for negative and positive address cache records are
34157 independent, and can be set by the global options &%callout_negative_expire%&
34158 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
34159
34160 If a host gives a negative response to an SMTP connection, or rejects any
34161 commands up to and including
34162 .code
34163 MAIL FROM:<>
34164 .endd
34165 (but not including the MAIL command with a non-empty address),
34166 any callout attempt is bound to fail. Exim remembers such failures in a
34167 domain cache record, which it uses to fail callouts for the domain without
34168 making new connections, until the domain record times out. There are two
34169 separate expiry times for domain cache records:
34170 &%callout_domain_negative_expire%& (default 3h) and
34171 &%callout_domain_positive_expire%& (default 7d).
34172
34173 Domain records expire when the negative expiry time is reached if callouts
34174 cannot be made for the domain, or if the postmaster check failed.
34175 Otherwise, they expire when the positive expiry time is reached. This
34176 ensures that, for example, a host that stops accepting &"random"& local parts
34177 will eventually be noticed.
34178
34179 The callout caching mechanism is based on the domain of the address that is
34180 being tested. If the domain routes to several hosts, it is assumed that their
34181 behaviour will be the same.
34182
34183
34184
34185 .section "Quota caching" "SECTquotacache"
34186 .cindex "hints database" "quota cache"
34187 .cindex "quota" "cache, description of"
34188 .cindex "caching" "quota"
34189 Exim caches the results of quota verification
34190 in order to reduce the amount of resources used.
34191 The &"callout"& hints database is used.
34192
34193 The default cache periods are five minutes for a positive (good) result
34194 and one hour for a negative result.
34195 To change the periods the &%quota%& option can be followed by an equals sign
34196 and a number of optional paramemters, separated by commas.
34197 For example:
34198 .code
34199 verify = recipient/quota=cachepos=1h,cacheneg=1d
34200 .endd
34201 Possible parameters are:
34202 .vlist
34203 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
34204 .cindex "quota cache" "positive entry expiry, specifying"
34205 Set the lifetime for a positive cache entry.
34206 A value of zero seconds is legitimate.
34207
34208 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
34209 .cindex "quota cache" "negative entry expiry, specifying"
34210 As above, for a negative entry.
34211
34212 .vitem &*no_cache*&
34213 Set both positive and negative lifetimes to zero.
34214
34215 .section "Sender address verification reporting" "SECTsenaddver"
34216 .cindex "verifying" "suppressing error details"
34217 See section &<<SECTaddressverification>>& for a general discussion of
34218 verification. When sender verification fails in an ACL, the details of the
34219 failure are given as additional output lines before the 550 response to the
34220 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
34221 you might see:
34222 .code
34223 MAIL FROM:<xyz@abc.example>
34224 250 OK
34225 RCPT TO:<pqr@def.example>
34226 550-Verification failed for <xyz@abc.example>
34227 550-Called:   192.168.34.43
34228 550-Sent:     RCPT TO:<xyz@abc.example>
34229 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
34230 550 Sender verification failed
34231 .endd
34232 If more than one RCPT command fails in the same way, the details are given
34233 only for the first of them. However, some administrators do not want to send
34234 out this much information. You can suppress the details by adding
34235 &`/no_details`& to the ACL statement that requests sender verification. For
34236 example:
34237 .code
34238 verify = sender/no_details
34239 .endd
34240
34241 .section "Redirection while verifying" "SECTredirwhilveri"
34242 .cindex "verifying" "redirection while"
34243 .cindex "address redirection" "while verifying"
34244 A dilemma arises when a local address is redirected by aliasing or forwarding
34245 during verification: should the generated addresses themselves be verified,
34246 or should the successful expansion of the original address be enough to verify
34247 it? By default, Exim takes the following pragmatic approach:
34248
34249 .ilist
34250 When an incoming address is redirected to just one child address, verification
34251 continues with the child address, and if that fails to verify, the original
34252 verification also fails.
34253 .next
34254 When an incoming address is redirected to more than one child address,
34255 verification does not continue. A success result is returned.
34256 .endlist
34257
34258 This seems the most reasonable behaviour for the common use of aliasing as a
34259 way of redirecting different local parts to the same mailbox. It means, for
34260 example, that a pair of alias entries of the form
34261 .code
34262 A.Wol:   aw123
34263 aw123:   :fail: Gone away, no forwarding address
34264 .endd
34265 work as expected, with both local parts causing verification failure. When a
34266 redirection generates more than one address, the behaviour is more like a
34267 mailing list, where the existence of the alias itself is sufficient for
34268 verification to succeed.
34269
34270 It is possible, however, to change the default behaviour so that all successful
34271 redirections count as successful verifications, however many new addresses are
34272 generated. This is specified by the &%success_on_redirect%& verification
34273 option. For example:
34274 .code
34275 require verify = recipient/success_on_redirect/callout=10s
34276 .endd
34277 In this example, verification succeeds if a router generates a new address, and
34278 the callout does not occur, because no address was routed to a remote host.
34279
34280 When verification is being tested via the &%-bv%& option, the treatment of
34281 redirections is as just described, unless the &%-v%& or any debugging option is
34282 also specified. In that case, full verification is done for every generated
34283 address and a report is output for each of them.
34284
34285
34286
34287 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34288 .cindex "CSA" "verifying"
34289 Client SMTP Authorization is a system that allows a site to advertise
34290 which machines are and are not permitted to send email. This is done by placing
34291 special SRV records in the DNS; these are looked up using the client's HELO
34292 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34293 Authorization checks in Exim are performed by the ACL condition:
34294 .code
34295 verify = csa
34296 .endd
34297 This fails if the client is not authorized. If there is a DNS problem, or if no
34298 valid CSA SRV record is found, or if the client is authorized, the condition
34299 succeeds. These three cases can be distinguished using the expansion variable
34300 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34301 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34302 be likely to cause problems for legitimate email.
34303
34304 The error messages produced by the CSA code include slightly more
34305 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34306 looking up the CSA SRV record, or problems looking up the CSA target
34307 address record. There are four reasons for &$csa_status$& being &"fail"&:
34308
34309 .ilist
34310 The client's host name is explicitly not authorized.
34311 .next
34312 The client's IP address does not match any of the CSA target IP addresses.
34313 .next
34314 The client's host name is authorized but it has no valid target IP addresses
34315 (for example, the target's addresses are IPv6 and the client is using IPv4).
34316 .next
34317 The client's host name has no CSA SRV record but a parent domain has asserted
34318 that all subdomains must be explicitly authorized.
34319 .endlist
34320
34321 The &%csa%& verification condition can take an argument which is the domain to
34322 use for the DNS query. The default is:
34323 .code
34324 verify = csa/$sender_helo_name
34325 .endd
34326 This implementation includes an extension to CSA. If the query domain
34327 is an address literal such as [192.0.2.95], or if it is a bare IP
34328 address, Exim searches for CSA SRV records in the reverse DNS as if
34329 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34330 meaningful to say:
34331 .code
34332 verify = csa/$sender_host_address
34333 .endd
34334 In fact, this is the check that Exim performs if the client does not say HELO.
34335 This extension can be turned off by setting the main configuration option
34336 &%dns_csa_use_reverse%& to be false.
34337
34338 If a CSA SRV record is not found for the domain itself, a search
34339 is performed through its parent domains for a record which might be
34340 making assertions about subdomains. The maximum depth of this search is limited
34341 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34342 default. Exim does not look for CSA SRV records in a top level domain, so the
34343 default settings handle HELO domains as long as seven
34344 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34345 of legitimate HELO domains.
34346
34347 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34348 direct SRV lookups, this is not sufficient because of the extra parent domain
34349 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34350 addresses into lookups in the reverse DNS space. The result of a successful
34351 lookup such as:
34352 .code
34353 ${lookup dnsdb {csa=$sender_helo_name}}
34354 .endd
34355 has two space-separated fields: an authorization code and a target host name.
34356 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34357 authorization required but absent, or &"?"& for unknown.
34358
34359
34360
34361
34362 .section "Bounce address tag validation" "SECTverifyPRVS"
34363 .cindex "BATV, verifying"
34364 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34365 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34366 Genuine incoming bounce messages should therefore always be addressed to
34367 recipients that have a valid tag. This scheme is a way of detecting unwanted
34368 bounce messages caused by sender address forgeries (often called &"collateral
34369 spam"&), because the recipients of such messages do not include valid tags.
34370
34371 There are two expansion items to help with the implementation of the BATV
34372 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34373 the original envelope sender address by using a simple key to add a hash of the
34374 address and some time-based randomizing information. The &%prvs%& expansion
34375 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34376 The syntax of these expansion items is described in section
34377 &<<SECTexpansionitems>>&.
34378 The validity period on signed addresses is seven days.
34379
34380 As an example, suppose the secret per-address keys are stored in an MySQL
34381 database. A query to look up the key for an address could be defined as a macro
34382 like this:
34383 .code
34384 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34385                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34386                 }{$value}}
34387 .endd
34388 Suppose also that the senders who make use of BATV are defined by an address
34389 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34390 use this:
34391 .code
34392 # Bounces: drop unsigned addresses for BATV senders
34393 deny senders = :
34394      recipients = +batv_senders
34395      message = This address does not send an unsigned reverse path
34396
34397 # Bounces: In case of prvs-signed address, check signature.
34398 deny senders = :
34399      condition  = ${prvscheck {$local_part@$domain}\
34400                   {PRVSCHECK_SQL}{1}}
34401      !condition = $prvscheck_result
34402      message = Invalid reverse path signature.
34403 .endd
34404 The first statement rejects recipients for bounce messages that are addressed
34405 to plain BATV sender addresses, because it is known that BATV senders do not
34406 send out messages with plain sender addresses. The second statement rejects
34407 recipients that are prvs-signed, but with invalid signatures (either because
34408 the key is wrong, or the signature has timed out).
34409
34410 A non-prvs-signed address is not rejected by the second statement, because the
34411 &%prvscheck%& expansion yields an empty string if its first argument is not a
34412 prvs-signed address, thus causing the &%condition%& condition to be false. If
34413 the first argument is a syntactically valid prvs-signed address, the yield is
34414 the third string (in this case &"1"&), whether or not the cryptographic and
34415 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34416 of the checks (empty for failure, &"1"& for success).
34417
34418 There is one more issue you must consider when implementing prvs-signing:
34419 you have to ensure that the routers accept prvs-signed addresses and
34420 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34421 router to remove the signature with a configuration along these lines:
34422 .code
34423 batv_redirect:
34424   driver = redirect
34425   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34426 .endd
34427 This works because, if the third argument of &%prvscheck%& is empty, the result
34428 of the expansion of a prvs-signed address is the decoded value of the original
34429 address. This router should probably be the first of your routers that handles
34430 local addresses.
34431
34432 To create BATV-signed addresses in the first place, a transport of this form
34433 can be used:
34434 .code
34435 external_smtp_batv:
34436   driver = smtp
34437   return_path = ${prvs {$return_path} \
34438                        {${lookup mysql{SELECT \
34439                        secret FROM batv_prvs WHERE \
34440                        sender='${quote_mysql:$sender_address}'} \
34441                        {$value}fail}}}
34442 .endd
34443 If no key can be found for the existing return path, no signing takes place.
34444
34445
34446
34447 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34448 .cindex "&ACL;" "relay control"
34449 .cindex "relaying" "control by ACL"
34450 .cindex "policy control" "relay control"
34451 An MTA is said to &'relay'& a message if it receives it from some host and
34452 delivers it directly to another host as a result of a remote address contained
34453 within it. Redirecting a local address via an alias or forward file and then
34454 passing the message on to another host is not relaying,
34455 .cindex "&""percent hack""&"
34456 but a redirection as a result of the &"percent hack"& is.
34457
34458 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34459 A host which is acting as a gateway or an MX backup is concerned with incoming
34460 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34461 a host which is acting as a smart host for a number of clients is concerned
34462 with outgoing relaying from those clients to the Internet at large. Often the
34463 same host is fulfilling both functions,
34464 . ///
34465 . as illustrated in the diagram below,
34466 . ///
34467 but in principle these two kinds of relaying are entirely independent. What is
34468 not wanted is the transmission of mail from arbitrary remote hosts through your
34469 system to arbitrary domains.
34470
34471
34472 You can implement relay control by means of suitable statements in the ACL that
34473 runs for each RCPT command. For convenience, it is often easiest to use
34474 Exim's named list facility to define the domains and hosts involved. For
34475 example, suppose you want to do the following:
34476
34477 .ilist
34478 Deliver a number of domains to mailboxes on the local host (or process them
34479 locally in some other way). Let's say these are &'my.dom1.example'& and
34480 &'my.dom2.example'&.
34481 .next
34482 Relay mail for a number of other domains for which you are the secondary MX.
34483 These might be &'friend1.example'& and &'friend2.example'&.
34484 .next
34485 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34486 Suppose your LAN is 192.168.45.0/24.
34487 .endlist
34488
34489
34490 In the main part of the configuration, you put the following definitions:
34491 .code
34492 domainlist local_domains    = my.dom1.example : my.dom2.example
34493 domainlist relay_to_domains = friend1.example : friend2.example
34494 hostlist   relay_from_hosts = 192.168.45.0/24
34495 .endd
34496 Now you can use these definitions in the ACL that is run for every RCPT
34497 command:
34498 .code
34499 acl_check_rcpt:
34500   accept domains = +local_domains : +relay_to_domains
34501   accept hosts   = +relay_from_hosts
34502 .endd
34503 The first statement accepts any RCPT command that contains an address in
34504 the local or relay domains. For any other domain, control passes to the second
34505 statement, which accepts the command only if it comes from one of the relay
34506 hosts. In practice, you will probably want to make your ACL more sophisticated
34507 than this, for example, by including sender and recipient verification. The
34508 default configuration includes a more comprehensive example, which is described
34509 in chapter &<<CHAPdefconfil>>&.
34510
34511
34512
34513 .section "Checking a relay configuration" "SECTcheralcon"
34514 .cindex "relaying" "checking control of"
34515 You can check the relay characteristics of your configuration in the same way
34516 that you can test any ACL behaviour for an incoming SMTP connection, by using
34517 the &%-bh%& option to run a fake SMTP session with which you interact.
34518 .ecindex IIDacl
34519
34520
34521
34522 . ////////////////////////////////////////////////////////////////////////////
34523 . ////////////////////////////////////////////////////////////////////////////
34524
34525 .chapter "Content scanning at ACL time" "CHAPexiscan"
34526 .scindex IIDcosca "content scanning" "at ACL time"
34527 The extension of Exim to include content scanning at ACL time, formerly known
34528 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34529 was integrated into the main source for Exim release 4.50, and Tom continues to
34530 maintain it. Most of the wording of this chapter is taken from Tom's
34531 specification.
34532
34533 It is also possible to scan the content of messages at other times. The
34534 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34535 scanning after all the ACLs have run. A transport filter can be used to scan
34536 messages at delivery time (see the &%transport_filter%& option, described in
34537 chapter &<<CHAPtransportgeneric>>&).
34538
34539 If you want to include the ACL-time content-scanning features when you compile
34540 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34541 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34542
34543 .ilist
34544 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34545 for all MIME parts for SMTP and non-SMTP messages, respectively.
34546 .next
34547 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34548 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34549 run at the end of message reception (the &%acl_smtp_data%& ACL).
34550 .next
34551 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34552 of messages, or parts of messages, for debugging purposes.
34553 .next
34554 Additional expansion variables that are set in the new ACL and by the new
34555 conditions.
34556 .next
34557 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34558 .endlist
34559
34560 Content-scanning is continually evolving, and new features are still being
34561 added. While such features are still unstable and liable to incompatible
34562 changes, they are made available in Exim by setting options whose names begin
34563 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34564 this manual. You can find out about them by reading the file called
34565 &_doc/experimental.txt_&.
34566
34567 All the content-scanning facilities work on a MBOX copy of the message that is
34568 temporarily created in a file called:
34569 .display
34570 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34571 .endd
34572 The &_.eml_& extension is a friendly hint to virus scanners that they can
34573 expect an MBOX-like structure inside that file. The file is created when the
34574 first content scanning facility is called. Subsequent calls to content
34575 scanning conditions open the same file again. The directory is recursively
34576 removed when the &%acl_smtp_data%& ACL has finished running, unless
34577 .code
34578 control = no_mbox_unspool
34579 .endd
34580 has been encountered. When the MIME ACL decodes files, they are put into the
34581 same directory by default.
34582
34583
34584
34585 .section "Scanning for viruses" "SECTscanvirus"
34586 .cindex "virus scanning"
34587 .cindex "content scanning" "for viruses"
34588 .cindex "content scanning" "the &%malware%& condition"
34589 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34590 It supports a &"generic"& interface to scanners called via the shell, and
34591 specialized interfaces for &"daemon"& type virus scanners, which are resident
34592 in memory and thus are much faster.
34593
34594 Since message data needs to have arrived,
34595 the condition may be only called in ACL defined by
34596 &%acl_smtp_data%&,
34597 &%acl_smtp_data_prdr%&,
34598 &%acl_smtp_mime%& or
34599 &%acl_smtp_dkim%&
34600
34601 A timeout of 2 minutes is applied to a scanner call (by default);
34602 if it expires then a defer action is taken.
34603
34604 .oindex "&%av_scanner%&"
34605 You can set the &%av_scanner%& option in the main part of the configuration
34606 to specify which scanner to use, together with any additional options that
34607 are needed. The basic syntax is as follows:
34608 .display
34609 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34610 .endd
34611 If you do not set &%av_scanner%&, it defaults to
34612 .code
34613 av_scanner = sophie:/var/run/sophie
34614 .endd
34615 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34616 before use.
34617 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34618 The following scanner types are supported in this release,
34619 though individual ones can be included or not at build time:
34620
34621 .vlist
34622 .vitem &%avast%&
34623 .cindex "virus scanners" "avast"
34624 This is the scanner daemon of Avast. It has been tested with Avast Core
34625 Security (currently at version 2.2.0).
34626 You can get a trial version at &url(https://www.avast.com) or for Linux
34627 at &url(https://www.avast.com/linux-server-antivirus).
34628 This scanner type takes one option,
34629 which can be either a full path to a UNIX socket,
34630 or host and port specifiers separated by white space.
34631 The host may be a name or an IP address; the port is either a
34632 single number or a pair of numbers with a dash between.
34633 A list of options may follow. These options are interpreted on the
34634 Exim's side of the malware scanner, or are given on separate lines to
34635 the daemon as options before the main scan command.
34636
34637 .cindex &`pass_unscanned`& "avast"
34638 If &`pass_unscanned`&
34639 is set, any files the Avast scanner can't scan (e.g.
34640 decompression bombs, or invalid archives) are considered clean. Use with
34641 care.
34642
34643 For example:
34644 .code
34645 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34646 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34647 av_scanner = avast:192.168.2.22 5036
34648 .endd
34649 If you omit the argument, the default path
34650 &_/var/run/avast/scan.sock_&
34651 is used.
34652 If you use a remote host,
34653 you need to make Exim's spool directory available to it,
34654 as the scanner is passed a file path, not file contents.
34655 For information about available commands and their options you may use
34656 .code
34657 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34658     FLAGS
34659     SENSITIVITY
34660     PACK
34661 .endd
34662
34663 If the scanner returns a temporary failure (e.g. license issues, or
34664 permission problems), the message is deferred and a paniclog entry is
34665 written.  The usual &`defer_ok`& option is available.
34666
34667 .vitem &%aveserver%&
34668 .cindex "virus scanners" "Kaspersky"
34669 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34670 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34671 which is the path to the daemon's UNIX socket. The default is shown in this
34672 example:
34673 .code
34674 av_scanner = aveserver:/var/run/aveserver
34675 .endd
34676
34677
34678 .vitem &%clamd%&
34679 .cindex "virus scanners" "clamd"
34680 This daemon-type scanner is GPL and free. You can get it at
34681 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34682 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34683 in the MIME ACL. This is no longer believed to be necessary.
34684
34685 The options are a list of server specifiers, which may be
34686 a UNIX socket specification,
34687 a TCP socket specification,
34688 or a (global) option.
34689
34690 A socket specification consists of a space-separated list.
34691 For a Unix socket the first element is a full path for the socket,
34692 for a TCP socket the first element is the IP address
34693 and the second a port number,
34694 Any further elements are per-server (non-global) options.
34695 These per-server options are supported:
34696 .code
34697 retry=<timespec>        Retry on connect fail
34698 .endd
34699
34700 The &`retry`& option specifies a time after which a single retry for
34701 a failed connect is made.  The default is to not retry.
34702
34703 If a Unix socket file is specified, only one server is supported.
34704
34705 Examples:
34706 .code
34707 av_scanner = clamd:/opt/clamd/socket
34708 av_scanner = clamd:192.0.2.3 1234
34709 av_scanner = clamd:192.0.2.3 1234:local
34710 av_scanner = clamd:192.0.2.3 1234 retry=10s
34711 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34712 .endd
34713 If the value of av_scanner points to a UNIX socket file or contains the
34714 &`local`&
34715 option, then the ClamAV interface will pass a filename containing the data
34716 to be scanned, which should normally result in less I/O happening and be
34717 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34718 Exim does not assume that there is a common filesystem with the remote host.
34719
34720 The final example shows that multiple TCP targets can be specified.  Exim will
34721 randomly use one for each incoming email (i.e. it load balances them).  Note
34722 that only TCP targets may be used if specifying a list of scanners; a UNIX
34723 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34724 unavailable, Exim will try the remaining one(s) until it finds one that works.
34725 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34726 not keep track of scanner state between multiple messages, and the scanner
34727 selection is random, so the message will get logged in the mainlog for each
34728 email that the down scanner gets chosen first (message wrapped to be readable):
34729 .code
34730 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34731    clamd: connection to localhost, port 3310 failed
34732    (Connection refused)
34733 .endd
34734
34735 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34736 contributing the code for this scanner.
34737
34738 .vitem &%cmdline%&
34739 .cindex "virus scanners" "command line interface"
34740 This is the keyword for the generic command line scanner interface. It can be
34741 used to attach virus scanners that are invoked from the shell. This scanner
34742 type takes 3 mandatory options:
34743
34744 .olist
34745 The full path and name of the scanner binary, with all command line options,
34746 and a placeholder (&`%s`&) for the directory to scan.
34747
34748 .next
34749 A regular expression to match against the STDOUT and STDERR output of the
34750 virus scanner. If the expression matches, a virus was found. You must make
34751 absolutely sure that this expression matches on &"virus found"&. This is called
34752 the &"trigger"& expression.
34753
34754 .next
34755 Another regular expression, containing exactly one pair of parentheses, to
34756 match the name of the virus found in the scanners output. This is called the
34757 &"name"& expression.
34758 .endlist olist
34759
34760 For example, Sophos Sweep reports a virus on a line like this:
34761 .code
34762 Virus 'W32/Magistr-B' found in file ./those.bat
34763 .endd
34764 For the trigger expression, we can match the phrase &"found in file"&. For the
34765 name expression, we want to extract the W32/Magistr-B string, so we can match
34766 for the single quotes left and right of it. Altogether, this makes the
34767 configuration setting:
34768 .code
34769 av_scanner = cmdline:\
34770              /path/to/sweep -ss -all -rec -archive %s:\
34771              found in file:'(.+)'
34772 .endd
34773 .vitem &%drweb%&
34774 .cindex "virus scanners" "DrWeb"
34775 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34776 takes one option,
34777 either a full path to a UNIX socket,
34778 or host and port specifiers separated by white space.
34779 The host may be a name or an IP address; the port is either a
34780 single number or a pair of numbers with a dash between.
34781 For example:
34782 .code
34783 av_scanner = drweb:/var/run/drwebd.sock
34784 av_scanner = drweb:192.168.2.20 31337
34785 .endd
34786 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34787 is used. Thanks to Alex Miller for contributing the code for this scanner.
34788
34789 .vitem &%f-protd%&
34790 .cindex "virus scanners" "f-protd"
34791 The f-protd scanner is accessed via HTTP over TCP.
34792 One argument is taken, being a space-separated hostname and port number
34793 (or port-range).
34794 For example:
34795 .code
34796 av_scanner = f-protd:localhost 10200-10204
34797 .endd
34798 If you omit the argument, the default values shown above are used.
34799
34800 .vitem &%f-prot6d%&
34801 .cindex "virus scanners" "f-prot6d"
34802 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34803 One argument is taken, being a space-separated hostname and port number.
34804 For example:
34805 .code
34806 av_scanner = f-prot6d:localhost 10200
34807 .endd
34808 If you omit the argument, the default values show above are used.
34809
34810 .vitem &%fsecure%&
34811 .cindex "virus scanners" "F-Secure"
34812 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34813 argument which is the path to a UNIX socket. For example:
34814 .code
34815 av_scanner = fsecure:/path/to/.fsav
34816 .endd
34817 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34818 Thelmen for contributing the code for this scanner.
34819
34820 .vitem &%kavdaemon%&
34821 .cindex "virus scanners" "Kaspersky"
34822 This is the scanner daemon of Kaspersky Version 4. This version of the
34823 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34824 scanner type takes one option, which is the path to the daemon's UNIX socket.
34825 For example:
34826 .code
34827 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34828 .endd
34829 The default path is &_/var/run/AvpCtl_&.
34830
34831 .vitem &%mksd%&
34832 .cindex "virus scanners" "mksd"
34833 This was a daemon type scanner that is aimed mainly at Polish users,
34834 though some documentation was available in English.
34835 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34836 and this appears to be a candidate for removal from Exim, unless
34837 we are informed of other virus scanners which use the same protocol
34838 to integrate.
34839 The only option for this scanner type is
34840 the maximum number of processes used simultaneously to scan the attachments,
34841 provided that mksd has
34842 been run with at least the same number of child processes. For example:
34843 .code
34844 av_scanner = mksd:2
34845 .endd
34846 You can safely omit this option (the default value is 1).
34847
34848 .vitem &%sock%&
34849 .cindex "virus scanners" "simple socket-connected"
34850 This is a general-purpose way of talking to simple scanner daemons
34851 running on the local machine.
34852 There are four options:
34853 an address (which may be an IP address and port, or the path of a Unix socket),
34854 a commandline to send (may include a single %s which will be replaced with
34855 the path to the mail file to be scanned),
34856 an RE to trigger on from the returned data,
34857 and an RE to extract malware_name from the returned data.
34858 For example:
34859 .code
34860 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34861 .endd
34862 Note that surrounding whitespace is stripped from each option, meaning
34863 there is no way to specify a trailing newline.
34864 The socket specifier and both regular-expressions are required.
34865 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34866 specify an empty element to get this.
34867
34868 .vitem &%sophie%&
34869 .cindex "virus scanners" "Sophos and Sophie"
34870 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34871 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34872 for this scanner type is the path to the UNIX socket that Sophie uses for
34873 client communication. For example:
34874 .code
34875 av_scanner = sophie:/tmp/sophie
34876 .endd
34877 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34878 the option.
34879 .endlist
34880
34881 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34882 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34883 ACL.
34884
34885 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34886 makes it possible to use different scanners. See further below for an example.
34887 The &%malware%& condition caches its results, so when you use it multiple times
34888 for the same message, the actual scanning process is only carried out once.
34889 However, using expandable items in &%av_scanner%& disables this caching, in
34890 which case each use of the &%malware%& condition causes a new scan of the
34891 message.
34892
34893 The &%malware%& condition takes a right-hand argument that is expanded before
34894 use and taken as a list, slash-separated by default.
34895 The first element can then be one of
34896
34897 .ilist
34898 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34899 The condition succeeds if a virus was found, and fail otherwise. This is the
34900 recommended usage.
34901 .next
34902 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34903 the condition fails immediately.
34904 .next
34905 A regular expression, in which case the message is scanned for viruses. The
34906 condition succeeds if a virus is found and its name matches the regular
34907 expression. This allows you to take special actions on certain types of virus.
34908 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34909 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34910 .endlist
34911
34912 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34913 messages even if there is a problem with the virus scanner.
34914 Otherwise, such a problem causes the ACL to defer.
34915
34916 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34917 specify a non-default timeout.  The default is two minutes.
34918 For example:
34919 .code
34920 malware = * / defer_ok / tmo=10s
34921 .endd
34922 A timeout causes the ACL to defer.
34923
34924 .vindex "&$callout_address$&"
34925 When a connection is made to the scanner the expansion variable &$callout_address$&
34926 is set to record the actual address used.
34927
34928 .vindex "&$malware_name$&"
34929 When a virus is found, the condition sets up an expansion variable called
34930 &$malware_name$& that contains the name of the virus. You can use it in a
34931 &%message%& modifier that specifies the error returned to the sender, and/or in
34932 logging data.
34933
34934 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34935 imposed by your anti-virus scanner.
34936
34937 Here is a very simple scanning example:
34938 .code
34939 deny malware = *
34940      message = This message contains malware ($malware_name)
34941 .endd
34942 The next example accepts messages when there is a problem with the scanner:
34943 .code
34944 deny malware = */defer_ok
34945      message = This message contains malware ($malware_name)
34946 .endd
34947 The next example shows how to use an ACL variable to scan with both sophie and
34948 aveserver. It assumes you have set:
34949 .code
34950 av_scanner = $acl_m0
34951 .endd
34952 in the main Exim configuration.
34953 .code
34954 deny set acl_m0 = sophie
34955      malware = *
34956      message = This message contains malware ($malware_name)
34957
34958 deny set acl_m0 = aveserver
34959      malware = *
34960      message = This message contains malware ($malware_name)
34961 .endd
34962
34963
34964 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34965 .cindex "content scanning" "for spam"
34966 .cindex "spam scanning"
34967 .cindex "SpamAssassin"
34968 .cindex "Rspamd"
34969 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34970 score and a report for the message.
34971 Support is also provided for Rspamd.
34972
34973 For more information about installation and configuration of SpamAssassin or
34974 Rspamd refer to their respective websites at
34975 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34976
34977 SpamAssassin can be installed with CPAN by running:
34978 .code
34979 perl -MCPAN -e 'install Mail::SpamAssassin'
34980 .endd
34981 SpamAssassin has its own set of configuration files. Please review its
34982 documentation to see how you can tweak it. The default installation should work
34983 nicely, however.
34984
34985 .oindex "&%spamd_address%&"
34986 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34987 intend to use an instance running on the local host you do not need to set
34988 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34989 you must set the &%spamd_address%& option in the global part of the Exim
34990 configuration as follows (example):
34991 .code
34992 spamd_address = 192.168.99.45 783
34993 .endd
34994 The SpamAssassin protocol relies on a TCP half-close from the client.
34995 If your SpamAssassin client side is running a Linux system with an
34996 iptables firewall, consider setting
34997 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34998 timeout, Exim uses when waiting for a response from the SpamAssassin
34999 server (currently defaulting to 120s).  With a lower value the Linux
35000 connection tracking may consider your half-closed connection as dead too
35001 soon.
35002
35003
35004 To use Rspamd (which by default listens on all local addresses
35005 on TCP port 11333)
35006 you should add &%variant=rspamd%& after the address/port pair, for example:
35007 .code
35008 spamd_address = 127.0.0.1 11333 variant=rspamd
35009 .endd
35010
35011 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
35012 sockets. If you want to us these, supply &%spamd_address%& with an absolute
35013 filename instead of an address/port pair:
35014 .code
35015 spamd_address = /var/run/spamd_socket
35016 .endd
35017 You can have multiple &%spamd%& servers to improve scalability. These can
35018 reside on other hardware reachable over the network. To specify multiple
35019 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
35020 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
35021 .code
35022 spamd_address = 192.168.2.10 783 : \
35023                 192.168.2.11 783 : \
35024                 192.168.2.12 783
35025 .endd
35026 Up to 32 &%spamd%& servers are supported.
35027 When a server fails to respond to the connection attempt, all other
35028 servers are tried until one succeeds. If no server responds, the &%spam%&
35029 condition defers.
35030
35031 Unix and TCP socket specifications may be mixed in any order.
35032 Each element of the list is a list itself, space-separated by default
35033 and changeable in the usual way (&<<SECTlistsepchange>>&);
35034 take care to not double the separator.
35035
35036 For TCP socket specifications a host name or IP (v4 or v6, but
35037 subject to list-separator quoting rules) address can be used,
35038 and the port can be one or a dash-separated pair.
35039 In the latter case, the range is tried in strict order.
35040
35041 Elements after the first for Unix sockets, or second for TCP socket,
35042 are options.
35043 The supported options are:
35044 .code
35045 pri=<priority>      Selection priority
35046 weight=<value>      Selection bias
35047 time=<start>-<end>  Use only between these times of day
35048 retry=<timespec>    Retry on connect fail
35049 tmo=<timespec>      Connection time limit
35050 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
35051 .endd
35052
35053 The &`pri`& option specifies a priority for the server within the list,
35054 higher values being tried first.
35055 The default priority is 1.
35056
35057 The &`weight`& option specifies a selection bias.
35058 Within a priority set
35059 servers are queried in a random fashion, weighted by this value.
35060 The default value for selection bias is 1.
35061
35062 Time specifications for the &`time`& option are <hour>.<minute>.<second>
35063 in the local time zone; each element being one or more digits.
35064 Either the seconds or both minutes and seconds, plus the leading &`.`&
35065 characters, may be omitted and will be taken as zero.
35066
35067 Timeout specifications for the &`retry`& and &`tmo`& options
35068 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
35069
35070 The &`tmo`& option specifies an overall timeout for communication.
35071 The default value is two minutes.
35072
35073 The &`retry`& option specifies a time after which a single retry for
35074 a failed connect is made.
35075 The default is to not retry.
35076
35077 The &%spamd_address%& variable is expanded before use if it starts with
35078 a dollar sign. In this case, the expansion may return a string that is
35079 used as the list so that multiple spamd servers can be the result of an
35080 expansion.
35081
35082 .vindex "&$callout_address$&"
35083 When a connection is made to the server the expansion variable &$callout_address$&
35084 is set to record the actual address used.
35085
35086 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
35087 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
35088 .code
35089 deny spam = joe
35090      message = This message was classified as SPAM
35091 .endd
35092 The right-hand side of the &%spam%& condition specifies a name. This is
35093 relevant if you have set up multiple SpamAssassin profiles. If you do not want
35094 to scan using a specific profile, but rather use the SpamAssassin system-wide
35095 default profile, you can scan for an unknown name, or simply use &"nobody"&.
35096 Rspamd does not use this setting. However, you must put something on the
35097 right-hand side.
35098
35099 The name allows you to use per-domain or per-user antispam profiles in
35100 principle, but this is not straightforward in practice, because a message may
35101 have multiple recipients, not necessarily all in the same domain. Because the
35102 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
35103 read the contents of the message, the variables &$local_part$& and &$domain$&
35104 are not set.
35105 Careful enforcement of single-recipient messages
35106 (e.g. by responding with defer in the recipient ACL for all recipients
35107 after the first),
35108 or the use of PRDR,
35109 .cindex "PRDR" "use for per-user SpamAssassin profiles"
35110 are needed to use this feature.
35111
35112 The right-hand side of the &%spam%& condition is expanded before being used, so
35113 you can put lookups or conditions there. When the right-hand side evaluates to
35114 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
35115
35116
35117 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
35118 large ones may cause significant performance degradation. As most spam messages
35119 are quite small, it is recommended that you do not scan the big ones. For
35120 example:
35121 .code
35122 deny condition = ${if < {$message_size}{10K}}
35123      spam = nobody
35124      message = This message was classified as SPAM
35125 .endd
35126
35127 The &%spam%& condition returns true if the threshold specified in the user's
35128 SpamAssassin profile has been matched or exceeded. If you want to use the
35129 &%spam%& condition for its side effects (see the variables below), you can make
35130 it always return &"true"& by appending &`:true`& to the username.
35131
35132 .cindex "spam scanning" "returned variables"
35133 When the &%spam%& condition is run, it sets up a number of expansion
35134 variables.
35135 Except for &$spam_report$&,
35136 these variables are saved with the received message so are
35137 available for use at delivery time.
35138
35139 .vlist
35140 .vitem &$spam_score$&
35141 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
35142 for inclusion in log or reject messages.
35143
35144 .vitem &$spam_score_int$&
35145 The spam score of the message, multiplied by ten, as an integer value. For
35146 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
35147 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
35148 The integer value is useful for numeric comparisons in conditions.
35149
35150 .vitem &$spam_bar$&
35151 A string consisting of a number of &"+"& or &"-"& characters, representing the
35152 integer part of the spam score value. A spam score of 4.4 would have a
35153 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
35154 headers, since MUAs can match on such strings. The maximum length of the
35155 spam bar is 50 characters.
35156
35157 .vitem &$spam_report$&
35158 A multiline text table, containing the full SpamAssassin report for the
35159 message. Useful for inclusion in headers or reject messages.
35160 This variable is only usable in a DATA-time ACL.
35161 Beware that SpamAssassin may return non-ASCII characters, especially
35162 when running in country-specific locales, which are not legal
35163 unencoded in headers.
35164
35165 .vitem &$spam_action$&
35166 For SpamAssassin either 'reject' or 'no action' depending on the
35167 spam score versus threshold.
35168 For Rspamd, the recommended action.
35169
35170 .endlist
35171
35172 The &%spam%& condition caches its results unless expansion in
35173 spamd_address was used. If you call it again with the same user name, it
35174 does not scan again, but rather returns the same values as before.
35175
35176 The &%spam%& condition returns DEFER if there is any error while running
35177 the message through SpamAssassin or if the expansion of spamd_address
35178 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
35179 statement block), append &`/defer_ok`& to the right-hand side of the
35180 spam condition, like this:
35181 .code
35182 deny spam    = joe/defer_ok
35183      message = This message was classified as SPAM
35184 .endd
35185 This causes messages to be accepted even if there is a problem with &%spamd%&.
35186
35187 Here is a longer, commented example of the use of the &%spam%&
35188 condition:
35189 .code
35190 # put headers in all messages (no matter if spam or not)
35191 warn  spam = nobody:true
35192       add_header = X-Spam-Score: $spam_score ($spam_bar)
35193       add_header = X-Spam-Report: $spam_report
35194
35195 # add second subject line with *SPAM* marker when message
35196 # is over threshold
35197 warn  spam = nobody
35198       add_header = Subject: *SPAM* $h_Subject:
35199
35200 # reject spam at high scores (> 12)
35201 deny  spam = nobody:true
35202       condition = ${if >{$spam_score_int}{120}{1}{0}}
35203       message = This message scored $spam_score spam points.
35204 .endd
35205
35206
35207
35208 .section "Scanning MIME parts" "SECTscanmimepart"
35209 .cindex "content scanning" "MIME parts"
35210 .cindex "MIME content scanning"
35211 .oindex "&%acl_smtp_mime%&"
35212 .oindex "&%acl_not_smtp_mime%&"
35213 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
35214 each MIME part of an SMTP message, including multipart types, in the sequence
35215 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
35216 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
35217 options may both refer to the same ACL if you want the same processing in both
35218 cases.
35219
35220 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
35221 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
35222 the case of a non-SMTP message. However, a MIME ACL is called only if the
35223 message contains a &'Content-Type:'& header line. When a call to a MIME
35224 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
35225 result code is sent to the client. In the case of an SMTP message, the
35226 &%acl_smtp_data%& ACL is not called when this happens.
35227
35228 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
35229 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
35230 condition to match against the raw MIME part. You can also use the
35231 &%mime_regex%& condition to match against the decoded MIME part (see section
35232 &<<SECTscanregex>>&).
35233
35234 At the start of a MIME ACL, a number of variables are set from the header
35235 information for the relevant MIME part. These are described below. The contents
35236 of the MIME part are not by default decoded into a disk file except for MIME
35237 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
35238 part into a disk file, you can use the &%decode%& condition. The general
35239 syntax is:
35240 .display
35241 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
35242 .endd
35243 The right hand side is expanded before use. After expansion,
35244 the value can be:
35245
35246 .olist
35247 &"0"& or &"false"&, in which case no decoding is done.
35248 .next
35249 The string &"default"&. In that case, the file is put in the temporary
35250 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35251 a sequential filename consisting of the message id and a sequence number. The
35252 full path and name is available in &$mime_decoded_filename$& after decoding.
35253 .next
35254 A full path name starting with a slash. If the full name is an existing
35255 directory, it is used as a replacement for the default directory. The filename
35256 is then sequentially assigned. If the path does not exist, it is used as
35257 the full path and filename.
35258 .next
35259 If the string does not start with a slash, it is used as the
35260 filename, and the default path is then used.
35261 .endlist
35262 The &%decode%& condition normally succeeds. It is only false for syntax
35263 errors or unusual circumstances such as memory shortages.
35264 The variable &$mime_filename$& will have the suggested name for the file.
35265 Note however that this might contain anything, and is very difficult
35266 to safely use as all or even part of the filename.
35267 If you place files outside of the default path, they are not
35268 automatically unlinked.
35269
35270 For RFC822 attachments (these are messages attached to messages, with a
35271 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35272 as for the primary message, only that the &$mime_is_rfc822$& expansion
35273 variable is set (see below). Attached messages are always decoded to disk
35274 before being checked, and the files are unlinked once the check is done.
35275
35276 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35277 used to match regular expressions against raw and decoded MIME parts,
35278 respectively. They are described in section &<<SECTscanregex>>&.
35279
35280 .cindex "MIME content scanning" "returned variables"
35281 The following list describes all expansion variables that are
35282 available in the MIME ACL:
35283
35284 .vlist
35285 .vitem &$mime_anomaly_level$& &&&
35286        &$mime_anomaly_text$&
35287 .vindex &$mime_anomaly_level$&
35288 .vindex &$mime_anomaly_text$&
35289 If there are problems decoding, these variables contain information on
35290 the detected issue.
35291
35292 .vitem &$mime_boundary$&
35293 .vindex &$mime_boundary$&
35294 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35295 have a boundary string, which is stored in this variable. If the current part
35296 has no boundary parameter in the &'Content-Type:'& header, this variable
35297 contains the empty string.
35298
35299 .vitem &$mime_charset$&
35300 .vindex &$mime_charset$&
35301 This variable contains the character set identifier, if one was found in the
35302 &'Content-Type:'& header. Examples for charset identifiers are:
35303 .code
35304 us-ascii
35305 gb2312 (Chinese)
35306 iso-8859-1
35307 .endd
35308 Please note that this value is not normalized, so you should do matches
35309 case-insensitively.
35310
35311 .vitem &$mime_content_description$&
35312 .vindex &$mime_content_description$&
35313 This variable contains the normalized content of the &'Content-Description:'&
35314 header. It can contain a human-readable description of the parts content. Some
35315 implementations repeat the filename for attachments here, but they are usually
35316 only used for display purposes.
35317
35318 .vitem &$mime_content_disposition$&
35319 .vindex &$mime_content_disposition$&
35320 This variable contains the normalized content of the &'Content-Disposition:'&
35321 header. You can expect strings like &"attachment"& or &"inline"& here.
35322
35323 .vitem &$mime_content_id$&
35324 .vindex &$mime_content_id$&
35325 This variable contains the normalized content of the &'Content-ID:'& header.
35326 This is a unique ID that can be used to reference a part from another part.
35327
35328 .vitem &$mime_content_size$&
35329 .vindex &$mime_content_size$&
35330 This variable is set only after the &%decode%& modifier (see above) has been
35331 successfully run. It contains the size of the decoded part in kilobytes. The
35332 size is always rounded up to full kilobytes, so only a completely empty part
35333 has a &$mime_content_size$& of zero.
35334
35335 .vitem &$mime_content_transfer_encoding$&
35336 .vindex &$mime_content_transfer_encoding$&
35337 This variable contains the normalized content of the
35338 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35339 type. Typical values are &"base64"& and &"quoted-printable"&.
35340
35341 .vitem &$mime_content_type$&
35342 .vindex &$mime_content_type$&
35343 If the MIME part has a &'Content-Type:'& header, this variable contains its
35344 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35345 are some examples of popular MIME types, as they may appear in this variable:
35346 .code
35347 text/plain
35348 text/html
35349 application/octet-stream
35350 image/jpeg
35351 audio/midi
35352 .endd
35353 If the MIME part has no &'Content-Type:'& header, this variable contains the
35354 empty string.
35355
35356 .vitem &$mime_decoded_filename$&
35357 .vindex &$mime_decoded_filename$&
35358 This variable is set only after the &%decode%& modifier (see above) has been
35359 successfully run. It contains the full path and filename of the file
35360 containing the decoded data.
35361 .endlist
35362
35363 .cindex "RFC 2047"
35364 .vlist
35365 .vitem &$mime_filename$&
35366 .vindex &$mime_filename$&
35367 This is perhaps the most important of the MIME variables. It contains a
35368 proposed filename for an attachment, if one was found in either the
35369 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35370 RFC2047
35371 or RFC2231
35372 decoded, but no additional sanity checks are done.
35373  If no filename was
35374 found, this variable contains the empty string.
35375
35376 .vitem &$mime_is_coverletter$&
35377 .vindex &$mime_is_coverletter$&
35378 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35379 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35380 content in the cover letter, while not restricting attachments at all.
35381
35382 The variable contains 1 (true) for a MIME part believed to be part of the
35383 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35384 follows:
35385
35386 .olist
35387 The outermost MIME part of a message is always a cover letter.
35388
35389 .next
35390 If a multipart/alternative or multipart/related MIME part is a cover letter,
35391 so are all MIME subparts within that multipart.
35392
35393 .next
35394 If any other multipart is a cover letter, the first subpart is a cover letter,
35395 and the rest are attachments.
35396
35397 .next
35398 All parts contained within an attachment multipart are attachments.
35399 .endlist olist
35400
35401 As an example, the following will ban &"HTML mail"& (including that sent with
35402 alternative plain text), while allowing HTML files to be attached. HTML
35403 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35404 .code
35405 deny !condition = $mime_is_rfc822
35406      condition = $mime_is_coverletter
35407      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35408      message = HTML mail is not accepted here
35409 .endd
35410
35411 .vitem &$mime_is_multipart$&
35412 .vindex &$mime_is_multipart$&
35413 This variable has the value 1 (true) when the current part has the main type
35414 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35415 Since multipart entities only serve as containers for other parts, you may not
35416 want to carry out specific actions on them.
35417
35418 .vitem &$mime_is_rfc822$&
35419 .vindex &$mime_is_rfc822$&
35420 This variable has the value 1 (true) if the current part is not a part of the
35421 checked message itself, but part of an attached message. Attached message
35422 decoding is fully recursive.
35423
35424 .vitem &$mime_part_count$&
35425 .vindex &$mime_part_count$&
35426 This variable is a counter that is raised for each processed MIME part. It
35427 starts at zero for the very first part (which is usually a multipart). The
35428 counter is per-message, so it is reset when processing RFC822 attachments (see
35429 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35430 complete, so you can use it in the DATA ACL to determine the number of MIME
35431 parts of a message. For non-MIME messages, this variable contains the value -1.
35432 .endlist
35433
35434
35435
35436 .section "Scanning with regular expressions" "SECTscanregex"
35437 .cindex "content scanning" "with regular expressions"
35438 .cindex "regular expressions" "content scanning with"
35439 You can specify your own custom regular expression matches on the full body of
35440 the message, or on individual MIME parts.
35441
35442 The &%regex%& condition takes one or more regular expressions as arguments and
35443 matches them against the full message (when called in the DATA ACL) or a raw
35444 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35445 linewise, with a maximum line length of 32K characters. That means you cannot
35446 have multiline matches with the &%regex%& condition.
35447
35448 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35449 to 32K of decoded content (the whole content at once, not linewise). If the
35450 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35451 is decoded automatically when &%mime_regex%& is executed (using default path
35452 and filename values). If the decoded data is larger than  32K, only the first
35453 32K characters are checked.
35454
35455 The regular expressions are passed as a colon-separated list. To include a
35456 literal colon, you must double it. Since the whole right-hand side string is
35457 expanded before being used, you must also escape dollar signs and backslashes
35458 with more backslashes, or use the &`\N`& facility to disable expansion.
35459 Here is a simple example that contains two regular expressions:
35460 .code
35461 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35462      message = contains blacklisted regex ($regex_match_string)
35463 .endd
35464 The conditions returns true if any one of the regular expressions matches. The
35465 &$regex_match_string$& expansion variable is then set up and contains the
35466 matching regular expression.
35467 The expansion variables &$regex1$& &$regex2$& etc
35468 are set to any substrings captured by the regular expression.
35469
35470 &*Warning*&: With large messages, these conditions can be fairly
35471 CPU-intensive.
35472
35473 .ecindex IIDcosca
35474
35475
35476
35477
35478 . ////////////////////////////////////////////////////////////////////////////
35479 . ////////////////////////////////////////////////////////////////////////////
35480
35481 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35482          "Local scan function"
35483 .scindex IIDlosca "&[local_scan()]& function" "description of"
35484 .cindex "customizing" "input scan using C function"
35485 .cindex "policy control" "by local scan function"
35486 In these days of email worms, viruses, and ever-increasing spam, some sites
35487 want to apply a lot of checking to messages before accepting them.
35488
35489 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35490 passing messages to external virus and spam scanning software. You can also do
35491 a certain amount in Exim itself through string expansions and the &%condition%&
35492 condition in the ACL that runs after the SMTP DATA command or the ACL for
35493 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35494
35495 To allow for further customization to a site's own requirements, there is the
35496 possibility of linking Exim with a private message scanning function, written
35497 in C. If you want to run code that is written in something other than C, you
35498 can of course use a little C stub to call it.
35499
35500 The local scan function is run once for every incoming message, at the point
35501 when Exim is just about to accept the message.
35502 It can therefore be used to control non-SMTP messages from local processes as
35503 well as messages arriving via SMTP.
35504
35505 Exim applies a timeout to calls of the local scan function, and there is an
35506 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35507 Zero means &"no timeout"&.
35508 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35509 before calling the local scan function, so that the most common types of crash
35510 are caught. If the timeout is exceeded or one of those signals is caught, the
35511 incoming message is rejected with a temporary error if it is an SMTP message.
35512 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35513 code. The incident is logged on the main and reject logs.
35514
35515
35516
35517 .section "Building Exim to use a local scan function" "SECID207"
35518 .cindex "&[local_scan()]& function" "building Exim to use"
35519 To make use of the local scan function feature, you must tell Exim where your
35520 function is before building Exim, by setting
35521 both HAVE_LOCAL_SCAN and
35522 LOCAL_SCAN_SOURCE in your
35523 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35524 directory, so you might set
35525 .code
35526 HAVE_LOCAL_SCAN=yes
35527 LOCAL_SCAN_SOURCE=Local/local_scan.c
35528 .endd
35529 for example. The function must be called &[local_scan()]&;
35530 the source file(s) for it should first #define LOCAL_SCAN
35531 and then #include "local_scan.h".
35532 It is called by
35533 Exim after it has received a message, when the success return code is about to
35534 be sent. This is after all the ACLs have been run. The return code from your
35535 function controls whether the message is actually accepted or not. There is a
35536 commented template function (that just accepts the message) in the file
35537 _src/local_scan.c_.
35538
35539 If you want to make use of Exim's runtime configuration file to set options
35540 for your &[local_scan()]& function, you must also set
35541 .code
35542 LOCAL_SCAN_HAS_OPTIONS=yes
35543 .endd
35544 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35545
35546
35547
35548
35549 .section "API for local_scan()" "SECTapiforloc"
35550 .cindex "&[local_scan()]& function" "API description"
35551 .cindex &%dlfunc%& "API description"
35552 You must include this line near the start of your code:
35553 .code
35554 #define LOCAL_SCAN
35555 #include "local_scan.h"
35556 .endd
35557 This header file defines a number of variables and other values, and the
35558 prototype for the function itself. Exim is coded to use unsigned char values
35559 almost exclusively, and one of the things this header defines is a shorthand
35560 for &`unsigned char`& called &`uschar`&.
35561 It also makes available the following macro definitions, to simplify casting character
35562 strings and pointers to character strings:
35563 .code
35564 #define CS   (char *)
35565 #define CCS  (const char *)
35566 #define CSS  (char **)
35567 #define US   (unsigned char *)
35568 #define CUS  (const unsigned char *)
35569 #define USS  (unsigned char **)
35570 .endd
35571 The function prototype for &[local_scan()]& is:
35572 .code
35573 extern int local_scan(int fd, uschar **return_text);
35574 .endd
35575 The arguments are as follows:
35576
35577 .ilist
35578 &%fd%& is a file descriptor for the file that contains the body of the message
35579 (the -D file). The file is open for reading and writing, but updating it is not
35580 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35581
35582 The descriptor is positioned at character 26 of the file, which is the first
35583 character of the body itself, because the first 26 characters (19 characters
35584 before Exim  4.97) are the message id followed by &`-D`& and a newline.
35585 If you rewind the file, you should use the
35586 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35587 case this changes in some future version.
35588 .next
35589 &%return_text%& is an address which you can use to return a pointer to a text
35590 string at the end of the function. The value it points to on entry is NULL.
35591 .endlist
35592
35593 The function must return an &%int%& value which is one of the following macros:
35594
35595 .vlist
35596 .vitem &`LOCAL_SCAN_ACCEPT`&
35597 .vindex "&$local_scan_data$&"
35598 The message is accepted. If you pass back a string of text, it is saved with
35599 the message, and made available in the variable &$local_scan_data$&. No
35600 newlines are permitted (if there are any, they are turned into spaces) and the
35601 maximum length of text is 1000 characters.
35602
35603 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35604 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35605 queued without immediate delivery, and is frozen.
35606
35607 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35608 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35609 queued without immediate delivery.
35610
35611 .vitem &`LOCAL_SCAN_REJECT`&
35612 The message is rejected; the returned text is used as an error message which is
35613 passed back to the sender and which is also logged. Newlines are permitted &--
35614 they cause a multiline response for SMTP rejections, but are converted to
35615 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35616 used.
35617
35618 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35619 The message is temporarily rejected; the returned text is used as an error
35620 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35621 problem"& is used.
35622
35623 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35624 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35625 message is not written to the reject log. It has the effect of unsetting the
35626 &%rejected_header%& log selector for just this rejection. If
35627 &%rejected_header%& is already unset (see the discussion of the
35628 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35629 same as LOCAL_SCAN_REJECT.
35630
35631 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35632 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35633 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35634 .endlist
35635
35636 If the message is not being received by interactive SMTP, rejections are
35637 reported by writing to &%stderr%& or by sending an email, as configured by the
35638 &%-oe%& command line options.
35639
35640
35641
35642 .section "Configuration options for local_scan()" "SECTconoptloc"
35643 .cindex "&[local_scan()]& function" "configuration options"
35644 It is possible to have option settings in the main configuration file
35645 that set values in static variables in the &[local_scan()]& module. If you
35646 want to do this, you must have the line
35647 .code
35648 LOCAL_SCAN_HAS_OPTIONS=yes
35649 .endd
35650 in your &_Local/Makefile_& when you build Exim. (This line is in
35651 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35652 file, you must define static variables to hold the option values, and a table
35653 to define them.
35654
35655 The table must be a vector called &%local_scan_options%&, of type
35656 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35657 and a pointer to the variable that holds the value. The entries must appear in
35658 alphabetical order. Following &%local_scan_options%& you must also define a
35659 variable called &%local_scan_options_count%& that contains the number of
35660 entries in the table. Here is a short example, showing two kinds of option:
35661 .code
35662 static int my_integer_option = 42;
35663 static uschar *my_string_option = US"a default string";
35664
35665 optionlist local_scan_options[] = {
35666   { "my_integer", opt_int,       &my_integer_option },
35667   { "my_string",  opt_stringptr, &my_string_option }
35668 };
35669
35670 int local_scan_options_count =
35671   sizeof(local_scan_options)/sizeof(optionlist);
35672 .endd
35673 The values of the variables can now be changed from Exim's runtime
35674 configuration file by including a local scan section as in this example:
35675 .code
35676 begin local_scan
35677 my_integer = 99
35678 my_string = some string of text...
35679 .endd
35680 The available types of option data are as follows:
35681
35682 .vlist
35683 .vitem &*opt_bool*&
35684 This specifies a boolean (true/false) option. The address should point to a
35685 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35686 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35687 whether such a variable has been set at all, you can initialize it to
35688 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35689 values.)
35690
35691 .vitem &*opt_fixed*&
35692 This specifies a fixed point number, such as is used for load averages.
35693 The address should point to a variable of type &`int`&. The value is stored
35694 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35695
35696 .vitem &*opt_int*&
35697 This specifies an integer; the address should point to a variable of type
35698 &`int`&. The value may be specified in any of the integer formats accepted by
35699 Exim.
35700
35701 .vitem &*opt_mkint*&
35702 This is the same as &%opt_int%&, except that when such a value is output in a
35703 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35704 printed with the suffix K or M.
35705
35706 .vitem &*opt_octint*&
35707 This also specifies an integer, but the value is always interpreted as an
35708 octal integer, whether or not it starts with the digit zero, and it is
35709 always output in octal.
35710
35711 .vitem &*opt_stringptr*&
35712 This specifies a string value; the address must be a pointer to a
35713 variable that points to a string (for example, of type &`uschar *`&).
35714
35715 .vitem &*opt_time*&
35716 This specifies a time interval value. The address must point to a variable of
35717 type &`int`&. The value that is placed there is a number of seconds.
35718 .endlist
35719
35720 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35721 out the values of all the &[local_scan()]& options.
35722
35723
35724
35725 .section "Available Exim variables" "SECID208"
35726 .cindex "&[local_scan()]& function" "available Exim variables"
35727 The header &_local_scan.h_& gives you access to a number of C variables. These
35728 are the only ones that are guaranteed to be maintained from release to release.
35729 Note, however, that you can obtain the value of any Exim expansion variable,
35730 including &$recipients$&, by calling &'expand_string()'&. The exported
35731 C variables are as follows:
35732
35733 .vlist
35734 .vitem &*int&~body_linecount*&
35735 This variable contains the number of lines in the message's body.
35736 It is not valid if the &%spool_wireformat%& option is used.
35737
35738 .vitem &*int&~body_zerocount*&
35739 This variable contains the number of binary zero bytes in the message's body.
35740 It is not valid if the &%spool_wireformat%& option is used.
35741
35742 .vitem &*unsigned&~int&~debug_selector*&
35743 This variable is set to zero when no debugging is taking place. Otherwise, it
35744 is a bitmap of debugging selectors. Two bits are identified for use in
35745 &[local_scan()]&; they are defined as macros:
35746
35747 .ilist
35748 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35749 testing option that is not privileged &-- any caller may set it. All the
35750 other selector bits can be set only by admin users.
35751
35752 .next
35753 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35754 by the &`+local_scan`& debug selector. It is not included in the default set
35755 of debugging bits.
35756 .endlist ilist
35757
35758 Thus, to write to the debugging output only when &`+local_scan`& has been
35759 selected, you should use code like this:
35760 .code
35761 if ((debug_selector & D_local_scan) != 0)
35762   debug_printf("xxx", ...);
35763 .endd
35764 .vitem &*uschar&~*expand_string_message*&
35765 After a failing call to &'expand_string()'& (returned value NULL), the
35766 variable &%expand_string_message%& contains the error message, zero-terminated.
35767
35768 .vitem &*header_line&~*header_list*&
35769 A pointer to a chain of header lines. The &%header_line%& structure is
35770 discussed below.
35771
35772 .vitem &*header_line&~*header_last*&
35773 A pointer to the last of the header lines.
35774
35775 .vitem &*const&~uschar&~*headers_charset*&
35776 The value of the &%headers_charset%& configuration option.
35777
35778 .vitem &*BOOL&~host_checking*&
35779 This variable is TRUE during a host checking session that is initiated by the
35780 &%-bh%& command line option.
35781
35782 .vitem &*uschar&~*interface_address*&
35783 The IP address of the interface that received the message, as a string. This
35784 is NULL for locally submitted messages.
35785
35786 .vitem &*int&~interface_port*&
35787 The port on which this message was received. When testing with the &%-bh%&
35788 command line option, the value of this variable is -1 unless a port has been
35789 specified via the &%-oMi%& option.
35790
35791 .vitem &*uschar&~*message_id*&
35792 This variable contains Exim's message id for the incoming message (the value of
35793 &$message_exim_id$&) as a zero-terminated string.
35794
35795 .vitem &*uschar&~*received_protocol*&
35796 The name of the protocol by which the message was received.
35797
35798 .vitem &*int&~recipients_count*&
35799 The number of accepted recipients.
35800
35801 .vitem &*recipient_item&~*recipients_list*&
35802 .cindex "recipient" "adding in local scan"
35803 .cindex "recipient" "removing in local scan"
35804 The list of accepted recipients, held in a vector of length
35805 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35806 can add additional recipients by calling &'receive_add_recipient()'& (see
35807 below). You can delete recipients by removing them from the vector and
35808 adjusting the value in &%recipients_count%&. In particular, by setting
35809 &%recipients_count%& to zero you remove all recipients. If you then return the
35810 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35811 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35812 and then call &'receive_add_recipient()'& as often as needed.
35813
35814 .vitem &*uschar&~*sender_address*&
35815 The envelope sender address. For bounce messages this is the empty string.
35816
35817 .vitem &*uschar&~*sender_host_address*&
35818 The IP address of the sending host, as a string. This is NULL for
35819 locally-submitted messages.
35820
35821 .vitem &*uschar&~*sender_host_authenticated*&
35822 The name of the authentication mechanism that was used, or NULL if the message
35823 was not received over an authenticated SMTP connection.
35824
35825 .vitem &*uschar&~*sender_host_name*&
35826 The name of the sending host, if known.
35827
35828 .vitem &*int&~sender_host_port*&
35829 The port on the sending host.
35830
35831 .vitem &*BOOL&~smtp_input*&
35832 This variable is TRUE for all SMTP input, including BSMTP.
35833
35834 .vitem &*BOOL&~smtp_batched_input*&
35835 This variable is TRUE for BSMTP input.
35836
35837 .vitem &*int&~store_pool*&
35838 The contents of this variable control which pool of memory is used for new
35839 requests. See section &<<SECTmemhanloc>>& for details.
35840 .endlist
35841
35842
35843 .section "Structure of header lines" "SECID209"
35844 The &%header_line%& structure contains the members listed below.
35845 You can add additional header lines by calling the &'header_add()'& function
35846 (see below). You can cause header lines to be ignored (deleted) by setting
35847 their type to *.
35848
35849
35850 .vlist
35851 .vitem &*struct&~header_line&~*next*&
35852 A pointer to the next header line, or NULL for the last line.
35853
35854 .vitem &*int&~type*&
35855 A code identifying certain headers that Exim recognizes. The codes are printing
35856 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35857 Notice in particular that any header line whose type is * is not transmitted
35858 with the message. This flagging is used for header lines that have been
35859 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35860 lines.) Effectively, * means &"deleted"&.
35861
35862 .vitem &*int&~slen*&
35863 The number of characters in the header line, including the terminating and any
35864 internal newlines.
35865
35866 .vitem &*uschar&~*text*&
35867 A pointer to the text of the header. It always ends with a newline, followed by
35868 a zero byte. Internal newlines are preserved.
35869 .endlist
35870
35871
35872
35873 .section "Structure of recipient items" "SECID210"
35874 The &%recipient_item%& structure contains these members:
35875
35876 .vlist
35877 .vitem &*uschar&~*address*&
35878 This is a pointer to the recipient address as it was received.
35879
35880 .vitem &*int&~pno*&
35881 This is used in later Exim processing when top level addresses are created by
35882 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35883 and must always contain -1 at this stage.
35884
35885 .vitem &*uschar&~*errors_to*&
35886 If this value is not NULL, bounce messages caused by failing to deliver to the
35887 recipient are sent to the address it contains. In other words, it overrides the
35888 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35889 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35890 an unqualified address, Exim qualifies it using the domain from
35891 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35892 is NULL for all recipients.
35893 .endlist
35894
35895
35896
35897 .section "Available Exim functions" "SECID211"
35898 .cindex "&[local_scan()]& function" "available Exim functions"
35899 The header &_local_scan.h_& gives you access to a number of Exim functions.
35900 These are the only ones that are guaranteed to be maintained from release to
35901 release:
35902
35903 .vlist
35904 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35905        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35906
35907 This function creates a child process that runs the command specified by
35908 &%argv%&. The environment for the process is specified by &%envp%&, which can
35909 be NULL if no environment variables are to be passed. A new umask is supplied
35910 for the process in &%newumask%&.
35911
35912 Pipes to the standard input and output of the new process are set up
35913 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35914 standard error is cloned to the standard output. If there are any file
35915 descriptors &"in the way"& in the new process, they are closed. If the final
35916 argument is TRUE, the new process is made into a process group leader.
35917
35918 The function returns the pid of the new process, or -1 if things go wrong.
35919
35920 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35921 This function waits for a child process to terminate, or for a timeout (in
35922 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35923 return value is as follows:
35924
35925 .ilist
35926 >= 0
35927
35928 The process terminated by a normal exit and the value is the process
35929 ending status.
35930
35931 .next
35932 < 0 and > &--256
35933
35934 The process was terminated by a signal and the value is the negation of the
35935 signal number.
35936
35937 .next
35938 &--256
35939
35940 The process timed out.
35941 .next
35942 &--257
35943
35944 The was some other error in wait(); &%errno%& is still set.
35945 .endlist
35946
35947 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35948 This function provide you with a means of submitting a new message to
35949 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35950 want, but this packages it all up for you.) The function creates a pipe,
35951 forks a subprocess that is running
35952 .code
35953 exim -t -oem -oi -f <>
35954 .endd
35955 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35956 that is connected to the standard input. The yield of the function is the PID
35957 of the subprocess. You can then write a message to the file descriptor, with
35958 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35959
35960 When you have finished, call &'child_close()'& to wait for the process to
35961 finish and to collect its ending status. A timeout value of zero is usually
35962 fine in this circumstance. Unless you have made a mistake with the recipient
35963 addresses, you should get a return code of zero.
35964
35965
35966 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35967        *sender_authentication)*&
35968 This function is a more sophisticated version of &'child_open()'&. The command
35969 that it runs is:
35970 .display
35971 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35972 .endd
35973 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35974
35975
35976 .vitem &*void&~debug_printf(char&~*,&~...)*&
35977 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35978 output is written to the standard error stream. If no debugging is selected,
35979 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35980 conditional on the &`local_scan`& debug selector by coding like this:
35981 .code
35982 if ((debug_selector & D_local_scan) != 0)
35983   debug_printf("xxx", ...);
35984 .endd
35985
35986 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35987 This is an interface to Exim's string expansion code. The return value is the
35988 expanded string, or NULL if there was an expansion failure.
35989 The C variable &%expand_string_message%& contains an error message after an
35990 expansion failure. If expansion does not change the string, the return value is
35991 the pointer to the input string. Otherwise, the return value points to a new
35992 block of memory that was obtained by a call to &'store_get()'&. See section
35993 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35994
35995 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35996 This function allows you to an add additional header line at the end of the
35997 existing ones. The first argument is the type, and should normally be a space
35998 character. The second argument is a format string and any number of
35999 substitution arguments as for &[sprintf()]&. You may include internal newlines
36000 if you want, and you must ensure that the string ends with a newline.
36001
36002 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
36003         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
36004 This function adds a new header line at a specified point in the header
36005 chain. The header itself is specified as for &'header_add()'&.
36006
36007 If &%name%& is NULL, the new header is added at the end of the chain if
36008 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
36009 NULL, the header lines are searched for the first non-deleted header that
36010 matches the name. If one is found, the new header is added before it if
36011 &%after%& is false. If &%after%& is true, the new header is added after the
36012 found header and any adjacent subsequent ones with the same name (even if
36013 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
36014 option controls where the header is added. If it is true, addition is at the
36015 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
36016 headers, or at the top if there are no &'Received:'& headers, you could use
36017 .code
36018 header_add_at_position(TRUE, US"Received", TRUE,
36019   ' ', "X-xxx: ...");
36020 .endd
36021 Normally, there is always at least one non-deleted &'Received:'& header, but
36022 there may not be if &%received_header_text%& expands to an empty string.
36023
36024
36025 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
36026 This function removes header lines. If &%occurrence%& is zero or negative, all
36027 occurrences of the header are removed. If occurrence is greater than zero, that
36028 particular instance of the header is removed. If no header(s) can be found that
36029 match the specification, the function does nothing.
36030
36031
36032 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
36033         int&~length,&~BOOL&~notdel)*&"
36034 This function tests whether the given header has the given name. It is not just
36035 a string comparison, because white space is permitted between the name and the
36036 colon. If the &%notdel%& argument is true, a false return is forced for all
36037 &"deleted"& headers; otherwise they are not treated specially. For example:
36038 .code
36039 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
36040 .endd
36041 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
36042 .cindex "base64 encoding" "functions for &[local_scan()]& use"
36043 This function base64-encodes a string, which is passed by address and length.
36044 The text may contain bytes of any value, including zero. The result is passed
36045 back in dynamic memory that is obtained by calling &'store_get()'&. It is
36046 zero-terminated.
36047
36048 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
36049 This function decodes a base64-encoded string. Its arguments are a
36050 zero-terminated base64-encoded string and the address of a variable that is set
36051 to point to the result, which is in dynamic memory. The length of the decoded
36052 string is the yield of the function. If the input is invalid base64 data, the
36053 yield is -1. A zero byte is added to the end of the output string to make it
36054 easy to interpret as a C string (assuming it contains no zeros of its own). The
36055 added zero byte is not included in the returned count.
36056
36057 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
36058 This function checks for a match in a domain list. Domains are always
36059 matched caselessly. The return value is one of the following:
36060 .itable none 0 0 2 15* left 85* left
36061 .irow &`OK`&    "match succeeded"
36062 .irow &`FAIL`&  "match failed"
36063 .irow &`DEFER`& "match deferred"
36064 .endtable
36065 DEFER is usually caused by some kind of lookup defer, such as the
36066 inability to contact a database.
36067
36068 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
36069         BOOL&~caseless)*&"
36070 This function checks for a match in a local part list. The third argument
36071 controls case-sensitivity. The return values are as for
36072 &'lss_match_domain()'&.
36073
36074 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
36075         BOOL&~caseless)*&"
36076 This function checks for a match in an address list. The third argument
36077 controls the case-sensitivity of the local part match. The domain is always
36078 matched caselessly. The return values are as for &'lss_match_domain()'&.
36079
36080 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
36081         uschar&~*list)*&"
36082 This function checks for a match in a host list. The most common usage is
36083 expected to be
36084 .code
36085 lss_match_host(sender_host_name, sender_host_address, ...)
36086 .endd
36087 .vindex "&$sender_host_address$&"
36088 An empty address field matches an empty item in the host list. If the host name
36089 is NULL, the name corresponding to &$sender_host_address$& is automatically
36090 looked up if a host name is required to match an item in the list. The return
36091 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
36092 returns ERROR in the case when it had to look up a host name, but the lookup
36093 failed.
36094
36095 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
36096         *format,&~...)*&"
36097 This function writes to Exim's log files. The first argument should be zero (it
36098 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
36099 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
36100 them. It specifies to which log or logs the message is written. The remaining
36101 arguments are a format and relevant insertion arguments. The string should not
36102 contain any newlines, not even at the end.
36103
36104
36105 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
36106 This function adds an additional recipient to the message. The first argument
36107 is the recipient address. If it is unqualified (has no domain), it is qualified
36108 with the &%qualify_recipient%& domain. The second argument must always be -1.
36109
36110 This function does not allow you to specify a private &%errors_to%& address (as
36111 described with the structure of &%recipient_item%& above), because it pre-dates
36112 the addition of that field to the structure. However, it is easy to add such a
36113 value afterwards. For example:
36114 .code
36115  receive_add_recipient(US"monitor@mydom.example", -1);
36116  recipients_list[recipients_count-1].errors_to =
36117    US"postmaster@mydom.example";
36118 .endd
36119
36120 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
36121 This is a convenience function to remove a named recipient from the list of
36122 recipients. It returns true if a recipient was removed, and false if no
36123 matching recipient could be found. The argument must be a complete email
36124 address.
36125 .endlist
36126
36127
36128 .cindex "RFC 2047"
36129 .vlist
36130 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
36131   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
36132 This function decodes strings that are encoded according to RFC 2047. Typically
36133 these are the contents of header lines. First, each &"encoded word"& is decoded
36134 from the Q or B encoding into a byte-string. Then, if provided with the name of
36135 a charset encoding, and if the &[iconv()]& function is available, an attempt is
36136 made  to translate the result to the named character set. If this fails, the
36137 binary string is returned with an error message.
36138
36139 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
36140 maximum MIME word length is enforced. The third argument is the target
36141 encoding, or NULL if no translation is wanted.
36142
36143 .cindex "binary zero" "in RFC 2047 decoding"
36144 .cindex "RFC 2047" "binary zero in"
36145 If a binary zero is encountered in the decoded string, it is replaced by the
36146 contents of the &%zeroval%& argument. For use with Exim headers, the value must
36147 not be 0 because header lines are handled as zero-terminated strings.
36148
36149 The function returns the result of processing the string, zero-terminated; if
36150 &%lenptr%& is not NULL, the length of the result is set in the variable to
36151 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
36152
36153 If an error is encountered, the function returns NULL and uses the &%error%&
36154 argument to return an error message. The variable pointed to by &%error%& is
36155 set to NULL if there is no error; it may be set non-NULL even when the function
36156 returns a non-NULL value if decoding was successful, but there was a problem
36157 with translation.
36158
36159
36160 .vitem &*int&~smtp_fflush(void)*&
36161 This function is used in conjunction with &'smtp_printf()'&, as described
36162 below.
36163
36164 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
36165 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
36166 output stream. You should use this function only when there is an SMTP output
36167 stream, that is, when the incoming message is being received via interactive
36168 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
36169 is FALSE. If you want to test for an incoming message from another host (as
36170 opposed to a local process that used the &%-bs%& command line option), you can
36171 test the value of &%sender_host_address%&, which is non-NULL when a remote host
36172 is involved.
36173
36174 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
36175 output function, so it can be used for all forms of SMTP connection.
36176
36177 The second argument is used to request that the data be buffered
36178 (when TRUE) or flushed (along with any previously buffered, when FALSE).
36179 This is advisory only, but likely to save on system-calls and packets
36180 sent when a sequence of calls to the function are made.
36181
36182 The argument was added in Exim version 4.90 - changing the API/ABI.
36183 Nobody noticed until 4.93 was imminent, at which point the
36184 ABI version number was incremented.
36185
36186 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
36187 must start with an appropriate response code: 550 if you are going to return
36188 LOCAL_SCAN_REJECT, 451 if you are going to return
36189 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
36190 initial lines of a multi-line response, the code must be followed by a hyphen
36191 to indicate that the line is not the final response line. You must also ensure
36192 that the lines you write terminate with CRLF. For example:
36193 .code
36194 smtp_printf("550-this is some extra info\r\n");
36195 return LOCAL_SCAN_REJECT;
36196 .endd
36197 Note that you can also create multi-line responses by including newlines in
36198 the data returned via the &%return_text%& argument. The added value of using
36199 &'smtp_printf()'& is that, for instance, you could introduce delays between
36200 multiple output lines.
36201
36202 The &'smtp_printf()'& function does not return any error indication, because it
36203 does not
36204 guarantee a flush of
36205 pending output, and therefore does not test
36206 the state of the stream. (In the main code of Exim, flushing and error
36207 detection is done when Exim is ready for the next SMTP input command.) If
36208 you want to flush the output and check for an error (for example, the
36209 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
36210 arguments. It flushes the output stream, and returns a non-zero value if there
36211 is an error.
36212
36213 .vitem &*void&~*store_get(int,BOOL)*&
36214 This function accesses Exim's internal store (memory) manager. It gets a new
36215 chunk of memory whose size is given by the first argument.
36216 The second argument should be given as TRUE if the memory will be used for
36217 data possibly coming from an attacker (eg. the message content),
36218 FALSE if it is locally-sourced.
36219 Exim bombs out if it ever
36220 runs out of memory. See the next section for a discussion of memory handling.
36221
36222 .vitem &*void&~*store_get_perm(int,BOOL)*&
36223 This function is like &'store_get()'&, but it always gets memory from the
36224 permanent pool. See the next section for a discussion of memory handling.
36225
36226 .vitem &*uschar&~*string_copy(uschar&~*string)*&
36227 See below.
36228
36229 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
36230 See below.
36231
36232 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
36233 These three functions create strings using Exim's dynamic memory facilities.
36234 The first makes a copy of an entire string. The second copies up to a maximum
36235 number of characters, indicated by the second argument. The third uses a format
36236 and insertion arguments to create a new string. In each case, the result is a
36237 pointer to a new string in the current memory pool. See the next section for
36238 more discussion.
36239 .endlist
36240
36241
36242
36243 .section "More about Exim's memory handling" "SECTmemhanloc"
36244 .cindex "&[local_scan()]& function" "memory handling"
36245 No function is provided for freeing memory, because that is never needed.
36246 The dynamic memory that Exim uses when receiving a message is automatically
36247 recycled if another message is received by the same process (this applies only
36248 to incoming SMTP connections &-- other input methods can supply only one
36249 message at a time). After receiving the last message, a reception process
36250 terminates.
36251
36252 Because it is recycled, the normal dynamic memory cannot be used for holding
36253 data that must be preserved over a number of incoming messages on the same SMTP
36254 connection. However, Exim in fact uses two pools of dynamic memory; the second
36255 one is not recycled, and can be used for this purpose.
36256
36257 If you want to allocate memory that remains available for subsequent messages
36258 in the same SMTP connection, you should set
36259 .code
36260 store_pool = POOL_PERM
36261 .endd
36262 before calling the function that does the allocation. There is no need to
36263 restore the value if you do not need to; however, if you do want to revert to
36264 the normal pool, you can either restore the previous value of &%store_pool%& or
36265 set it explicitly to POOL_MAIN.
36266
36267 The pool setting applies to all functions that get dynamic memory, including
36268 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36269 There is also a convenience function called &'store_get_perm()'& that gets a
36270 block of memory from the permanent pool while preserving the value of
36271 &%store_pool%&.
36272 .ecindex IIDlosca
36273
36274
36275
36276
36277 . ////////////////////////////////////////////////////////////////////////////
36278 . ////////////////////////////////////////////////////////////////////////////
36279
36280 .chapter "System-wide message filtering" "CHAPsystemfilter"
36281 .scindex IIDsysfil1 "filter" "system filter"
36282 .scindex IIDsysfil2 "filtering all mail"
36283 .scindex IIDsysfil3 "system filter"
36284 The previous chapters (on ACLs and the local scan function) describe checks
36285 that can be applied to messages before they are accepted by a host. There is
36286 also a mechanism for checking messages once they have been received, but before
36287 they are delivered. This is called the &'system filter'&.
36288
36289 The system filter operates in a similar manner to users' filter files, but it
36290 is run just once per message (however many recipients the message has).
36291 It should not normally be used as a substitute for routing, because &%deliver%&
36292 commands in a system router provide new envelope recipient addresses.
36293 The system filter must be an Exim filter. It cannot be a Sieve filter.
36294
36295 The system filter is run at the start of a delivery attempt, before any routing
36296 is done. If a message fails to be completely delivered at the first attempt,
36297 the system filter is run again at the start of every retry.
36298 If you want your filter to do something only once per message, you can make use
36299 .cindex retry condition
36300 of the &%first_delivery%& condition in an &%if%& command in the filter to
36301 prevent it happening on retries.
36302
36303 .vindex "&$domain$&"
36304 .vindex "&$local_part$&"
36305 &*Warning*&: Because the system filter runs just once, variables that are
36306 specific to individual recipient addresses, such as &$local_part$& and
36307 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36308 you want to run a centrally-specified filter for each recipient address
36309 independently, you can do so by setting up a suitable &(redirect)& router, as
36310 described in section &<<SECTperaddfil>>& below.
36311
36312
36313 .section "Specifying a system filter" "SECID212"
36314 .cindex "uid (user id)" "system filter"
36315 .cindex "gid (group id)" "system filter"
36316 The name of the file that contains the system filter must be specified by
36317 setting &%system_filter%&. If you want the filter to run under a uid and gid
36318 other than root, you must also set &%system_filter_user%& and
36319 &%system_filter_group%& as appropriate. For example:
36320 .code
36321 system_filter = /etc/mail/exim.filter
36322 system_filter_user = exim
36323 .endd
36324 If a system filter generates any deliveries directly to files or pipes (via the
36325 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36326 specified by setting &%system_filter_file_transport%& and
36327 &%system_filter_pipe_transport%&, respectively. Similarly,
36328 &%system_filter_reply_transport%& must be set to handle any messages generated
36329 by the &%reply%& command.
36330
36331
36332 .section "Testing a system filter" "SECID213"
36333 You can run simple tests of a system filter in the same way as for a user
36334 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36335 are permitted only in system filters are recognized.
36336
36337 If you want to test the combined effect of a system filter and a user filter,
36338 you can use both &%-bF%& and &%-bf%& on the same command line.
36339
36340
36341
36342 .section "Contents of a system filter" "SECID214"
36343 The language used to specify system filters is the same as for users' filter
36344 files. It is described in the separate end-user document &'Exim's interface to
36345 mail filtering'&. However, there are some additional features that are
36346 available only in system filters; these are described in subsequent sections.
36347 If they are encountered in a user's filter file or when testing with &%-bf%&,
36348 they cause errors.
36349
36350 .cindex "frozen messages" "manual thaw; testing in filter"
36351 There are two special conditions which, though available in users' filter
36352 files, are designed for use in system filters. The condition &%first_delivery%&
36353 is true only for the first attempt at delivering a message, and
36354 &%manually_thawed%& is true only if the message has been frozen, and
36355 subsequently thawed by an admin user. An explicit forced delivery counts as a
36356 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36357
36358 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36359 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36360 succeed, it will not be tried again.
36361 If you want Exim to retry an unseen delivery until it succeeds, you should
36362 arrange to set it up every time the filter runs.
36363
36364 When a system filter finishes running, the values of the variables &$n0$& &--
36365 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36366 users' filter files. Thus a system filter can, for example, set up &"scores"&
36367 to which users' filter files can refer.
36368
36369
36370
36371 .section "Additional variable for system filters" "SECID215"
36372 .vindex "&$recipients$&"
36373 The expansion variable &$recipients$&, containing a list of all the recipients
36374 of the message (separated by commas and white space), is available in system
36375 filters. It is not available in users' filters for privacy reasons.
36376
36377
36378
36379 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36380 .cindex "freezing messages"
36381 .cindex "message" "freezing"
36382 .cindex "message" "forced failure"
36383 .cindex "&%fail%&" "in system filter"
36384 .cindex "&%freeze%& in system filter"
36385 .cindex "&%defer%& in system filter"
36386 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36387 always available in system filters, but are not normally enabled in users'
36388 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36389 for the &(redirect)& router.) These commands can optionally be followed by the
36390 word &%text%& and a string containing an error message, for example:
36391 .code
36392 fail text "this message looks like spam to me"
36393 .endd
36394 The keyword &%text%& is optional if the next character is a double quote.
36395
36396 The &%defer%& command defers delivery of the original recipients of the
36397 message. The &%fail%& command causes all the original recipients to be failed,
36398 and a bounce message to be created. The &%freeze%& command suspends all
36399 delivery attempts for the original recipients. In all cases, any new deliveries
36400 that are specified by the filter are attempted as normal after the filter has
36401 run.
36402
36403 The &%freeze%& command is ignored if the message has been manually unfrozen and
36404 not manually frozen since. This means that automatic freezing by a system
36405 filter can be used as a way of checking out suspicious messages. If a message
36406 is found to be all right, manually unfreezing it allows it to be delivered.
36407
36408 .cindex "log" "&%fail%& command log line"
36409 .cindex "&%fail%&" "log line; reducing"
36410 The text given with a fail command is used as part of the bounce message as
36411 well as being written to the log. If the message is quite long, this can fill
36412 up a lot of log space when such failures are common. To reduce the size of the
36413 log message, Exim interprets the text in a special way if it starts with the
36414 two characters &`<<`& and contains &`>>`& later. The text between these two
36415 strings is written to the log, and the rest of the text is used in the bounce
36416 message. For example:
36417 .code
36418 fail "<<filter test 1>>Your message is rejected \
36419      because it contains attachments that we are \
36420      not prepared to receive."
36421 .endd
36422
36423 .cindex "loop" "caused by &%fail%&"
36424 Take great care with the &%fail%& command when basing the decision to fail on
36425 the contents of the message, because the bounce message will of course include
36426 the contents of the original message and will therefore trigger the &%fail%&
36427 command again (causing a mail loop) unless steps are taken to prevent this.
36428 Testing the &%error_message%& condition is one way to prevent this. You could
36429 use, for example
36430 .code
36431 if $message_body contains "this is spam" and not error_message
36432 then fail text "spam is not wanted here" endif
36433 .endd
36434 though of course that might let through unwanted bounce messages. The
36435 alternative is clever checking of the body and/or headers to detect bounces
36436 generated by the filter.
36437
36438 The interpretation of a system filter file ceases after a
36439 &%defer%&,
36440 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36441 set up earlier in the filter file are honoured, so you can use a sequence such
36442 as
36443 .code
36444 mail ...
36445 freeze
36446 .endd
36447 to send a specified message when the system filter is freezing (or deferring or
36448 failing) a message. The normal deliveries for the message do not, of course,
36449 take place.
36450
36451
36452
36453 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36454 .cindex "header lines" "adding; in system filter"
36455 .cindex "header lines" "removing; in system filter"
36456 .cindex "filter" "header lines; adding/removing"
36457 Two filter commands that are available only in system filters are:
36458 .code
36459 headers add <string>
36460 headers remove <string>
36461 .endd
36462 The argument for the &%headers add%& is a string that is expanded and then
36463 added to the end of the message's headers. It is the responsibility of the
36464 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36465 space is ignored, and if the string is otherwise empty, or if the expansion is
36466 forced to fail, the command has no effect.
36467
36468 You can use &"\n"& within the string, followed by white space, to specify
36469 continued header lines. More than one header may be added in one command by
36470 including &"\n"& within the string without any following white space. For
36471 example:
36472 .code
36473 headers add "X-header-1: ....\n  \
36474              continuation of X-header-1 ...\n\
36475              X-header-2: ...."
36476 .endd
36477 Note that the header line continuation white space after the first newline must
36478 be placed before the backslash that continues the input string, because white
36479 space after input continuations is ignored.
36480
36481 The argument for &%headers remove%& is a colon-separated list of header names.
36482 This command applies only to those headers that are stored with the message;
36483 those that are added at delivery time (such as &'Envelope-To:'& and
36484 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36485 header with the same name, they are all removed.
36486
36487 The &%headers%& command in a system filter makes an immediate change to the set
36488 of header lines that was received with the message (with possible additions
36489 from ACL processing). Subsequent commands in the system filter operate on the
36490 modified set, which also forms the basis for subsequent message delivery.
36491 Unless further modified during routing or transporting, this set of headers is
36492 used for all recipients of the message.
36493
36494 During routing and transporting, the variables that refer to the contents of
36495 header lines refer only to those lines that are in this set. Thus, header lines
36496 that are added by a system filter are visible to users' filter files and to all
36497 routers and transports. This contrasts with the manipulation of header lines by
36498 routers and transports, which is not immediate, but which instead is saved up
36499 until the message is actually being written (see section
36500 &<<SECTheadersaddrem>>&).
36501
36502 If the message is not delivered at the first attempt, header lines that were
36503 added by the system filter are stored with the message, and so are still
36504 present at the next delivery attempt. Header lines that were removed are still
36505 present, but marked &"deleted"& so that they are not transported with the
36506 message. For this reason, it is usual to make the &%headers%& command
36507 conditional on &%first_delivery%& so that the set of header lines is not
36508 modified more than once.
36509
36510 Because header modification in a system filter acts immediately, you have to
36511 use an indirect approach if you want to modify the contents of a header line.
36512 For example:
36513 .code
36514 headers add "Old-Subject: $h_subject:"
36515 headers remove "Subject"
36516 headers add "Subject: new subject (was: $h_old-subject:)"
36517 headers remove "Old-Subject"
36518 .endd
36519
36520
36521
36522 .section "Setting an errors address in a system filter" "SECID217"
36523 .cindex "envelope from"
36524 .cindex "envelope sender"
36525 In a system filter, if a &%deliver%& command is followed by
36526 .code
36527 errors_to <some address>
36528 .endd
36529 in order to change the envelope sender (and hence the error reporting) for that
36530 delivery, any address may be specified. (In a user filter, only the current
36531 user's address can be set.) For example, if some mail is being monitored, you
36532 might use
36533 .code
36534 unseen deliver monitor@spying.example errors_to root@local.example
36535 .endd
36536 to take a copy which would not be sent back to the normal error reporting
36537 address if its delivery failed.
36538
36539
36540
36541 .section "Per-address filtering" "SECTperaddfil"
36542 .vindex "&$domain_data$&"
36543 .vindex "&$local_part_data$&"
36544 In contrast to the system filter, which is run just once per message for each
36545 delivery attempt, it is also possible to set up a system-wide filtering
36546 operation that runs once for each recipient address. In this case, variables
36547 such as &$local_part_data$& and &$domain_data$& can be used,
36548 and indeed, the choice of filter file could be made dependent on them.
36549 This is an example of a router which implements such a filter:
36550 .code
36551 central_filter:
36552   check_local_user
36553   driver = redirect
36554   domains = +local_domains
36555   file = /central/filters/$local_part_data
36556   no_verify
36557   allow_filter
36558   allow_freeze
36559 .endd
36560 The filter is run in a separate process under its own uid. Therefore, either
36561 &%check_local_user%& must be set (as above), in which case the filter is run as
36562 the local user, or the &%user%& option must be used to specify which user to
36563 use. If both are set, &%user%& overrides.
36564
36565 Care should be taken to ensure that none of the commands in the filter file
36566 specify a significant delivery if the message is to go on to be delivered to
36567 its intended recipient. The router will not then claim to have dealt with the
36568 address, so it will be passed on to subsequent routers to be delivered in the
36569 normal way.
36570 .ecindex IIDsysfil1
36571 .ecindex IIDsysfil2
36572 .ecindex IIDsysfil3
36573
36574
36575
36576
36577
36578
36579 . ////////////////////////////////////////////////////////////////////////////
36580 . ////////////////////////////////////////////////////////////////////////////
36581
36582 .chapter "Message processing" "CHAPmsgproc"
36583 .scindex IIDmesproc "message" "general processing"
36584 Exim performs various transformations on the sender and recipient addresses of
36585 all messages that it handles, and also on the messages' header lines. Some of
36586 these are optional and configurable, while others always take place. All of
36587 this processing, except rewriting as a result of routing, and the addition or
36588 removal of header lines while delivering, happens when a message is received,
36589 before it is placed on Exim's queue.
36590
36591 Some of the automatic processing takes place by default only for
36592 &"locally-originated"& messages. This adjective is used to describe messages
36593 that are not received over TCP/IP, but instead are passed to an Exim process on
36594 its standard input. This includes the interactive &"local SMTP"& case that is
36595 set up by the &%-bs%& command line option.
36596
36597 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36598 or ::1) are not considered to be locally-originated. Exim does not treat the
36599 loopback interface specially in any way.
36600
36601 If you want the loopback interface to be treated specially, you must ensure
36602 that there are appropriate entries in your ACLs.
36603
36604
36605
36606
36607 .section "Submission mode for non-local messages" "SECTsubmodnon"
36608 .cindex "message" "submission"
36609 .cindex "submission mode"
36610 Processing that happens automatically for locally-originated messages (unless
36611 &%suppress_local_fixups%& is set) can also be requested for messages that are
36612 received over TCP/IP. The term &"submission mode"& is used to describe this
36613 state. Submission mode is set by the modifier
36614 .code
36615 control = submission
36616 .endd
36617 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36618 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36619 a local submission, and is normally used when the source of the message is
36620 known to be an MUA running on a client host (as opposed to an MTA). For
36621 example, to set submission mode for messages originating on the IPv4 loopback
36622 interface, you could include the following in the MAIL ACL:
36623 .code
36624 warn  hosts = 127.0.0.1
36625       control = submission
36626 .endd
36627 .cindex "&%sender_retain%& submission option"
36628 There are some options that can be used when setting submission mode. A slash
36629 is used to separate options. For example:
36630 .code
36631 control = submission/sender_retain
36632 .endd
36633 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36634 true and &%local_from_check%& false for the current incoming message. The first
36635 of these allows an existing &'Sender:'& header in the message to remain, and
36636 the second suppresses the check to ensure that &'From:'& matches the
36637 authenticated sender. With this setting, Exim still fixes up messages by adding
36638 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36639 attempt to check sender authenticity in header lines.
36640
36641 When &%sender_retain%& is not set, a submission mode setting may specify a
36642 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36643 example:
36644 .code
36645 control = submission/domain=some.domain
36646 .endd
36647 The domain may be empty. How this value is used is described in sections
36648 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36649 that allows you to specify the user's full name for inclusion in a created
36650 &'Sender:'& or &'From:'& header line. For example:
36651 .code
36652 accept authenticated = *
36653        control = submission/domain=wonderland.example/\
36654                             name=${lookup {$authenticated_id} \
36655                                    lsearch {/etc/exim/namelist}}
36656 .endd
36657 Because the name may contain any characters, including slashes, the &%name%&
36658 option must be given last. The remainder of the string is used as the name. For
36659 the example above, if &_/etc/exim/namelist_& contains:
36660 .code
36661 bigegg:  Humpty Dumpty
36662 .endd
36663 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36664 line would be:
36665 .code
36666 Sender: Humpty Dumpty <bigegg@wonderland.example>
36667 .endd
36668 .cindex "return path" "in submission mode"
36669 By default, submission mode forces the return path to the same address as is
36670 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36671 specified, the return path is also left unchanged.
36672
36673 &*Note*&: The changes caused by submission mode take effect after the predata
36674 ACL. This means that any sender checks performed before the fix-ups use the
36675 untrusted sender address specified by the user, not the trusted sender address
36676 specified by submission mode. Although this might be slightly unexpected, it
36677 does mean that you can configure ACL checks to spot that a user is trying to
36678 spoof another's address.
36679
36680 .section "Line endings" "SECTlineendings"
36681 .cindex "line endings"
36682 .cindex "carriage return"
36683 .cindex "linefeed"
36684 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36685 linefeed) is the line ending for messages transmitted over the Internet using
36686 SMTP over TCP/IP. However, within individual operating systems, different
36687 conventions are used. For example, Unix-like systems use just LF, but others
36688 use CRLF or just CR.
36689
36690 Exim was designed for Unix-like systems, and internally, it stores messages
36691 using the system's convention of a single LF as a line terminator. When
36692 receiving a message, all line endings are translated to this standard format.
36693 Originally, it was thought that programs that passed messages directly to an
36694 MTA within an operating system would use that system's convention. Experience
36695 has shown that this is not the case; for example, there are Unix applications
36696 that use CRLF in this circumstance. For this reason, and for compatibility with
36697 other MTAs, the way Exim handles line endings for all messages is now as
36698 follows:
36699
36700 .ilist
36701 CR is treated as a line ending; if it is immediately followed by LF, the LF
36702 is ignored.
36703 .next
36704 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36705 nor a local message in the state where a line containing only a dot is a
36706 terminator.
36707 .next
36708 If a bare CR is encountered within a header line, an extra space is added after
36709 the line terminator so as not to end the header line. The reasoning behind this
36710 is that bare CRs in header lines are most likely either to be mistakes, or
36711 people trying to play silly games.
36712 .next
36713 If the first header line received in a message ends with CRLF, a subsequent
36714 bare LF in a header line is treated in the same way as a bare CR in a header
36715 line and a bare LF in a body line is replaced with a space.
36716 .next
36717 If the first header line received in a message does not end with CRLF, a subsequent
36718 LF not preceded by CR is treated as a line ending.
36719 .endlist
36720
36721
36722
36723
36724
36725 .section "Unqualified addresses" "SECID218"
36726 .cindex "unqualified addresses"
36727 .cindex "address" "qualification"
36728 By default, Exim expects every envelope address it receives from an external
36729 host to be fully qualified. Unqualified addresses cause negative responses to
36730 SMTP commands. However, because SMTP is used as a means of transporting
36731 messages from MUAs running on personal workstations, there is sometimes a
36732 requirement to accept unqualified addresses from specific hosts or IP networks.
36733
36734 Exim has two options that separately control which hosts may send unqualified
36735 sender or recipient addresses in SMTP commands, namely
36736 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36737 cases, if an unqualified address is accepted, it is qualified by adding the
36738 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36739
36740 .oindex "&%qualify_domain%&"
36741 .oindex "&%qualify_recipient%&"
36742 Unqualified addresses in header lines are automatically qualified for messages
36743 that are locally originated, unless the &%-bnq%& option is given on the command
36744 line. For messages received over SMTP, unqualified addresses in header lines
36745 are qualified only if unqualified addresses are permitted in SMTP commands. In
36746 other words, such qualification is also controlled by
36747 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36748
36749
36750
36751
36752 .section "The UUCP From line" "SECID219"
36753 .cindex "&""From""& line"
36754 .cindex "UUCP" "&""From""& line"
36755 .cindex "sender" "address"
36756 .oindex "&%uucp_from_pattern%&"
36757 .oindex "&%uucp_from_sender%&"
36758 .cindex "envelope from"
36759 .cindex "envelope sender"
36760 .cindex "Sendmail compatibility" "&""From""& line"
36761 Messages that have come from UUCP (and some other applications) often begin
36762 with a line containing the envelope sender and a timestamp, following the word
36763 &"From"&. Examples of two common formats are:
36764 .code
36765 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36766 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36767 .endd
36768 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36769 Exim recognizes such lines at the start of messages that are submitted to it
36770 via the command line (that is, on the standard input). It does not recognize
36771 such lines in incoming SMTP messages, unless the sending host matches
36772 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36773 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36774 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36775 default value matches the two common cases shown above and puts the address
36776 that follows &"From"& into &$1$&.
36777
36778 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36779 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36780 a trusted user, the message's sender address is constructed by expanding the
36781 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36782 then parsed as an RFC 2822 address. If there is no domain, the local part is
36783 qualified with &%qualify_domain%& unless it is the empty string. However, if
36784 the command line &%-f%& option is used, it overrides the &"From"& line.
36785
36786 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36787 sender address is not changed. This is also the case for incoming SMTP messages
36788 that are permitted to contain &"From"& lines.
36789
36790 Only one &"From"& line is recognized. If there is more than one, the second is
36791 treated as a data line that starts the body of the message, as it is not valid
36792 as a header line. This also happens if a &"From"& line is present in an
36793 incoming SMTP message from a source that is not permitted to send them.
36794
36795
36796
36797 .section "Header lines"
36798 .subsection "Resent- header lines" SECID220
36799 .chindex Resent-
36800 RFC 2822 makes provision for sets of header lines starting with the string
36801 &`Resent-`& to be added to a message when it is resent by the original
36802 recipient to somebody else. These headers are &'Resent-Date:'&,
36803 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36804 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36805
36806 .blockquote
36807 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36808 processing of replies or other such automatic actions on messages.'&
36809 .endblockquote
36810
36811 This leaves things a bit vague as far as other processing actions such as
36812 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36813 follows:
36814
36815 .ilist
36816 A &'Resent-From:'& line that just contains the login id of the submitting user
36817 is automatically rewritten in the same way as &'From:'& (see below).
36818 .next
36819 If there's a rewriting rule for a particular header line, it is also applied to
36820 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36821 &'From:'& also rewrites &'Resent-From:'&.
36822 .next
36823 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36824 also removed.
36825 .next
36826 For a locally-submitted message,
36827 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36828 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36829 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36830 included in log lines in this case.
36831 .next
36832 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36833 &%Resent-%& header lines are present.
36834 .endlist
36835
36836
36837
36838
36839 .subsection Auto-Submitted: SECID221
36840 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36841 includes the header line:
36842 .code
36843 Auto-Submitted: auto-replied
36844 .endd
36845
36846 .subsection Bcc: SECID222
36847 .cindex "&'Bcc:'& header line"
36848 If Exim is called with the &%-t%& option, to take recipient addresses from a
36849 message's header, it removes any &'Bcc:'& header line that may exist (after
36850 extracting its addresses). If &%-t%& is not present on the command line, any
36851 existing &'Bcc:'& is not removed.
36852
36853
36854 .subsection Date: SECID223
36855 .cindex Date:
36856 If a locally-generated or submission-mode message has no &'Date:'& header line,
36857 Exim adds one, using the current date and time, unless the
36858 &%suppress_local_fixups%& control has been specified.
36859
36860 .subsection Delivery-date: SECID224
36861 .cindex "&'Delivery-date:'& header line"
36862 .oindex "&%delivery_date_remove%&"
36863 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36864 set. Exim can be configured to add them to the final delivery of messages. (See
36865 the generic &%delivery_date_add%& transport option.) They should not be present
36866 in messages in transit. If the &%delivery_date_remove%& configuration option is
36867 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36868 messages.
36869
36870
36871 .subsection Envelope-to: SECID225
36872 .chindex Envelope-to:
36873 .oindex "&%envelope_to_remove%&"
36874 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36875 Exim can be configured to add them to the final delivery of messages. (See the
36876 generic &%envelope_to_add%& transport option.) They should not be present in
36877 messages in transit. If the &%envelope_to_remove%& configuration option is set
36878 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36879 messages.
36880
36881
36882 .subsection From: SECTthefrohea
36883 .chindex From:
36884 .cindex "Sendmail compatibility" "&""From""& line"
36885 .cindex "message" "submission"
36886 .cindex "submission mode"
36887 If a submission-mode message does not contain a &'From:'& header line, Exim
36888 adds one if either of the following conditions is true:
36889
36890 .ilist
36891 The envelope sender address is not empty (that is, this is not a bounce
36892 message). The added header line copies the envelope sender address.
36893 .next
36894 .vindex "&$authenticated_id$&"
36895 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36896 .olist
36897 .vindex "&$qualify_domain$&"
36898 If no domain is specified by the submission control, the local part is
36899 &$authenticated_id$& and the domain is &$qualify_domain$&.
36900 .next
36901 If a non-empty domain is specified by the submission control, the local
36902 part is &$authenticated_id$&, and the domain is the specified domain.
36903 .next
36904 If an empty domain is specified by the submission control,
36905 &$authenticated_id$& is assumed to be the complete address.
36906 .endlist
36907 .endlist
36908
36909 A non-empty envelope sender takes precedence.
36910
36911 If a locally-generated incoming message does not contain a &'From:'& header
36912 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36913 containing the sender's address. The calling user's login name and full name
36914 are used to construct the address, as described in section &<<SECTconstr>>&.
36915 They are obtained from the password data by calling &[getpwuid()]& (but see the
36916 &%unknown_login%& configuration option). The address is qualified with
36917 &%qualify_domain%&.
36918
36919 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36920 &'From:'& header line containing just the unqualified login name of the calling
36921 user, this is replaced by an address containing the user's login name and full
36922 name as described in section &<<SECTconstr>>&.
36923
36924
36925 .subsection Message-ID: SECID226
36926 .chindex Message-ID:
36927 .cindex "message" "submission"
36928 .oindex "&%message_id_header_text%&"
36929 If a locally-generated or submission-mode incoming message does not contain a
36930 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36931 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36932 to the message. If there are any &'Resent-:'& headers in the message, it
36933 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36934 message id, preceded by the letter E to ensure it starts with a letter, and
36935 followed by @ and the primary host name. Additional information can be included
36936 in this header line by setting the &%message_id_header_text%& and/or
36937 &%message_id_header_domain%& options.
36938
36939
36940 .subsection Received: SECID227
36941 .chindex Received:
36942 A &'Received:'& header line is added at the start of every message. The
36943 contents are defined by the &%received_header_text%& configuration option, and
36944 Exim automatically adds a semicolon and a timestamp to the configured string.
36945
36946 The &'Received:'& header is generated as soon as the message's header lines
36947 have been received. At this stage, the timestamp in the &'Received:'& header
36948 line is the time that the message started to be received. This is the value
36949 that is seen by the DATA ACL and by the &[local_scan()]& function.
36950
36951 Once a message is accepted, the timestamp in the &'Received:'& header line is
36952 changed to the time of acceptance, which is (apart from a small delay while the
36953 -H spool file is written) the earliest time at which delivery could start.
36954
36955
36956 .subsection References: SECID228
36957 .chindex References:
36958 Messages created by the &(autoreply)& transport include a &'References:'&
36959 header line. This is constructed according to the rules that are described in
36960 section 3.64 of RFC 2822 (which states that replies should contain such a
36961 header line), and section 3.14 of RFC 3834 (which states that automatic
36962 responses are not different in this respect). However, because some mail
36963 processing software does not cope well with very long header lines, no more
36964 than 12 message IDs are copied from the &'References:'& header line in the
36965 incoming message. If there are more than 12, the first one and then the final
36966 11 are copied, before adding the message ID of the incoming message.
36967
36968
36969
36970 .subsection Return-path: SECID229
36971 .chindex Return-path:
36972 .oindex "&%return_path_remove%&"
36973 &'Return-path:'& header lines are defined as something an MTA may insert when
36974 it does the final delivery of messages. (See the generic &%return_path_add%&
36975 transport option.) Therefore, they should not be present in messages in
36976 transit. If the &%return_path_remove%& configuration option is set (the
36977 default), Exim removes &'Return-path:'& header lines from incoming messages.
36978
36979
36980
36981 .subsection Sender: SECTthesenhea
36982 .cindex "&'Sender:'& header line"
36983 .cindex "message" "submission"
36984 .chindex Sender:
36985 For a locally-originated message from an untrusted user, Exim may remove an
36986 existing &'Sender:'& header line, and it may add a new one. You can modify
36987 these actions by setting the &%local_sender_retain%& option true, the
36988 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36989 control setting.
36990
36991 When a local message is received from an untrusted user and
36992 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36993 control has not been set, a check is made to see if the address given in the
36994 &'From:'& header line is the correct (local) sender of the message. The address
36995 that is expected has the login name as the local part and the value of
36996 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36997 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36998 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36999 line is added to the message.
37000
37001 If you set &%local_from_check%& false, this checking does not occur. However,
37002 the removal of an existing &'Sender:'& line still happens, unless you also set
37003 &%local_sender_retain%& to be true. It is not possible to set both of these
37004 options true at the same time.
37005
37006 .cindex "submission mode"
37007 By default, no processing of &'Sender:'& header lines is done for messages
37008 received over TCP/IP or for messages submitted by trusted users. However, when
37009 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
37010 not specified on the submission control, the following processing takes place:
37011
37012 .vindex "&$authenticated_id$&"
37013 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
37014 authenticated, and &$authenticated_id$& is not empty, a sender address is
37015 created as follows:
37016
37017 .ilist
37018 .vindex "&$qualify_domain$&"
37019 If no domain is specified by the submission control, the local part is
37020 &$authenticated_id$& and the domain is &$qualify_domain$&.
37021 .next
37022 If a non-empty domain is specified by the submission control, the local part
37023 is &$authenticated_id$&, and the domain is the specified domain.
37024 .next
37025 If an empty domain is specified by the submission control,
37026 &$authenticated_id$& is assumed to be the complete address.
37027 .endlist
37028
37029 This address is compared with the address in the &'From:'& header line. If they
37030 are different, a &'Sender:'& header line containing the created address is
37031 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
37032 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
37033
37034 .cindex "return path" "created from &'Sender:'&"
37035 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
37036 the message (the envelope sender address) is changed to be the same address,
37037 except in the case of submission mode when &%sender_retain%& is specified.
37038
37039
37040
37041 .section "Adding and removing header lines in routers and transports" &&&
37042          "SECTheadersaddrem"
37043 .cindex "header lines" "adding; in router or transport"
37044 .cindex "header lines" "removing; in router or transport"
37045 When a message is delivered, the addition and removal of header lines can be
37046 specified in a system filter, or on any of the routers and transports that
37047 process the message. Section &<<SECTaddremheasys>>& contains details about
37048 modifying headers in a system filter. Header lines can also be added in an ACL
37049 as a message is received (see section &<<SECTaddheadacl>>&).
37050
37051 In contrast to what happens in a system filter, header modifications that are
37052 specified on routers and transports apply only to the particular recipient
37053 addresses that are being processed by those routers and transports. These
37054 changes do not actually take place until a copy of the message is being
37055 transported. Therefore, they do not affect the basic set of header lines, and
37056 they do not affect the values of the variables that refer to header lines.
37057
37058 &*Note*&: In particular, this means that any expansions in the configuration of
37059 the transport cannot refer to the modified header lines, because such
37060 expansions all occur before the message is actually transported.
37061
37062 For both routers and transports, the argument of a &%headers_add%&
37063 option must be in the form of one or more RFC 2822 header lines, separated by
37064 newlines (coded as &"\n"&). For example:
37065 .code
37066 headers_add = X-added-header: added by $primary_hostname\n\
37067               X-added-second: another added header line
37068 .endd
37069 Exim does not check the syntax of these added header lines.
37070
37071 Multiple &%headers_add%& options for a single router or transport can be
37072 specified; the values will append to a single list of header lines.
37073 Each header-line is separately expanded.
37074
37075 The argument of a &%headers_remove%& option must consist of a colon-separated
37076 list of header names. This is confusing, because header names themselves are
37077 often terminated by colons. In this case, the colons are the list separators,
37078 not part of the names. For example:
37079 .code
37080 headers_remove = return-receipt-to:acknowledge-to
37081 .endd
37082
37083 Multiple &%headers_remove%& options for a single router or transport can be
37084 specified; the arguments will append to a single header-names list.
37085 Each item is separately expanded.
37086 Note that colons in complex expansions which are used to
37087 form all or part of a &%headers_remove%& list
37088 will act as list separators.
37089
37090 When &%headers_add%& or &%headers_remove%& is specified on a router,
37091 items are expanded at routing time,
37092 and then associated with all addresses that are
37093 accepted by that router, and also with any new addresses that it generates. If
37094 an address passes through several routers as a result of aliasing or
37095 forwarding, the changes are cumulative.
37096
37097 .oindex "&%unseen%&"
37098 However, this does not apply to multiple routers that result from the use of
37099 the &%unseen%& option. Any header modifications that were specified by the
37100 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
37101
37102 Addresses that end up with different &%headers_add%& or &%headers_remove%&
37103 settings cannot be delivered together in a batch, so a transport is always
37104 dealing with a set of addresses that have the same header-processing
37105 requirements.
37106
37107 The transport starts by writing the original set of header lines that arrived
37108 with the message, possibly modified by the system filter. As it writes out
37109 these lines, it consults the list of header names that were attached to the
37110 recipient address(es) by &%headers_remove%& options in routers, and it also
37111 consults the transport's own &%headers_remove%& option. Header lines whose
37112 names are on either of these lists are not written out. If there are multiple
37113 instances of any listed header, they are all skipped.
37114
37115 After the remaining original header lines have been written, new header
37116 lines that were specified by routers' &%headers_add%& options are written, in
37117 the order in which they were attached to the address. These are followed by any
37118 header lines specified by the transport's &%headers_add%& option.
37119
37120 This way of handling header line modifications in routers and transports has
37121 the following consequences:
37122
37123 .ilist
37124 The original set of header lines, possibly modified by the system filter,
37125 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
37126 to it, at all times.
37127 .next
37128 Header lines that are added by a router's
37129 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
37130 expansion syntax in subsequent routers or the transport.
37131 .next
37132 Conversely, header lines that are specified for removal by &%headers_remove%&
37133 in a router remain visible to subsequent routers and the transport.
37134 .next
37135 Headers added to an address by &%headers_add%& in a router cannot be removed by
37136 a later router or by a transport.
37137 .next
37138 An added header can refer to the contents of an original header that is to be
37139 removed, even it has the same name as the added header. For example:
37140 .code
37141 headers_remove = subject
37142 headers_add = Subject: new subject (was: $h_subject:)
37143 .endd
37144 .endlist
37145
37146 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
37147 for a &(redirect)& router that has the &%one_time%& option set.
37148
37149
37150
37151
37152
37153 .section "Constructed addresses" "SECTconstr"
37154 .cindex "address" "constructed"
37155 .cindex "constructed address"
37156 When Exim constructs a sender address for a locally-generated message, it uses
37157 the form
37158 .display
37159 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
37160 .endd
37161 For example:
37162 .code
37163 Zaphod Beeblebrox <zaphod@end.univ.example>
37164 .endd
37165 The user name is obtained from the &%-F%& command line option if set, or
37166 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
37167 &"gecos"& field from the password entry. If the &"gecos"& field contains an
37168 ampersand character, this is replaced by the login name with the first letter
37169 upper cased, as is conventional in a number of operating systems. See the
37170 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
37171 The &%unknown_username%& option can be used to specify user names in cases when
37172 there is no password file entry.
37173
37174 .cindex "RFC 2047"
37175 In all cases, the user name is made to conform to RFC 2822 by quoting all or
37176 parts of it if necessary. In addition, if it contains any non-printing
37177 characters, it is encoded as described in RFC 2047, which defines a way of
37178 including non-ASCII characters in header lines. The value of the
37179 &%headers_charset%& option specifies the name of the encoding that is used (the
37180 characters are assumed to be in this encoding). The setting of
37181 &%print_topbitchars%& controls whether characters with the top bit set (that
37182 is, with codes greater than 127) count as printing characters or not.
37183
37184
37185
37186 .section "Case of local parts" "SECID230"
37187 .cindex "case of local parts"
37188 .cindex "local part" "case of"
37189 RFC 2822 states that the case of letters in the local parts of addresses cannot
37190 be assumed to be non-significant. Exim preserves the case of local parts of
37191 addresses, but by default it uses a lower-cased form when it is routing,
37192 because on most Unix systems, usernames are in lower case and case-insensitive
37193 routing is required. However, any particular router can be made to use the
37194 original case for local parts by setting the &%caseful_local_part%& generic
37195 router option.
37196
37197 .cindex "mixed-case login names"
37198 If you must have mixed-case user names on your system, the best way to proceed,
37199 assuming you want case-independent handling of incoming email, is to set up
37200 your first router to convert incoming local parts in your domains to the
37201 correct case by means of a file lookup. For example:
37202 .code
37203 correct_case:
37204   driver = redirect
37205   domains = +local_domains
37206   data = ${lookup{$local_part}cdb\
37207               {/etc/usercased.cdb}{$value}fail}\
37208               @$domain
37209 .endd
37210 For this router, the local part is forced to lower case by the default action
37211 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
37212 up a new local part in the correct case. If you then set &%caseful_local_part%&
37213 on any subsequent routers which process your domains, they will operate on
37214 local parts with the correct case in a case-sensitive manner.
37215
37216
37217
37218 .section "Dots in local parts" "SECID231"
37219 .cindex "dot" "in local part"
37220 .cindex "local part" "dots in"
37221 RFC 2822 forbids empty components in local parts. That is, an unquoted local
37222 part may not begin or end with a dot, nor have two consecutive dots in the
37223 middle. However, it seems that many MTAs do not enforce this, so Exim permits
37224 empty components for compatibility.
37225
37226
37227
37228 .section "Rewriting addresses" "SECID232"
37229 .cindex "rewriting" "addresses"
37230 Rewriting of sender and recipient addresses, and addresses in headers, can
37231 happen automatically, or as the result of configuration options, as described
37232 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
37233 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
37234
37235 Automatic rewriting includes qualification, as mentioned above. The other case
37236 in which it can happen is when an incomplete non-local domain is given. The
37237 routing process may cause this to be expanded into the full domain name. For
37238 example, a header such as
37239 .code
37240 To: hare@teaparty
37241 .endd
37242 might get rewritten as
37243 .code
37244 To: hare@teaparty.wonderland.fict.example
37245 .endd
37246 Rewriting as a result of routing is the one kind of message processing that
37247 does not happen at input time, as it cannot be done until the address has
37248 been routed.
37249
37250 Strictly, one should not do &'any'& deliveries of a message until all its
37251 addresses have been routed, in case any of the headers get changed as a
37252 result of routing. However, doing this in practice would hold up many
37253 deliveries for unreasonable amounts of time, just because one address could not
37254 immediately be routed. Exim therefore does not delay other deliveries when
37255 routing of one or more addresses is deferred.
37256 .ecindex IIDmesproc
37257
37258
37259
37260 . ////////////////////////////////////////////////////////////////////////////
37261 . ////////////////////////////////////////////////////////////////////////////
37262
37263 .chapter "SMTP processing" "CHAPSMTP"
37264 .scindex IIDsmtpproc1 "SMTP" "processing details"
37265 .scindex IIDsmtpproc2 "LMTP" "processing details"
37266 Exim supports a number of different ways of using the SMTP protocol, and its
37267 LMTP variant, which is an interactive protocol for transferring messages into a
37268 closed mail store application. This chapter contains details of how SMTP is
37269 processed. For incoming mail, the following are available:
37270
37271 .ilist
37272 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37273 .next
37274 SMTP over the standard input and output (the &%-bs%& option);
37275 .next
37276 Batched SMTP on the standard input (the &%-bS%& option).
37277 .endlist
37278
37279 For mail delivery, the following are available:
37280
37281 .ilist
37282 SMTP over TCP/IP (the &(smtp)& transport);
37283 .next
37284 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37285 &"lmtp"&);
37286 .next
37287 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37288 transport);
37289 .next
37290 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37291 the &%use_bsmtp%& option set).
37292 .endlist
37293
37294 &'Batched SMTP'& is the name for a process in which batches of messages are
37295 stored in or read from files (or pipes), in a format in which SMTP commands are
37296 used to contain the envelope information.
37297
37298
37299
37300 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37301 .cindex "SMTP" "outgoing over TCP/IP"
37302 .cindex "outgoing SMTP over TCP/IP"
37303 .cindex "LMTP" "over TCP/IP"
37304 .cindex "outgoing LMTP over TCP/IP"
37305 .cindex "EHLO"
37306 .cindex "HELO"
37307 .cindex "SIZE" "option on MAIL command"
37308 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37309 The &%protocol%& option selects which protocol is to be used, but the actual
37310 processing is the same in both cases.
37311
37312 .cindex "ESMTP extensions" SIZE
37313 If, in response to its EHLO command, Exim is told that the SIZE
37314 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37315 command. The value of <&'n'&> is the message size plus the value of the
37316 &%size_addition%& option (default 1024) to allow for additions to the message
37317 such as per-transport header lines, or changes made in a
37318 .cindex "transport" "filter"
37319 .cindex "filter" "transport filter"
37320 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37321 suppressed.
37322
37323 If the remote server advertises support for PIPELINING, Exim uses the
37324 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37325 required for the transaction.
37326
37327 If the remote server advertises support for the STARTTLS command, and Exim
37328 was built to support TLS encryption, it tries to start a TLS session unless the
37329 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37330 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37331 is called for verification.
37332
37333 If the remote server advertises support for the AUTH command, Exim scans
37334 the authenticators configuration for any suitable client settings, as described
37335 in chapter &<<CHAPSMTPAUTH>>&.
37336
37337 .cindex "carriage return"
37338 .cindex "linefeed"
37339 Responses from the remote host are supposed to be terminated by CR followed by
37340 LF. However, there are known to be hosts that do not send CR characters, so in
37341 order to be able to interwork with such hosts, Exim treats LF on its own as a
37342 line terminator.
37343
37344 If a message contains a number of different addresses, all those with the same
37345 characteristics (for example, the same envelope sender) that resolve to the
37346 same set of hosts, in the same order, are sent in a single SMTP transaction,
37347 even if they are for different domains, unless there are more than the setting
37348 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37349 they are split into groups containing no more than &%max_rcpt%&s addresses
37350 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37351 in parallel sessions. The order of hosts with identical MX values is not
37352 significant when checking whether addresses can be batched in this way.
37353
37354 When the &(smtp)& transport suffers a temporary failure that is not
37355 message-related, Exim updates its transport-specific database, which contains
37356 records indexed by host name that remember which messages are waiting for each
37357 particular host. It also updates the retry database with new retry times.
37358
37359 .cindex "hints database" "retry keys"
37360 Exim's retry hints are based on host name plus IP address, so if one address of
37361 a multi-homed host is broken, it will soon be skipped most of the time.
37362 See the next section for more detail about error handling.
37363
37364 .cindex "SMTP" "passed connection"
37365 .cindex "SMTP" "batching over TCP/IP"
37366 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37367 looks in the hints database for the transport to see if there are any queued
37368 messages waiting for the host to which it is connected.
37369 If it finds one, it arranges to attempt that message on the same connection.
37370
37371 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37372 limit the number of messages sent down a single TCP/IP connection.
37373
37374 .cindex "asterisk" "after IP address"
37375 The second and subsequent messages delivered down an existing connection are
37376 identified in the main log by the addition of an asterisk after the closing
37377 square bracket of the IP address.
37378
37379
37380
37381
37382 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37383 .cindex "error" "in outgoing SMTP"
37384 .cindex "SMTP" "errors in outgoing"
37385 .cindex "host" "error"
37386 Three different kinds of error are recognized for outgoing SMTP: host errors,
37387 message errors, and recipient errors.
37388
37389 .vlist
37390 .vitem "&*Host errors*&"
37391 A host error is not associated with a particular message or with a
37392 particular recipient of a message. The host errors are:
37393
37394 .ilist
37395 Connection refused or timed out,
37396 .next
37397 Any error response code on connection,
37398 .next
37399 Any error response code to EHLO or HELO,
37400 .next
37401 Loss of connection at any time, except after &"."&,
37402 .next
37403 I/O errors at any time,
37404 .next
37405 Timeouts during the session, other than in response to MAIL, RCPT or
37406 the &"."& at the end of the data.
37407 .endlist ilist
37408
37409 For a host error, a permanent error response on connection, or in response to
37410 EHLO, causes all addresses routed to the host to be failed. Any other host
37411 error causes all addresses to be deferred, and retry data to be created for the
37412 host. It is not tried again, for any message, until its retry time arrives. If
37413 the current set of addresses are not all delivered in this run (to some
37414 alternative host), the message is added to the list of those waiting for this
37415 host, so if it is still undelivered when a subsequent successful delivery is
37416 made to the host, it will be sent down the same SMTP connection.
37417
37418 .vitem "&*Message errors*&"
37419 .cindex "message" "error"
37420 A message error is associated with a particular message when sent to a
37421 particular host, but not with a particular recipient of the message. The
37422 message errors are:
37423
37424 .ilist
37425 Any error response code to MAIL, DATA, or the &"."& that terminates
37426 the data,
37427 .next
37428 Timeout after MAIL,
37429 .next
37430 Timeout or loss of connection after the &"."& that terminates the data. A
37431 timeout after the DATA command itself is treated as a host error, as is loss of
37432 connection at any other time.
37433 .endlist ilist
37434
37435 For a message error, a permanent error response (5&'xx'&) causes all addresses
37436 to be failed, and a delivery error report to be returned to the sender. A
37437 temporary error response (4&'xx'&), or one of the timeouts, causes all
37438 addresses to be deferred. Retry data is not created for the host, but instead,
37439 a retry record for the combination of host plus message id is created. The
37440 message is not added to the list of those waiting for this host. This ensures
37441 that the failing message will not be sent to this host again until the retry
37442 time arrives. However, other messages that are routed to the host are not
37443 affected, so if it is some property of the message that is causing the error,
37444 it will not stop the delivery of other mail.
37445
37446 If the remote host specified support for the SIZE parameter in its response
37447 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37448 over-large message will cause a message error because the error arrives as a
37449 response to MAIL.
37450
37451 .vitem "&*Recipient errors*&"
37452 .cindex "recipient" "error"
37453 A recipient error is associated with a particular recipient of a message. The
37454 recipient errors are:
37455
37456 .ilist
37457 Any error response to RCPT,
37458 .next
37459 Timeout after RCPT.
37460 .endlist
37461
37462 For a recipient error, a permanent error response (5&'xx'&) causes the
37463 recipient address to be failed, and a bounce message to be returned to the
37464 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37465 address to be deferred, and routing retry data to be created for it. This is
37466 used to delay processing of the address in subsequent queue runs, until its
37467 routing retry time arrives. This applies to all messages, but because it
37468 operates only in queue runs, one attempt will be made to deliver a new message
37469 to the failing address before the delay starts to operate. This ensures that,
37470 if the failure is really related to the message rather than the recipient
37471 (&"message too big for this recipient"& is a possible example), other messages
37472 have a chance of getting delivered. If a delivery to the address does succeed,
37473 the retry information gets cleared, so all stuck messages get tried again, and
37474 the retry clock is reset.
37475
37476 The message is not added to the list of those waiting for this host. Use of the
37477 host for other messages is unaffected, and except in the case of a timeout,
37478 other recipients are processed independently, and may be successfully delivered
37479 in the current SMTP session. After a timeout it is of course impossible to
37480 proceed with the session, so all addresses get deferred. However, those other
37481 than the one that failed do not suffer any subsequent retry delays. Therefore,
37482 if one recipient is causing trouble, the others have a chance of getting
37483 through when a subsequent delivery attempt occurs before the failing
37484 recipient's retry time.
37485 .endlist
37486
37487 In all cases, if there are other hosts (or IP addresses) available for the
37488 current set of addresses (for example, from multiple MX records), they are
37489 tried in this run for any undelivered addresses, subject of course to their
37490 own retry data. In other words, recipient error retry data does not take effect
37491 until the next delivery attempt.
37492
37493 Some hosts have been observed to give temporary error responses to every
37494 MAIL command at certain times (&"insufficient space"& has been seen). It
37495 would be nice if such circumstances could be recognized, and defer data for the
37496 host itself created, but this is not possible within the current Exim design.
37497 What actually happens is that retry data for every (host, message) combination
37498 is created.
37499
37500 The reason that timeouts after MAIL and RCPT are treated specially is that
37501 these can sometimes arise as a result of the remote host's verification
37502 procedures. Exim makes this assumption, and treats them as if a temporary error
37503 response had been received. A timeout after &"."& is treated specially because
37504 it is known that some broken implementations fail to recognize the end of the
37505 message if the last character of the last line is a binary zero. Thus, it is
37506 helpful to treat this case as a message error.
37507
37508 Timeouts at other times are treated as host errors, assuming a problem with the
37509 host, or the connection to it. If a timeout after MAIL, RCPT,
37510 or &"."& is really a connection problem, the assumption is that at the next try
37511 the timeout is likely to occur at some other point in the dialogue, causing it
37512 then to be treated as a host error.
37513
37514 There is experimental evidence that some MTAs drop the connection after the
37515 terminating &"."& if they do not like the contents of the message for some
37516 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37517 should be given. That is why Exim treats this case as a message rather than a
37518 host error, in order not to delay other messages to the same host.
37519
37520
37521
37522
37523 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37524 .cindex "SMTP" "incoming over TCP/IP"
37525 .cindex "incoming SMTP over TCP/IP"
37526 .cindex "inetd"
37527 .cindex "daemon"
37528 Incoming SMTP messages can be accepted in one of two ways: by running a
37529 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37530 &_/etc/inetd.conf_& should be like this:
37531 .code
37532 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37533 .endd
37534 Exim distinguishes between this case and the case of a locally running user
37535 agent using the &%-bs%& option by checking whether or not the standard input is
37536 a socket. When it is, either the port must be privileged (less than 1024), or
37537 the caller must be root or the Exim user. If any other user passes a socket
37538 with an unprivileged port number, Exim prints a message on the standard error
37539 stream and exits with an error code.
37540
37541 By default, Exim does not make a log entry when a remote host connects or
37542 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37543 unexpected. It can be made to write such log entries by setting the
37544 &%smtp_connection%& log selector.
37545
37546 .cindex "carriage return"
37547 .cindex "linefeed"
37548 Commands from the remote host are supposed to be terminated by CR followed by
37549 LF. However, there are known to be hosts that do not send CR characters. In
37550 order to be able to interwork with such hosts, Exim treats LF on its own as a
37551 line terminator.
37552 Furthermore, because common code is used for receiving messages from all
37553 sources, a CR on its own is also interpreted as a line terminator. However, the
37554 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37555
37556 .cindex "EHLO" "invalid data"
37557 .cindex "HELO" "invalid data"
37558 One area that sometimes gives rise to problems concerns the EHLO or
37559 HELO commands. Some clients send syntactically invalid versions of these
37560 commands, which Exim rejects by default. (This is nothing to do with verifying
37561 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37562 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37563 match the broken hosts that send invalid commands.
37564
37565 .cindex "SIZE option on MAIL command"
37566 .cindex "MAIL" "SIZE option"
37567 The amount of disk space available is checked whenever SIZE is received on
37568 a MAIL command, independently of whether &%message_size_limit%& or
37569 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37570 false. A temporary error is given if there is not enough space. If
37571 &%check_spool_space%& is set, the check is for that amount of space plus the
37572 value given with SIZE, that is, it checks that the addition of the incoming
37573 message will not reduce the space below the threshold.
37574
37575 When a message is successfully received, Exim includes the local message id in
37576 its response to the final &"."& that terminates the data. If the remote host
37577 logs this text it can help with tracing what has happened to a message.
37578
37579 The Exim daemon can limit the number of simultaneous incoming connections it is
37580 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37581 number of simultaneous incoming connections from a single remote host (see the
37582 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37583 rejected using the SMTP temporary error code 421.
37584
37585 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37586 subprocess has finished, as this can get lost at busy times. Instead, it looks
37587 for completed subprocesses every time it wakes up. Provided there are other
37588 things happening (new incoming calls, starts of queue runs), completed
37589 processes will be noticed and tidied away. On very quiet systems you may
37590 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37591 it will be noticed when the daemon next wakes up.
37592
37593 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37594 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37595 high system load &-- for details see the &%smtp_accept_reserve%&,
37596 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37597 applies in both the daemon and &'inetd'& cases.
37598
37599 Exim normally starts a delivery process for each message received, though this
37600 can be varied by means of the &%-odq%& command line option and the
37601 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37602 number of simultaneously running delivery processes started in this way from
37603 SMTP input can be limited by the &%smtp_accept_queue%& and
37604 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37605 subsequently received messages are just put on the input queue without starting
37606 a delivery process.
37607
37608 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37609 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37610 started up from the &'inetd'& daemon, because in that case each connection is
37611 handled by an entirely independent Exim process. Control by load average is,
37612 however, available with &'inetd'&.
37613
37614 Exim can be configured to verify addresses in incoming SMTP commands as they
37615 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37616 to rewrite addresses at this time &-- before any syntax checking is done. See
37617 section &<<SSECTrewriteS>>&.
37618
37619 Exim can also be configured to limit the rate at which a client host submits
37620 MAIL and RCPT commands in a single SMTP session. See the
37621 &%smtp_ratelimit_hosts%& option.
37622
37623
37624
37625 .subsection "Unrecognized SMTP commands" SECID234
37626 .cindex "SMTP" "unrecognized commands"
37627 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37628 commands during a single SMTP connection, it drops the connection after sending
37629 the error response to the last command. The default value for
37630 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37631 abuse that subvert web servers into making connections to SMTP ports; in these
37632 circumstances, a number of non-SMTP lines are sent first.
37633
37634
37635 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37636 .cindex "SMTP" "syntax errors"
37637 .cindex "SMTP" "protocol errors"
37638 A syntax error is detected if an SMTP command is recognized, but there is
37639 something syntactically wrong with its data, for example, a malformed email
37640 address in a RCPT command. Protocol errors include invalid command
37641 sequencing such as RCPT before MAIL. If Exim receives more than
37642 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37643 drops the connection after sending the error response to the last command. The
37644 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37645 broken clients that loop sending bad commands (yes, it has been seen).
37646
37647
37648
37649 .subsection "Use of non-mail SMTP commands" SECID236
37650 .cindex "SMTP" "non-mail commands"
37651 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37652 DATA. Exim counts such commands, and drops the connection if there are too
37653 many of them in a single SMTP session. This action catches some
37654 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37655 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37656 defines what &"too many"& means. Its default value is 10.
37657
37658 When a new message is expected, one occurrence of RSET is not counted. This
37659 allows a client to send one RSET between messages (this is not necessary,
37660 but some clients do it). Exim also allows one uncounted occurrence of HELO
37661 or EHLO, and one occurrence of STARTTLS between messages. After
37662 starting up a TLS session, another EHLO is expected, and so it too is not
37663 counted.
37664
37665 The first occurrence of AUTH in a connection, or immediately following
37666 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37667 RCPT, DATA, and QUIT are counted.
37668
37669 You can control which hosts are subject to the limit set by
37670 &%smtp_accept_max_nonmail%& by setting
37671 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37672 the limit apply to all hosts. This option means that you can exclude any
37673 specific badly-behaved hosts that you have to live with.
37674
37675
37676
37677
37678 .subsection "The VRFY and EXPN commands" SECID237
37679 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37680 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37681 appropriate) in order to decide whether the command should be accepted or not.
37682
37683 .cindex "VRFY" "processing"
37684 When no ACL is defined for VRFY, or if it rejects without
37685 setting an explicit response code, the command is accepted
37686 (with a 252 SMTP response code)
37687 in order to support awkward clients that do a VRFY before every RCPT.
37688 When VRFY is accepted, it runs exactly the same code as when Exim is
37689 called with the &%-bv%& option, and returns 250/451/550
37690 SMTP response codes.
37691
37692 .cindex "EXPN" "processing"
37693 If no ACL for EXPN is defined, the command is rejected.
37694 When EXPN is accepted, a single-level expansion of the address is done.
37695 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37696 than a verification (the &%-bv%& option). If an unqualified local part is given
37697 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37698 of VRFY and EXPN commands are logged on the main and reject logs, and
37699 VRFY verification failures are logged in the main log for consistency with
37700 RCPT failures.
37701
37702
37703
37704 .subsection "The ETRN command" SECTETRN
37705 .cindex "ETRN" "processing"
37706 .cindex "ESMTP extensions" ETRN
37707 Most modern installations never need to use this.
37708 It is used for managing messages queued for an intermittently-connecting
37709 destination (eg. one using a dialup connection).
37710
37711 .oindex "&%acl_smtp_etrn%&"
37712 The command is only available if permitted by an ACL
37713 specfied by the main-section &%acl_smtp_etrn%& option.
37714
37715 RFC 1985 describes an ESMTP command called ETRN that is designed to
37716 overcome the security problems of the TURN command (which has fallen into
37717 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37718 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37719 should be accepted or not. If no ACL is defined, the command is rejected.
37720
37721 The ETRN command is concerned with &"releasing"& messages that are awaiting
37722 delivery to certain hosts. As Exim does not organize its message queue by host,
37723 the only form of ETRN that is supported by default is the one where the
37724 text starts with the &"#"& prefix, in which case the remainder of the text is
37725 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37726 the &%-R%& option to happen, with the remainder of the ETRN text as its
37727 argument. For example,
37728 .code
37729 ETRN #brigadoon
37730 .endd
37731 runs the command
37732 .code
37733 exim -R brigadoon
37734 .endd
37735 which causes a delivery attempt on all messages with undelivered addresses
37736 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37737 default), Exim prevents the simultaneous execution of more than one queue run
37738 for the same argument string as a result of an ETRN command. This stops
37739 a misbehaving client from starting more than one queue runner at once.
37740
37741 .cindex "hints database" "ETRN serialization"
37742 Exim implements the serialization by means of a hints database in which a
37743 record is written whenever a process is started by ETRN, and deleted when
37744 the process completes. However, Exim does not keep the SMTP session waiting for
37745 the ETRN process to complete. Once ETRN is accepted, the client is sent
37746 a &"success"& return code. Obviously there is scope for hints records to get
37747 left lying around if there is a system or program crash. To guard against this,
37748 Exim ignores any records that are more than six hours old.
37749
37750 .oindex "&%smtp_etrn_command%&"
37751 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37752 used. This specifies a command that is run whenever ETRN is received,
37753 whatever the form of its argument. For
37754 example:
37755 .code
37756 smtp_etrn_command = /etc/etrn_command $domain \
37757                     $sender_host_address
37758 .endd
37759 .vindex "&$domain$&"
37760 The string is split up into arguments which are independently expanded. The
37761 expansion variable &$domain$& is set to the argument of the ETRN command,
37762 and no syntax checking is done on the contents of this argument. Exim does not
37763 wait for the command to complete, so its status code is not checked. Exim runs
37764 under its own uid and gid when receiving incoming SMTP, so it is not possible
37765 for it to change them before running the command.
37766
37767
37768
37769 .section "Incoming local SMTP" "SECID238"
37770 .cindex "SMTP" "local incoming"
37771 Some user agents use SMTP to pass messages to their local MTA using the
37772 standard input and output, as opposed to passing the envelope on the command
37773 line and writing the message to the standard input. This is supported by the
37774 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37775 messages over TCP/IP (including the use of ACLs), except that the envelope
37776 sender given in a MAIL command is ignored unless the caller is trusted. In
37777 an ACL you can detect this form of SMTP input by testing for an empty host
37778 identification. It is common to have this as the first line in the ACL that
37779 runs for RCPT commands:
37780 .code
37781 accept hosts = :
37782 .endd
37783 This accepts SMTP messages from local processes without doing any other tests.
37784
37785
37786
37787 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37788 .cindex "SMTP" "batched outgoing"
37789 .cindex "batched SMTP output"
37790 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37791 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37792 be output in BSMTP format. No SMTP responses are possible for this form of
37793 delivery. All it is doing is using SMTP commands as a way of transmitting the
37794 envelope along with the message.
37795
37796 The message is written to the file or pipe preceded by the SMTP commands
37797 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37798 the message that start with a dot have an extra dot added. The SMTP command
37799 HELO is not normally used. If it is required, the &%message_prefix%& option
37800 can be used to specify it.
37801
37802 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37803 one recipient address at a time by default. However, you can arrange for them
37804 to handle several addresses at once by setting the &%batch_max%& option. When
37805 this is done for BSMTP, messages may contain multiple RCPT commands. See
37806 chapter &<<CHAPbatching>>& for more details.
37807
37808 .vindex "&$host$&"
37809 When one or more addresses are routed to a BSMTP transport by a router that
37810 sets up a host list, the name of the first host on the list is available to the
37811 transport in the variable &$host$&. Here is an example of such a transport and
37812 router:
37813 .code
37814 begin routers
37815 route_append:
37816   driver = manualroute
37817   transport = smtp_appendfile
37818   route_list = domain.example  batch.host.example
37819
37820 begin transports
37821 smtp_appendfile:
37822   driver = appendfile
37823   directory = /var/bsmtp/$host
37824   batch_max = 1000
37825   use_bsmtp
37826   user = exim
37827 .endd
37828 This causes messages addressed to &'domain.example'& to be written in BSMTP
37829 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37830 message (unless there are more than 1000 recipients).
37831
37832
37833
37834 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37835 .cindex "SMTP" "batched incoming"
37836 .cindex "batched SMTP input"
37837 The &%-bS%& command line option causes Exim to accept one or more messages by
37838 reading SMTP on the standard input, but to generate no responses. If the caller
37839 is trusted, the senders in the MAIL commands are believed; otherwise the
37840 sender is always the caller of Exim. Unqualified senders and receivers are not
37841 rejected (there seems little point) but instead just get qualified. HELO
37842 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37843 as NOOP; QUIT quits.
37844
37845 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37846 ACL is run in the same way as for non-SMTP local input.
37847
37848 If an error is detected while reading a message, including a missing &"."& at
37849 the end, Exim gives up immediately. It writes details of the error to the
37850 standard output in a stylized way that the calling program should be able to
37851 make some use of automatically, for example:
37852 .code
37853 554 Unexpected end of file
37854 Transaction started in line 10
37855 Error detected in line 14
37856 .endd
37857 It writes a more verbose version, for human consumption, to the standard error
37858 file, for example:
37859 .code
37860 An error was detected while processing a file of BSMTP input.
37861 The error message was:
37862
37863 501 '>' missing at end of address
37864
37865 The SMTP transaction started in line 10.
37866 The error was detected in line 12.
37867 The SMTP command at fault was:
37868
37869 rcpt to:<malformed@in.com.plete
37870
37871 1 previous message was successfully processed.
37872 The rest of the batch was abandoned.
37873 .endd
37874 The return code from Exim is zero only if there were no errors. It is 1 if some
37875 messages were accepted before an error was detected, and 2 if no messages were
37876 accepted.
37877 .ecindex IIDsmtpproc1
37878 .ecindex IIDsmtpproc2
37879
37880
37881
37882 . ////////////////////////////////////////////////////////////////////////////
37883 . ////////////////////////////////////////////////////////////////////////////
37884
37885 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37886          "Customizing messages"
37887 When a message fails to be delivered, or remains in the queue for more than a
37888 configured amount of time, Exim sends a message to the original sender, or
37889 to an alternative configured address. The text of these messages is built into
37890 the code of Exim, but it is possible to change it, either by adding a single
37891 string, or by replacing each of the paragraphs by text supplied in a file.
37892
37893 The &'From:'& and &'To:'& header lines are automatically generated; you can
37894 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37895 option. Exim also adds the line
37896 .code
37897 Auto-Submitted: auto-generated
37898 .endd
37899 to all warning and bounce messages,
37900
37901
37902 .section "Customizing bounce messages" "SECID239"
37903 .cindex "customizing" "bounce message"
37904 .cindex "bounce message" "customizing"
37905 If &%bounce_message_text%& is set, its contents are included in the default
37906 message immediately after &"This message was created automatically by mail
37907 delivery software."& The string is not expanded. It is not used if
37908 &%bounce_message_file%& is set.
37909
37910 When &%bounce_message_file%& is set, it must point to a template file for
37911 constructing error messages. The file consists of a series of text items,
37912 separated by lines consisting of exactly four asterisks. If the file cannot be
37913 opened, default text is used and a message is written to the main and panic
37914 logs. If any text item in the file is empty, default text is used for that
37915 item.
37916
37917 .vindex "&$bounce_recipient$&"
37918 .vindex "&$bounce_return_size_limit$&"
37919 Each item of text that is read from the file is expanded, and there are two
37920 expansion variables which can be of use here: &$bounce_recipient$& is set to
37921 the recipient of an error message while it is being created, and
37922 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37923 option, rounded to a whole number.
37924
37925 The items must appear in the file in the following order:
37926
37927 .ilist
37928 The first item is included in the headers, and should include at least a
37929 &'Subject:'& header. Exim does not check the syntax of these headers.
37930 .next
37931 The second item forms the start of the error message. After it, Exim lists the
37932 failing addresses with their error messages.
37933 .next
37934 The third item is used to introduce any text from pipe transports that is to be
37935 returned to the sender. It is omitted if there is no such text.
37936 .next
37937 The fourth, fifth and sixth items will be ignored and may be empty.
37938 The fields exist for back-compatibility
37939 .endlist
37940
37941 The default state (&%bounce_message_file%& unset) is equivalent to the
37942 following file, in which the sixth item is empty. The &'Subject:'& and some
37943 other lines have been split in order to fit them on the page:
37944 .code
37945 Subject: Mail delivery failed
37946   ${if eq{$sender_address}{$bounce_recipient}
37947   {: returning message to sender}}
37948 ****
37949 This message was created automatically by mail delivery software.
37950
37951 A message ${if eq{$sender_address}{$bounce_recipient}
37952   {that you sent }{sent by
37953
37954 <$sender_address>
37955
37956 }}could not be delivered to all of its recipients.
37957 This is a permanent error. The following address(es) failed:
37958 ****
37959 The following text was generated during the delivery attempt(s):
37960 ****
37961 ------ This is a copy of the message, including all the headers.
37962   ------
37963 ****
37964 ------ The body of the message is $message_size characters long;
37965   only the first
37966 ------ $bounce_return_size_limit or so are included here.
37967 ****
37968 .endd
37969 .section "Customizing warning messages" "SECTcustwarn"
37970 .cindex "customizing" "warning message"
37971 .cindex "warning of delay" "customizing the message"
37972 The option &%warn_message_file%& can be pointed at a template file for use when
37973 warnings about message delays are created. In this case there are only three
37974 text sections:
37975
37976 .ilist
37977 The first item is included in the headers, and should include at least a
37978 &'Subject:'& header. Exim does not check the syntax of these headers.
37979 .next
37980 The second item forms the start of the warning message. After it, Exim lists
37981 the delayed addresses.
37982 .next
37983 The third item then ends the message.
37984 .endlist
37985
37986 The default state is equivalent to the following file, except that some lines
37987 have been split here, in order to fit them on the page:
37988 .code
37989 Subject: Warning: message $message_exim_id delayed
37990   $warn_message_delay
37991 ****
37992 This message was created automatically by mail delivery software.
37993
37994 A message ${if eq{$sender_address}{$warn_message_recipients}
37995 {that you sent }{sent by
37996
37997 <$sender_address>
37998
37999 }}has not been delivered to all of its recipients after
38000 more than $warn_message_delay in the queue on $primary_hostname.
38001
38002 The message identifier is:     $message_exim_id
38003 The subject of the message is: $h_subject
38004 The date of the message is:    $h_date
38005
38006 The following address(es) have not yet been delivered:
38007 ****
38008 No action is required on your part. Delivery attempts will
38009 continue for some time, and this warning may be repeated at
38010 intervals if the message remains undelivered. Eventually the
38011 mail delivery software will give up, and when that happens,
38012 the message will be returned to you.
38013 .endd
38014 .vindex "&$warn_message_delay$&"
38015 .vindex "&$warn_message_recipients$&"
38016 However, in the default state the subject and date lines are omitted if no
38017 appropriate headers exist. During the expansion of this file,
38018 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
38019 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
38020 of recipients for the warning message. There may be more than one if there are
38021 multiple addresses with different &%errors_to%& settings on the routers that
38022 handled them.
38023
38024
38025
38026
38027 . ////////////////////////////////////////////////////////////////////////////
38028 . ////////////////////////////////////////////////////////////////////////////
38029
38030 .chapter "Some common configuration settings" "CHAPcomconreq"
38031 This chapter discusses some configuration settings that seem to be fairly
38032 common. More examples and discussion can be found in the Exim book.
38033
38034
38035
38036 .section "Sending mail to a smart host" "SECID240"
38037 .cindex "smart host" "example router"
38038 If you want to send all mail for non-local domains to a &"smart host"&, you
38039 should replace the default &(dnslookup)& router with a router which does the
38040 routing explicitly:
38041 .code
38042 send_to_smart_host:
38043   driver = manualroute
38044   route_list = !+local_domains smart.host.name
38045   transport = remote_smtp
38046 .endd
38047 You can use the smart host's IP address instead of the name if you wish.
38048 If you are using Exim only to submit messages to a smart host, and not for
38049 receiving incoming messages, you can arrange for it to do the submission
38050 synchronously by setting the &%mua_wrapper%& option (see chapter
38051 &<<CHAPnonqueueing>>&).
38052
38053
38054
38055
38056 .section "Using Exim to handle mailing lists" "SECTmailinglists"
38057 .cindex "mailing lists"
38058 Exim can be used to run simple mailing lists, but for large and/or complicated
38059 requirements, the use of additional specialized mailing list software such as
38060 Majordomo or Mailman is recommended.
38061
38062 The &(redirect)& router can be used to handle mailing lists where each list
38063 is maintained in a separate file, which can therefore be managed by an
38064 independent manager. The &%domains%& router option can be used to run these
38065 lists in a separate domain from normal mail. For example:
38066 .code
38067 lists:
38068   driver = redirect
38069   domains = lists.example
38070   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
38071   forbid_pipe
38072   forbid_file
38073   errors_to = ${quote_local_part:$local_part-request}@lists.example
38074   no_more
38075 .endd
38076 This router is skipped for domains other than &'lists.example'&. For addresses
38077 in that domain, it looks for a file that matches the local part. If there is no
38078 such file, the router declines, but because &%no_more%& is set, no subsequent
38079 routers are tried, and so the whole delivery fails.
38080
38081 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
38082 expanded into a filename or a pipe delivery, which is usually inappropriate in
38083 a mailing list.
38084
38085 .oindex "&%errors_to%&"
38086 The &%errors_to%& option specifies that any delivery errors caused by addresses
38087 taken from a mailing list are to be sent to the given address rather than the
38088 original sender of the message. However, before acting on this, Exim verifies
38089 the error address, and ignores it if verification fails.
38090
38091 For example, using the configuration above, mail sent to
38092 &'dicts@lists.example'& is passed on to those addresses contained in
38093 &_/usr/lists/dicts_&, with error reports directed to
38094 &'dicts-request@lists.example'&, provided that this address can be verified.
38095 There could be a file called &_/usr/lists/dicts-request_& containing
38096 the address(es) of this particular list's manager(s), but other approaches,
38097 such as setting up an earlier router (possibly using the &%local_part_prefix%&
38098 or &%local_part_suffix%& options) to handle addresses of the form
38099 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
38100
38101
38102
38103 .section "Syntax errors in mailing lists" "SECID241"
38104 .cindex "mailing lists" "syntax errors in"
38105 If an entry in redirection data contains a syntax error, Exim normally defers
38106 delivery of the original address. That means that a syntax error in a mailing
38107 list holds up all deliveries to the list. This may not be appropriate when a
38108 list is being maintained automatically from data supplied by users, and the
38109 addresses are not rigorously checked.
38110
38111 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
38112 entries that fail to parse, noting the incident in the log. If in addition
38113 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
38114 whenever a broken address is skipped. It is usually appropriate to set
38115 &%syntax_errors_to%& to the same address as &%errors_to%&.
38116
38117
38118
38119 .section "Re-expansion of mailing lists" "SECID242"
38120 .cindex "mailing lists" "re-expansion of"
38121 Exim remembers every individual address to which a message has been delivered,
38122 in order to avoid duplication, but it normally stores only the original
38123 recipient addresses with a message. If all the deliveries to a mailing list
38124 cannot be done at the first attempt, the mailing list is re-expanded when the
38125 delivery is next tried. This means that alterations to the list are taken into
38126 account at each delivery attempt, so addresses that have been added to
38127 the list since the message arrived will therefore receive a copy of the
38128 message, even though it pre-dates their subscription.
38129
38130 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
38131 on the &(redirect)& router. If this is done, any addresses generated by the
38132 router that fail to deliver at the first attempt are added to the message as
38133 &"top level"& addresses, and the parent address that generated them is marked
38134 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
38135 subsequent delivery attempts. The disadvantage of this is that if any of the
38136 failing addresses are incorrect, correcting them in the file has no effect on
38137 pre-existing messages.
38138
38139 The original top-level address is remembered with each of the generated
38140 addresses, and is output in any log messages. However, any intermediate parent
38141 addresses are not recorded. This makes a difference to the log only if the
38142 &%all_parents%& selector is set, but for mailing lists there is normally only
38143 one level of expansion anyway.
38144
38145
38146
38147 .section "Closed mailing lists" "SECID243"
38148 .cindex "mailing lists" "closed"
38149 The examples so far have assumed open mailing lists, to which anybody may
38150 send mail. It is also possible to set up closed lists, where mail is accepted
38151 from specified senders only. This is done by making use of the generic
38152 &%senders%& option to restrict the router that handles the list.
38153
38154 The following example uses the same file as a list of recipients and as a list
38155 of permitted senders. It requires three routers:
38156 .code
38157 lists_request:
38158   driver = redirect
38159   domains = lists.example
38160   local_part_suffix = -request
38161   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
38162   file = /usr/lists/${local_part_data}-request
38163   no_more
38164
38165 lists_post:
38166   driver = redirect
38167   domains = lists.example
38168   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
38169   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
38170   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
38171   forbid_pipe
38172   forbid_file
38173   errors_to = ${quote_local_part:$local_part-request}@lists.example
38174   no_more
38175
38176 lists_closed:
38177   driver = redirect
38178   domains = lists.example
38179   allow_fail
38180   data = :fail: $local_part@lists.example is a closed mailing list
38181 .endd
38182 All three routers have the same &%domains%& setting, so for any other domains,
38183 they are all skipped. The first router runs only if the local part ends in
38184 &%-request%&. It handles messages to the list manager(s) by means of an open
38185 mailing list.
38186
38187 The second router runs only if the &%senders%& precondition is satisfied. It
38188 checks for the existence of a list that corresponds to the local part, and then
38189 checks that the sender is on the list by means of a linear search. It is
38190 necessary to check for the existence of the file before trying to search it,
38191 because otherwise Exim thinks there is a configuration error. If the file does
38192 not exist, the expansion of &%senders%& is *, which matches all senders. This
38193 means that the router runs, but because there is no list, declines, and
38194 &%no_more%& ensures that no further routers are run. The address fails with an
38195 &"unrouteable address"& error.
38196
38197 The third router runs only if the second router is skipped, which happens when
38198 a mailing list exists, but the sender is not on it. This router forcibly fails
38199 the address, giving a suitable error message.
38200
38201
38202
38203
38204 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
38205 .cindex "VERP"
38206 .cindex "Variable Envelope Return Paths"
38207 .cindex "envelope from"
38208 .cindex "envelope sender"
38209 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
38210 are a way of helping mailing list administrators discover which subscription
38211 address is the cause of a particular delivery failure. The idea is to encode
38212 the original recipient address in the outgoing envelope sender address, so that
38213 if the message is forwarded by another host and then subsequently bounces, the
38214 original recipient can be extracted from the recipient address of the bounce.
38215
38216 .oindex &%errors_to%&
38217 .oindex &%return_path%&
38218 Envelope sender addresses can be modified by Exim using two different
38219 facilities: the &%errors_to%& option on a router (as shown in previous mailing
38220 list examples), or the &%return_path%& option on a transport. The second of
38221 these is effective only if the message is successfully delivered to another
38222 host; it is not used for errors detected on the local host (see the description
38223 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
38224 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
38225 .code
38226 verp_smtp:
38227   driver = smtp
38228   max_rcpt = 1
38229   return_path = \
38230     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38231       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38232 .endd
38233 This has the effect of rewriting the return path (envelope sender) on outgoing
38234 SMTP messages, if the local part of the original return path ends in
38235 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
38236 local part and domain of the recipient into the return path. Suppose, for
38237 example, that a message whose return path has been set to
38238 &'somelist-request@your.dom.example'& is sent to
38239 &'subscriber@other.dom.example'&. In the transport, the return path is
38240 rewritten as
38241 .code
38242 somelist-request+subscriber=other.dom.example@your.dom.example
38243 .endd
38244 .vindex "&$local_part$&"
38245 For this to work, you must tell Exim to send multiple copies of messages that
38246 have more than one recipient, so that each copy has just one recipient. This is
38247 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
38248 might be sent to several different recipients in the same domain, in which case
38249 &$local_part$& is not available in the transport, because it is not unique.
38250
38251 Unless your host is doing nothing but mailing list deliveries, you should
38252 probably use a separate transport for the VERP deliveries, so as not to use
38253 extra resources in making one-per-recipient copies for other deliveries. This
38254 can easily be done by expanding the &%transport%& option in the router:
38255 .code
38256 dnslookup:
38257   driver = dnslookup
38258   domains = ! +local_domains
38259   transport = \
38260     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38261       {verp_smtp}{remote_smtp}}
38262   no_more
38263 .endd
38264 If you want to change the return path using &%errors_to%& in a router instead
38265 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38266 routers that handle mailing list addresses. This will ensure that all delivery
38267 errors, including those detected on the local host, are sent to the VERP
38268 address.
38269
38270 On a host that does no local deliveries and has no manual routing, only the
38271 &(dnslookup)& router needs to be changed. A special transport is not needed for
38272 SMTP deliveries. Every mailing list recipient has its own return path value,
38273 and so Exim must hand them to the transport one at a time. Here is an example
38274 of a &(dnslookup)& router that implements VERP:
38275 .code
38276 verp_dnslookup:
38277   driver = dnslookup
38278   domains = ! +local_domains
38279   transport = remote_smtp
38280   errors_to = \
38281     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38282      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38283   no_more
38284 .endd
38285 Before you start sending out messages with VERPed return paths, you must also
38286 configure Exim to accept the bounce messages that come back to those paths.
38287 Typically this is done by setting a &%local_part_suffix%& option for a
38288 router, and using this to route the messages to wherever you want to handle
38289 them.
38290
38291 The overhead incurred in using VERP depends very much on the size of the
38292 message, the number of recipient addresses that resolve to the same remote
38293 host, and the speed of the connection over which the message is being sent. If
38294 a lot of addresses resolve to the same host and the connection is slow, sending
38295 a separate copy of the message for each address may take substantially longer
38296 than sending a single copy with many recipients (for which VERP cannot be
38297 used).
38298
38299
38300
38301
38302
38303
38304 .section "Virtual domains" "SECTvirtualdomains"
38305 .cindex "virtual domains"
38306 .cindex "domain" "virtual"
38307 The phrase &'virtual domain'& is unfortunately used with two rather different
38308 meanings:
38309
38310 .ilist
38311 A domain for which there are no real mailboxes; all valid local parts are
38312 aliases for other email addresses. Common examples are organizational
38313 top-level domains and &"vanity"& domains.
38314 .next
38315 One of a number of independent domains that are all handled by the same host,
38316 with mailboxes on that host, but where the mailbox owners do not necessarily
38317 have login accounts on that host.
38318 .endlist
38319
38320 The first usage is probably more common, and does seem more &"virtual"& than
38321 the second. This kind of domain can be handled in Exim with a straightforward
38322 aliasing router. One approach is to create a separate alias file for each
38323 virtual domain. Exim can test for the existence of the alias file to determine
38324 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38325 to a router of this form:
38326 .code
38327 virtual:
38328   driver = redirect
38329   domains = dsearch;/etc/mail/virtual
38330   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38331   no_more
38332 .endd
38333 The &%domains%& option specifies that the router is to be skipped, unless there
38334 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38335 domain that is being processed.
38336 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38337 being placed into the &$domain_data$& variable.
38338
38339 When the router runs, it looks up the local
38340 part in the file to find a new address (or list of addresses). The &%no_more%&
38341 setting ensures that if the lookup fails (leading to &%data%& being an empty
38342 string), Exim gives up on the address without trying any subsequent routers.
38343
38344 This one router can handle all the virtual domains because the alias filenames
38345 follow a fixed pattern. Permissions can be arranged so that appropriate people
38346 can edit the different alias files. A successful aliasing operation results in
38347 a new envelope recipient address, which is then routed from scratch.
38348
38349 The other kind of &"virtual"& domain can also be handled in a straightforward
38350 way. One approach is to create a file for each domain containing a list of
38351 valid local parts, and use it in a router like this:
38352 .code
38353 my_domains:
38354   driver = accept
38355   domains = dsearch;/etc/mail/domains
38356   local_parts = lsearch;/etc/mail/domains/$domain
38357   transport = my_mailboxes
38358 .endd
38359 The address is accepted if there is a file for the domain, and the local part
38360 can be found in the file. The &%domains%& option is used to check for the
38361 file's existence because &%domains%& is tested before the &%local_parts%&
38362 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38363 because that option is tested after &%local_parts%&. The transport is as
38364 follows:
38365 .code
38366 my_mailboxes:
38367   driver = appendfile
38368   file = /var/mail/$domain_data/$local_part_data
38369   user = mail
38370 .endd
38371 This uses a directory of mailboxes for each domain. The &%user%& setting is
38372 required, to specify which uid is to be used for writing to the mailboxes.
38373
38374 The configuration shown here is just one example of how you might support this
38375 requirement. There are many other ways this kind of configuration can be set
38376 up, for example, by using a database instead of separate files to hold all the
38377 information about the domains.
38378
38379
38380
38381 .section "Multiple user mailboxes" "SECTmulbox"
38382 .cindex "multiple mailboxes"
38383 .cindex "mailbox" "multiple"
38384 .cindex "local part" "prefix"
38385 .cindex "local part" "suffix"
38386 Heavy email users often want to operate with multiple mailboxes, into which
38387 incoming mail is automatically sorted. A popular way of handling this is to
38388 allow users to use multiple sender addresses, so that replies can easily be
38389 identified. Users are permitted to add prefixes or suffixes to their local
38390 parts for this purpose. The wildcard facility of the generic router options
38391 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38392 example, consider this router:
38393 .code
38394 userforward:
38395   driver = redirect
38396   check_local_user
38397   file = $home/.forward
38398   local_part_suffix = -*
38399   local_part_suffix_optional
38400   allow_filter
38401 .endd
38402 .vindex "&$local_part_suffix$&"
38403 It runs a user's &_.forward_& file for all local parts of the form
38404 &'username-*'&. Within the filter file the user can distinguish different
38405 cases by testing the variable &$local_part_suffix$&. For example:
38406 .code
38407 if $local_part_suffix contains -special then
38408 save /home/$local_part_data/Mail/special
38409 endif
38410 .endd
38411 If the filter file does not exist, or does not deal with such addresses, they
38412 fall through to subsequent routers, and, assuming no subsequent use of the
38413 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38414 control over which suffixes are valid.
38415
38416 Alternatively, a suffix can be used to trigger the use of a different
38417 &_.forward_& file &-- which is the way a similar facility is implemented in
38418 another MTA:
38419 .code
38420 userforward:
38421   driver = redirect
38422   check_local_user
38423   local_part_suffix = -*
38424   local_part_suffix_optional
38425   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38426   allow_filter
38427 .endd
38428 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38429 example, &_.forward-special_& is used. Once again, if the appropriate file
38430 does not exist, or does not deal with the address, it is passed on to
38431 subsequent routers, which could, if required, look for an unqualified
38432 &_.forward_& file to use as a default.
38433
38434
38435
38436 .section "Simplified vacation processing" "SECID244"
38437 .cindex "vacation processing"
38438 The traditional way of running the &'vacation'& program is for a user to set up
38439 a pipe command in a &_.forward_& file
38440 (see section &<<SECTspecitredli>>& for syntax details).
38441 This is prone to error by inexperienced users. There are two features of Exim
38442 that can be used to make this process simpler for users:
38443
38444 .ilist
38445 A local part prefix such as &"vacation-"& can be specified on a router which
38446 can cause the message to be delivered directly to the &'vacation'& program, or
38447 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38448 &_.forward_& file are then much simpler. For example:
38449 .code
38450 spqr, vacation-spqr
38451 .endd
38452 .next
38453 The &%require_files%& generic router option can be used to trigger a
38454 vacation delivery by checking for the existence of a certain file in the
38455 user's home directory. The &%unseen%& generic option should also be used, to
38456 ensure that the original delivery also proceeds. In this case, all the user has
38457 to do is to create a file called, say, &_.vacation_&, containing a vacation
38458 message.
38459 .endlist
38460
38461 Another advantage of both these methods is that they both work even when the
38462 use of arbitrary pipes by users is locked out.
38463
38464
38465
38466 .section "Taking copies of mail" "SECID245"
38467 .cindex "message" "copying every"
38468 Some installations have policies that require archive copies of all messages to
38469 be made. A single copy of each message can easily be taken by an appropriate
38470 command in a system filter, which could, for example, use a different file for
38471 each day's messages.
38472
38473 There is also a shadow transport mechanism that can be used to take copies of
38474 messages that are successfully delivered by local transports, one copy per
38475 delivery. This could be used, &'inter alia'&, to implement automatic
38476 notification of delivery by sites that insist on doing such things.
38477
38478
38479
38480 .section "Intermittently connected hosts" "SECID246"
38481 .cindex "intermittently connected hosts"
38482 It has become quite common (because it is cheaper) for hosts to connect to the
38483 Internet periodically rather than remain connected all the time. The normal
38484 arrangement is that mail for such hosts accumulates on a system that is
38485 permanently connected.
38486
38487 Exim was designed for use on permanently connected hosts, and so it is not
38488 particularly well-suited to use in an intermittently connected environment.
38489 Nevertheless there are some features that can be used.
38490
38491
38492 .section "Exim on the upstream server host" "SECID247"
38493 It is tempting to arrange for incoming mail for the intermittently connected
38494 host to remain in Exim's queue until the client connects. However, this
38495 approach does not scale very well. Two different kinds of waiting message are
38496 being mixed up in the same queue &-- those that cannot be delivered because of
38497 some temporary problem, and those that are waiting for their destination host
38498 to connect. This makes it hard to manage the queue, as well as wasting
38499 resources, because each queue runner scans the entire queue.
38500
38501 A better approach is to separate off those messages that are waiting for an
38502 intermittently connected host. This can be done by delivering these messages
38503 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38504 format, from where they are transmitted by other software when their
38505 destination connects. This makes it easy to collect all the mail for one host
38506 in a single directory, and to apply local timeout rules on a per-message basis
38507 if required.
38508
38509 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38510 you are doing this, you should configure Exim with a long retry period for the
38511 intermittent host. For example:
38512 .code
38513 cheshire.wonderland.fict.example    *   F,5d,24h
38514 .endd
38515 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38516 which messages it has queued up for that host. Once the intermittent host comes
38517 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38518 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38519 causes all the queued up messages to be delivered, often down a single SMTP
38520 connection. While the host remains connected, any new messages get delivered
38521 immediately.
38522
38523 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38524 issued with a different IP address each time it connects, Exim's retry
38525 mechanisms on the holding host get confused, because the IP address is normally
38526 used as part of the key string for holding retry information. This can be
38527 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38528 Since this has disadvantages for permanently connected hosts, it is best to
38529 arrange a separate transport for the intermittently connected ones.
38530
38531
38532
38533 .section "Exim on the intermittently connected client host" "SECID248"
38534 The value of &%smtp_accept_queue_per_connection%& should probably be
38535 increased, or even set to zero (that is, disabled) on the intermittently
38536 connected host, so that all incoming messages down a single connection get
38537 delivered immediately.
38538
38539 .cindex "SMTP" "passed connection"
38540 .cindex "SMTP" "multiple deliveries"
38541 .cindex "multiple SMTP deliveries"
38542 .cindex "first pass routing"
38543 Mail waiting to be sent from an intermittently connected host will probably
38544 not have been routed, because without a connection DNS lookups are not
38545 possible. This means that if a normal queue run is done at connection time,
38546 each message is likely to be sent in a separate SMTP session. This can be
38547 avoided by starting the queue run with a command line option beginning with
38548 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38549 first pass, routing is done but no deliveries take place. The second pass is a
38550 normal queue run; since all the messages have been previously routed, those
38551 destined for the same host are likely to get sent as multiple deliveries in a
38552 single SMTP connection.
38553
38554
38555
38556 . ////////////////////////////////////////////////////////////////////////////
38557 . ////////////////////////////////////////////////////////////////////////////
38558
38559 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38560          "Exim as a non-queueing client"
38561 .cindex "client, non-queueing"
38562 .cindex "smart host" "suppressing queueing"
38563 On a personal computer, it is a common requirement for all
38564 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38565 configured to operate that way, for all the popular operating systems.
38566 However, there are some MUAs for Unix-like systems that cannot be so
38567 configured: they submit messages using the command line interface of
38568 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38569 messages this way.
38570
38571 If the personal computer runs continuously, there is no problem, because it can
38572 run a conventional MTA that handles delivery to the smart host, and deal with
38573 any delays via its queueing mechanism. However, if the computer does not run
38574 continuously or runs different operating systems at different times, queueing
38575 email is not desirable.
38576
38577 There is therefore a requirement for something that can provide the
38578 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38579 any queueing or retrying facilities. Furthermore, the delivery to the smart
38580 host should be synchronous, so that if it fails, the sending MUA is immediately
38581 informed. In other words, we want something that extends an MUA that submits
38582 to a local MTA via the command line so that it behaves like one that submits
38583 to a remote smart host using TCP/SMTP.
38584
38585 There are a number of applications (for example, there is one called &'ssmtp'&)
38586 that do this job. However, people have found them to be lacking in various
38587 ways. For instance, you might want to allow aliasing and forwarding to be done
38588 before sending a message to the smart host.
38589
38590 Exim already had the necessary infrastructure for doing this job. Just a few
38591 tweaks were needed to make it behave as required, though it is somewhat of an
38592 overkill to use a fully-featured MTA for this purpose.
38593
38594 .oindex "&%mua_wrapper%&"
38595 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38596 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38597 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38598 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38599 compatible router and transport configuration. Typically there will be just one
38600 router and one transport, sending everything to a smart host.
38601
38602 When run in MUA wrapping mode, the behaviour of Exim changes in the
38603 following ways:
38604
38605 .ilist
38606 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38607 In other words, the only way to submit messages is via the command line.
38608 .next
38609 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38610 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38611 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38612 does not finish until the delivery attempt is complete. If the delivery is
38613 successful, a zero return code is given.
38614 .next
38615 Address redirection is permitted, but the final routing for all addresses must
38616 be to the same remote transport, and to the same list of hosts. Furthermore,
38617 the return address (envelope sender) must be the same for all recipients, as
38618 must any added or deleted header lines. In other words, it must be possible to
38619 deliver the message in a single SMTP transaction, however many recipients there
38620 are.
38621 .next
38622 If these conditions are not met, or if routing any address results in a
38623 failure or defer status, or if Exim is unable to deliver all the recipients
38624 successfully to one of the smart hosts, delivery of the entire message fails.
38625 .next
38626 Because no queueing is allowed, all failures are treated as permanent; there
38627 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38628 smart host. Furthermore, because only a single yes/no response can be given to
38629 the caller, it is not possible to deliver to some recipients and not others. If
38630 there is an error (temporary or permanent) for any recipient, all are failed.
38631 .next
38632 If more than one smart host is listed, Exim will try another host after a
38633 connection failure or a timeout, in the normal way. However, if this kind of
38634 failure happens for all the hosts, the delivery fails.
38635 .next
38636 When delivery fails, an error message is written to the standard error stream
38637 (as well as to Exim's log), and Exim exits to the caller with a return code
38638 value 1. The message is expunged from Exim's spool files. No bounce messages
38639 are ever generated.
38640 .next
38641 No retry data is maintained, and any retry rules are ignored.
38642 .next
38643 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38644 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38645 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38646 .endlist
38647
38648 The overall effect is that Exim makes a single synchronous attempt to deliver
38649 the message, failing if there is any kind of problem. Because no local
38650 deliveries are done and no daemon can be run, Exim does not need root
38651 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38652 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38653 the advantages and disadvantages of running without root privilege.
38654
38655
38656
38657
38658 . ////////////////////////////////////////////////////////////////////////////
38659 . ////////////////////////////////////////////////////////////////////////////
38660
38661 .chapter "Log files" "CHAPlog"
38662 .scindex IIDloggen "log" "general description"
38663 .cindex "log" "types of"
38664 Exim writes three different logs, referred to as the main log, the reject log,
38665 and the panic log:
38666
38667 .ilist
38668 .cindex "main log"
38669 The main log records the arrival of each message and each delivery in a single
38670 line in each case. The format is as compact as possible, in an attempt to keep
38671 down the size of log files. Two-character flag sequences make it easy to pick
38672 out these lines. A number of other events are recorded in the main log. Some of
38673 them are optional, in which case the &%log_selector%& option controls whether
38674 they are included or not. A Perl script called &'eximstats'&, which does simple
38675 analysis of main log files, is provided in the Exim distribution (see section
38676 &<<SECTmailstat>>&).
38677 .next
38678 .cindex "reject log"
38679 The reject log records information from messages that are rejected as a result
38680 of a configuration option (that is, for policy reasons).
38681 The first line of each rejection is a copy of the line that is also written to
38682 the main log. Then, if the message's header has been read at the time the log
38683 is written, its contents are written to this log. Only the original header
38684 lines are available; header lines added by ACLs are not logged. You can use the
38685 reject log to check that your policy controls are working correctly; on a busy
38686 host this may be easier than scanning the main log for rejection messages. You
38687 can suppress the writing of the reject log by setting &%write_rejectlog%&
38688 false.
38689 .next
38690 .cindex "panic log"
38691 .cindex "system log"
38692 When certain serious errors occur, Exim writes entries to its panic log. If the
38693 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38694 are usually written to the main log as well, but can get lost amid the mass of
38695 other entries. The panic log should be empty under normal circumstances. It is
38696 therefore a good idea to check it (or to have a &'cron'& script check it)
38697 regularly, in order to become aware of any problems. When Exim cannot open its
38698 panic log, it tries as a last resort to write to the system log (syslog). This
38699 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38700 message itself is written at priority LOG_CRIT.
38701 .endlist
38702
38703 Every log line starts with a timestamp, in the format shown in the following
38704 example. Note that many of the examples shown in this chapter are line-wrapped.
38705 In the log file, this would be all on one line:
38706 .code
38707 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38708   by QUIT
38709 .endd
38710 By default, the timestamps are in the local timezone. There are two
38711 ways of changing this:
38712
38713 .ilist
38714 You can set the &%timezone%& option to a different time zone; in particular, if
38715 you set
38716 .code
38717 timezone = UTC
38718 .endd
38719 the timestamps will be in UTC (aka GMT).
38720 .next
38721 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38722 example:
38723 .code
38724 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38725 .endd
38726 .endlist
38727
38728 .cindex "log" "process ids in"
38729 .cindex "pid (process id)" "in log lines"
38730 Exim does not include its process id in log lines by default, but you can
38731 request that it does so by specifying the &`pid`& log selector (see section
38732 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38733 brackets, immediately after the time and date.
38734
38735
38736
38737
38738 .section "Where the logs are written" "SECTwhelogwri"
38739 .cindex "log" "destination"
38740 .cindex "log" "to file"
38741 .cindex "log" "to syslog"
38742 .cindex "syslog"
38743 The logs may be written to local files, or to syslog, or both. However, it
38744 should be noted that many syslog implementations use UDP as a transport, and
38745 are therefore unreliable in the sense that messages are not guaranteed to
38746 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38747 It has also been reported that on large log files (tens of megabytes) you may
38748 need to tweak syslog to prevent it syncing the file with each write &-- on
38749 Linux this has been seen to make syslog take 90% plus of CPU time.
38750
38751 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38752 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38753 configuration. This latter string is expanded, so it can contain, for example,
38754 references to the host name:
38755 .code
38756 log_file_path = /var/log/$primary_hostname/exim_%slog
38757 .endd
38758 It is generally advisable, however, to set the string in &_Local/Makefile_&
38759 rather than at runtime, because then the setting is available right from the
38760 start of Exim's execution. Otherwise, if there's something it wants to log
38761 before it has read the configuration file (for example, an error in the
38762 configuration file) it will not use the path you want, and may not be able to
38763 log at all.
38764
38765 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38766 list, currently limited to at most two items. This is one option where the
38767 facility for changing a list separator may not be used. The list must always be
38768 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38769 otherwise the item must either be an absolute path, containing &`%s`& at the
38770 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38771 implying the use of a default path.
38772
38773 When Exim encounters an empty item in the list, it searches the list defined by
38774 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38775 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38776 mean &"use the path specified at build time"&. If no such item exists, log
38777 files are written in the &_log_& subdirectory of the spool directory. This is
38778 equivalent to the configuration file setting:
38779 .code
38780 log_file_path = $spool_directory/log/%slog
38781 .endd
38782 If you do not specify anything at build time or runtime,
38783 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38784 that is where the logs are written.
38785
38786 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38787 are in use &-- see section &<<SECTdatlogfil>>& below.
38788
38789 Here are some examples of possible Makefile settings:
38790 .display
38791 &`LOG_FILE_PATH=syslog                    `& syslog only
38792 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38793 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38794 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38795 .endd
38796 If there are more than two paths in the list, the first is used and a panic
38797 error is logged.
38798
38799
38800
38801 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38802 .cindex "log" "cycling local files"
38803 .cindex "cycling logs"
38804 .cindex "&'exicyclog'&"
38805 .cindex "log" "local files; writing to"
38806 Some operating systems provide centralized and standardized methods for cycling
38807 log files. For those that do not, a utility script called &'exicyclog'& is
38808 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38809 main and reject logs each time it is called. The maximum number of old logs to
38810 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38811
38812 An Exim delivery process opens the main log when it first needs to write to it,
38813 and it keeps the file open in case subsequent entries are required &-- for
38814 example, if a number of different deliveries are being done for the same
38815 message. However, remote SMTP deliveries can take a long time, and this means
38816 that the file may be kept open long after it is renamed if &'exicyclog'& or
38817 something similar is being used to rename log files on a regular basis. To
38818 ensure that a switch of log files is noticed as soon as possible, Exim calls
38819 &[stat()]& on the main log's name before reusing an open file, and if the file
38820 does not exist, or its inode has changed, the old file is closed and Exim
38821 tries to open the main log from scratch. Thus, an old log file may remain open
38822 for quite some time, but no Exim processes should write to it once it has been
38823 renamed.
38824
38825
38826
38827 .section "Datestamped log files" "SECTdatlogfil"
38828 .cindex "log" "datestamped files"
38829 Instead of cycling the main and reject log files by renaming them
38830 periodically, some sites like to use files whose names contain a datestamp,
38831 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38832 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38833 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38834 point where the datestamp is required. For example:
38835 .code
38836 log_file_path = /var/spool/exim/log/%slog-%D
38837 log_file_path = /var/log/exim-%s-%D.log
38838 log_file_path = /var/spool/exim/log/%D-%slog
38839 log_file_path = /var/log/exim/%s.%M
38840 .endd
38841 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38842 examples of names generated by the above examples:
38843 .code
38844 /var/spool/exim/log/mainlog-20021225
38845 /var/log/exim-reject-20021225.log
38846 /var/spool/exim/log/20021225-mainlog
38847 /var/log/exim/main.200212
38848 .endd
38849 When this form of log file is specified, Exim automatically switches to new
38850 files at midnight. It does not make any attempt to compress old logs; you
38851 will need to write your own script if you require this. You should not
38852 run &'exicyclog'& with this form of logging.
38853
38854 The location of the panic log is also determined by &%log_file_path%&, but it
38855 is not datestamped, because rotation of the panic log does not make sense.
38856 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38857 the string. In addition, if it immediately follows a slash, a following
38858 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38859 character is removed. Thus, the four examples above would give these panic
38860 log names:
38861 .code
38862 /var/spool/exim/log/paniclog
38863 /var/log/exim-panic.log
38864 /var/spool/exim/log/paniclog
38865 /var/log/exim/panic
38866 .endd
38867
38868
38869 .section "Logging to syslog" "SECID249"
38870 .cindex "log" "syslog; writing to"
38871 The use of syslog does not change what Exim logs or the format of its messages,
38872 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38873 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38874 that, the same strings are written to syslog as to log files. The syslog
38875 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38876 by default, but you can change these by setting the &%syslog_facility%& and
38877 &%syslog_processname%& options, respectively. If Exim was compiled with
38878 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38879 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38880 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38881 the time and host name to each line.
38882 The three log streams are mapped onto syslog priorities as follows:
38883
38884 .ilist
38885 &'mainlog'& is mapped to LOG_INFO
38886 .next
38887 &'rejectlog'& is mapped to LOG_NOTICE
38888 .next
38889 &'paniclog'& is mapped to LOG_ALERT
38890 .endlist
38891
38892 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38893 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38894 these are routed by syslog to the same place. You can suppress this duplication
38895 by setting &%syslog_duplication%& false.
38896
38897 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38898 entries contain multiple lines when headers are included. To cope with both
38899 these cases, entries written to syslog are split into separate &[syslog()]&
38900 calls at each internal newline, and also after a maximum of
38901 870 data characters. (This allows for a total syslog line length of 1024, when
38902 additions such as timestamps are added.) If you are running a syslog
38903 replacement that can handle lines longer than the 1024 characters allowed by
38904 RFC 3164, you should set
38905 .code
38906 SYSLOG_LONG_LINES=yes
38907 .endd
38908 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38909 lines, but it still splits at internal newlines in &'reject'& log entries.
38910
38911 To make it easy to re-assemble split lines later, each component of a split
38912 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38913 where <&'n'&> is the component number and <&'m'&> is the total number of
38914 components in the entry. The / delimiter is used when the line was split
38915 because it was too long; if it was split because of an internal newline, the \
38916 delimiter is used. For example, supposing the length limit to be 50 instead of
38917 870, the following would be the result of a typical rejection message to
38918 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38919 name, and pid as added by syslog:
38920 .code
38921 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38922 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38923 [3/5]  when scanning for sender: missing or malformed lo
38924 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38925 [5/5] mple>)
38926 .endd
38927 The same error might cause the following lines to be written to &"rejectlog"&
38928 (LOG_NOTICE):
38929 .code
38930 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38931 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38932 [3/18] er when scanning for sender: missing or malformed
38933 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38934 [5\18] .example>)
38935 [6\18] Recipients: ph10@some.domain.cam.example
38936 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38937 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38938 [9\18]        id 16RdAL-0006pc-00
38939 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38940 [11\18] 09:43 +0100
38941 [12\18] F From: <>
38942 [13\18]   Subject: this is a test header
38943 [18\18]   X-something: this is another header
38944 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38945 [16\18] le>
38946 [17\18] B Bcc:
38947 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38948 .endd
38949 Log lines that are neither too long nor contain newlines are written to syslog
38950 without modification.
38951
38952 If only syslog is being used, the Exim monitor is unable to provide a log tail
38953 display, unless syslog is routing &'mainlog'& to a file on the local host and
38954 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38955 where it is.
38956
38957
38958
38959 .section "Log line flags" "SECID250"
38960 One line is written to the main log for each message received, and for each
38961 successful, unsuccessful, and delayed delivery. These lines can readily be
38962 picked out by the distinctive two-character flags that immediately follow the
38963 timestamp. The flags are:
38964 .itable none 0 0 2 10* left 90* left
38965 .irow &%<=%&     "message arrival"
38966 .irow &%(=%&     "message fakereject"
38967 .irow &%=>%&     "normal message delivery"
38968 .irow &%->%&     "additional address in same delivery"
38969 .irow &%>>%&     "cutthrough message delivery"
38970 .irow &%*>%&     "delivery suppressed by &%-N%&"
38971 .irow &%**%&     "delivery failed; address bounced"
38972 .irow &%==%&     "delivery deferred; temporary problem"
38973 .endtable
38974
38975
38976 .section "Logging message reception" "SECID251"
38977 .cindex "log" "reception line"
38978 The format of the single-line entry in the main log that is written for every
38979 message received is shown in the basic example below, which is split over
38980 several lines in order to fit it on the page:
38981 .code
38982 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38983   H=mailer.fict.example [192.168.123.123] U=exim
38984   P=smtp S=5678 id=<incoming message id>
38985 .endd
38986 The address immediately following &"<="& is the envelope sender address. A
38987 bounce message is shown with the sender address &"<>"&, and if it is locally
38988 generated, this is followed by an item of the form
38989 .code
38990 R=<message id>
38991 .endd
38992 which is a reference to the message that caused the bounce to be sent.
38993
38994 .cindex "HELO"
38995 .cindex "EHLO"
38996 For messages from other hosts, the H and U fields identify the remote host and
38997 record the RFC 1413 identity of the user that sent the message, if one was
38998 received. The number given in square brackets is the IP address of the sending
38999 host. If there is a single, unparenthesized  host name in the H field, as
39000 above, it has been verified to correspond to the IP address (see the
39001 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
39002 by the remote host in the SMTP HELO or EHLO command, and has not been
39003 verified. If verification yields a different name to that given for HELO or
39004 EHLO, the verified name appears first, followed by the HELO or EHLO
39005 name in parentheses.
39006
39007 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
39008 without brackets, in the HELO or EHLO command, leading to entries in
39009 the log containing text like these examples:
39010 .code
39011 H=(10.21.32.43) [192.168.8.34]
39012 H=([10.21.32.43]) [192.168.8.34]
39013 .endd
39014 This can be confusing. Only the final address in square brackets can be relied
39015 on.
39016
39017 For locally generated messages (that is, messages not received over TCP/IP),
39018 the H field is omitted, and the U field contains the login name of the caller
39019 of Exim.
39020
39021 .cindex "authentication" "logging"
39022 .cindex "AUTH" "logging"
39023 For all messages, the P field specifies the protocol used to receive the
39024 message. This is the value that is stored in &$received_protocol$&. In the case
39025 of incoming SMTP messages, the value indicates whether or not any SMTP
39026 extensions (ESMTP), encryption, or authentication were used. If the SMTP
39027 session was encrypted, there is an additional X field that records the cipher
39028 suite that was used.
39029
39030 .cindex log protocol
39031 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
39032 hosts that have authenticated themselves using the SMTP AUTH command. The first
39033 value is used when the SMTP connection was encrypted (&"secure"&). In this case
39034 there is an additional item A= followed by the name of the authenticator that
39035 was used. If an authenticated identification was set up by the authenticator's
39036 &%server_set_id%& option, this is logged too, separated by a colon from the
39037 authenticator name.
39038
39039 .cindex "size" "of message"
39040 The id field records the existing message id, if present. The size of the
39041 received message is given by the S field. When the message is delivered,
39042 headers may be removed or added, so that the size of delivered copies of the
39043 message may not correspond with this value (and indeed may be different to each
39044 other).
39045
39046 The &%log_selector%& option can be used to request the logging of additional
39047 data when a message is received. See section &<<SECTlogselector>>& below.
39048
39049
39050
39051 .section "Logging deliveries" "SECID252"
39052 .cindex "log" "delivery line"
39053 The format of the single-line entry in the main log that is written for every
39054 delivery is shown in one of the examples below, for local and remote
39055 deliveries, respectively. Each example has been split into multiple lines in order
39056 to fit it on the page:
39057 .code
39058 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
39059   <marv@hitch.fict.example> R=localuser T=local_delivery
39060 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
39061   monk@holistic.fict.example R=dnslookup T=remote_smtp
39062   H=holistic.fict.example [192.168.234.234]
39063 .endd
39064 For ordinary local deliveries, the original address is given in angle brackets
39065 after the final delivery address, which might be a pipe or a file. If
39066 intermediate address(es) exist between the original and the final address, the
39067 last of these is given in parentheses after the final address. The R and T
39068 fields record the router and transport that were used to process the address.
39069
39070 If SMTP AUTH was used for the delivery there is an additional item A=
39071 followed by the name of the authenticator that was used.
39072 If an authenticated identification was set up by the authenticator's &%client_set_id%&
39073 option, this is logged too, as a second colon-separated list item.
39074 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
39075
39076 If a shadow transport was run after a successful local delivery, the log line
39077 for the successful delivery has an item added on the end, of the form
39078 .display
39079 &`ST=<`&&'shadow transport name'&&`>`&
39080 .endd
39081 If the shadow transport did not succeed, the error message is put in
39082 parentheses afterwards.
39083
39084 .cindex "asterisk" "after IP address"
39085 When more than one address is included in a single delivery (for example, two
39086 SMTP RCPT commands in one transaction) the second and subsequent addresses are
39087 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
39088 down a single SMTP connection, an asterisk follows the
39089 remote IP address (and port if enabled)
39090 in the log lines for the second and subsequent messages.
39091 When two or more messages are delivered down a single TLS connection, the
39092 DNS and some TLS-related information logged for the first message delivered
39093 will not be present in the log lines for the second and subsequent messages.
39094 TLS cipher information is still available.
39095
39096 .cindex "delivery" "cutthrough; logging"
39097 .cindex "cutthrough" "logging"
39098 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
39099 line precedes the reception line, since cutthrough waits for a possible
39100 rejection from the destination in case it can reject the sourced item.
39101
39102 The generation of a reply message by a filter file gets logged as a
39103 &"delivery"& to the addressee, preceded by &">"&.
39104
39105 The &%log_selector%& option can be used to request the logging of additional
39106 data when a message is delivered. See section &<<SECTlogselector>>& below.
39107
39108
39109 .section "Discarded deliveries" "SECID253"
39110 .cindex "discarded messages"
39111 .cindex "message" "discarded"
39112 .cindex "delivery" "discarded; logging"
39113 When a message is discarded as a result of the command &"seen finish"& being
39114 obeyed in a filter file which generates no deliveries, a log entry of the form
39115 .code
39116 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
39117   <low.club@bridge.example> R=userforward
39118 .endd
39119 is written, to record why no deliveries are logged. When a message is discarded
39120 because it is aliased to &":blackhole:"& the log line is like this:
39121 .code
39122 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
39123   <hole@nowhere.example> R=blackhole_router
39124 .endd
39125
39126
39127 .section "Deferred deliveries" "SECID254"
39128 When a delivery is deferred, a line of the following form is logged:
39129 .code
39130 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
39131   R=dnslookup T=smtp defer (146): Connection refused
39132 .endd
39133 In the case of remote deliveries, the error is the one that was given for the
39134 last IP address that was tried. Details of individual SMTP failures are also
39135 written to the log, so the above line would be preceded by something like
39136 .code
39137 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
39138   mail1.endrest.example [192.168.239.239]: Connection refused
39139 .endd
39140 When a deferred address is skipped because its retry time has not been reached,
39141 a message is written to the log, but this can be suppressed by setting an
39142 appropriate value in &%log_selector%&.
39143
39144
39145
39146 .section "Delivery failures" "SECID255"
39147 .cindex "delivery" "failure; logging"
39148 If a delivery fails because an address cannot be routed, a line of the
39149 following form is logged:
39150 .code
39151 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
39152   <jim@trek99.example>: unknown mail domain
39153 .endd
39154 If a delivery fails at transport time, the router and transport are shown, and
39155 the response from the remote host is included, as in this example:
39156 .code
39157 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
39158   R=dnslookup T=remote_smtp: SMTP error from remote mailer
39159   after pipelined RCPT TO:<ace400@pb.example>: host
39160   pbmail3.py.example [192.168.63.111]: 553 5.3.0
39161   <ace400@pb.example>...Addressee unknown
39162 .endd
39163 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
39164 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
39165 disabling PIPELINING. The log lines for all forms of delivery failure are
39166 flagged with &`**`&.
39167
39168
39169
39170 .section "Fake deliveries" "SECID256"
39171 .cindex "delivery" "fake; logging"
39172 If a delivery does not actually take place because the &%-N%& option has been
39173 used to suppress it, a normal delivery line is written to the log, except that
39174 &"=>"& is replaced by &"*>"&.
39175
39176
39177
39178 .section "Completion" "SECID257"
39179 A line of the form
39180 .code
39181 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
39182 .endd
39183 is written to the main log when a message is about to be removed from the spool
39184 at the end of its processing.
39185
39186
39187
39188
39189 .section "Summary of Fields in Log Lines" "SECID258"
39190 .cindex "log" "summary of fields"
39191 A summary of the field identifiers that are used in log lines is shown in
39192 the following table:
39193 .display
39194 &`A   `&        authenticator name (and optional id and sender)
39195 &`C   `&        SMTP confirmation on delivery
39196 &`Ci  `&        connection identifier
39197 &`    `&        command list for &"no mail in SMTP session"&
39198 &`CV  `&        certificate verification status
39199 &`D   `&        duration of &"no mail in SMTP session"&
39200 &`DKIM`&        domain verified in incoming message
39201 &`DN  `&        distinguished name from peer certificate
39202 &`DS  `&        DNSSEC secured lookups
39203 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
39204 &`F   `&        sender address (on delivery lines)
39205 &`H   `&        host name and IP address
39206 &`I   `&        local interface used
39207 &`id  `&        message id (from header) for incoming message
39208 &`K   `&        CHUNKING extension used
39209 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
39210 &`M8S `&        8BITMIME status for incoming message
39211 &`P   `&        on &`<=`& lines: protocol used
39212 &`    `&        on &`=>`& and &`**`& lines: return path
39213 &`PRDR`&        PRDR extension used
39214 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
39215 &`Q   `&        alternate queue name
39216 &`QT  `&        on &`=>`& lines: time spent on queue so far
39217 &`    `&        on &"Completed"& lines: time spent on queue
39218 &`R   `&        on &`<=`& lines: reference for local bounce
39219 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
39220 &`RT  `&        on &`<=`& lines: time taken for reception
39221 &`S   `&        size of message in bytes
39222 &`SNI `&        server name indication from TLS client hello
39223 &`ST  `&        shadow transport name
39224 &`T   `&        on &`<=`& lines: message subject (topic)
39225 &`TFO `&        connection took advantage of TCP Fast Open
39226 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
39227 &`U   `&        local user or RFC 1413 identity
39228 &`X   `&        TLS cipher suite
39229 .endd
39230
39231
39232 .section "Other log entries" "SECID259"
39233 Various other types of log entry are written from time to time. Most should be
39234 self-explanatory. Among the more common are:
39235
39236 .ilist
39237 .cindex "retry" "time not reached"
39238 &'retry time not reached'&&~&~An address previously suffered a temporary error
39239 during routing or local delivery, and the time to retry has not yet arrived.
39240 This message is not written to an individual message log file unless it happens
39241 during the first delivery attempt.
39242 .next
39243 &'retry time not reached for any host'&&~&~An address previously suffered
39244 temporary errors during remote delivery, and the retry time has not yet arrived
39245 for any of the hosts to which it is routed.
39246 .next
39247 .cindex "spool directory" "file locked"
39248 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
39249 some other Exim process is already working on the message. This can be quite
39250 common if queue running processes are started at frequent intervals. The
39251 &'exiwhat'& utility script can be used to find out what Exim processes are
39252 doing.
39253 .next
39254 .cindex "error" "ignored"
39255 &'error ignored'&&~&~There are several circumstances that give rise to this
39256 message:
39257 .olist
39258 Exim failed to deliver a bounce message whose age was greater than
39259 &%ignore_bounce_errors_after%&. The bounce was discarded.
39260 .next
39261 A filter file set up a delivery using the &"noerror"& option, and the delivery
39262 failed. The delivery was discarded.
39263 .next
39264 A delivery set up by a router configured with
39265 . ==== As this is a nested list, any displays it contains must be indented
39266 . ==== as otherwise they are too far to the left.
39267 .code
39268     errors_to = <>
39269 .endd
39270 failed. The delivery was discarded.
39271 .endlist olist
39272 .next
39273 .cindex DKIM "log line"
39274 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39275 logging and the message has a DKIM signature header.
39276 .endlist ilist
39277
39278
39279
39280
39281
39282 .section "Reducing or increasing what is logged" "SECTlogselector"
39283 .cindex "log" "selectors"
39284 By setting the &%log_selector%& global option, you can disable some of Exim's
39285 default logging to the main log, or you can request additional logging. The value of
39286 &%log_selector%& is made up of names preceded by plus or minus characters. For
39287 example:
39288 .code
39289 log_selector = +arguments -retry_defer
39290 .endd
39291 The list of optional log items is in the following table, with the default
39292 selection marked by asterisks:
39293 .itable none 0 0 3 2.8in left 10pt center 3in left
39294 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39295 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39296 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39297 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39298 .irow &`arguments`&                     &nbsp; "command line arguments"
39299 .irow &`connection_id`&                 &nbsp;  "connection identifier"
39300 .irow &`connection_reject`&             *       "connection rejections"
39301 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39302 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39303 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39304 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39305 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature; DKIM signing"
39306 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39307 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39308 .irow &`etrn`&                          *       "ETRN commands"
39309 .irow &`host_lookup_failed`&            *       "as it says"
39310 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39311 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39312 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39313 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39314 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39315 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39316 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39317 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39318 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39319 .irow &`queue_run`&                     *       "start and end queue runs"
39320 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39321 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39322 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39323 .irow &`pid`&                           &nbsp; "Exim process id"
39324 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39325 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39326 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39327 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39328 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39329 .irow &`rejected_header`&               *       "header contents on reject log"
39330 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39331 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39332 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39333 .irow &`sender_verify_fail`&            *       "sender verification failures"
39334 .irow &`size_reject`&                   *       "rejection because too big"
39335 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39336 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39337 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39338 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39339 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39340 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39341 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39342 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39343 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39344 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39345 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39346 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39347 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39348 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39349 .irow &`unknown_in_list`&               &nbsp; "lookup failed in list match"
39350 .irow &`all`&                           &nbsp; "&*all of the above*&"
39351 .endtable
39352 See also the &%slow_lookup_log%& main configuration option,
39353 section &<<SECID99>>&
39354
39355 More details on each of these items follows:
39356
39357 .ilist
39358 .cindex "8BITMIME"
39359 .cindex "log" "8BITMIME"
39360 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39361 which may help in tracking down interoperability issues with ancient MTAs
39362 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39363 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39364 &`7BIT`& and &`8BITMIME`& respectively.
39365 .next
39366 .cindex "&%warn%& ACL verb" "log when skipping"
39367 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39368 its conditions cannot be evaluated, a log line to this effect is written if
39369 this log selector is set.
39370 .next
39371 .cindex "log" "rewriting"
39372 .cindex "rewriting" "logging"
39373 &%address_rewrite%&: This applies both to global rewrites and per-transport
39374 rewrites, but not to rewrites in filters run as an unprivileged user (because
39375 such users cannot access the log).
39376 .next
39377 .cindex "log" "full parentage"
39378 &%all_parents%&: Normally only the original and final addresses are logged on
39379 delivery lines; with this selector, intermediate parents are given in
39380 parentheses between them.
39381 .next
39382 .cindex "log" "Exim arguments"
39383 .cindex "Exim arguments, logging"
39384 &%arguments%&: This causes Exim to write the arguments with which it was called
39385 to the main log, preceded by the current working directory. This is a debugging
39386 feature, added to make it easier to find out how certain MUAs call
39387 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39388 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39389 that are empty or that contain white space are quoted. Non-printing characters
39390 are shown as escape sequences. This facility cannot log unrecognized arguments,
39391 because the arguments are checked before the configuration file is read. The
39392 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39393 between the caller and Exim.
39394 .next
39395 .cindex log "connection identifier"
39396 .cindex connection "identifier logging"
39397 &%connection_id%&: An identifier for the accepted connection is added to
39398 connection start and end lines and to message accept lines.
39399 The identifier is tagged by Ci=.
39400 The value is PID-based, so will reset on reboot and will wrap.
39401 .next
39402 .cindex log "connection rejections"
39403 .cindex connection "rejection logging"
39404 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39405 connection is rejected, for whatever reason.
39406 .next
39407 .cindex log "delayed delivery"
39408 .cindex "delayed delivery, logging"
39409 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39410 started for an incoming message because the load is too high or too many
39411 messages were received on one connection. Logging does not occur if no delivery
39412 process is started because &%queue_only%& is set or &%-odq%& was used.
39413 .next
39414 .cindex "log" "delivery duration"
39415 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39416 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39417 If millisecond logging is enabled, short times will be shown with greater
39418 precision, eg. &`DT=0.304s`&.
39419 .next
39420 .cindex "log" "message size on delivery"
39421 .cindex "size" "of message"
39422 &%delivery_size%&: For each delivery, the size of message delivered is added to
39423 the &"=>"& line, tagged with S=.
39424 .next
39425 .cindex log "DKIM verification"
39426 .cindex DKIM "verification logging"
39427 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39428 verifies successfully a tag of DKIM is added, with one of the verified domains.
39429 .next
39430 .cindex log "DKIM verification"
39431 .cindex DKIM "verification logging"
39432 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39433 Also, on message delivery lines signing information (domain and selector)
39434 is added, tagged with DKIM=.
39435 .next
39436 .cindex "log" "dnslist defer"
39437 .cindex "DNS list" "logging defer"
39438 .cindex "black list (DNS)"
39439 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39440 DNS black list suffers a temporary error.
39441 .next
39442 .cindex log dnssec
39443 .cindex dnssec logging
39444 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39445 dns lookups gave secure results a tag of DS is added.
39446 For acceptance this covers the reverse and forward lookups for host name verification.
39447 It does not cover helo-name verification.
39448 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39449 .next
39450 .cindex "log" "ETRN commands"
39451 .cindex "ETRN" "logging"
39452 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39453 is run to determine whether or not it is actually accepted. An invalid ETRN
39454 command, or one received within a message transaction is not logged by this
39455 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39456 .next
39457 .cindex "log" "host lookup failure"
39458 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39459 any addresses, or when a lookup of an IP address fails to find a host name, a
39460 log line is written. This logging does not apply to direct DNS lookups when
39461 routing email addresses, but it does apply to &"byname"& lookups.
39462 .next
39463 .cindex "log" "ident timeout"
39464 .cindex "RFC 1413" "logging timeout"
39465 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39466 client's ident port times out.
39467 .next
39468 .cindex "log" "incoming interface"
39469 .cindex "log" "outgoing interface"
39470 .cindex "log" "local interface"
39471 .cindex "log" "local address and port"
39472 .cindex "TCP/IP" "logging local address and port"
39473 .cindex "interface" "logging"
39474 &%incoming_interface%&: The interface on which a message was received is added
39475 to the &"<="& line as an IP address in square brackets, tagged by I= and
39476 followed by a colon and the port number. The local interface and port are also
39477 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39478 rejection lines, and (despite the name) to outgoing
39479 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39480 The latter can be disabled by turning off the &%outgoing_interface%& option.
39481 .next
39482 .cindex log "incoming proxy address"
39483 .cindex proxy "logging proxy address"
39484 .cindex "TCP/IP" "logging proxy address"
39485 &%proxy%&: The internal (closest to the system running Exim) IP address
39486 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39487 on a proxied connection
39488 or the &"=>"& line for a message delivered on a proxied connection.
39489 See &<<SECTproxyInbound>>& for more information.
39490 .next
39491 .cindex "log" "incoming remote port"
39492 .cindex "port" "logging remote"
39493 .cindex "TCP/IP" "logging incoming remote port"
39494 .vindex "&$sender_fullhost$&"
39495 .vindex "&$sender_rcvhost$&"
39496 &%incoming_port%&: The remote port number from which a message was received is
39497 added to log entries and &'Received:'& header lines, following the IP address
39498 in square brackets, and separated from it by a colon. This is implemented by
39499 changing the value that is put in the &$sender_fullhost$& and
39500 &$sender_rcvhost$& variables. Recording the remote port number has become more
39501 important with the widening use of NAT (see RFC 2505).
39502 .next
39503 .cindex "log" "dropped connection"
39504 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39505 connection is unexpectedly dropped.
39506 .next
39507 .cindex "log" "millisecond timestamps"
39508 .cindex millisecond logging
39509 .cindex timestamps "millisecond, in logs"
39510 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39511 appended to the seconds value.
39512 .next
39513 .cindex "log" "message id"
39514 &%msg_id%&: The value of the Message-ID: header.
39515 .next
39516 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39517 This will be either because the message is a bounce, or was submitted locally
39518 (submission mode) without one.
39519 The field identifier will have an asterix appended: &"id*="&.
39520 .next
39521 .cindex "log" "outgoing interface"
39522 .cindex "log" "local interface"
39523 .cindex "log" "local address and port"
39524 .cindex "TCP/IP" "logging local address and port"
39525 .cindex "interface" "logging"
39526 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39527 interface on which a message was sent is added to delivery lines as an I= tag
39528 followed by IP address in square brackets. You can disable this by turning
39529 off the &%outgoing_interface%& option.
39530 .next
39531 .cindex "log" "outgoing remote port"
39532 .cindex "port" "logging outgoing remote"
39533 .cindex "TCP/IP" "logging outgoing remote port"
39534 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39535 containing => tags) following the IP address.
39536 The local port is also added if &%incoming_interface%& and
39537 &%outgoing_interface%& are both enabled.
39538 This option is not included in the default setting, because for most ordinary
39539 configurations, the remote port number is always 25 (the SMTP port), and the
39540 local port is a random ephemeral port.
39541 .next
39542 .cindex "log" "process ids in"
39543 .cindex "pid (process id)" "in log lines"
39544 &%pid%&: The current process id is added to every log line, in square brackets,
39545 immediately after the time and date.
39546 .next
39547 .cindex log pipelining
39548 .cindex pipelining "logging outgoing"
39549 &%pipelining%&: A field is added to delivery and accept
39550 log lines when the ESMTP PIPELINING extension was used.
39551 The field is a single "L".
39552
39553 On accept lines, where PIPELINING was offered but not used by the client,
39554 the field has a minus appended.
39555
39556 .cindex "pipelining" "early connection"
39557 If Exim is built without the DISABLE_PIPE_CONNECT build option
39558 accept "L" fields have a period appended if the feature was
39559 offered but not used, or an asterisk appended if used.
39560 Delivery "L" fields have an asterisk appended if used.
39561
39562 .next
39563 .cindex "log" "queue run"
39564 .cindex "queue runner" "logging"
39565 &%queue_run%&: The start and end of every queue run are logged.
39566 .next
39567 .cindex "log" "queue time"
39568 &%queue_time%&: The amount of time the message has been in the queue on the
39569 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39570 &`QT=3m45s`&.
39571 If millisecond logging is enabled, short times will be shown with greater
39572 precision, eg. &`QT=1.578s`&.
39573 .next
39574 &%queue_time_overall%&: The amount of time the message has been in the queue on
39575 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39576 example, &`QT=3m45s`&.
39577 .next
39578 .cindex "log" "receive duration"
39579 &%receive_time%&: For each message, the amount of real time it has taken to
39580 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39581 If millisecond logging is enabled, short times will be shown with greater
39582 precision, eg. &`RT=0.204s`&.
39583 .next
39584 .cindex "log" "recipients"
39585 &%received_recipients%&: The recipients of a message are listed in the main log
39586 as soon as the message is received. The list appears at the end of the log line
39587 that is written when a message is received, preceded by the word &"for"&. The
39588 addresses are listed after they have been qualified, but before any rewriting
39589 has taken place.
39590 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39591 in the list.
39592 .next
39593 .cindex "log" "sender reception"
39594 &%received_sender%&: The unrewritten original sender of a message is added to
39595 the end of the log line that records the message's arrival, after the word
39596 &"from"& (before the recipients if &%received_recipients%& is also set).
39597 .next
39598 .cindex "log" "header lines for rejection"
39599 &%rejected_header%&: If a message's header has been received at the time a
39600 rejection is written to the reject log, the complete header is added to the
39601 log. Header logging can be turned off individually for messages that are
39602 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39603 .next
39604 .cindex "log" "retry defer"
39605 &%retry_defer%&: A log line is written if a delivery is deferred because a
39606 retry time has not yet been reached. However, this &"retry time not reached"&
39607 message is always omitted from individual message logs after the first delivery
39608 attempt.
39609 .next
39610 .cindex "log" "return path"
39611 &%return_path_on_delivery%&: The return path that is being transmitted with
39612 the message is included in delivery and bounce lines, using the tag P=.
39613 This is omitted if no delivery actually happens, for example, if routing fails,
39614 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39615 .next
39616 .cindex "log" "sender on delivery"
39617 &%sender_on_delivery%&: The message's sender address is added to every delivery
39618 and bounce line, tagged by F= (for &"from"&).
39619 This is the original sender that was received with the message; it is not
39620 necessarily the same as the outgoing return path.
39621 .next
39622 .cindex "log" "sender verify failure"
39623 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39624 gives details of a sender verification failure is not written. Log lines for
39625 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39626 detail is lost.
39627 .next
39628 .cindex "log" "size rejection"
39629 &%size_reject%&: A log line is written whenever a message is rejected because
39630 it is too big.
39631 .next
39632 .cindex "log" "frozen messages; skipped"
39633 .cindex "frozen messages" "logging skipping"
39634 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39635 queue run because it another process is already delivering it or because
39636 it is frozen.
39637 .cindex "&""spool file is locked""&"
39638 .cindex "&""message is frozen""&"
39639 The message that is written is either &"spool file is locked"& or
39640 &"message is frozen"&.
39641 .next
39642 .cindex "log" "smtp confirmation"
39643 .cindex "SMTP" "logging confirmation"
39644 .cindex "LMTP" "logging confirmation"
39645 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39646 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39647 A number of MTAs (including Exim) return an identifying string in this
39648 response.
39649 .next
39650 .cindex "log" "SMTP connections"
39651 .cindex "SMTP" "logging connections"
39652 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39653 established or closed, unless the connection is from a host that matches
39654 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39655 only when the closure is unexpected.) This applies to connections from local
39656 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39657 dropped in the middle of a message, a log line is always written, whether or
39658 not this selector is set, but otherwise nothing is written at the start and end
39659 of connections unless this selector is enabled.
39660
39661 For TCP/IP connections to an Exim daemon, the current number of connections is
39662 included in the log message for each new connection, but note that the count is
39663 reset if the daemon is restarted.
39664 Also, because connections are closed (and the closure is logged) in
39665 subprocesses, the count may not include connections that have been closed but
39666 whose termination the daemon has not yet noticed. Thus, while it is possible to
39667 match up the opening and closing of connections in the log, the value of the
39668 logged counts may not be entirely accurate.
39669 .next
39670 .cindex "log" "SMTP transaction; incomplete"
39671 .cindex "SMTP" "logging incomplete transactions"
39672 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39673 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39674 and the message sender plus any accepted recipients are included in the log
39675 line. This can provide evidence of dictionary attacks.
39676 .next
39677 .cindex "log" "non-MAIL SMTP sessions"
39678 .cindex "MAIL" "logging session without"
39679 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39680 connection terminates without having issued a MAIL command. This includes both
39681 the case when the connection is dropped, and the case when QUIT is used. It
39682 does not include cases where the connection is rejected right at the start (by
39683 an ACL, or because there are too many connections, or whatever). These cases
39684 already have their own log lines.
39685
39686 The log line that is written contains the identity of the client in the usual
39687 way, followed by D= and a time, which records the duration of the connection.
39688 If the connection was authenticated, this fact is logged exactly as it is for
39689 an incoming message, with an A= item. If the connection was encrypted, CV=,
39690 DN=, and X= items may appear as they do for an incoming message, controlled by
39691 the same logging options.
39692
39693 Finally, if any SMTP commands were issued during the connection, a C= item
39694 is added to the line, listing the commands that were used. For example,
39695 .code
39696 C=EHLO,QUIT
39697 .endd
39698 shows that the client issued QUIT straight after EHLO. If there were fewer
39699 than 20 commands, they are all listed. If there were more than 20 commands,
39700 the last 20 are listed, preceded by &"..."&. However, with the default
39701 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39702 have been aborted before 20 non-mail commands are processed.
39703 .next
39704 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39705 colon-separated, is appended to the A= item for a message arrival or delivery
39706 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39707 was accepted or used.
39708 .next
39709 .cindex "log" "SMTP protocol error"
39710 .cindex "SMTP" "logging protocol error"
39711 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39712 encountered. Exim does not have perfect detection of all protocol errors
39713 because of transmission delays and the use of pipelining. If PIPELINING has
39714 been advertised to a client, an Exim server assumes that the client will use
39715 it, and therefore it does not count &"expected"& errors (for example, RCPT
39716 received after rejecting MAIL) as protocol errors.
39717 .next
39718 .cindex "SMTP" "logging syntax errors"
39719 .cindex "SMTP" "syntax errors; logging"
39720 .cindex "SMTP" "unknown command; logging"
39721 .cindex "log" "unknown SMTP command"
39722 .cindex "log" "SMTP syntax error"
39723 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39724 encountered. An unrecognized command is treated as a syntax error. For an
39725 external connection, the host identity is given; for an internal connection
39726 using &%-bs%& the sender identification (normally the calling user) is given.
39727 .next
39728 .cindex "log" "subject"
39729 .cindex "subject, logging"
39730 &%subject%&: The subject of the message is added to the arrival log line,
39731 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39732 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39733 specifies whether characters with values greater than 127 should be logged
39734 unchanged, or whether they should be rendered as escape sequences.
39735 .next
39736 .cindex "log" "certificate verification"
39737 .cindex log DANE
39738 .cindex DANE logging
39739 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39740 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39741 verified
39742 using a CA trust anchor,
39743 &`CV=dane`& if using a DNS trust anchor,
39744 and &`CV=no`& if not.
39745 .next
39746 .cindex "log" "TLS cipher"
39747 .cindex "TLS" "logging cipher"
39748 &%tls_cipher%&: When a message is sent or received over an encrypted
39749 connection, the cipher suite used is added to the log line, preceded by X=.
39750 .next
39751 .cindex "log" "TLS peer DN"
39752 .cindex "TLS" "logging peer DN"
39753 &%tls_peerdn%&: When a message is sent or received over an encrypted
39754 connection, and a certificate is supplied by the remote host, the peer DN is
39755 added to the log line, preceded by DN=.
39756 .next
39757 .cindex "log" "TLS resumption"
39758 .cindex "TLS" "logging session resumption"
39759 &%tls_resumption%&: When a message is sent or received over an encrypted
39760 connection and the TLS session resumed one used on a previous TCP connection,
39761 an asterisk is appended to the X= cipher field in the log line.
39762 .next
39763 .cindex "log" "TLS SNI"
39764 .cindex "TLS" "logging SNI"
39765 .cindex SNI logging
39766 &%tls_sni%&: When a message is received over an encrypted connection, and
39767 the remote host provided the Server Name Indication extension, the SNI is
39768 added to the log line, preceded by SNI=.
39769 .next
39770 .cindex "log" "DNS failure in list"
39771 &%unknown_in_list%&: This setting causes a log entry to be written when the
39772 result of a list match is failure because a DNS lookup failed, or because
39773 a bad IP address was in the list.
39774 .endlist
39775
39776
39777 .section "Message log" "SECID260"
39778 .cindex "message" "log file for"
39779 .cindex "log" "message log; description of"
39780 .cindex "&_msglog_& directory"
39781 .oindex "&%preserve_message_logs%&"
39782 In addition to the general log files, Exim writes a log file for each message
39783 that it handles. The names of these per-message logs are the message ids, and
39784 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39785 message log contains copies of the log lines that apply to the message. This
39786 makes it easier to inspect the status of an individual message without having
39787 to search the main log. A message log is deleted when processing of the message
39788 is complete, unless &%preserve_message_logs%& is set, but this should be used
39789 only with great care because they can fill up your disk very quickly.
39790
39791 On a heavily loaded system, it may be desirable to disable the use of
39792 per-message logs, in order to reduce disk I/O. This can be done by setting the
39793 &%message_logs%& option false.
39794 .ecindex IIDloggen
39795
39796
39797
39798
39799 . ////////////////////////////////////////////////////////////////////////////
39800 . ////////////////////////////////////////////////////////////////////////////
39801
39802 .chapter "Exim utilities" "CHAPutils"
39803 .scindex IIDutils "utilities"
39804 A number of utility scripts and programs are supplied with Exim and are
39805 described in this chapter. There is also the Exim Monitor, which is covered in
39806 the next chapter. The utilities described here are:
39807
39808 .itable none 0 0 3  7* left  15* left  40* left
39809 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39810   "list what Exim processes are doing"
39811 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39812 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39813 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39814 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39815                                                 various criteria"
39816 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39817 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39818   "extract statistics from the log"
39819 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39820   "check address acceptance from given IP"
39821 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39822 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39823 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39824 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39825 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39826 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39827 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39828 .endtable
39829
39830 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39831 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39832 &url(https://duncanthrax.net/exilog/) for details.
39833
39834
39835
39836
39837 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39838 .cindex "&'exiwhat'&"
39839 .cindex "process, querying"
39840 .cindex "SIGUSR1"
39841 On operating systems that can restart a system call after receiving a signal
39842 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39843 a line describing what it is doing to the file &_exim-process.info_& in the
39844 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39845 processes it can find, having first emptied the file. It then waits for one
39846 second to allow the Exim processes to react before displaying the results. In
39847 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39848 send the signal to the Exim processes, so it is normally run as root.
39849
39850 &*Warning*&: This is not an efficient process. It is intended for occasional
39851 use by system administrators. It is not sensible, for example, to set up a
39852 script that sends SIGUSR1 signals to Exim processes at short intervals.
39853
39854
39855 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39856 varies in different operating systems. Not only are different options used,
39857 but the format of the output is different. For this reason, there are some
39858 system configuration options that configure exactly how &'exiwhat'& works. If
39859 it doesn't seem to be working for you, check the following compile-time
39860 options:
39861 .itable none 0 0 2 30* left 70* left
39862 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39863 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39864 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39865 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39866 .endtable
39867 An example of typical output from &'exiwhat'& is
39868 .code
39869 164 daemon: -q1h, listening on port 25
39870 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39871 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39872   [10.19.42.42] (editor@ref.example)
39873 10592 handling incoming call from [192.168.243.242]
39874 10628 accepting a local non-SMTP message
39875 .endd
39876 The first number in the output line is the process number. The third line has
39877 been split here, in order to fit it on the page.
39878
39879
39880
39881 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39882 .cindex "&'exiqgrep'&"
39883 .cindex "queue" "grepping"
39884 This utility is a Perl script contributed by Matt Hubbard. It runs
39885 .code
39886 exim -bpu
39887 .endd
39888 or (in case &*-a*& switch is specified)
39889 .code
39890 exim -bp
39891 .endd
39892 to obtain a queue listing, and then greps the output to select messages
39893 that match given criteria. The following selection options are available:
39894
39895 .vlist
39896 .vitem &*-f*&&~<&'regex'&>
39897 Match the sender address using a case-insensitive search. The field that is
39898 tested is enclosed in angle brackets, so you can test for bounce messages with
39899 .code
39900 exiqgrep -f '^<>$'
39901 .endd
39902 .vitem &*-r*&&~<&'regex'&>
39903 Match a recipient address using a case-insensitive search. The field that is
39904 tested is not enclosed in angle brackets.
39905
39906 .vitem &*-s*&&~<&'regex'&>
39907 Match against the size field.
39908
39909 .vitem &*-y*&&~<&'seconds'&>
39910 Match messages that are younger than the given time.
39911
39912 .vitem &*-o*&&~<&'seconds'&>
39913 Match messages that are older than the given time.
39914
39915 .vitem &*-z*&
39916 Match only frozen messages.
39917
39918 .vitem &*-x*&
39919 Match only non-frozen messages.
39920
39921 .vitem &*-G*&&~<&'queuename'&>
39922 Match only messages in the given queue.  Without this, the default queue is searched.
39923 .endlist
39924
39925 The following options control the format of the output:
39926
39927 .vlist
39928 .vitem &*-c*&
39929 Display only the count of matching messages.
39930
39931 .vitem &*-l*&
39932 Long format &-- display the full message information as output by Exim. This is
39933 the default.
39934
39935 .vitem &*-i*&
39936 Display message ids only.
39937
39938 .vitem &*-b*&
39939 Brief format &-- one line per message.
39940
39941 .vitem &*-R*&
39942 Display messages in reverse order.
39943
39944 .vitem &*-a*&
39945 Include delivered recipients in queue listing.
39946 .endlist
39947
39948 The following options give alternates for configuration:
39949
39950 .vlist
39951 .vitem &*-C*&&~<&'config&~file'&>
39952 is used to specify an alternate &_exim.conf_& which might
39953 contain alternate exim configuration the queue management might be using.
39954
39955 .vitem &*-E*&&~<&'path'&>
39956 can be used to specify a path for the exim binary,
39957 overriding the built-in one.
39958 .endlist
39959
39960 There is one more option, &%-h%&, which outputs a list of options.
39961 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39962
39963
39964
39965 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39966 .cindex "&'exiqsumm'&"
39967 .cindex "queue" "summary"
39968 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39969 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39970 running a command such as
39971 .code
39972 exim -bp | exiqsumm
39973 .endd
39974 The output consists of one line for each domain that has messages waiting for
39975 it, as in the following example:
39976 .code
39977 3   2322   74m   66m  msn.com.example
39978 .endd
39979 Each line lists the number of pending deliveries for a domain, their total
39980 volume, and the length of time that the oldest and the newest messages have
39981 been waiting. Note that the number of pending deliveries is greater than the
39982 number of messages when messages have more than one recipient.
39983
39984 A summary line is output at the end. By default the output is sorted on the
39985 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39986 the output to be sorted by oldest message and by count of messages,
39987 respectively. There are also three options that split the messages for each
39988 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39989 separates frozen messages, and &%-s%& separates messages according to their
39990 sender.
39991
39992 The output of &'exim -bp'& contains the original addresses in the message, so
39993 this also applies to the output from &'exiqsumm'&. No domains from addresses
39994 generated by aliasing or forwarding are included (unless the &%one_time%&
39995 option of the &(redirect)& router has been used to convert them into &"top
39996 level"& addresses).
39997
39998
39999
40000
40001 .section "Extracting specific information from the log (exigrep)" &&&
40002          "SECTextspeinf"
40003 .cindex "&'exigrep'&"
40004 .cindex "log" "extracts; grepping for"
40005 The &'exigrep'& utility is a Perl script that searches one or more main log
40006 files for entries that match a given pattern. When it finds a match, it
40007 extracts all the log entries for the relevant message, not just those that
40008 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
40009 given message, or all mail for a given user, or for a given host, for example.
40010 The input files can be in Exim log format or syslog format.
40011 If a matching log line is not associated with a specific message, it is
40012 included in &'exigrep'&'s output without any additional lines. The usage is:
40013 .display
40014 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
40015 .endd
40016 If no log filenames are given on the command line, the standard input is read.
40017
40018 The &%-t%& argument specifies a number of seconds. It adds an additional
40019 condition for message selection. Messages that are complete are shown only if
40020 they spent more than <&'n'&> seconds in the queue.
40021
40022 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
40023 makes it case-sensitive. This may give a performance improvement when searching
40024 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
40025 option; with &%-I%& they do not. In both cases it is possible to change the
40026 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
40027
40028 The &%-l%& option means &"literal"&, that is, treat all characters in the
40029 pattern as standing for themselves. Otherwise the pattern must be a Perl
40030 regular expression.
40031
40032 The &%-v%& option inverts the matching condition. That is, a line is selected
40033 if it does &'not'& match the pattern.
40034
40035 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
40036 that are generated as a result/response to a message that &'exigrep'& matched
40037 normally.
40038
40039 Example of &%-M%&:
40040 user_a sends a message to user_b, which generates a bounce back to user_b. If
40041 &'exigrep'& is used to search for &"user_a"&, only the first message will be
40042 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
40043 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
40044 when searching for &"user_a"& will show both messages since the bounce is
40045 &"related"& to or a &"result"& of the first message that was found by the
40046 search term.
40047
40048 If the location of a &'zcat'& command is known from the definition of
40049 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
40050 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
40051 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
40052 autodetection of some well known compression extensions.
40053
40054
40055 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
40056 .cindex "&'exipick'&"
40057 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
40058 lists messages from the queue according to a variety of criteria. For details
40059 of &'exipick'&'s facilities, run &'exipick'& with
40060 the &%--help%& option.
40061
40062
40063 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
40064 .cindex "log" "cycling local files"
40065 .cindex "cycling logs"
40066 .cindex "&'exicyclog'&"
40067 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
40068 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
40069 you are using log files with datestamps in their names (see section
40070 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
40071 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
40072 There are two command line options for &'exicyclog'&:
40073 .ilist
40074 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
40075 default that is set when Exim is built. The default default is 10.
40076 .next
40077 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
40078 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
40079 overriding the script's default, which is to find the setting from Exim's
40080 configuration.
40081 .endlist
40082
40083 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
40084 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
40085 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
40086 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
40087 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
40088 logs are handled similarly.
40089
40090 If the limit is greater than 99, the script uses 3-digit numbers such as
40091 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
40092 to one that is greater, or &'vice versa'&, you will have to fix the names of
40093 any existing log files.
40094
40095 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
40096 the end are deleted. All files with numbers greater than 01 are compressed,
40097 using a compression command which is configured by the COMPRESS_COMMAND
40098 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
40099 root &%crontab%& entry of the form
40100 .code
40101 1 0 * * * su exim -c /usr/exim/bin/exicyclog
40102 .endd
40103 assuming you have used the name &"exim"& for the Exim user. You can run
40104 &'exicyclog'& as root if you wish, but there is no need.
40105
40106
40107
40108 .section "Mail statistics (eximstats)" "SECTmailstat"
40109 .cindex "statistics"
40110 .cindex "&'eximstats'&"
40111 A Perl script called &'eximstats'& is provided for extracting statistical
40112 information from log files. The output is either plain text, or HTML.
40113 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
40114 . --- 404 error and everything else points to that.
40115
40116 The &'eximstats'& script has been hacked about quite a bit over time. The
40117 latest version is the result of some extensive revision by Steve Campbell. A
40118 lot of information is given by default, but there are options for suppressing
40119 various parts of it. Following any options, the arguments to the script are a
40120 list of files, which should be main log files. For example:
40121 .code
40122 eximstats -nr /var/spool/exim/log/mainlog.01
40123 .endd
40124 By default, &'eximstats'& extracts information about the number and volume of
40125 messages received from or delivered to various hosts. The information is sorted
40126 both by message count and by volume, and the top fifty hosts in each category
40127 are listed on the standard output. Similar information, based on email
40128 addresses or domains instead of hosts can be requested by means of various
40129 options. For messages delivered and received locally, similar statistics are
40130 also produced per user.
40131
40132 The output also includes total counts and statistics about delivery errors, and
40133 histograms showing the number of messages received and deliveries made in each
40134 hour of the day. A delivery with more than one address in its envelope (for
40135 example, an SMTP transaction with more than one RCPT command) is counted
40136 as a single delivery by &'eximstats'&.
40137
40138 Though normally more deliveries than receipts are reported (as messages may
40139 have multiple recipients), it is possible for &'eximstats'& to report more
40140 messages received than delivered, even though the queue is empty at the start
40141 and end of the period in question. If an incoming message contains no valid
40142 recipients, no deliveries are recorded for it. A bounce message is handled as
40143 an entirely separate message.
40144
40145 &'eximstats'& always outputs a grand total summary giving the volume and number
40146 of messages received and deliveries made, and the number of hosts involved in
40147 each case. It also outputs the number of messages that were delayed (that is,
40148 not completely delivered at the first attempt), and the number that had at
40149 least one address that failed.
40150
40151 The remainder of the output is in sections that can be independently disabled
40152 or modified by various options. It consists of a summary of deliveries by
40153 transport, histograms of messages received and delivered per time interval
40154 (default per hour), information about the time messages spent in the queue,
40155 a list of relayed messages, lists of the top fifty sending hosts, local
40156 senders, destination hosts, and destination local users by count and by volume,
40157 and a list of delivery errors that occurred.
40158
40159 The relay information lists messages that were actually relayed, that is, they
40160 came from a remote host and were directly delivered to some other remote host,
40161 without being processed (for example, for aliasing or forwarding) locally.
40162
40163 There are quite a few options for &'eximstats'& to control exactly what it
40164 outputs. These are documented in the Perl script itself, and can be extracted
40165 by running the command &(perldoc)& on the script. For example:
40166 .code
40167 perldoc /usr/exim/bin/eximstats
40168 .endd
40169
40170 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
40171 .cindex "&'exim_checkaccess'&"
40172 .cindex "policy control" "checking access"
40173 .cindex "checking access"
40174 The &%-bh%& command line argument allows you to run a fake SMTP session with
40175 debugging output, in order to check what Exim is doing when it is applying
40176 policy controls to incoming SMTP mail. However, not everybody is sufficiently
40177 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
40178 sometimes you just want to answer the question &"Does this address have
40179 access?"& without bothering with any further details.
40180
40181 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
40182 two arguments, an IP address and an email address:
40183 .code
40184 exim_checkaccess 10.9.8.7 A.User@a.domain.example
40185 .endd
40186 The utility runs a call to Exim with the &%-bh%& option, to test whether the
40187 given email address would be accepted in a RCPT command in a TCP/IP
40188 connection from the host with the given IP address. The output of the utility
40189 is either the word &"accepted"&, or the SMTP error response, for example:
40190 .code
40191 Rejected:
40192 550 Relay not permitted
40193 .endd
40194 When running this test, the utility uses &`<>`& as the envelope sender address
40195 for the MAIL command, but you can change this by providing additional
40196 options. These are passed directly to the Exim command. For example, to specify
40197 that the test is to be run with the sender address &'himself@there.example'&
40198 you can use:
40199 .code
40200 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
40201                  -f himself@there.example
40202 .endd
40203 Note that these additional Exim command line items must be given after the two
40204 mandatory arguments.
40205
40206 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
40207 while running its checks. You can run checks that include callouts by using
40208 &%-bhc%&, but this is not yet available in a &"packaged"& form.
40209
40210
40211
40212 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
40213 .cindex "DBM" "building dbm files"
40214 .cindex "building DBM files"
40215 .cindex "&'exim_dbmbuild'&"
40216 .cindex "lower casing"
40217 .cindex "binary zero" "in lookup key"
40218 The &'exim_dbmbuild'& program reads an input file containing keys and data in
40219 the format used by the &(lsearch)& lookup (see section
40220 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
40221 names as keys and the remainder of the information as data. The lower-casing
40222 can be prevented by calling the program with the &%-nolc%& option.
40223
40224 A terminating zero is included as part of the key string. This is expected by
40225 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
40226 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
40227 strings or the data strings. The &(dbmnz)& lookup type can be used with such
40228 files.
40229
40230 The program requires two arguments: the name of the input file (which can be a
40231 single hyphen to indicate the standard input), and the name of the output file.
40232 It creates the output under a temporary name, and then renames it if all went
40233 well.
40234
40235 .cindex "USE_DB"
40236 If the native DB interface is in use (USE_DB is set in a compile-time
40237 configuration file &-- this is common in free versions of Unix) the two
40238 filenames must be different, because in this mode the Berkeley DB functions
40239 create a single output file using exactly the name given. For example,
40240 .code
40241 exim_dbmbuild /etc/aliases /etc/aliases.db
40242 .endd
40243 reads the system alias file and creates a DBM version of it in
40244 &_/etc/aliases.db_&.
40245
40246 In systems that use the &'ndbm'& routines (mostly proprietary versions of
40247 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
40248 environment, the suffixes are added to the second argument of
40249 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
40250 when the Berkeley functions are used in compatibility mode (though this is not
40251 recommended), because in that case it adds a &_.db_& suffix to the filename.
40252
40253 If a duplicate key is encountered, the program outputs a warning, and when it
40254 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
40255 option is used. By default, only the first of a set of duplicates is used &--
40256 this makes it compatible with &(lsearch)& lookups. There is an option
40257 &%-lastdup%& which causes it to use the data for the last duplicate instead.
40258 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
40259 &%stderr%&. For other errors, where it doesn't actually make a new file, the
40260 return code is 2.
40261
40262
40263
40264
40265 .section "Finding individual retry times (exinext)" "SECTfinindret"
40266 .cindex "retry" "times"
40267 .cindex "&'exinext'&"
40268 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40269 fish specific information out of the retry database. Given a mail domain (or a
40270 complete address), it looks up the hosts for that domain, and outputs any retry
40271 information for the hosts or for the domain. At present, the retry information
40272 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40273 output. For example:
40274 .code
40275 $ exinext piglet@milne.fict.example
40276 kanga.milne.example:192.168.8.1 error 146: Connection refused
40277   first failed: 21-Feb-1996 14:57:34
40278   last tried:   21-Feb-1996 14:57:34
40279   next try at:  21-Feb-1996 15:02:34
40280 roo.milne.example:192.168.8.3 error 146: Connection refused
40281   first failed: 20-Jan-1996 13:12:08
40282   last tried:   21-Feb-1996 11:42:03
40283   next try at:  21-Feb-1996 19:42:03
40284   past final cutoff time
40285 .endd
40286 You can also give &'exinext'& a local part, without a domain, and it
40287 will give any retry information for that local part in your default domain.
40288 A message id can be used to obtain retry information pertaining to a specific
40289 message. This exists only when an attempt to deliver a message to a remote host
40290 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40291 &'exinext'& is not particularly efficient, but then it is not expected to be
40292 run very often.
40293
40294 The &'exinext'& utility calls Exim to find out information such as the location
40295 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40296 passed on to the &'exim'& commands. The first specifies an alternate Exim
40297 configuration file, and the second sets macros for use within the configuration
40298 file. These features are mainly to help in testing, but might also be useful in
40299 environments where more than one configuration file is in use.
40300
40301
40302
40303 .section "Hints database maintenance" "SECThindatmai"
40304 .cindex "hints database" "maintenance"
40305 .cindex "maintaining Exim's hints database"
40306 Three utility programs are provided for maintaining the DBM files that Exim
40307 uses to contain its delivery hint information. Each program requires two
40308 arguments. The first specifies the name of Exim's spool directory, and the
40309 second is the name of the database it is to operate on. These are as follows:
40310
40311 .ilist
40312 &'retry'&: the database of retry information
40313 .next
40314 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40315 for remote hosts
40316 .next
40317 &'callout'&: the callout cache
40318 .next
40319 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40320 .next
40321 &'tls'&: TLS session resumption data
40322 .next
40323 &'misc'&: other hints data
40324 .endlist
40325
40326 The &'misc'& database is used for
40327
40328 .ilist
40329 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40330 &(smtp)& transport)
40331 .next
40332 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40333 in a transport)
40334 .next
40335 Recording EHLO-time facilities advertised by hosts
40336 .next
40337 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40338 .endlist
40339
40340
40341
40342 .subsection "exim_dumpdb" "SECTdumpdb"
40343 .cindex "&'exim_dumpdb'&"
40344 The entire contents of a database are written to the standard output by the
40345 &'exim_dumpdb'& program,
40346 taking as arguments the spool and database names.
40347 An option &'-z'& may be given to request times in UTC;
40348 otherwise times are in the local timezone.
40349 An option &'-k'& may be given to dump only the record keys.
40350 For example, to dump the retry database:
40351 .code
40352 exim_dumpdb /var/spool/exim retry
40353 .endd
40354 For the retry database
40355 two lines of output are produced for each entry:
40356 .code
40357 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40358 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40359 .endd
40360 The first item on the first line is the key of the record. It starts with one
40361 of the letters R, or T, depending on whether it refers to a routing or
40362 transport retry. For a local delivery, the next part is the local address; for
40363 a remote delivery it is the name of the remote host, followed by its failing IP
40364 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40365 transport). If the remote port is not the standard one (port 25), it is added
40366 to the IP address. Then there follows an error code, an additional error code,
40367 and a textual description of the error.
40368
40369 The three times on the second line are the time of first failure, the time of
40370 the last delivery attempt, and the computed time for the next attempt. The line
40371 ends with an asterisk if the cutoff time for the last retry rule has been
40372 exceeded.
40373
40374 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40375 consists of a host name followed by a list of ids for messages that are or were
40376 waiting to be delivered to that host. If there are a very large number for any
40377 one host, continuation records, with a sequence number added to the host name,
40378 may be seen. The data in these records is often out of date, because a message
40379 may be routed to several alternative hosts, and Exim makes no effort to keep
40380 cross-references.
40381
40382
40383
40384 .subsection "exim_tidydb" "SECTtidydb"
40385 .cindex "&'exim_tidydb'&"
40386 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40387 database. If run with no options, it removes all records that are more than 30
40388 days old. The age is calculated from the date and time that the record was last
40389 updated. Note that, in the case of the retry database, it is &'not'& the time
40390 since the first delivery failure. Information about a host that has been down
40391 for more than 30 days will remain in the database, provided that the record is
40392 updated sufficiently often.
40393
40394 The cutoff date can be altered by means of the &%-t%& option, which must be
40395 followed by a time. For example, to remove all records older than a week from
40396 the retry database:
40397 .code
40398 exim_tidydb -t 7d /var/spool/exim retry
40399 .endd
40400 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40401 message ids. In the former these appear as data in records keyed by host &--
40402 they were messages that were waiting for that host &-- and in the latter they
40403 are the keys for retry information for messages that have suffered certain
40404 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40405 message ids in database records are those of messages that are still on the
40406 queue. Message ids for messages that no longer exist are removed from
40407 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40408 For the &'retry'& database, records whose keys are non-existent message ids are
40409 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40410 whenever it removes information from the database.
40411
40412 Certain records are automatically removed by Exim when they are no longer
40413 needed, but others are not. For example, if all the MX hosts for a domain are
40414 down, a retry record is created for each one. If the primary MX host comes back
40415 first, its record is removed when Exim successfully delivers to it, but the
40416 records for the others remain because Exim has not tried to use those hosts.
40417
40418 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40419 hints databases. You should do this at a quiet time of day, because it requires
40420 a database to be locked (and therefore inaccessible to Exim) while it does its
40421 work. Removing records from a DBM file does not normally make the file smaller,
40422 but all the common DBM libraries are able to re-use the space that is released.
40423 After an initial phase of increasing in size, the databases normally reach a
40424 point at which they no longer get any bigger, as long as they are regularly
40425 tidied.
40426
40427 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40428 databases is likely to keep on increasing.
40429
40430
40431
40432
40433 .subsection "exim_fixdb" "SECTfixdb"
40434 .cindex "&'exim_fixdb'&"
40435 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40436 Its main use is for testing Exim, but it might also be occasionally useful for
40437 getting round problems in a live system. Its interface
40438 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40439 key of a database record can then be entered, and the data for that record is
40440 displayed.
40441
40442 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40443 except the &'retry'& database, that is the only operation that can be carried
40444 out. For the &'retry'& database, each field is output preceded by a number, and
40445 data for individual fields can be changed by typing the field number followed
40446 by new data, for example:
40447 .code
40448 > 4 951102:1000
40449 .endd
40450 resets the time of the next delivery attempt. Time values are given as a
40451 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40452 used as optional separators.
40453
40454 Both displayed and input times are in the local timezone by default.
40455 If an option &'-z'& is used on the command line, displayed times
40456 are in UTC.
40457
40458
40459
40460
40461 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40462 .cindex "mailbox" "maintenance"
40463 .cindex "&'exim_lock'&"
40464 .cindex "locking mailboxes"
40465 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40466 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40467 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40468 a user agent while investigating a problem. The utility requires the name of
40469 the file as its first argument. If the locking is successful, the second
40470 argument is run as a command (using C's &[system()]& function); if there is no
40471 second argument, the value of the SHELL environment variable is used; if this
40472 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40473 is unlocked and the utility ends. The following options are available:
40474
40475 .vlist
40476 .vitem &%-fcntl%&
40477 Use &[fcntl()]& locking on the open mailbox.
40478
40479 .vitem &%-flock%&
40480 Use &[flock()]& locking on the open mailbox, provided the operating system
40481 supports it.
40482
40483 .vitem &%-interval%&
40484 This must be followed by a number, which is a number of seconds; it sets the
40485 interval to sleep between retries (default 3).
40486
40487 .vitem &%-lockfile%&
40488 Create a lock file before opening the mailbox.
40489
40490 .vitem &%-mbx%&
40491 Lock the mailbox using MBX rules.
40492
40493 .vitem &%-q%&
40494 Suppress verification output.
40495
40496 .vitem &%-retries%&
40497 This must be followed by a number; it sets the number of times to try to get
40498 the lock (default 10).
40499
40500 .vitem &%-restore_time%&
40501 This option causes &%exim_lock%& to restore the modified and read times to the
40502 locked file before exiting. This allows you to access a locked mailbox (for
40503 example, to take a backup copy) without disturbing the times that the user
40504 subsequently sees.
40505
40506 .vitem &%-timeout%&
40507 This must be followed by a number, which is a number of seconds; it sets a
40508 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40509 default), a non-blocking call is used.
40510
40511 .vitem &%-v%&
40512 Generate verbose output.
40513 .endlist
40514
40515 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40516 default is to create a lock file and also to use &[fcntl()]& locking on the
40517 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40518 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40519 requires that the directory containing the file be writeable. Locking by lock
40520 file does not last forever; Exim assumes that a lock file is expired if it is
40521 more than 30 minutes old.
40522
40523 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40524 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40525 to be taken out on the open mailbox, and an exclusive lock on the file
40526 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40527 number of the mailbox file. When the locking is released, if an exclusive lock
40528 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40529
40530 The default output contains verification of the locking that takes place. The
40531 &%-v%& option causes some additional information to be given. The &%-q%& option
40532 suppresses all output except error messages.
40533
40534 A command such as
40535 .code
40536 exim_lock /var/spool/mail/spqr
40537 .endd
40538 runs an interactive shell while the file is locked, whereas
40539 .display
40540 &`exim_lock -q /var/spool/mail/spqr <<End`&
40541 <&'some commands'&>
40542 &`End`&
40543 .endd
40544 runs a specific non-interactive sequence of commands while the file is locked,
40545 suppressing all verification output. A single command can be run by a command
40546 such as
40547 .code
40548 exim_lock -q /var/spool/mail/spqr \
40549   "cp /var/spool/mail/spqr /some/where"
40550 .endd
40551 Note that if a command is supplied, it must be entirely contained within the
40552 second argument &-- hence the quotes.
40553
40554
40555 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40556 .cindex "exim_msgdate"
40557 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40558 This Perl script converts an Exim Mesage ID back into a human readable form.
40559 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40560
40561 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40562 .ecindex IIDutils
40563 . ////////////////////////////////////////////////////////////////////////////
40564 . ////////////////////////////////////////////////////////////////////////////
40565
40566 .chapter "The Exim monitor" "CHAPeximon"
40567 .scindex IIDeximon "Exim monitor" "description"
40568 .cindex "X-windows"
40569 .cindex "&'eximon'&"
40570 .cindex "Local/eximon.conf"
40571 .cindex "&_exim_monitor/EDITME_&"
40572 The Exim monitor is an application which displays in an X window information
40573 about the state of Exim's queue and what Exim is doing. An admin user can
40574 perform certain operations on messages from this GUI interface; however all
40575 such facilities are also available from the command line, and indeed, the
40576 monitor itself makes use of the command line to perform any actions requested.
40577
40578
40579
40580 .section "Running the monitor" "SECID264"
40581 The monitor is started by running the script called &'eximon'&. This is a shell
40582 script that sets up a number of environment variables, and then runs the
40583 binary called &_eximon.bin_&. The default appearance of the monitor window can
40584 be changed by editing the &_Local/eximon.conf_& file created by editing
40585 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40586 parameters are for.
40587
40588 The parameters that get built into the &'eximon'& script can be overridden for
40589 a particular invocation by setting up environment variables of the same names,
40590 preceded by &`EXIMON_`&. For example, a shell command such as
40591 .code
40592 EXIMON_LOG_DEPTH=400 eximon
40593 .endd
40594 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40595 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40596 overrides the Exim log file configuration. This makes it possible to have
40597 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40598 syslog messages are routed to a file on the local host.
40599
40600 X resources can be used to change the appearance of the window in the normal
40601 way. For example, a resource setting of the form
40602 .code
40603 Eximon*background: gray94
40604 .endd
40605 changes the colour of the background to light grey rather than white. The
40606 stripcharts are drawn with both the data lines and the reference lines in
40607 black. This means that the reference lines are not visible when on top of the
40608 data. However, their colour can be changed by setting a resource called
40609 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40610 For example, if your X server is running Unix, you could set up lighter
40611 reference lines in the stripcharts by obeying
40612 .code
40613 xrdb -merge <<End
40614 Eximon*highlight: gray
40615 End
40616 .endd
40617 .cindex "admin user"
40618 In order to see the contents of messages in the queue, and to operate on them,
40619 &'eximon'& must either be run as root or by an admin user.
40620
40621 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40622 contain X11 resource parameters interpreted by the X11 library.  In addition,
40623 if the first parameter starts with the string "gdb" then it is removed and the
40624 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40625 versioned variants of gdb can be invoked).
40626
40627 The monitor's window is divided into three parts. The first contains one or
40628 more stripcharts and two action buttons, the second contains a &"tail"& of the
40629 main log file, and the third is a display of the queue of messages awaiting
40630 delivery, with two more action buttons. The following sections describe these
40631 different parts of the display.
40632
40633
40634
40635
40636 .section "The stripcharts" "SECID265"
40637 .cindex "stripchart"
40638 The first stripchart is always a count of messages in the queue. Its name can
40639 be configured by setting QUEUE_STRIPCHART_NAME in the
40640 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40641 configuration script by regular expression matches on log file entries, making
40642 it possible to display, for example, counts of messages delivered to certain
40643 hosts or using certain transports. The supplied defaults display counts of
40644 received and delivered messages, and of local and SMTP deliveries. The default
40645 period between stripchart updates is one minute; this can be adjusted by a
40646 parameter in the &_Local/eximon.conf_& file.
40647
40648 The stripchart displays rescale themselves automatically as the value they are
40649 displaying changes. There are always 10 horizontal lines in each chart; the
40650 title string indicates the value of each division when it is greater than one.
40651 For example, &"x2"& means that each division represents a value of 2.
40652
40653 It is also possible to have a stripchart which shows the percentage fullness of
40654 a particular disk partition, which is useful when local deliveries are confined
40655 to a single partition.
40656
40657 .cindex "&%statvfs%& function"
40658 This relies on the availability of the &[statvfs()]& function or equivalent in
40659 the operating system. Most, but not all versions of Unix that support Exim have
40660 this. For this particular stripchart, the top of the chart always represents
40661 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40662 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40663 &_Local/eximon.conf_& file.
40664
40665
40666
40667
40668 .section "Main action buttons" "SECID266"
40669 .cindex "size" "of monitor window"
40670 .cindex "Exim monitor" "window size"
40671 .cindex "window size"
40672 Below the stripcharts there is an action button for quitting the monitor. Next
40673 to this is another button marked &"Size"&. They are placed here so that
40674 shrinking the window to its default minimum size leaves just the queue count
40675 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40676 the window to expand to its maximum size, unless it is already at the maximum,
40677 in which case it is reduced to its minimum.
40678
40679 When expanding to the maximum, if the window cannot be fully seen where it
40680 currently is, it is moved back to where it was the last time it was at full
40681 size. When it is expanding from its minimum size, the old position is
40682 remembered, and next time it is reduced to the minimum it is moved back there.
40683
40684 The idea is that you can keep a reduced window just showing one or two
40685 stripcharts at a convenient place on your screen, easily expand it to show
40686 the full window when required, and just as easily put it back to what it was.
40687 The idea is copied from what the &'twm'& window manager does for its
40688 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40689 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40690
40691 Normally, the monitor starts up with the window at its full size, but it can be
40692 built so that it starts up with the window at its smallest size, by setting
40693 START_SMALL=yes in &_Local/eximon.conf_&.
40694
40695
40696
40697 .section "The log display" "SECID267"
40698 .cindex "log" "tail of; in monitor"
40699 The second section of the window is an area in which a display of the tail of
40700 the main log is maintained.
40701 To save space on the screen, the timestamp on each log line is shortened by
40702 removing the date and, if &%log_timezone%& is set, the timezone.
40703 The log tail is not available when the only destination for logging data is
40704 syslog, unless the syslog lines are routed to a local file whose name is passed
40705 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40706
40707 The log sub-window has a scroll bar at its lefthand side which can be used to
40708 move back to look at earlier text, and the up and down arrow keys also have a
40709 scrolling effect. The amount of log that is kept depends on the setting of
40710 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40711 to use. When this is full, the earlier 50% of data is discarded &-- this is
40712 much more efficient than throwing it away line by line. The sub-window also has
40713 a horizontal scroll bar for accessing the ends of long log lines. This is the
40714 only means of horizontal scrolling; the right and left arrow keys are not
40715 available. Text can be cut from this part of the window using the mouse in the
40716 normal way. The size of this subwindow is controlled by parameters in the
40717 configuration file &_Local/eximon.conf_&.
40718
40719 Searches of the text in the log window can be carried out by means of the ^R
40720 and ^S keystrokes, which default to a reverse and a forward search,
40721 respectively. The search covers only the text that is displayed in the window.
40722 It cannot go further back up the log.
40723
40724 The point from which the search starts is indicated by a caret marker. This is
40725 normally at the end of the text in the window, but can be positioned explicitly
40726 by pointing and clicking with the left mouse button, and is moved automatically
40727 by a successful search. If new text arrives in the window when it is scrolled
40728 back, the caret remains where it is, but if the window is not scrolled back,
40729 the caret is moved to the end of the new text.
40730
40731 Pressing ^R or ^S pops up a window into which the search text can be typed.
40732 There are buttons for selecting forward or reverse searching, for carrying out
40733 the search, and for cancelling. If the &"Search"& button is pressed, the search
40734 happens and the window remains so that further searches can be done. If the
40735 &"Return"& key is pressed, a single search is done and the window is closed. If
40736 ^C is typed the search is cancelled.
40737
40738 The searching facility is implemented using the facilities of the Athena text
40739 widget. By default this pops up a window containing both &"search"& and
40740 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40741 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40742 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40743 provided version of &%TextPop%& when the remaining parts of the text widget
40744 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40745 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40746 on these systems, at the expense of having unwanted items in the search popup
40747 window.
40748
40749
40750
40751 .section "The queue display" "SECID268"
40752 .cindex "queue" "display in monitor"
40753 The bottom section of the monitor window contains a list of all messages that
40754 are in the queue, which includes those currently being received or delivered,
40755 as well as those awaiting delivery. The size of this subwindow is controlled by
40756 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40757 at which it is updated is controlled by another parameter in the same file &--
40758 the default is 5 minutes, since queue scans can be quite expensive. However,
40759 there is an &"Update"& action button just above the display which can be used
40760 to force an update of the queue display at any time.
40761
40762 When a host is down for some time, a lot of pending mail can build up for it,
40763 and this can make it hard to deal with other messages in the queue. To help
40764 with this situation there is a button next to &"Update"& called &"Hide"&. If
40765 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40766 type anything in here and press &"Return"&, the text is added to a chain of
40767 such texts, and if every undelivered address in a message matches at least one
40768 of the texts, the message is not displayed.
40769
40770 If there is an address that does not match any of the texts, all the addresses
40771 are displayed as normal. The matching happens on the ends of addresses so, for
40772 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40773 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40774 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40775 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40776 a hide request is automatically cancelled after one hour.
40777
40778 While the dialogue box is displayed, you can't press any buttons or do anything
40779 else to the monitor window. For this reason, if you want to cut text from the
40780 queue display to use in the dialogue box, you have to do the cutting before
40781 pressing the &"Hide"& button.
40782
40783 The queue display contains, for each unhidden queued message, the length of
40784 time it has been in the queue, the size of the message, the message id, the
40785 message sender, and the first undelivered recipient, all on one line. If it is
40786 a bounce message, the sender is shown as &"<>"&. If there is more than one
40787 recipient to which the message has not yet been delivered, subsequent ones are
40788 listed on additional lines, up to a maximum configured number, following which
40789 an ellipsis is displayed. Recipients that have already received the message are
40790 not shown.
40791
40792 .cindex "frozen messages" "display"
40793 If a message is frozen, an asterisk is displayed at the left-hand side.
40794
40795 The queue display has a vertical scroll bar, and can also be scrolled by means
40796 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40797 The text searching facilities, as described above for the log window, are also
40798 available, but the caret is always moved to the end of the text when the queue
40799 display is updated.
40800
40801
40802
40803 .section "The queue menu" "SECID269"
40804 .cindex "queue" "menu in monitor"
40805 If the &%shift%& key is held down and the left button is clicked when the mouse
40806 pointer is over the text for any message, an action menu pops up, and the first
40807 line of the queue display for the message is highlighted. This does not affect
40808 any selected text.
40809
40810 If you want to use some other event for popping up the menu, you can set the
40811 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40812 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40813 value set in this parameter is a standard X event description. For example, to
40814 run eximon using &%ctrl%& rather than &%shift%& you could use
40815 .code
40816 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40817 .endd
40818 The title of the menu is the message id, and it contains entries which act as
40819 follows:
40820
40821 .ilist
40822 &'message log'&: The contents of the message log for the message are displayed
40823 in a new text window.
40824 .next
40825 &'headers'&: Information from the spool file that contains the envelope
40826 information and headers is displayed in a new text window. See chapter
40827 &<<CHAPspool>>& for a description of the format of spool files.
40828 .next
40829 &'body'&: The contents of the spool file containing the body of the message are
40830 displayed in a new text window. There is a default limit of 20,000 bytes to the
40831 amount of data displayed. This can be changed by setting the BODY_MAX
40832 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40833 .next
40834 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40835 delivery of the message. This causes an automatic thaw if the message is
40836 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40837 a new text window. The delivery is run in a separate process, to avoid holding
40838 up the monitor while the delivery proceeds.
40839 .next
40840 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40841 that the message be frozen.
40842 .next
40843 .cindex "thawing messages"
40844 .cindex "unfreezing messages"
40845 .cindex "frozen messages" "thawing"
40846 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40847 that the message be thawed.
40848 .next
40849 .cindex "delivery" "forcing failure"
40850 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40851 that Exim gives up trying to deliver the message. A bounce message is generated
40852 for any remaining undelivered addresses.
40853 .next
40854 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40855 that the message be deleted from the system without generating a bounce
40856 message.
40857 .next
40858 &'add recipient'&: A dialog box is displayed into which a recipient address can
40859 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40860 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40861 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40862 causes a call to Exim to be made using the &%-Mar%& option to request that an
40863 additional recipient be added to the message, unless the entry box is empty, in
40864 which case no action is taken.
40865 .next
40866 &'mark delivered'&: A dialog box is displayed into which a recipient address
40867 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40868 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40869 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40870 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40871 recipient address as already delivered, unless the entry box is empty, in which
40872 case no action is taken.
40873 .next
40874 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40875 mark all recipient addresses as already delivered.
40876 .next
40877 &'edit sender'&: A dialog box is displayed initialized with the current
40878 sender's address. Pressing RETURN causes a call to Exim to be made using the
40879 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40880 in which case no action is taken. If you want to set an empty sender (as in
40881 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40882 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40883 the address is qualified with that domain.
40884 .endlist
40885
40886 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40887 other cases when a call to Exim is made, if there is any output from Exim (in
40888 particular, if the command fails) a window containing the command and the
40889 output is displayed. Otherwise, the results of the action are normally apparent
40890 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40891 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40892 if no output is generated.
40893
40894 The queue display is automatically updated for actions such as freezing and
40895 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40896 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40897 force an update of the display after one of these actions.
40898
40899 In any text window that is displayed as result of a menu action, the normal
40900 cut-and-paste facility is available, and searching can be carried out using ^R
40901 and ^S, as described above for the log tail window.
40902 .ecindex IIDeximon
40903
40904
40905
40906
40907
40908 . ////////////////////////////////////////////////////////////////////////////
40909 . ////////////////////////////////////////////////////////////////////////////
40910
40911 .chapter "Security considerations" "CHAPsecurity"
40912 .scindex IIDsecurcon "security" "discussion of"
40913 This chapter discusses a number of issues concerned with security, some of
40914 which are also covered in other parts of this manual.
40915
40916 For reasons that this author does not understand, some people have promoted
40917 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40918 existence of this chapter in the documentation. However, the intent of the
40919 chapter is simply to describe the way Exim works in relation to certain
40920 security concerns, not to make any specific claims about the effectiveness of
40921 its security as compared with other MTAs.
40922
40923 What follows is a description of the way Exim is supposed to be. Best efforts
40924 have been made to try to ensure that the code agrees with the theory, but an
40925 absence of bugs can never be guaranteed. Any that are reported will get fixed
40926 as soon as possible.
40927
40928
40929 .section "Building a more &""hardened""& Exim" "SECID286"
40930 .cindex "security" "build-time features"
40931 There are a number of build-time options that can be set in &_Local/Makefile_&
40932 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40933 Exim administrator who does not have the root password, or by someone who has
40934 penetrated the Exim (but not the root) account. These options are as follows:
40935
40936 .ilist
40937 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40938 start of any filenames used with the &%-C%& option. When it is set, these
40939 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40940 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40941 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40942 default setting for &%ALT_CONFIG_PREFIX%&.
40943
40944 If the permitted configuration files are confined to a directory to
40945 which only root has access, this guards against someone who has broken
40946 into the Exim account from running a privileged Exim with an arbitrary
40947 configuration file, and using it to break into other accounts.
40948 .next
40949
40950 If a non-trusted configuration file (i.e. not the default configuration file
40951 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40952 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40953 the next item), then root privilege is retained only if the caller of Exim is
40954 root. This locks out the possibility of testing a configuration using &%-C%&
40955 right through message reception and delivery, even if the caller is root. The
40956 reception works, but by that time, Exim is running as the Exim user, so when
40957 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40958 privilege to be lost. However, root can test reception and delivery using two
40959 separate commands.
40960
40961 .next
40962 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40963 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40964 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40965 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40966 the restrictive side.  Requiring build-time selection of safe macros is onerous
40967 but this option is intended solely as a transition mechanism to permit
40968 previously-working configurations to continue to work after release 4.73.
40969 .next
40970 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40971 is disabled.
40972 .next
40973 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40974 never to be used for any deliveries. This is like the &%never_users%& runtime
40975 option, but it cannot be overridden; the runtime option adds additional users
40976 to the list. The default setting is &"root"&; this prevents a non-root user who
40977 is permitted to modify the runtime file from using Exim as a way to get root.
40978 .endlist
40979
40980
40981
40982 .section "Root privilege" "SECID270"
40983 .cindex "setuid"
40984 .cindex "root privilege"
40985 The Exim binary is normally setuid to root, which means that it gains root
40986 privilege (runs as root) when it starts execution. In some special cases (for
40987 example, when the daemon is not in use and there are no local deliveries), it
40988 may be possible to run Exim setuid to some user other than root. This is
40989 discussed in the next section. However, in most installations, root privilege
40990 is required for two things:
40991
40992 .ilist
40993 To set up a socket connected to the standard SMTP port (25) when initialising
40994 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40995 not required.
40996 .next
40997 To be able to change uid and gid in order to read users' &_.forward_& files and
40998 perform local deliveries as the receiving user or as specified in the
40999 configuration.
41000 .endlist
41001
41002 It is not necessary to be root to do any of the other things Exim does, such as
41003 receiving messages and delivering them externally over SMTP, and it is
41004 obviously more secure if Exim does not run as root except when necessary.
41005 For this reason, a user and group for Exim to use must be defined in
41006 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
41007 group"&. Their values can be changed by the runtime configuration, though this
41008 is not recommended. Often a user called &'exim'& is used, but some sites use
41009 &'mail'& or another user name altogether.
41010
41011 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
41012 abdication; the process cannot regain root afterwards. Prior to release 4.00,
41013 &[seteuid()]& was used in some circumstances, but this is no longer the case.
41014
41015 After a new Exim process has interpreted its command line options, it changes
41016 uid and gid in the following cases:
41017
41018 .ilist
41019 .oindex "&%-C%&"
41020 .oindex "&%-D%&"
41021 If the &%-C%& option is used to specify an alternate configuration file, or if
41022 the &%-D%& option is used to define macro values for the configuration, and the
41023 calling process is not running as root, the uid and gid are changed to those of
41024 the calling process.
41025 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
41026 option may not be used at all.
41027 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
41028 can be supplied if the calling process is running as root, the Exim run-time
41029 user or CONFIGURE_OWNER, if defined.
41030 .next
41031 .oindex "&%-be%&"
41032 .oindex "&%-bf%&"
41033 .oindex "&%-bF%&"
41034 If the expansion test option (&%-be%&) or one of the filter testing options
41035 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
41036 calling process.
41037 .next
41038 If the process is not a daemon process or a queue runner process or a delivery
41039 process or a process for testing address routing (started with &%-bt%&), the
41040 uid and gid are changed to the Exim user and group. This means that Exim always
41041 runs under its own uid and gid when receiving messages. This also applies when
41042 testing address verification
41043 .oindex "&%-bv%&"
41044 .oindex "&%-bh%&"
41045 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
41046 option).
41047 .next
41048 For a daemon, queue runner, delivery, or address testing process, the uid
41049 remains as root at this stage, but the gid is changed to the Exim group.
41050 .endlist
41051
41052 The processes that initially retain root privilege behave as follows:
41053
41054 .ilist
41055 A daemon process changes the gid to the Exim group and the uid to the Exim
41056 user after setting up one or more listening sockets. The &[initgroups()]&
41057 function is called, so that if the Exim user is in any additional groups, they
41058 will be used during message reception.
41059 .next
41060 A queue runner process retains root privilege throughout its execution. Its
41061 job is to fork a controlled sequence of delivery processes.
41062 .next
41063 A delivery process retains root privilege throughout most of its execution,
41064 but any actual deliveries (that is, the transports themselves) are run in
41065 subprocesses which always change to a non-root uid and gid. For local
41066 deliveries this is typically the uid and gid of the owner of the mailbox; for
41067 remote deliveries, the Exim uid and gid are used. Once all the delivery
41068 subprocesses have been run, a delivery process changes to the Exim uid and gid
41069 while doing post-delivery tidying up such as updating the retry database and
41070 generating bounce and warning messages.
41071
41072 While the recipient addresses in a message are being routed, the delivery
41073 process runs as root. However, if a user's filter file has to be processed,
41074 this is done in a subprocess that runs under the individual user's uid and
41075 gid. A system filter is run as root unless &%system_filter_user%& is set.
41076 .next
41077 A process that is testing addresses (the &%-bt%& option) runs as root so that
41078 the routing is done in the same environment as a message delivery.
41079 .endlist
41080
41081
41082
41083
41084 .section "Running Exim without privilege" "SECTrunexiwitpri"
41085 .cindex "privilege, running without"
41086 .cindex "unprivileged running"
41087 .cindex "root privilege" "running without"
41088 Some installations like to run Exim in an unprivileged state for more of its
41089 operation, for added security. Support for this mode of operation is provided
41090 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
41091 gid are changed to the Exim user and group at the start of a delivery process
41092 (and also queue runner and address testing processes). This means that address
41093 routing is no longer run as root, and the deliveries themselves cannot change
41094 to any other uid.
41095
41096 .cindex SIGHUP
41097 .cindex "daemon" "restarting"
41098 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
41099 that the daemon can still be started in the usual way, and it can respond
41100 correctly to SIGHUP because the re-invocation regains root privilege.
41101
41102 An alternative approach is to make Exim setuid to the Exim user and also setgid
41103 to the Exim group. If you do this, the daemon must be started from a root
41104 process. (Calling Exim from a root process makes it behave in the way it does
41105 when it is setuid root.) However, the daemon cannot restart itself after a
41106 SIGHUP signal because it cannot regain privilege.
41107
41108 It is still useful to set &%deliver_drop_privilege%& in this case, because it
41109 stops Exim from trying to re-invoke itself to do a delivery after a message has
41110 been received. Such a re-invocation is a waste of resources because it has no
41111 effect.
41112
41113 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
41114 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
41115 to the Exim user seems a clean approach, but there is one complication:
41116
41117 In this style of operation, Exim is running with the real uid and gid set to
41118 those of the calling process, and the effective uid/gid set to Exim's values.
41119 Ideally, any association with the calling process' uid/gid should be dropped,
41120 that is, the real uid/gid should be reset to the effective values so as to
41121 discard any privileges that the caller may have. While some operating systems
41122 have a function that permits this action for a non-root effective uid, quite a
41123 number of them do not. Because of this lack of standardization, Exim does not
41124 address this problem at this time.
41125
41126 For this reason, the recommended approach for &"mostly unprivileged"& running
41127 is to keep the Exim binary setuid to root, and to set
41128 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
41129 be used in the most straightforward way.
41130
41131 If you configure Exim not to run delivery processes as root, there are a
41132 number of restrictions on what you can do:
41133
41134 .ilist
41135 You can deliver only as the Exim user/group. You should  explicitly use the
41136 &%user%& and &%group%& options to override routers or local transports that
41137 normally deliver as the recipient. This makes sure that configurations that
41138 work in this mode function the same way in normal mode. Any implicit or
41139 explicit specification of another user causes an error.
41140 .next
41141 Use of &_.forward_& files is severely restricted, such that it is usually
41142 not worthwhile to include them in the configuration.
41143 .next
41144 Users who wish to use &_.forward_& would have to make their home directory and
41145 the file itself accessible to the Exim user. Pipe and append-to-file entries,
41146 and their equivalents in Exim filters, cannot be used. While they could be
41147 enabled in the Exim user's name, that would be insecure and not very useful.
41148 .next
41149 Unless the local user mailboxes are all owned by the Exim user (possible in
41150 some POP3 or IMAP-only environments):
41151
41152 .olist
41153 They must be owned by the Exim group and be writeable by that group. This
41154 implies you must set &%mode%& in the appendfile configuration, as well as the
41155 mode of the mailbox files themselves.
41156 .next
41157 You must set &%no_check_owner%&, since most or all of the files will not be
41158 owned by the Exim user.
41159 .next
41160 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
41161 on a newly created mailbox when unprivileged. This also implies that new
41162 mailboxes need to be created manually.
41163 .endlist olist
41164 .endlist ilist
41165
41166
41167 These restrictions severely restrict what can be done in local deliveries.
41168 However, there are no restrictions on remote deliveries. If you are running a
41169 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
41170 gives more security at essentially no cost.
41171
41172 If you are using the &%mua_wrapper%& facility (see chapter
41173 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
41174
41175
41176
41177
41178 .section "Delivering to local files" "SECID271"
41179 Full details of the checks applied by &(appendfile)& before it writes to a file
41180 are given in chapter &<<CHAPappendfile>>&.
41181
41182
41183
41184 .section "Running local commands" "SECTsecconslocalcmds"
41185 .cindex "security" "local commands"
41186 .cindex "security" "command injection attacks"
41187 There are a number of ways in which an administrator can configure Exim to run
41188 commands based upon received, untrustworthy, data. Further, in some
41189 configurations a user who can control a &_.forward_& file can also arrange to
41190 run commands. Configuration to check includes, but is not limited to:
41191
41192 .ilist
41193 Use of &%use_shell%& in the pipe transport: various forms of shell command
41194 injection may be possible with this option present. It is dangerous and should
41195 be used only with considerable caution. Consider constraints which whitelist
41196 allowed characters in a variable which is to be used in a pipe transport that
41197 has &%use_shell%& enabled.
41198 .next
41199 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
41200 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
41201 &_.forward_& files in a redirect router. If Exim is running on a central mail
41202 hub to which ordinary users do not have shell access, but home directories are
41203 NFS mounted (for instance) then administrators should review the list of these
41204 forbid options available, and should bear in mind that the options that may
41205 need forbidding can change as new features are added between releases.
41206 .next
41207 The &%${run...}%& expansion item does not use a shell by default, but
41208 administrators can configure use of &_/bin/sh_& as part of the command.
41209 Such invocations should be viewed with prejudicial suspicion.
41210 .next
41211 Administrators who use embedded Perl are advised to explore how Perl's
41212 taint checking might apply to their usage.
41213 .next
41214 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
41215 administrators are well advised to view its use with suspicion, in case (for
41216 instance) it allows a local-part to contain embedded Exim directives.
41217 .next
41218 Use of &%${match_local_part...}%& and friends becomes more dangerous if
41219 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
41220 each can reference arbitrary lists and files, rather than just being a list
41221 of opaque strings.
41222 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
41223 real-world security vulnerabilities caused by its use with untrustworthy data
41224 injected in, for SQL injection attacks.
41225 Consider the use of the &%inlisti%& expansion condition instead.
41226 .endlist
41227
41228
41229
41230
41231 .section "Trust in configuration data" "SECTsecconfdata"
41232 .cindex "security" "data sources"
41233 .cindex "security" "regular expressions"
41234 .cindex "regular expressions" "security"
41235 .cindex "PCRE2" "security"
41236 If configuration data for Exim can come from untrustworthy sources, there
41237 are some issues to be aware of:
41238
41239 .ilist
41240 Use of &%${expand...}%& may provide a path for shell injection attacks.
41241 .next
41242 Letting untrusted data provide a regular expression is unwise.
41243 .next
41244 Using &%${match...}%& to apply a fixed regular expression against untrusted
41245 data may result in pathological behaviour within PCRE2.  Be aware of what
41246 "backtracking" means and consider options for being more strict with a regular
41247 expression. Avenues to explore include limiting what can match (avoiding &`.`&
41248 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
41249 possessive quantifiers or just not using regular expressions against untrusted
41250 data.
41251 .next
41252 It can be important to correctly use &%${quote:...}%&,
41253 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
41254 items to ensure that data is correctly constructed.
41255 .next
41256 Some lookups might return multiple results, even though normal usage is only
41257 expected to yield one result.
41258 .endlist
41259
41260
41261
41262
41263 .section "IPv4 source routing" "SECID272"
41264 .cindex "source routing" "in IP packets"
41265 .cindex "IP source routing"
41266 Many operating systems suppress IP source-routed packets in the kernel, but
41267 some cannot be made to do this, so Exim does its own check. It logs incoming
41268 IPv4 source-routed TCP calls, and then drops them. Things are all different in
41269 IPv6. No special checking is currently done.
41270
41271
41272
41273 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41274 Support for these SMTP commands is disabled by default. If required, they can
41275 be enabled by defining suitable ACLs.
41276
41277
41278
41279
41280 .section "Privileged users" "SECID274"
41281 .cindex "trusted users"
41282 .cindex "admin user"
41283 .cindex "privileged user"
41284 .cindex "user" "trusted"
41285 .cindex "user" "admin"
41286 Exim recognizes two sets of users with special privileges. Trusted users are
41287 able to submit new messages to Exim locally, but supply their own sender
41288 addresses and information about a sending host. For other users submitting
41289 local messages, Exim sets up the sender address from the uid, and doesn't
41290 permit a remote host to be specified.
41291
41292 .oindex "&%-f%&"
41293 However, an untrusted user is permitted to use the &%-f%& command line option
41294 in the special form &%-f <>%& to indicate that a delivery failure for the
41295 message should not cause an error report. This affects the message's envelope,
41296 but it does not affect the &'Sender:'& header. Untrusted users may also be
41297 permitted to use specific forms of address with the &%-f%& option by setting
41298 the &%untrusted_set_sender%& option.
41299
41300 Trusted users are used to run processes that receive mail messages from some
41301 other mail domain and pass them on to Exim for delivery either locally, or over
41302 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41303 as any user listed in the &%trusted_users%& configuration option, or under any
41304 group listed in the &%trusted_groups%& option.
41305
41306 Admin users are permitted to do things to the messages on Exim's queue. They
41307 can freeze or thaw messages, cause them to be returned to their senders, remove
41308 them entirely, or modify them in various ways. In addition, admin users can run
41309 the Exim monitor and see all the information it is capable of providing, which
41310 includes the contents of files on the spool.
41311
41312 .oindex "&%-M%&"
41313 .oindex "&%-q%&"
41314 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41315 delivery of messages on its queue is restricted to admin users. This
41316 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41317 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41318 queue is also restricted to admin users. This restriction can be relaxed by
41319 setting &%no_queue_list_requires_admin%&.
41320
41321 Exim recognizes an admin user if the calling process is running as root or as
41322 the Exim user or if any of the groups associated with the calling process is
41323 the Exim group. It is not necessary actually to be running under the Exim
41324 group. However, if admin users who are not root or the Exim user are to access
41325 the contents of files on the spool via the Exim monitor (which runs
41326 unprivileged), Exim must be built to allow group read access to its spool
41327 files.
41328
41329 By default, regular users are trusted to perform basic testing and
41330 introspection commands, as themselves.  This setting can be tightened by
41331 setting the &%commandline_checks_require_admin%& option.
41332 This affects most of the checking options,
41333 such as &%-be%& and anything else &%-b*%&.
41334
41335
41336 .section "Spool files" "SECID275"
41337 .cindex "spool directory" "files"
41338 Exim's spool directory and everything it contains is owned by the Exim user and
41339 set to the Exim group. The mode for spool files is defined in the
41340 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41341 any user who is a member of the Exim group can access these files.
41342
41343
41344
41345 .section "Use of argv[0]" "SECID276"
41346 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41347 of specific strings, Exim assumes certain options. For example, calling Exim
41348 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41349 to calling it with the option &%-bS%&. There are no security implications in
41350 this.
41351
41352
41353
41354 .section "Use of %f formatting" "SECID277"
41355 The only use made of &"%f"& by Exim is in formatting load average values. These
41356 are actually stored in integer variables as 1000 times the load average.
41357 Consequently, their range is limited and so therefore is the length of the
41358 converted output.
41359
41360
41361
41362 .section "Embedded Exim path" "SECID278"
41363 Exim uses its own path name, which is embedded in the code, only when it needs
41364 to re-exec in order to regain root privilege. Therefore, it is not root when it
41365 does so. If some bug allowed the path to get overwritten, it would lead to an
41366 arbitrary program's being run as exim, not as root.
41367
41368
41369
41370 .section "Dynamic module directory" "SECTdynmoddir"
41371 Any dynamically loadable modules must be installed into the directory
41372 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41373 loading it.
41374
41375
41376 .section "Use of sprintf()" "SECID279"
41377 .cindex "&[sprintf()]&"
41378 A large number of occurrences of &"sprintf"& in the code are actually calls to
41379 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41380 The intermediate formatting is done into a large fixed buffer by a function
41381 that runs through the format string itself, and checks the length of each
41382 conversion before performing it, thus preventing buffer overruns.
41383
41384 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41385 the output buffer is known to be sufficiently long to contain the converted
41386 string.
41387
41388
41389
41390 .section "Use of debug_printf() and log_write()" "SECID280"
41391 Arbitrary strings are passed to both these functions, but they do their
41392 formatting by calling the function &'string_vformat()'&, which runs through
41393 the format string itself, and checks the length of each conversion.
41394
41395
41396
41397 .section "Use of strcat() and strcpy()" "SECID281"
41398 These are used only in cases where the output buffer is known to be large
41399 enough to hold the result.
41400 .ecindex IIDsecurcon
41401
41402
41403
41404
41405 . ////////////////////////////////////////////////////////////////////////////
41406 . ////////////////////////////////////////////////////////////////////////////
41407
41408 .chapter "Format of spool files" "CHAPspool"
41409 .scindex IIDforspo1 "format" "spool files"
41410 .scindex IIDforspo2 "spool directory" "format of files"
41411 .scindex IIDforspo3 "spool files" "format of"
41412 .cindex "spool files" "editing"
41413 A message on Exim's queue consists of two files, whose names are the message id
41414 followed by -D and -H, respectively. The data portion of the message is kept in
41415 the -D file on its own. The message's envelope, status, and headers are all
41416 kept in the -H file, whose format is described in this chapter. Each of these
41417 two files contains the final component of its own name as its first line. This
41418 is insurance against disk crashes where the directory is lost but the files
41419 themselves are recoverable.
41420
41421 The file formats may be changed, or new formats added, at any release.
41422 Spool files are not intended as an interface to other programs
41423 and should not be used as such.
41424
41425 Some people are tempted into editing -D files in order to modify messages. You
41426 need to be extremely careful if you do this; it is not recommended and you are
41427 on your own if you do it. Here are some of the pitfalls:
41428
41429 .ilist
41430 You must ensure that Exim does not try to deliver the message while you are
41431 fiddling with it. The safest way is to take out a write lock on the -D file,
41432 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41433 place, the lock will be retained. If you write a new file and rename it, the
41434 lock will be lost at the instant of rename.
41435 .next
41436 .vindex "&$body_linecount$&"
41437 If you change the number of lines in the file, the value of
41438 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41439 cause incomplete transmission of messages or undeliverable messages.
41440 .next
41441 If the message is in MIME format, you must take care not to break it.
41442 .next
41443 If the message is cryptographically signed, any change will invalidate the
41444 signature.
41445 .endlist
41446 All in all, modifying -D files is fraught with danger.
41447
41448 Files whose names end with -J may also be seen in the &_input_& directory (or
41449 its subdirectories when &%split_spool_directory%& is set). These are journal
41450 files, used to record addresses to which the message has been delivered during
41451 the course of a delivery attempt. If there are still undelivered recipients at
41452 the end, the -H file is updated, and the -J file is deleted. If, however, there
41453 is some kind of crash (for example, a power outage) before this happens, the -J
41454 file remains in existence. When Exim next processes the message, it notices the
41455 -J file and uses it to update the -H file before starting the next delivery
41456 attempt.
41457
41458 Files whose names end with -K or .eml may also be seen in the spool.
41459 These are temporaries used for DKIM or malware processing, when that is used.
41460 They should be tidied up by normal operations; any old ones are probably
41461 relics of crashes and can be removed.
41462
41463 .section "Format of the -H file" "SECID282"
41464 .cindex "uid (user id)" "in spool file"
41465 .cindex "gid (group id)" "in spool file"
41466 The second line of the -H file contains the login name for the uid of the
41467 process that called Exim to read the message, followed by the numerical uid and
41468 gid. For a locally generated message, this is normally the user who sent the
41469 message. For a message received over TCP/IP via the daemon, it is
41470 normally the Exim user.
41471
41472 The third line of the file contains the address of the message's sender as
41473 transmitted in the envelope, contained in angle brackets. The sender address is
41474 empty for bounce messages. For incoming SMTP mail, the sender address is given
41475 in the MAIL command. For locally generated mail, the sender address is
41476 created by Exim from the login name of the current user and the configured
41477 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41478 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41479 &"<>"& or an address that matches &%untrusted_set_senders%&.
41480
41481 The fourth line contains two numbers. The first is the time that the message
41482 was received, in the conventional Unix form &-- the number of seconds since the
41483 start of the epoch. The second number is a count of the number of messages
41484 warning of delayed delivery that have been sent to the sender.
41485
41486 There follow a number of lines starting with a hyphen.
41487 These contain variables, can appear in any
41488 order, and are omitted when not relevant.
41489
41490 If there is a second hyphen after the first,
41491 the corresponding data is tainted.
41492 If there is a value in parentheses, the data is quoted for a lookup.
41493
41494 The following word specifies a variable,
41495 and the remainder of the item depends on the variable.
41496
41497 .vlist
41498 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41499 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41500 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41501 recognized, to provide backward compatibility. In the old format, a line of
41502 this form is present for every ACL variable that is not empty. The number
41503 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41504 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41505 the data string for the variable. The string itself starts at the beginning of
41506 the next line, and is followed by a newline character. It may contain internal
41507 newlines.
41508
41509 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41510 A line of this form is present for every ACL connection variable that is
41511 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41512 The length is the length of the data string for the variable. The string itself
41513 starts at the beginning of the next line, and is followed by a newline
41514 character. It may contain internal newlines.
41515
41516 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41517 A line of this form is present for every ACL message variable that is defined.
41518 Note that there is a space between &%-aclm%& and the rest of the name. The
41519 length is the length of the data string for the variable. The string itself
41520 starts at the beginning of the next line, and is followed by a newline
41521 character. It may contain internal newlines.
41522
41523 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41524 This is present if, when the message was received over SMTP, the value of
41525 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41526
41527 .vitem &%-allow_unqualified_recipient%&
41528 This is present if unqualified recipient addresses are permitted in header
41529 lines (to stop such addresses from being qualified if rewriting occurs at
41530 transport time). Local messages that were input using &%-bnq%& and remote
41531 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41532
41533 .vitem &%-allow_unqualified_sender%&
41534 This is present if unqualified sender addresses are permitted in header lines
41535 (to stop such addresses from being qualified if rewriting occurs at transport
41536 time). Local messages that were input using &%-bnq%& and remote messages from
41537 hosts that match &%sender_unqualified_hosts%& set this flag.
41538
41539 .vitem "&%-auth_id%&&~<&'text'&>"
41540 The id information for a message received on an authenticated SMTP connection
41541 &-- the value of the &$authenticated_id$& variable.
41542
41543 .vitem "&%-auth_sender%&&~<&'address'&>"
41544 The address of an authenticated sender &-- the value of the
41545 &$authenticated_sender$& variable.
41546
41547 .vitem "&%-body_linecount%&&~<&'number'&>"
41548 This records the number of lines in the body of the message, and is
41549 present unless &%-spool_file_wireformat%& is.
41550
41551 .vitem "&%-body_zerocount%&&~<&'number'&>"
41552 This records the number of binary zero bytes in the body of the message, and is
41553 present if the number is greater than zero.
41554
41555 .vitem &%-deliver_firsttime%&
41556 This is written when a new message is first added to the spool. When the spool
41557 file is updated after a deferral, it is omitted.
41558
41559 .vitem "&%-frozen%&&~<&'time'&>"
41560 .cindex "frozen messages" "spool data"
41561 The message is frozen, and the freezing happened at <&'time'&>.
41562
41563 .vitem "&%-helo_name%&&~<&'text'&>"
41564 This records the host name as specified by a remote host in a HELO or EHLO
41565 command.
41566
41567 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41568 This records the IP address of the host from which the message was received and
41569 the remote port number that was used. It is omitted for locally generated
41570 messages.
41571
41572 .vitem "&%-host_auth%&&~<&'text'&>"
41573 If the message was received on an authenticated SMTP connection, this records
41574 the name of the authenticator &-- the value of the
41575 &$sender_host_authenticated$& variable.
41576
41577 .vitem &%-host_lookup_failed%&
41578 This is present if an attempt to look up the sending host's name from its IP
41579 address failed. It corresponds to the &$host_lookup_failed$& variable.
41580
41581 .vitem "&%-host_name%&&~<&'text'&>"
41582 .cindex "reverse DNS lookup"
41583 .cindex "DNS" "reverse lookup"
41584 This records the name of the remote host from which the message was received,
41585 if the host name was looked up from the IP address when the message was being
41586 received. It is not present if no reverse lookup was done.
41587
41588 .vitem "&%-ident%&&~<&'text'&>"
41589 For locally submitted messages, this records the login of the originating user,
41590 unless it was a trusted user and the &%-oMt%& option was used to specify an
41591 ident value. For messages received over TCP/IP, this records the ident string
41592 supplied by the remote host, if any.
41593
41594 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41595 This records the IP address of the local interface and the port number through
41596 which a message was received from a remote host. It is omitted for locally
41597 generated messages.
41598
41599 .vitem &%-local%&
41600 The message is from a local sender.
41601
41602 .vitem &%-localerror%&
41603 The message is a locally-generated bounce message.
41604
41605 .vitem "&%-local_scan%&&~<&'string'&>"
41606 This records the data string that was returned by the &[local_scan()]& function
41607 when the message was received &-- the value of the &$local_scan_data$&
41608 variable. It is omitted if no data was returned.
41609
41610 .vitem &%-manual_thaw%&
41611 The message was frozen but has been thawed manually, that is, by an explicit
41612 Exim command rather than via the auto-thaw process.
41613
41614 .vitem &%-N%&
41615 A testing delivery process was started using the &%-N%& option to suppress any
41616 actual deliveries, but delivery was deferred. At any further delivery attempts,
41617 &%-N%& is assumed.
41618
41619 .vitem &%-received_protocol%&
41620 This records the value of the &$received_protocol$& variable, which contains
41621 the name of the protocol by which the message was received.
41622
41623 .vitem &%-sender_set_untrusted%&
41624 The envelope sender of this message was set by an untrusted local caller (used
41625 to ensure that the caller is displayed in queue listings).
41626
41627 .vitem "&%-spam_score_int%&&~<&'number'&>"
41628 If a message was scanned by SpamAssassin, this is present. It records the value
41629 of &$spam_score_int$&.
41630
41631 .vitem &%-spool_file_wireformat%&
41632 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41633 rather than Unix-format.
41634 The line-ending is CRLF rather than newline.
41635 There is still, however, no leading-dot-stuffing.
41636
41637 .vitem &%-tls_certificate_verified%&
41638 A TLS certificate was received from the client that sent this message, and the
41639 certificate was verified by the server.
41640
41641 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41642 When the message was received over an encrypted connection, this records the
41643 name of the cipher suite that was used.
41644
41645 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41646 When the message was received over an encrypted connection, and a certificate
41647 was received from the client, this records the Distinguished Name from that
41648 certificate.
41649 .endlist
41650
41651 Following the options there is a list of those addresses to which the message
41652 is not to be delivered. This set of addresses is initialized from the command
41653 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41654 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41655 the address is added to this set. The addresses are kept internally as a
41656 balanced binary tree, and it is a representation of that tree which is written
41657 to the spool file. If an address is expanded via an alias or forward file, the
41658 original address is added to the tree when deliveries to all its child
41659 addresses are complete.
41660
41661 If the tree is empty, there is a single line in the spool file containing just
41662 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41663 Y or N, followed by an address. The address is the value for the node of the
41664 tree, and the letters indicate whether the node has a left branch and/or a
41665 right branch attached to it, respectively. If branches exist, they immediately
41666 follow. Here is an example of a three-node tree:
41667 .code
41668 YY darcy@austen.fict.example
41669 NN alice@wonderland.fict.example
41670 NN editor@thesaurus.ref.example
41671 .endd
41672 After the non-recipients tree, there is a list of the message's recipients.
41673 This is a simple list, preceded by a count. It includes all the original
41674 recipients of the message, including those to whom the message has already been
41675 delivered. In the simplest case, the list contains one address per line. For
41676 example:
41677 .code
41678 4
41679 editor@thesaurus.ref.example
41680 darcy@austen.fict.example
41681 rdo@foundation
41682 alice@wonderland.fict.example
41683 .endd
41684 However, when a child address has been added to the top-level addresses as a
41685 result of the use of the &%one_time%& option on a &(redirect)& router, each
41686 line is of the following form:
41687 .display
41688 <&'top-level address'&> <&'errors_to address'&> &&&
41689   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41690 .endd
41691 The 01 flag bit indicates the presence of the three other fields that follow
41692 the top-level address. Other bits may be used in future to support additional
41693 fields. The <&'parent number'&> is the offset in the recipients list of the
41694 original parent of the &"one time"& address. The first two fields are the
41695 envelope sender that is associated with this address and its length. If the
41696 length is zero, there is no special envelope sender (there are then two space
41697 characters in the line). A non-empty field can arise from a &(redirect)& router
41698 that has an &%errors_to%& setting.
41699
41700
41701 A blank line separates the envelope and status information from the headers
41702 which follow. A header may occupy several lines of the file, and to save effort
41703 when reading it in, each header is preceded by a number and an identifying
41704 character. The number is the number of characters in the header, including any
41705 embedded newlines and the terminating newline. The character is one of the
41706 following:
41707
41708 .table2 50pt
41709 .row <&'blank'&>         "header in which Exim has no special interest"
41710 .row &`B`&               "&'Bcc:'& header"
41711 .row &`C`&               "&'Cc:'& header"
41712 .row &`F`&               "&'From:'& header"
41713 .row &`I`&               "&'Message-id:'& header"
41714 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41715 .row &`R`&               "&'Reply-To:'& header"
41716 .row &`S`&               "&'Sender:'& header"
41717 .row &`T`&               "&'To:'& header"
41718 .row &`*`&               "replaced or deleted header"
41719 .endtable
41720
41721 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41722 purposes. They are not transmitted when the message is delivered. Here is a
41723 typical set of headers:
41724 .code
41725 111P Received: by hobbit.fict.example with local (Exim 4.00)
41726 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41727 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41728 038* X-rewrote-sender: bb@hobbit.fict.example
41729 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41730 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41731 099* To: alice@wonderland.fict.example, rdo@foundation,
41732 darcy@austen.fict.example, editor@thesaurus.ref.example
41733 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41734 darcy@austen.fict.example, editor@thesaurus.ref.example
41735 038  Date: Fri, 11 May 2001 10:28:59 +0100
41736 .endd
41737 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41738 &'To:'& header have been rewritten, the last one because routing expanded the
41739 unqualified domain &'foundation'&.
41740 .ecindex IIDforspo1
41741 .ecindex IIDforspo2
41742 .ecindex IIDforspo3
41743
41744 .section "Format of the -D file" "SECID282a"
41745 The data file is traditionally in Unix-standard format: lines are ended with
41746 an ASCII newline character.
41747 However, when the &%spool_wireformat%& main option is used some -D files
41748 can have an alternate format.
41749 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41750 The -D file lines (not including the first name-component line) are
41751 suitable for direct copying to the wire when transmitting using the
41752 ESMTP CHUNKING option, meaning lower processing overhead.
41753 Lines are terminated with an ASCII CRLF pair.
41754 There is no dot-stuffing (and no dot-termination).
41755
41756 . ////////////////////////////////////////////////////////////////////////////
41757 . ////////////////////////////////////////////////////////////////////////////
41758
41759 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41760          "DKIM, SPF, SRS and DMARC Support"
41761
41762 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41763 .cindex "DKIM"
41764
41765 DKIM is a mechanism by which messages sent by some entity can be provably
41766 linked to a domain which that entity controls.  It permits reputation to
41767 be tracked on a per-domain basis, rather than merely upon source IP address.
41768 DKIM is documented in RFC 6376.
41769
41770 As DKIM relies on the message being unchanged in transit, messages handled
41771 by a mailing-list (which traditionally adds to the message) will not match
41772 any original DKIM signature.
41773
41774 DKIM support is compiled into Exim by default if TLS support is present.
41775 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41776
41777 Exim's DKIM implementation allows for
41778 .olist
41779 Signing outgoing messages: This function is implemented in the SMTP transport.
41780 It can co-exist with all other Exim features
41781 (including transport filters) except cutthrough delivery.
41782 However, signing options may not depend on headers modified by
41783 routers, the transport or a transport filter.
41784 .next
41785 Verifying signatures in incoming messages: This is implemented by an additional
41786 ACL (acl_smtp_dkim), which can be called several times per message, with
41787 different signature contexts.
41788 .endlist
41789
41790 In typical Exim style, the verification implementation does not include any
41791 default "policy". Instead it enables you to build your own policy using
41792 Exim's standard controls.
41793
41794 Please note that verification of DKIM signatures in incoming mail is turned
41795 on by default for logging (in the <= line) purposes.
41796
41797 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41798 When set, for each signature in incoming email,
41799 exim will log a line displaying the most important signature details, and the
41800 signature status. Here is an example (with line-breaks added for clarity):
41801 .code
41802 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41803     d=facebookmail.com s=q1-2009b
41804     c=relaxed/relaxed a=rsa-sha1
41805     i=@facebookmail.com t=1252484542 [verification succeeded]
41806 .endd
41807
41808 You might want to turn off DKIM verification processing entirely for internal
41809 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41810 control modifier. This should typically be done in the RCPT ACL, at points
41811 where you accept mail from relay sources (internal hosts or authenticated
41812 senders).
41813
41814
41815 .subsection "Signing outgoing messages" SECDKIMSIGN
41816 .cindex DKIM signing
41817
41818 For signing to be usable you must have published a DKIM record in DNS.
41819 Note that RFC 8301 (which does not cover EC keys) says:
41820 .code
41821 rsa-sha1 MUST NOT be used for signing or verifying.
41822
41823 Signers MUST use RSA keys of at least 1024 bits for all keys.
41824 Signers SHOULD use RSA keys of at least 2048 bits.
41825 .endd
41826
41827 Note also that the key content (the 'p=' field)
41828 in the DNS record is different between RSA and EC keys;
41829 for the former it is the base64 of the ASN.1 for the RSA public key
41830 (equivalent to the private-key .pem with the header/trailer stripped)
41831 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41832
41833 Signing is enabled by setting private options on the SMTP transport.
41834 These options take (expandable) strings as arguments.
41835
41836 .option dkim_domain smtp "string list&!!" unset
41837 The domain(s) you want to sign with.
41838 After expansion, this can be a list.
41839 Each element in turn,
41840 lowercased,
41841 .vindex "&$dkim_domain$&"
41842 is put into the &%$dkim_domain%& expansion variable
41843 while expanding the remaining signing options.
41844 If it is empty after expansion, DKIM signing is not done,
41845 and no error will result even if &%dkim_strict%& is set.
41846
41847 .option dkim_selector smtp "string list&!!" unset
41848 This sets the key selector string.
41849 After expansion, which can use &$dkim_domain$&, this can be a list.
41850 Each element in turn is put in the expansion
41851 .vindex "&$dkim_selector$&"
41852 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41853 option along with &%$dkim_domain%&.
41854 If the option is empty after expansion, DKIM signing is not done for this domain,
41855 and no error will result even if &%dkim_strict%& is set.
41856
41857 To do, for example, dual-signing with RSA and EC keys
41858 this could be be used:
41859 .code
41860 dkim_selector = ec_sel : rsa_sel
41861 dkim_private_key = KEYS_DIR/$dkim_selector
41862 .endd
41863
41864 .option dkim_private_key smtp string&!! unset
41865 This sets the private key to use.
41866 You can use the &%$dkim_domain%& and
41867 &%$dkim_selector%& expansion variables to determine the private key to use.
41868 The result can either
41869 .ilist
41870 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41871 .next
41872 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41873 be a valid Ed25519 private key (same format as above)
41874 .next
41875 start with a slash, in which case it is treated as a file that contains
41876 the private key
41877 .next
41878 be "0", "false" or the empty string, in which case the message will not
41879 be signed. This case will not result in an error, even if &%dkim_strict%&
41880 is set.
41881 .endlist
41882
41883 To generate keys under OpenSSL:
41884 .code
41885 openssl genrsa -out dkim_rsa.private 2048
41886 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41887 .endd
41888 The result file from the first command should be retained, and
41889 this option set to use it.
41890 Take the base-64 lines from the output of the second command, concatenated,
41891 for the DNS TXT record.
41892 See section 3.6 of RFC6376 for the record specification.
41893
41894 Under GnuTLS:
41895 .code
41896 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41897 certtool --load-privkey=dkim_rsa.private --pubkey-info
41898 .endd
41899
41900 Note that RFC 8301 says:
41901 .code
41902 Signers MUST use RSA keys of at least 1024 bits for all keys.
41903 Signers SHOULD use RSA keys of at least 2048 bits.
41904 .endd
41905
41906 EC keys for DKIM are defined by RFC 8463.
41907 They are considerably smaller than RSA keys for equivalent protection.
41908 As they are a recent development, users should consider dual-signing
41909 (by setting a list of selectors, and an expansion for this option)
41910 for some transition period.
41911 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41912 for EC keys.
41913
41914 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41915 .code
41916 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41917 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41918 .endd
41919
41920 To produce the required public key value for a DNS record:
41921 .code
41922 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41923 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41924 .endd
41925
41926 Exim also supports an alternate format
41927 of Ed25519 keys in DNS which was a candidate during development
41928 of the standard, but not adopted.
41929 A future release will probably drop that support.
41930
41931 .option dkim_hash smtp string&!! sha256
41932 Can be set to any one of the supported hash methods, which are:
41933 .ilist
41934 &`sha1`& &-- should not be used, is old and insecure
41935 .next
41936 &`sha256`& &-- the default
41937 .next
41938 &`sha512`& &-- possibly more secure but less well supported
41939 .endlist
41940
41941 Note that RFC 8301 says:
41942 .code
41943 rsa-sha1 MUST NOT be used for signing or verifying.
41944 .endd
41945
41946 .option dkim_identity smtp string&!! unset
41947 If set after expansion, the value is used to set an "i=" tag in
41948 the signing header.  The DKIM standards restrict the permissible
41949 syntax of this optional tag to a mail address, with possibly-empty
41950 local part, an @, and a domain identical to or subdomain of the "d="
41951 tag value.  Note that Exim does not check the value.
41952
41953 .option dkim_canon smtp string&!! unset
41954 This option sets the canonicalization method used when signing a message.
41955 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41956 The option defaults to "relaxed" when unset. Note: the current implementation
41957 only supports signing with the same canonicalization method for both headers and body.
41958
41959 .option dkim_strict smtp string&!! unset
41960 This  option  defines  how  Exim  behaves  when  signing a message that
41961 should be signed fails for some reason.  When the expansion evaluates to
41962 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41963 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41964 variables here.
41965
41966 .option dkim_sign_headers smtp string&!! "see below"
41967 If set, this option must expand to a colon-separated
41968 list of header names.
41969 Headers with these names, or the absence of such a header, will be included
41970 in the message signature.
41971 When unspecified, the header names listed in RFC4871 will be used,
41972 whether or not each header is present in the message.
41973 The default list is available for the expansion in the macro
41974 &"_DKIM_SIGN_HEADERS"&
41975 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41976
41977 If a name is repeated, multiple headers by that name (or the absence thereof)
41978 will be signed.  The textually later headers in the headers part of the
41979 message are signed first, if there are multiples.
41980
41981 A name can be prefixed with either an &"="& or a &"+"& character.
41982 If an &"="& prefix is used, all headers that are present with this name
41983 will be signed.
41984 If a &"+"& prefix if used, all headers that are present with this name
41985 will be signed, and one signature added for a missing header with the
41986 name will be appended.
41987
41988 .option dkim_timestamps smtp integer&!! unset
41989 This option controls the inclusion of timestamp information in the signature.
41990 If not set, no such information will be included.
41991 Otherwise, must be an unsigned number giving an offset in seconds from the
41992 current time for the expiry tag (e.g. 1209600 for two weeks); both creation
41993 (t=) and expiry (x=) tags will be included unless the offset is 0 (no expiry).
41994
41995 RFC 6376 lists these tags as RECOMMENDED.
41996
41997
41998 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41999 .cindex DKIM verification
42000
42001 Verification of DKIM signatures in SMTP incoming email is done for all
42002 messages for which an ACL control &%dkim_disable_verify%& has not been set.
42003
42004 .cindex DKIM "selecting signature algorithms"
42005 Individual classes of DKIM signature algorithm can be ignored by changing
42006 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
42007 The &%dkim_verify_minimal%& option can be set to cease verification
42008 processing for a message once the first passing signature is found.
42009
42010 .cindex authentication "expansion item"
42011 Performing verification sets up information used by the
42012 &%authresults%& expansion item.
42013
42014 For most purposes the default option settings suffice and the remainder
42015 of this section can be ignored.
42016
42017 The results of verification are made available to the
42018 &%acl_smtp_dkim%& ACL, which (for complex needs) can examine and modify them.
42019 A missing ACL definition defaults to accept.
42020 By default, the ACL is called once for each
42021 syntactically(!) correct signature in the incoming message.
42022 If any ACL call does not accept, the message is not accepted.
42023 If a cutthrough delivery was in progress for the message, that is
42024 summarily dropped (having wasted the transmission effort).
42025
42026 To evaluate the verification result in the ACL
42027 a large number of expansion variables
42028 containing the signature status and its details are set up during the
42029 runtime of the ACL.
42030
42031 Calling the ACL only for existing signatures is not sufficient to build
42032 more advanced policies. For that reason, the main option
42033 &%dkim_verify_signers%&, and an expansion variable
42034 &%$dkim_signers%& exist.
42035
42036 The main option &%dkim_verify_signers%& can be set to a colon-separated
42037 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
42038 called. It is expanded when the message has been received. At this point,
42039 the expansion variable &%$dkim_signers%& already contains a colon-separated
42040 list of signer domains and identities for the message. When
42041 &%dkim_verify_signers%& is not specified in the main configuration,
42042 it defaults as:
42043 .code
42044 dkim_verify_signers = $dkim_signers
42045 .endd
42046 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
42047 DKIM signature in the message. Current DKIM verifiers may want to explicitly
42048 call the ACL for known domains or identities. This would be achieved as follows:
42049 .code
42050 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
42051 .endd
42052 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
42053 and "ebay.com", plus all domains and identities that have signatures in the message.
42054 You can also be more creative in constructing your policy. For example:
42055 .code
42056 dkim_verify_signers = $sender_address_domain:$dkim_signers
42057 .endd
42058
42059 If a domain or identity is listed several times in the (expanded) value of
42060 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
42061
42062 Note that if the option is set using untrustworthy data
42063 (such as the From: header)
42064 care should be taken to force lowercase for domains
42065 and for the domain part if identities.
42066 The default setting can be regarded as trustworthy in this respect.
42067
42068 If multiple signatures match a domain (or identity), the ACL is called once
42069 for each matching signature.
42070
42071
42072 Inside the DKIM ACL, the following expansion variables are
42073 available (from most to least important):
42074
42075
42076 .vlist
42077 .vitem &%$dkim_cur_signer%&
42078 The signer that is being evaluated in this ACL run. This can be a domain or
42079 an identity. This is one of the list items from the expanded main option
42080 &%dkim_verify_signers%& (see above).
42081
42082 .vitem &%$dkim_verify_status%&
42083 So long as a DKIM ACL is defined
42084 (it need do no more than accept, which is the default),
42085 after all the DKIM ACL runs have completed, the value becomes a
42086 colon-separated list of the values after each run.
42087 The value is maintained for the MIME, PRDR and DATA ACLs.
42088
42089 Within the DKIM ACL,
42090 a string describing the general status of the signature. One of
42091 .ilist
42092 &%none%&: There is no signature in the message for the current domain or
42093 identity (as reflected by &%$dkim_cur_signer%&).
42094 .next
42095 &%invalid%&: The signature could not be verified due to a processing error.
42096 More detail is available in &%$dkim_verify_reason%&.
42097 .next
42098 &%fail%&: Verification of the signature failed.  More detail is
42099 available in &%$dkim_verify_reason%&.
42100 .next
42101 &%pass%&: The signature passed verification. It is valid.
42102 .endlist
42103
42104 This variable can be overwritten using an ACL 'set' modifier.
42105 This might, for instance, be done to enforce a policy restriction on
42106 hash-method or key-size:
42107 .code
42108   warn condition       = ${if eq {$dkim_verify_status}{pass}}
42109        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
42110        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
42111                                   {< {$dkim_key_length}{1024}}}}
42112        logwrite        = NOTE: forcing DKIM verify fail (was pass)
42113        set dkim_verify_status = fail
42114        set dkim_verify_reason = hash too weak or key too short
42115 .endd
42116
42117 .vitem &%$dkim_verify_reason%&
42118 A string giving a little bit more detail when &%$dkim_verify_status%& is either
42119 "fail" or "invalid". One of
42120 .ilist
42121 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
42122 key for the domain could not be retrieved. This may be a temporary problem.
42123 .next
42124 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
42125 record for the domain is syntactically invalid.
42126 .next
42127 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
42128 body hash does not match the one specified in the signature header. This
42129 means that the message body was modified in transit.
42130 .next
42131 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
42132 could not be verified. This may mean that headers were modified,
42133 re-written or otherwise changed in a way which is incompatible with
42134 DKIM verification. It may of course also mean that the signature is forged.
42135 .endlist
42136
42137 This variable can be overwritten, with any value, using an ACL 'set' modifier.
42138
42139 .vitem &%$dkim_domain%&
42140 The signing domain. IMPORTANT: This variable is only populated if there is
42141 an actual signature in the message for the current domain or identity (as
42142 reflected by &%$dkim_cur_signer%&).
42143
42144 .vitem &%$dkim_identity%&
42145 The signing identity, if present. IMPORTANT: This variable is only populated
42146 if there is an actual signature in the message for the current domain or
42147 identity (as reflected by &%$dkim_cur_signer%&).
42148
42149 .vitem &%$dkim_selector%&
42150 The key record selector string.
42151
42152 .vitem &%$dkim_algo%&
42153 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
42154 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
42155 may also be 'ed25519-sha256'.
42156 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
42157 for EC keys.
42158
42159 Note that RFC 8301 says:
42160 .code
42161 rsa-sha1 MUST NOT be used for signing or verifying.
42162
42163 DKIM signatures identified as having been signed with historic
42164 algorithms (currently, rsa-sha1) have permanently failed evaluation
42165 .endd
42166
42167 To enforce this you must either have a DKIM ACL which checks this variable
42168 and overwrites the &$dkim_verify_status$& variable as discussed above,
42169 or have set the main option &%dkim_verify_hashes%& to exclude
42170 processing of such signatures.
42171
42172 .vitem &%$dkim_canon_body%&
42173 The body canonicalization method. One of 'relaxed' or 'simple'.
42174
42175 .vitem &%$dkim_canon_headers%&
42176 The header canonicalization method. One of 'relaxed' or 'simple'.
42177
42178 .vitem &%$dkim_copiedheaders%&
42179 A transcript of headers and their values which are included in the signature
42180 (copied from the 'z=' tag of the signature).
42181 Note that RFC6376 requires that verification fail if the From: header is
42182 not included in the signature.  Exim does not enforce this; sites wishing
42183 strict enforcement should code the check explicitly.
42184
42185 .vitem &%$dkim_bodylength%&
42186 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
42187 limit was set by the signer, "9999999999999" is returned. This makes sure
42188 that this variable always expands to an integer value.
42189 &*Note:*& The presence of the signature tag specifying a signing body length
42190 is one possible route to spoofing of valid DKIM signatures.
42191 A paranoid implementation might wish to regard signature where this variable
42192 shows less than the "no limit" return as being invalid.
42193
42194 .vitem &%$dkim_created%&
42195 UNIX timestamp reflecting the date and time when the signature was created.
42196 When this was not specified by the signer, "0" is returned.
42197
42198 .vitem &%$dkim_expires%&
42199 UNIX timestamp reflecting the date and time when the signer wants the
42200 signature to be treated as "expired". When this was not specified by the
42201 signer, "9999999999999" is returned. This makes it possible to do useful
42202 integer size comparisons against this value.
42203 Note that Exim does not check this value.
42204
42205 .vitem &%$dkim_headernames%&
42206 A colon-separated list of names of headers included in the signature.
42207
42208 .vitem &%$dkim_key_testing%&
42209 "1" if the key record has the "testing" flag set, "0" if not.
42210
42211 .vitem &%$dkim_key_nosubdomains%&
42212 "1" if the key record forbids subdomaining, "0" otherwise.
42213
42214 .vitem &%$dkim_key_srvtype%&
42215 Service type (tag s=) from the key record. Defaults to "*" if not specified
42216 in the key record.
42217
42218 .vitem &%$dkim_key_granularity%&
42219 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
42220 in the key record.
42221
42222 .vitem &%$dkim_key_notes%&
42223 Notes from the key record (tag n=).
42224
42225 .vitem &%$dkim_key_length%&
42226 Number of bits in the key.
42227 Valid only once the key is loaded, which is at the time the header signature
42228 is verified, which is after the body hash is.
42229
42230 Note that RFC 8301 says:
42231 .code
42232 Verifiers MUST NOT consider signatures using RSA keys of
42233 less than 1024 bits as valid signatures.
42234 .endd
42235
42236 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
42237 option.
42238
42239 .endlist
42240
42241 In addition, two ACL conditions are provided:
42242
42243 .vlist
42244 .vitem &%dkim_signers%&
42245 ACL condition that checks a colon-separated list of domains or identities
42246 for a match against the domain or identity that the ACL is currently verifying
42247 (reflected by &%$dkim_cur_signer%&).
42248 This condition is only usable in a DKIM ACL.
42249 This is typically used to restrict an ACL
42250 verb to a group of domains or identities. For example:
42251
42252 .code
42253 # Warn when Mail purportedly from GMail has no gmail signature
42254 warn sender_domains = gmail.com
42255      dkim_signers = gmail.com
42256      dkim_status = none
42257      log_message = GMail sender without gmail.com DKIM signature
42258 .endd
42259
42260 Note that the above does not check for a total lack of DKIM signing;
42261 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
42262
42263 .vitem &%dkim_status%&
42264 ACL condition that checks a colon-separated list of possible DKIM verification
42265 results against the actual result of verification,
42266 given by &$dkim_verify_status$& if that is non-empty or "none" if empty.
42267 This condition may be used in DKIM, MIME, PRDR and DATA ACLs.
42268
42269 A basic verification might be:
42270 .code
42271 deny !dkim_status = pass:none:invalid
42272 .endd
42273
42274 A more complex use could be
42275 to restrict an ACL verb to a list of verification outcomes, for example:
42276
42277 .code
42278 deny sender_domains = paypal.com:paypal.de
42279      dkim_signers = paypal.com:paypal.de
42280      dkim_status = none:invalid:fail
42281      message = Mail from Paypal with invalid/missing signature
42282 .endd
42283
42284 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42285 see the documentation of the &%$dkim_verify_status%& expansion variable above
42286 for more information of what they mean.
42287
42288 The condition is true if the status
42289 (or any of the list of status values)
42290 is any one of the supplied list.
42291 .endlist
42292
42293
42294
42295
42296 .section "SPF (Sender Policy Framework)" SECSPF
42297 .cindex SPF verification
42298
42299 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42300 messages with its domain in the envelope from, documented by RFC 7208.
42301 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42302 the &url(http://openspf.org).
42303 . --- 2019-10-28: still not https, open-spf.org is told to be a
42304 . --- web-archive copy of the now dead openspf.org site
42305 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42306 . --- discussion.
42307
42308 Messages sent by a system not authorised will fail checking of such assertions.
42309 This includes retransmissions done by traditional forwarders.
42310
42311 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42312 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42313 &url(https://www.libspf2.org/).
42314 There is no Exim involvement in the transmission of messages;
42315 publishing certain DNS records is all that is required.
42316
42317 For verification, an ACL condition and an expansion lookup are provided.
42318 .cindex authentication "expansion item"
42319 Performing verification sets up information used by the
42320 &%authresults%& expansion item.
42321
42322
42323 .cindex SPF "ACL condition"
42324 .cindex ACL "spf condition"
42325 The ACL condition "spf" can be used at or after the MAIL ACL.
42326 It takes as an argument a list of strings giving the outcome of the SPF check,
42327 and will succeed for any matching outcome.
42328 Valid strings are:
42329 .vlist
42330 .vitem &%pass%&
42331 The SPF check passed, the sending host is positively verified by SPF.
42332
42333 .vitem &%fail%&
42334 The SPF check failed, the sending host is NOT allowed to send mail for the
42335 domain in the envelope-from address.
42336
42337 .vitem &%softfail%&
42338 The SPF check failed, but the queried domain can't absolutely confirm that this
42339 is a forgery.
42340
42341 .vitem &%none%&
42342 The queried domain does not publish SPF records.
42343
42344 .vitem &%neutral%&
42345 The SPF check returned a "neutral" state.  This means the queried domain has
42346 published a SPF record, but wants to allow outside servers to send mail under
42347 its domain as well.  This should be treated like "none".
42348
42349 .vitem &%permerror%&
42350 This indicates a syntax error in the SPF record of the queried domain.
42351 You may deny messages when this occurs.
42352
42353 .vitem &%temperror%&
42354 This indicates a temporary error during all processing, including Exim's
42355 SPF processing.  You may defer messages when this occurs.
42356
42357 .vitem &%invalid%&
42358 There was an error during processing of the SPF lookup
42359 .endlist
42360
42361 You can prefix each string with an exclamation mark to  invert
42362 its meaning,  for example  "!fail" will  match all  results but
42363 "fail".  The  string  list is  evaluated  left-to-right,  in a
42364 short-circuit fashion.
42365
42366 Example:
42367 .code
42368 deny spf = fail
42369      message = $sender_host_address is not allowed to send mail from \
42370                ${if def:sender_address_domain \
42371                     {$sender_address_domain}{$sender_helo_name}}.  \
42372                Please see http://www.open-spf.org/Why;\
42373                identity=${if def:sender_address_domain \
42374                              {$sender_address}{$sender_helo_name}};\
42375                ip=$sender_host_address
42376 .endd
42377
42378 Note: The above mentioned URL may not be as helpful as expected. You are
42379 encouraged to replace the link with a link to a site with more
42380 explanations.
42381
42382 When the spf condition has run, it sets up several expansion
42383 variables:
42384
42385 .cindex SPF "verification variables"
42386 .vlist
42387 .vitem &$spf_header_comment$&
42388 .vindex &$spf_header_comment$&
42389   This contains a human-readable string describing the outcome
42390   of the SPF check. You can add it to a custom header or use
42391   it for logging purposes.
42392
42393 .vitem &$spf_received$&
42394 .vindex &$spf_received$&
42395   This contains a complete Received-SPF: header (name and
42396   content) that can be added to the message. Please note that
42397   according to the SPF draft, this header must be added at the
42398   top of the header list, i.e. with
42399 .code
42400 add_header = :at_start:$spf_received
42401 .endd
42402   See section &<<SECTaddheadacl>>& for further details.
42403
42404   Note: in case of "Best-guess" (see below), the convention is
42405   to put this string in a header called X-SPF-Guess: instead.
42406
42407 .vitem &$spf_result$&
42408 .vindex &$spf_result$&
42409   This contains the outcome of the SPF check in string form,
42410   currently one of pass, fail, softfail, none, neutral, permerror,
42411   temperror, or &"(invalid)"&.
42412
42413 .vitem &$spf_result_guessed$&
42414 .vindex &$spf_result_guessed$&
42415   This boolean is true only if a best-guess operation was used
42416   and required in order to obtain a result.
42417
42418 .vitem &$spf_smtp_comment$&
42419 .vindex &$spf_smtp_comment$&
42420 .vindex &%spf_smtp_comment_template%&
42421   This contains a string that can be used in a SMTP response
42422   to the calling party. Useful for "fail".
42423   The string is generated by the SPF library from the template configured in the main config
42424   option &%spf_smtp_comment_template%&.
42425 .endlist
42426
42427
42428 .cindex SPF "ACL condition"
42429 .cindex ACL "spf_guess condition"
42430 .cindex SPF "best guess"
42431 In addition to SPF, you can also perform checks for so-called
42432 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42433 SPF, but it is supported by the same framework that enables SPF
42434 capability.
42435 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42436 for a description of what it means.
42437 . --- 2019-10-28: still not https:
42438
42439 To access this feature, simply use the spf_guess condition in place
42440 of the spf one.  For example:
42441
42442 .code
42443 deny spf_guess = fail
42444      message = $sender_host_address doesn't look trustworthy to me
42445 .endd
42446
42447 In case you decide to reject messages based on this check, you
42448 should note that although it uses the same framework, "Best-guess"
42449 is not SPF, and therefore you should not mention SPF at all in your
42450 reject message.
42451
42452 When the spf_guess condition has run, it sets up the same expansion
42453 variables as when spf condition is run, described above.
42454
42455 Additionally, since Best-guess is not standardized, you may redefine
42456 what "Best-guess" means to you by redefining the main configuration
42457 &%spf_guess%& option.
42458 For example, the following:
42459
42460 .code
42461 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42462 .endd
42463
42464 would relax host matching rules to a broader network range.
42465
42466
42467 .cindex SPF "lookup expansion"
42468 .cindex lookup spf
42469 A lookup expansion is also available. It takes an email
42470 address as the key and an IP address
42471 (v4 or v6)
42472 as the database:
42473
42474 .code
42475   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42476 .endd
42477
42478 The lookup will return the same result strings as can appear in
42479 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42480
42481
42482
42483
42484
42485 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42486 .cindex SRS "sender rewriting scheme"
42487 .cindex VERP "variable envelope return path"
42488
42489 SRS can be used to modify sender addresses when forwarding so that
42490 SPF verification does not object to them.
42491 It can also be used to identify a received bounce message as
42492 likely (or not) having been trigged by a message from the
42493 local system, and for identifying dead addresses in mailing lists.
42494 It is one implementation of a VERP (Variable Envelope Return Path) method.
42495
42496 SRS operates by encoding the original envelope sender in a new
42497 sender local part and using a domain run by the forwarding site
42498 as the new domain for the sender.  Any DSN message should be returned
42499 to this new sender at the forwarding site, which can extract the
42500 original sender from the coded local part and forward the DSN to
42501 the originator.
42502
42503 This is a way of avoiding the breakage that SPF does to forwarding.
42504 The constructed local-part will be longer than the original,
42505 leading to possible problems with very long addresses.
42506 The changing of the sender address also hinders the tracing of mail
42507 problems.
42508
42509 Exim can be built to include native SRS support.  To do this
42510 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42511 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42512 will be defined.
42513 The support is limited to SRS0-encoding; SRS1 is not supported.
42514
42515 .cindex SRS excoding
42516 To encode an address use this expansion item:
42517 .vlist
42518 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42519 .cindex "&%srs_encode%& expansion item"
42520 .cindex SRS "expansion item"
42521 The first argument should be a secret known and used by all systems
42522 handling the recipient domain for the original message.
42523 There is no need to periodically change this key; a timestamp is also
42524 encoded.
42525 The second argument should be given as the envelope sender address before this
42526 encoding operation.
42527 If this value is empty the the expansion result will be empty.
42528 The third argument should be the recipient domain of the message when
42529 it arrived at this system.
42530 All arguments are expanded before use.
42531
42532 The result of the expansion is the replacement envelope-from (return path)
42533 to be used.
42534 .endlist
42535
42536 .cindex SRS decoding
42537 To decode an address use this expansion condition:
42538 .vlist
42539 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42540 The first argument should be the recipient local part as it was received.
42541 The second argument is the site secret.
42542 Both arguments are expanded before use.
42543
42544 If the messages is not for an SRS-encoded recipient the condition will
42545 return false.
42546 If it is, the condition will return true and the variable
42547 &$srs_recipient$& will be set to the decoded (original) value.
42548
42549 If the second argument is empty then the condition returns true if
42550 the first argument is in valid SRS formet, else false.
42551 The variable &$srs_recipient$& is not set for this case.
42552 .endlist
42553
42554 Example usage:
42555 .code
42556   #macro
42557   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42558
42559   #routers
42560
42561   outbound:
42562     driver =    dnslookup
42563     # if outbound, and forwarding has been done, use an alternate transport
42564     domains =   ! +my_domains
42565     transport = ${if eq {$local_part@$domain} \
42566                         {$original_local_part@$original_domain} \
42567                      {remote_smtp} {remote_forwarded_smtp}}
42568
42569   inbound_srs:
42570     driver =    redirect
42571     senders =   :
42572     domains =   +my_domains
42573     # detect inbound bounces which are SRS'd, and decode them
42574     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42575     data =      $srs_recipient
42576
42577   inbound_srs_failure:
42578     driver =    redirect
42579     senders =   :
42580     domains =   +my_domains
42581     # detect inbound bounces which look SRS'd but are invalid
42582     condition = ${if inbound_srs {$local_part} {}}
42583     allow_fail
42584     data =      :fail: Invalid SRS recipient address
42585
42586   #... further routers here get inbound_srs-redirected recipients
42587   # and any that were not SRS'd
42588
42589
42590   # transport; should look like the non-forward outbound
42591   # one, plus the max_rcpt and return_path options
42592   remote_forwarded_smtp:
42593     driver =              smtp
42594     # single-recipient so that $original_domain is valid
42595     max_rcpt =            1
42596     # modify the envelope from, for mails that we forward
42597     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42598 .endd
42599
42600
42601
42602
42603
42604 .section DMARC SECDMARC
42605 .cindex DMARC verification
42606
42607 DMARC combines feedback from SPF, DKIM, and header From: in order
42608 to attempt to provide better indicators of the authenticity of an
42609 email.  This document does not explain the fundamentals; you
42610 should read and understand how it works by visiting the website at
42611 &url(http://www.dmarc.org/).
42612
42613 If Exim is built with DMARC support,
42614 the libopendmarc library is used.
42615
42616 For building Exim yourself, obtain the library from
42617 &url(http://sourceforge.net/projects/opendmarc/)
42618 to obtain a copy, or find it in your favorite package
42619 repository.  You will need to attend to the local/Makefile feature
42620 SUPPORT_DMARC and the associated LDFLAGS addition.
42621 This description assumes
42622 that headers will be in /usr/local/include, and that the libraries
42623 are in /usr/local/lib.
42624
42625 .subsection Configuration SSECDMARCCONFIG
42626 .cindex DMARC configuration
42627
42628 There are three main-configuration options:
42629 .cindex DMARC "configuration options"
42630
42631 The &%dmarc_tld_file%& option
42632 .oindex &%dmarc_tld_file%&
42633 defines the location of a text file of valid
42634 top level domains the opendmarc library uses
42635 during domain parsing. Maintained by Mozilla,
42636 the most current version can be downloaded
42637 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42638 See also the util/renew-opendmarc-tlds.sh script.
42639 The default for the option is unset.
42640 If not set, DMARC processing is disabled.
42641
42642
42643 The &%dmarc_history_file%& option, if set
42644 .oindex &%dmarc_history_file%&
42645 defines the location of a file to log results
42646 of dmarc verification on inbound emails. The
42647 contents are importable by the opendmarc tools
42648 which will manage the data, send out DMARC
42649 reports, and expire the data. Make sure the
42650 directory of this file is writable by the user
42651 exim runs as.
42652 The default is unset.
42653
42654 The &%dmarc_forensic_sender%& option
42655 .oindex &%dmarc_forensic_sender%&
42656 defines an alternate email address to use when sending a
42657 forensic report detailing alignment failures
42658 if a sender domain's dmarc record specifies it
42659 and you have configured Exim to send them.
42660 If set, this is expanded and used for the
42661 From: header line; the address is extracted
42662 from it and used for the envelope from.
42663 If not set (the default), the From: header is expanded from
42664 the dsn_from option, and <> is used for the
42665 envelope from.
42666
42667 .subsection Controls SSECDMARCCONTROLS
42668 .cindex DMARC controls
42669
42670 By default, the DMARC processing will run for any remote,
42671 non-authenticated user.  It makes sense to only verify DMARC
42672 status of messages coming from remote, untrusted sources.  You can
42673 use standard conditions such as hosts, senders, etc, to decide that
42674 DMARC verification should *not* be performed for them and disable
42675 DMARC with an ACL control modifier:
42676 .code
42677   control = dmarc_disable_verify
42678 .endd
42679 A DMARC record can also specify a "forensic address", which gives
42680 exim an email address to submit reports about failed alignment.
42681 Exim does not do this by default because in certain conditions it
42682 results in unintended information leakage (what lists a user might
42683 be subscribed to, etc).  You must configure exim to submit forensic
42684 reports to the owner of the domain.  If the DMARC record contains a
42685 forensic address and you specify the control statement below, then
42686 exim will send these forensic emails.  It is also advised that you
42687 configure a &%dmarc_forensic_sender%& because the default sender address
42688 construction might be inadequate.
42689 .code
42690   control = dmarc_enable_forensic
42691 .endd
42692 (AGAIN: You can choose not to send these forensic reports by simply
42693 not putting the dmarc_enable_forensic control line at any point in
42694 your exim config.  If you don't tell exim to send them, it will not
42695 send them.)
42696
42697 There are no options to either control.  Both must appear before
42698 the DATA acl.
42699
42700 .subsection ACL SSECDMARCACL
42701 .cindex DMARC "ACL condition"
42702
42703 DMARC checks can be run on incoming SMTP  messages by using the
42704 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42705 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42706 condition.  Putting this condition in the ACLs is required in order
42707 for a DMARC check to actually occur.  All of the variables are set
42708 up before the DATA ACL, but there is no actual DMARC check that
42709 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42710
42711 The &"dmarc_status"& condition takes a list of strings on its
42712 right-hand side.  These strings describe recommended action based
42713 on the DMARC check.  To understand what the policy recommendations
42714 mean, refer to the DMARC website above.  Valid strings are:
42715 .itable none 0 0 2 20* left 80* left
42716 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42717 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42718 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42719 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42720 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42721 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42722 .irow &'temperror'&     "Library error or dns error"
42723 .irow &'off'&           "The DMARC check was disabled for this email"
42724 .endtable
42725 You can prefix each string with an exclamation mark to invert its
42726 meaning, for example "!accept" will match all results but
42727 "accept".  The string list is evaluated left-to-right in a
42728 short-circuit fashion.  When a string matches the outcome of the
42729 DMARC check, the condition succeeds.  If none of the listed
42730 strings matches the outcome of the DMARC check, the condition
42731 fails.
42732
42733 Of course, you can also use any other lookup method that Exim
42734 supports, including LDAP, Postgres, MySQL, etc, as long as the
42735 result is a list of colon-separated strings.
42736
42737 Performing the check sets up information used by the
42738 &%authresults%& expansion item.
42739
42740 Several expansion variables are set before the DATA ACL is
42741 processed, and you can use them in this ACL.  The following
42742 expansion variables are available:
42743
42744 .vlist
42745 .vitem &$dmarc_status$&
42746 .vindex &$dmarc_status$&
42747 .cindex DMARC result
42748 A one word status indicating what the DMARC library
42749 thinks of the email.  It is a combination of the results of
42750 DMARC record lookup and the SPF/DKIM/DMARC processing results
42751 (if a DMARC record was found).  The actual policy declared
42752 in the DMARC record is in a separate expansion variable.
42753
42754 .vitem &$dmarc_status_text$&
42755 .vindex &$dmarc_status_text$&
42756 Slightly longer, human readable status.
42757
42758 .vitem &$dmarc_used_domain$&
42759 .vindex &$dmarc_used_domain$&
42760 The domain which DMARC used to look up the DMARC policy record.
42761
42762 .vitem &$dmarc_domain_policy$&
42763 .vindex &$dmarc_domain_policy$&
42764 The policy declared in the DMARC record.  Valid values
42765 are "none", "reject" and "quarantine".  It is blank when there
42766 is any error, including no DMARC record.
42767 .endlist
42768
42769 .subsection Logging SSECDMARCLOGGING
42770 .cindex DMARC logging
42771
42772 By default, Exim's DMARC configuration is intended to be
42773 non-intrusive and conservative.  To facilitate this, Exim will not
42774 create any type of logging files without explicit configuration by
42775 you, the admin.  Nor will Exim send out any emails/reports about
42776 DMARC issues without explicit configuration by you, the admin (other
42777 than typical bounce messages that may come about due to ACL
42778 processing or failure delivery issues).
42779
42780 In order to log statistics suitable to be imported by the opendmarc
42781 tools, you need to:
42782 .ilist
42783 Configure the global option &%dmarc_history_file%&
42784 .next
42785 Configure cron jobs to call the appropriate opendmarc history
42786 import scripts and truncating the dmarc_history_file
42787 .endlist
42788
42789 In order to send forensic reports, you need to:
42790 .ilist
42791 Configure the global option &%dmarc_forensic_sender%&
42792 .next
42793 Configure, somewhere before the DATA ACL, the control option to
42794 enable sending DMARC forensic reports
42795 .endlist
42796
42797 .subsection Example SSECDMARCEXAMPLE
42798 .cindex DMARC example
42799
42800 Example usage:
42801 .code
42802 (RCPT ACL)
42803   warn    domains        = +local_domains
42804           hosts          = +local_hosts
42805           control        = dmarc_disable_verify
42806
42807   warn    !domains       = +screwed_up_dmarc_records
42808           control        = dmarc_enable_forensic
42809
42810   warn    condition      = (lookup if destined to mailing list)
42811           set acl_m_mailing_list = 1
42812
42813 (DATA ACL)
42814   warn    dmarc_status   = accept : none : off
42815           !authenticated = *
42816           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42817
42818   warn    dmarc_status   = !accept
42819           !authenticated = *
42820           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42821
42822   warn    dmarc_status   = quarantine
42823           !authenticated = *
42824           set $acl_m_quarantine = 1
42825           # Do something in a transport with this flag variable
42826
42827   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42828           condition      = ${if eq{$acl_m_mailing_list}{1}}
42829           message        = Messages from $dmarc_used_domain break mailing lists
42830
42831   deny    dmarc_status   = reject
42832           !authenticated = *
42833           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42834
42835   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42836 .endd
42837
42838
42839
42840
42841
42842 . ////////////////////////////////////////////////////////////////////////////
42843 . ////////////////////////////////////////////////////////////////////////////
42844
42845 .chapter "Proxies" "CHAPproxies" &&&
42846          "Proxy support"
42847 .cindex "proxy support"
42848 .cindex "proxy" "access via"
42849
42850 A proxy is an intermediate system through which communication is passed.
42851 Proxies may provide a security, availability or load-distribution function.
42852
42853
42854 .section "Inbound proxies" SECTproxyInbound
42855 .cindex proxy inbound
42856 .cindex proxy "server side"
42857 .cindex proxy "Proxy protocol"
42858 .cindex "Proxy protocol" proxy
42859
42860 Exim has support for receiving inbound SMTP connections via a proxy
42861 that uses &"Proxy Protocol"& to speak to it.
42862 To include this support, include &"SUPPORT_PROXY=yes"&
42863 in Local/Makefile.
42864
42865 It was built on the HAProxy specification, found at
42866 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42867
42868 The purpose of this facility is so that an application load balancer,
42869 such as HAProxy, can sit in front of several Exim servers
42870 to distribute load.
42871 Exim uses the local protocol communication with the proxy to obtain
42872 the remote SMTP system IP address and port information.
42873 There is no logging if a host passes or
42874 fails Proxy Protocol negotiation, but it can easily be determined and
42875 recorded in an ACL (example is below).
42876
42877 Use of a proxy is enabled by setting the &%hosts_proxy%&
42878 main configuration option to a hostlist; connections from these
42879 hosts will use Proxy Protocol.
42880 Exim supports both version 1 and version 2 of the Proxy Protocol and
42881 automatically determines which version is in use.
42882
42883 The Proxy Protocol header is the first data received on a TCP connection
42884 and is inserted before any TLS-on-connect handshake from the client; Exim
42885 negotiates TLS between Exim-as-server and the remote client, not between
42886 Exim and the proxy server. The Proxy Protocol header must be received
42887 within &%proxy_protocol_timeout%&, which defaults to 3s.
42888
42889 The following expansion variables are usable
42890 (&"internal"& and &"external"& here refer to the interfaces
42891 of the proxy):
42892 .itable none 0 0 2 30* left 70* left
42893 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42894 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42895 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42896 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42897 .irow $proxy_session            "boolean: SMTP connection via proxy"
42898 .endtable
42899 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42900 there was a protocol error.
42901 The variables &$sender_host_address$& and &$sender_host_port$&
42902 will have values for the actual client system, not the proxy.
42903
42904 Since the real connections are all coming from the proxy, and the
42905 per host connection tracking is done before Proxy Protocol is
42906 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42907 handle all of the parallel volume you expect per inbound proxy.
42908 With the option set so high, you lose the ability
42909 to protect your server from many connections from one IP.
42910 In order to prevent your server from overload, you
42911 need to add a per connection ratelimit to your connect ACL.
42912 A possible solution is:
42913 .display
42914   # Set max number of connections per host
42915   LIMIT   = 5
42916   # Or do some kind of IP lookup in a flat file or database
42917   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42918
42919   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42920           message        = Too many connections from this IP right now
42921 .endd
42922
42923
42924
42925 .section "Outbound proxies" SECTproxySOCKS
42926 .cindex proxy outbound
42927 .cindex proxy "client side"
42928 .cindex proxy SOCKS
42929 .cindex SOCKS proxy
42930 Exim has support for sending outbound SMTP via a proxy
42931 using a protocol called SOCKS5 (defined by RFC1928).
42932 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42933 Local/Makefile.
42934
42935 Use of a proxy is enabled by setting the &%socks_proxy%& option
42936 on an smtp transport.
42937 The option value is expanded and should then be a list
42938 (colon-separated by default) of proxy specifiers.
42939 Each proxy specifier is a list
42940 (space-separated by default) where the initial element
42941 is an IP address and any subsequent elements are options.
42942
42943 Options are a string <name>=<value>.
42944 The list of options is in the following table:
42945 .itable none 0 0 2 10* left 90* left
42946 .irow &'auth'&  "authentication method"
42947 .irow &'name'&  "authentication username"
42948 .irow &'pass'&  "authentication password"
42949 .irow &'port'&  "tcp port"
42950 .irow &'tmo'&   "connection timeout"
42951 .irow &'pri'&   "priority"
42952 .irow &'weight'& "selection bias"
42953 .endtable
42954
42955 More details on each of these options follows:
42956
42957 .ilist
42958 .cindex authentication "to proxy"
42959 .cindex proxy authentication
42960 &%auth%&: Either &"none"& (default) or &"name"&.
42961 Using &"name"& selects username/password authentication per RFC 1929
42962 for access to the proxy.
42963 Default is &"none"&.
42964 .next
42965 &%name%&: sets the username for the &"name"& authentication method.
42966 Default is empty.
42967 .next
42968 &%pass%&: sets the password for the &"name"& authentication method.
42969 Default is empty.
42970 .next
42971 &%port%&: the TCP port number to use for the connection to the proxy.
42972 Default is 1080.
42973 .next
42974 &%tmo%&: sets a connection timeout in seconds for this proxy.
42975 Default is 5.
42976 .next
42977 &%pri%&: specifies a priority for the proxy within the list,
42978 higher values being tried first.
42979 The default priority is 1.
42980 .next
42981 &%weight%&: specifies a selection bias.
42982 Within a priority set servers are queried in a random fashion,
42983 weighted by this value.
42984 The default value for selection bias is 1.
42985 .endlist
42986
42987 Proxies from the list are tried according to their priority
42988 and weight settings until one responds.  The timeout for the
42989 overall connection applies to the set of proxied attempts.
42990
42991 .section Logging SECTproxyLog
42992 To log the (local) IP of a proxy in the incoming or delivery logline,
42993 add &"+proxy"& to the &%log_selector%& option.
42994 This will add a component tagged with &"PRX="& to the line.
42995
42996 . ////////////////////////////////////////////////////////////////////////////
42997 . ////////////////////////////////////////////////////////////////////////////
42998
42999 .chapter "Internationalisation" "CHAPi18n" &&&
43000          "Internationalisation""
43001 .cindex internationalisation "email address"
43002 .cindex EAI
43003 .cindex i18n
43004 .cindex utf8 "mail name handling"
43005
43006 Exim has support for Internationalised mail names.
43007 To include this it must be built with SUPPORT_I18N and the libidn library.
43008 Standards supported are RFCs 2060, 5890, 6530 and 6533.
43009
43010 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
43011 instead of it) then IDNA2008 is supported; this adds an extra library
43012 requirement, upon libidn2.
43013
43014 .section "MTA operations" SECTi18nMTA
43015 .cindex SMTPUTF8 "ESMTP option"
43016 .cindex "ESMTP extensions" SMTPUTF8
43017 The main configuration option &%smtputf8_advertise_hosts%& specifies
43018 a host list.  If this matches the sending host and
43019 accept_8bitmime is true (the default) then the ESMTP option
43020 SMTPUTF8 will be advertised.
43021
43022 If the sender specifies the SMTPUTF8 option on a MAIL command
43023 international handling for the message is enabled and
43024 the expansion variable &$message_smtputf8$& will have value TRUE.
43025
43026 The option &%allow_utf8_domains%& is set to true for this
43027 message. All DNS lookups are converted to a-label form
43028 whatever the setting of &%allow_utf8_domains%&
43029 when Exim is built with SUPPORT_I18N.
43030
43031 Both localparts and domain are maintained as the original
43032 UTF-8 form internally; any comparison or regular-expression use will
43033 require appropriate care.  Filenames created, eg. by
43034 the appendfile transport, will have UTF-8 names.
43035
43036 HELO names sent by the smtp transport will have any UTF-8
43037 components expanded to a-label form,
43038 and any certificate name checks will be done using the a-label
43039 form of the name.
43040
43041 .cindex log protocol
43042 .cindex SMTPUTF8 logging
43043 .cindex i18n logging
43044 Log lines and Received-by: header lines will acquire a "utf8"
43045 prefix on the protocol element, eg. utf8esmtp.
43046
43047 The following expansion operators can be used:
43048 .code
43049 ${utf8_domain_to_alabel:str}
43050 ${utf8_domain_from_alabel:str}
43051 ${utf8_localpart_to_alabel:str}
43052 ${utf8_localpart_from_alabel:str}
43053 .endd
43054
43055 .cindex utf8 "address downconversion"
43056 .cindex i18n "utf8 address downconversion"
43057 The RCPT ACL
43058 may use the following modifier:
43059 .display
43060 control = utf8_downconvert
43061 control = utf8_downconvert/<value>
43062 .endd
43063 This sets a flag requiring that envelope addresses are converted to
43064 a-label form before smtp delivery.
43065 This is usually for use in a Message Submission Agent context,
43066 but could be used for any message.
43067
43068 If a value is appended it may be:
43069 .itable none 0 0 2 5* right 95* left
43070 .irow &`1`&     "mandatory downconversion"
43071 .irow &`0`&     "no downconversion"
43072 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
43073 .endtable
43074 If no value is given, 1 is used.
43075
43076 If mua_wrapper is set, the utf8_downconvert control
43077 is initially set to -1.
43078
43079 The smtp transport has an option &%utf8_downconvert%&.
43080 If set it must expand to one of the three values described above,
43081 or an empty string.
43082 If non-empty it overrides value previously set
43083 (due to mua_wrapper or by an ACL control).
43084
43085
43086 There is no explicit support for VRFY and EXPN.
43087 Configurations supporting these should inspect
43088 &$smtp_command_argument$& for an SMTPUTF8 argument.
43089
43090 There is no support for LMTP on Unix sockets.
43091 Using the "lmtp" protocol option on an smtp transport,
43092 for LMTP over TCP, should work as expected.
43093
43094 There is no support for DSN unitext handling,
43095 and no provision for converting logging from or to UTF-8.
43096
43097
43098
43099 .section "MDA operations" SECTi18nMDA
43100 To aid in constructing names suitable for IMAP folders
43101 the following expansion operator can be used:
43102 .code
43103 ${imapfolder {<string>} {<sep>} {<specials>}}
43104 .endd
43105
43106 The string is converted from the charset specified by
43107 the "headers charset" command (in a filter file)
43108 or &%headers_charset%& main configuration option (otherwise),
43109 to the
43110 modified UTF-7 encoding specified by RFC 2060,
43111 with the following exception: All occurrences of <sep>
43112 (which has to be a single character)
43113 are replaced with periods ("."), and all periods and slashes that are not
43114 <sep> and are not in the <specials> string are BASE64 encoded.
43115
43116 The third argument can be omitted, defaulting to an empty string.
43117 The second argument can be omitted, defaulting to "/".
43118
43119 This is the encoding used by Courier for Maildir names on disk, and followed
43120 by many other IMAP servers.
43121
43122 Examples:
43123 .display
43124 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
43125 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
43126 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
43127 .endd
43128
43129 Note that the source charset setting is vital, and also that characters
43130 must be representable in UTF-16.
43131
43132
43133 . ////////////////////////////////////////////////////////////////////////////
43134 . ////////////////////////////////////////////////////////////////////////////
43135
43136 .chapter "Events" "CHAPevents" &&&
43137          "Events"
43138 .cindex events
43139
43140 The events mechanism in Exim can be used to intercept processing at a number
43141 of points.  It was originally invented to give a way to do customised logging
43142 actions (for example, to a database) but can also be used to modify some
43143 processing actions.
43144
43145 Most installations will never need to use Events.
43146 The support can be left out of a build by defining DISABLE_EVENT=yes
43147 in &_Local/Makefile_&.
43148
43149 There are two major classes of events: main and transport.
43150 The main configuration option &%event_action%& controls reception events;
43151 a transport option &%event_action%& controls delivery events.
43152
43153 Both options are a string which is expanded when the event fires.
43154 An example might look like:
43155 .cindex logging custom
43156 .code
43157 event_action = ${if eq {msg:delivery}{$event_name} \
43158 {${lookup pgsql {SELECT * FROM record_Delivery( \
43159     '${quote_pgsql:$sender_address_domain}',\
43160     '${quote_pgsql:${lc:$sender_address_local_part}}', \
43161     '${quote_pgsql:$domain}', \
43162     '${quote_pgsql:${lc:$local_part}}', \
43163     '${quote_pgsql:$host_address}', \
43164     '${quote_pgsql:${lc:$host}}', \
43165     '${quote_pgsql:$message_exim_id}')}} \
43166 } {}}
43167 .endd
43168
43169 Events have names which correspond to the point in process at which they fire.
43170 The name is placed in the variable &$event_name$& and the event action
43171 expansion must check this, as it will be called for every possible event type.
43172
43173 .new
43174 The current list of events is:
43175 .itable all 0 0 4 25* left 10* center 15* center 50* left
43176 .row auth:fail              after    both       "per driver per authentication attempt"
43177 .row dane:fail              after    transport  "per connection"
43178 .row dns:fail               after    both       "per lookup"
43179 .row msg:complete           after    main       "per message"
43180 .row msg:defer              after    transport  "per message per delivery try"
43181 .row msg:delivery           after    transport  "per recipient"
43182 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
43183 .row msg:rcpt:defer         after    transport  "per recipient"
43184 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
43185 .row msg:fail:delivery      after    transport  "per recipient"
43186 .row msg:fail:internal      after    main       "per recipient"
43187 .row tcp:connect            before   transport  "per connection"
43188 .row tcp:close              after    transport  "per connection"
43189 .row tls:cert               before   both       "per certificate in verification chain"
43190 .row tls:fail:connect       after    main       "per connection"
43191 .row smtp:connect           after    transport  "per connection"
43192 .row smtp:ehlo              after    transport  "per connection"
43193 .row smtp:fail:protocol     after    main       "per connection"
43194 .row smtp:fail:syntax       after    main       "per connection"
43195 .endtable
43196 .wen
43197 New event types may be added in future.
43198
43199 The event name is a colon-separated list, defining the type of
43200 event in a tree of possibilities.  It may be used as a list
43201 or just matched on as a whole.  There will be no spaces in the name.
43202
43203 The second column in the table above describes whether the event fires
43204 before or after the action is associates with.  Those which fire before
43205 can be used to affect that action (more on this below).
43206
43207 The third column in the table above says what section of the configuration
43208 should define the event action.
43209
43210 An additional variable, &$event_data$&, is filled with information varying
43211 with the event type:
43212 .new
43213 .itable all 0 0 2 20* left 80* left
43214 .row auth:fail            "smtp response"
43215 .row dane:fail            "failure reason"
43216 .row dns:fail             "failure reason, key and lookup-type"
43217 .row msg:defer            "error string"
43218 .row msg:delivery         "smtp confirmation message"
43219 .row msg:fail:internal    "failure reason"
43220 .row msg:fail:delivery    "smtp error message"
43221 .row msg:host:defer       "error string"
43222 .row msg:rcpt:host:defer  "error string"
43223 .row msg:rcpt:defer       "error string"
43224 .row tls:cert             "verification chain depth"
43225 .row tls:fail:connect     "error string"
43226 .row smtp:connect         "smtp banner"
43227 .row smtp:ehlo            "smtp ehlo response"
43228 .row smtp:fail:protocol   "error string"
43229 .row smtp:fail:syntax     "error string"
43230 .endtable
43231 .wen
43232
43233 The :defer events populate one extra variable: &$event_defer_errno$&.
43234
43235 For complex operations an ACL expansion can be used in &%event_action%&,
43236 however due to the multiple contexts that Exim operates in during
43237 the course of its processing:
43238 .ilist
43239 variables set in transport events will not be visible outside that
43240 transport call
43241 .next
43242 acl_m variables in a server context are lost on a new connection,
43243 and after smtp helo/ehlo/mail/starttls/rset commands
43244 .endlist
43245 Using an ACL expansion with the logwrite modifier can be
43246 a useful way of writing to the main log.
43247
43248 The expansion of the event_action option should normally
43249 return an empty string.  Should it return anything else the
43250 following will be forced:
43251 .itable all 0 0 2 20* left 80* left
43252 .row auth:fail        "log information to write"
43253 .row tcp:connect      "do not connect"
43254 .row tls:cert         "refuse verification"
43255 .row smtp:connect     "close connection"
43256 .endtable
43257 All other message types ignore the result string, and
43258 no other use is made of it.
43259
43260 For a tcp:connect event, if the connection is being made to a proxy
43261 then the &$host_address$& and &$host_port$& variables
43262 will be that of the proxy and not the target system.
43263
43264 For tls:cert events, if GnuTLS is in use this will trigger only per
43265 chain element received on the connection.
43266 For OpenSSL it will trigger for every chain element including those
43267 loaded locally.
43268
43269 For dns:fail events from dnsdb lookups, a &"defer_never"& option does not
43270 affect the reporting of DNS_AGAIN.
43271
43272 . ////////////////////////////////////////////////////////////////////////////
43273 . ////////////////////////////////////////////////////////////////////////////
43274
43275 .chapter "Adding new drivers or lookup types" "CHID13" &&&
43276          "Adding drivers or lookups"
43277 .cindex "adding drivers"
43278 .cindex "new drivers, adding"
43279 .cindex "drivers" "adding new"
43280 The following actions have to be taken in order to add a new router, transport,
43281 authenticator, or lookup type to Exim:
43282
43283 .olist
43284 Choose a name for the driver or lookup type that does not conflict with any
43285 existing name; I will use &"newdriver"& in what follows.
43286 .next
43287 Add to &_src/EDITME_& the line:
43288 .display
43289 <&'type'&>&`_NEWDRIVER=yes`&
43290 .endd
43291 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
43292 code is not to be included in the binary by default, comment this line out. You
43293 should also add any relevant comments about the driver or lookup type.
43294 .next
43295 Add to &_src/config.h.defaults_& the line:
43296 .code
43297 #define <type>_NEWDRIVER
43298 .endd
43299 .next
43300 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
43301 and create a table entry as is done for all the other drivers and lookup types.
43302 .next
43303 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
43304 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
43305 Add your &`NEWDRIVER`& to that list.
43306 As long as the dynamic module would be named &_newdriver.so_&, you can use the
43307 simple form that most lookups have.
43308 .next
43309 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
43310 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
43311 driver or lookup type and add it to the definition of OBJ.
43312 .next
43313 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
43314 definition of OBJ_MACRO.  Add a set of line to do the compile also.
43315 .next
43316 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43317 &_src_&.
43318 .next
43319 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43320 as for other drivers and lookups.
43321 .endlist
43322
43323 Then all you need to do is write the code! A good way to start is to make a
43324 proforma by copying an existing module of the same type, globally changing all
43325 occurrences of the name, and cutting out most of the code. Note that any
43326 options you create must be listed in alphabetical order, because the tables are
43327 searched using a binary chop procedure.
43328
43329 There is a &_README_& file in each of the sub-directories of &_src_& describing
43330 the interface that is expected.
43331
43332
43333
43334
43335 . ////////////////////////////////////////////////////////////////////////////
43336 . ////////////////////////////////////////////////////////////////////////////
43337
43338 . /////////////////////////////////////////////////////////////////////////////
43339 . These lines are processing instructions for the Simple DocBook Processor that
43340 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43341 . PDFs than using xmlto and fop. They will be ignored by all other XML
43342 . processors.
43343 . /////////////////////////////////////////////////////////////////////////////
43344
43345 .literal xml
43346 <?sdop
43347   format="newpage"
43348   foot_right_recto="&chaptertitle;"
43349   foot_right_verso="&chaptertitle;"
43350 ?>
43351 .literal off
43352
43353 .makeindex "Options index"   "option"
43354 .makeindex "Variables index" "variable"
43355 .makeindex "Concept index"   "concept"
43356
43357
43358 . /////////////////////////////////////////////////////////////////////////////
43359 . /////////////////////////////////////////////////////////////////////////////