745794a2a8bdae5bc02a66c58c9626ea0d980415
[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 lookup module support" "SECTdynamicmodules"
2073 .cindex "lookup modules"
2074 .cindex "dynamic modules"
2075 .cindex ".so building"
2076 On some platforms, Exim supports not compiling all lookup types directly into
2077 the main binary, instead putting some into external modules which can be loaded
2078 on demand.
2079 This permits packagers to build Exim with support for lookups with extensive
2080 library dependencies without requiring all users to install all of those
2081 dependencies.
2082 Most, but not all, lookup types can be built this way.
2083
2084 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2085 installed; Exim will only load modules from that directory, as a security
2086 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2087 for your OS; see &_OS/Makefile-Linux_& for an example.
2088 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2089 see &_src/EDITME_& for details.
2090
2091 Then, for each module to be loaded dynamically, define the relevant
2092 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2093 For example, this will build in lsearch but load sqlite and mysql support
2094 on demand:
2095 .code
2096 LOOKUP_LSEARCH=yes
2097 LOOKUP_SQLITE=2
2098 LOOKUP_MYSQL=2
2099 .endd
2100
2101
2102 .section "The building process" "SECID29"
2103 .cindex "build directory"
2104 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2105 created, run &'make'& at the top level. It determines the architecture and
2106 operating system types, and creates a build directory if one does not exist.
2107 For example, on a Sun system running Solaris 8, the directory
2108 &_build-SunOS5-5.8-sparc_& is created.
2109 .cindex "symbolic link" "to source files"
2110 Symbolic links to relevant source files are installed in the build directory.
2111
2112 If this is the first time &'make'& has been run, it calls a script that builds
2113 a make file inside the build directory, using the configuration files from the
2114 &_Local_& directory. The new make file is then passed to another instance of
2115 &'make'&. This does the real work, building a number of utility scripts, and
2116 then compiling and linking the binaries for the Exim monitor (if configured), a
2117 number of utility programs, and finally Exim itself. The command &`make
2118 makefile`& can be used to force a rebuild of the make file in the build
2119 directory, should this ever be necessary.
2120
2121 If you have problems building Exim, check for any comments there may be in the
2122 &_README_& file concerning your operating system, and also take a look at the
2123 FAQ, where some common problems are covered.
2124
2125
2126
2127 .section 'Output from &"make"&' "SECID283"
2128 The output produced by the &'make'& process for compile lines is often very
2129 unreadable, because these lines can be very long. For this reason, the normal
2130 output is suppressed by default, and instead output similar to that which
2131 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2132 each module that is being compiled or linked. However, it is still possible to
2133 get the full output, by calling &'make'& like this:
2134 .code
2135 FULLECHO='' make -e
2136 .endd
2137 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2138 command reflection in &'make'&. When you ask for the full output, it is
2139 given in addition to the short output.
2140
2141
2142
2143 .section "Overriding build-time options for Exim" "SECToverride"
2144 .cindex "build-time options, overriding"
2145 The main make file that is created at the beginning of the building process
2146 consists of the concatenation of a number of files which set configuration
2147 values, followed by a fixed set of &'make'& instructions. If a value is set
2148 more than once, the last setting overrides any previous ones. This provides a
2149 convenient way of overriding defaults. The files that are concatenated are, in
2150 order:
2151 .display
2152 &_OS/Makefile-Default_&
2153 &_OS/Makefile-_&<&'ostype'&>
2154 &_Local/Makefile_&
2155 &_Local/Makefile-_&<&'ostype'&>
2156 &_Local/Makefile-_&<&'archtype'&>
2157 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2158 &_OS/Makefile-Base_&
2159 .endd
2160 .cindex "&_Local/Makefile_&"
2161 .cindex "building Exim" "operating system type"
2162 .cindex "building Exim" "architecture type"
2163 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2164 architecture type. &_Local/Makefile_& is required to exist, and the building
2165 process fails if it is absent. The other three &_Local_& files are optional,
2166 and are often not needed.
2167
2168 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2169 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2170 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2171 values are used, thereby providing a means of forcing particular settings.
2172 Otherwise, the scripts try to get values from the &%uname%& command. If this
2173 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2174 of &'ad hoc'& transformations are then applied, to produce the standard names
2175 that Exim expects. You can run these scripts directly from the shell in order
2176 to find out what values are being used on your system.
2177
2178
2179 &_OS/Makefile-Default_& contains comments about the variables that are set
2180 therein. Some (but not all) are mentioned below. If there is something that
2181 needs changing, review the contents of this file and the contents of the make
2182 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2183 default values are.
2184
2185
2186 .cindex "building Exim" "overriding default settings"
2187 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2188 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2189 need to change the original files. Instead, you should make the changes by
2190 putting the new values in an appropriate &_Local_& file. For example,
2191 .cindex "Tru64-Unix build-time settings"
2192 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2193 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2194 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2195 called with the option &%-std1%&, to make it recognize some of the features of
2196 Standard C that Exim uses. (Most other compilers recognize Standard C by
2197 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2198 containing the lines
2199 .code
2200 CC=cc
2201 CFLAGS=-std1
2202 .endd
2203 If you are compiling for just one operating system, it may be easier to put
2204 these lines directly into &_Local/Makefile_&.
2205
2206 Keeping all your local configuration settings separate from the distributed
2207 files makes it easy to transfer them to new versions of Exim simply by copying
2208 the contents of the &_Local_& directory.
2209
2210
2211 .cindex "NIS lookup type" "including support for"
2212 .cindex "NIS+ lookup type" "including support for"
2213 .cindex "LDAP" "including support for"
2214 .cindex "lookup" "inclusion in binary"
2215 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2216 lookup, but not all systems have these components installed, so the default is
2217 not to include the relevant code in the binary. All the different kinds of file
2218 and database lookup that Exim supports are implemented as separate code modules
2219 which are included only if the relevant compile-time options are set. In the
2220 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2221 .code
2222 LOOKUP_LDAP=yes
2223 LOOKUP_NIS=yes
2224 LOOKUP_NISPLUS=yes
2225 .endd
2226 and similar settings apply to the other lookup types. They are all listed in
2227 &_src/EDITME_&. In many cases the relevant include files and interface
2228 libraries need to be installed before compiling Exim.
2229 .cindex "cdb" "including support for"
2230 However, there are some optional lookup types (such as cdb) for which
2231 the code is entirely contained within Exim, and no external include
2232 files or libraries are required. When a lookup type is not included in the
2233 binary, attempts to configure Exim to use it cause runtime configuration
2234 errors.
2235
2236 .cindex "pkg-config" "lookups"
2237 .cindex "pkg-config" "authenticators"
2238 Many systems now use a tool called &'pkg-config'& to encapsulate information
2239 about how to compile against a library; Exim has some initial support for
2240 being able to use pkg-config for lookups and authenticators.  For any given
2241 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2242 variable with the &`_PC`& suffix in the name and assign as the value the
2243 name of the package to be queried.  The results of querying via the
2244 &'pkg-config'& command will be added to the appropriate Makefile variables
2245 with &`+=`& directives, so your version of &'make'& will need to support that
2246 syntax.  For instance:
2247 .code
2248 LOOKUP_SQLITE=yes
2249 LOOKUP_SQLITE_PC=sqlite3
2250 AUTH_GSASL=yes
2251 AUTH_GSASL_PC=libgsasl
2252 AUTH_HEIMDAL_GSSAPI=yes
2253 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2254 .endd
2255
2256 .cindex "Perl" "including support for"
2257 Exim can be linked with an embedded Perl interpreter, allowing Perl
2258 subroutines to be called during string expansion. To enable this facility,
2259 .code
2260 EXIM_PERL=perl.o
2261 .endd
2262 must be defined in &_Local/Makefile_&. Details of this facility are given in
2263 chapter &<<CHAPperl>>&.
2264
2265 .cindex "X11 libraries, location of"
2266 The location of the X11 libraries is something that varies a lot between
2267 operating systems, and there may be different versions of X11 to cope
2268 with. Exim itself makes no use of X11, but if you are compiling the Exim
2269 monitor, the X11 libraries must be available.
2270 The following three variables are set in &_OS/Makefile-Default_&:
2271 .code
2272 X11=/usr/X11R6
2273 XINCLUDE=-I$(X11)/include
2274 XLFLAGS=-L$(X11)/lib
2275 .endd
2276 These are overridden in some of the operating-system configuration files. For
2277 example, in &_OS/Makefile-SunOS5_& there is
2278 .code
2279 X11=/usr/openwin
2280 XINCLUDE=-I$(X11)/include
2281 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2282 .endd
2283 If you need to override the default setting for your operating system, place a
2284 definition of all three of these variables into your
2285 &_Local/Makefile-<ostype>_& file.
2286
2287 .cindex "EXTRALIBS"
2288 If you need to add any extra libraries to the link steps, these can be put in a
2289 variable called EXTRALIBS, which appears in all the link commands, but by
2290 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2291 command for linking the main Exim binary, and not for any associated utilities.
2292
2293 .cindex "DBM libraries" "configuration for building"
2294 There is also DBMLIB, which appears in the link commands for binaries that
2295 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2296 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2297 binary, and which can be used, for example, to include additional X11
2298 libraries.
2299
2300 .cindex "configuration file" "editing"
2301 The make file copes with rebuilding Exim correctly if any of the configuration
2302 files are edited. However, if an optional configuration file is deleted, it is
2303 necessary to touch the associated non-optional file (that is,
2304 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2305
2306
2307 .section "OS-specific header files" "SECID30"
2308 .cindex "&_os.h_&"
2309 .cindex "building Exim" "OS-specific C header files"
2310 The &_OS_& directory contains a number of files with names of the form
2311 &_os.h-<ostype>_&. These are system-specific C header files that should not
2312 normally need to be changed. There is a list of macro settings that are
2313 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2314 are porting Exim to a new operating system.
2315
2316
2317
2318 .section "Overriding build-time options for the monitor" "SECID31"
2319 .cindex "building Eximon"
2320 A similar process is used for overriding things when building the Exim monitor,
2321 where the files that are involved are
2322 .display
2323 &_OS/eximon.conf-Default_&
2324 &_OS/eximon.conf-_&<&'ostype'&>
2325 &_Local/eximon.conf_&
2326 &_Local/eximon.conf-_&<&'ostype'&>
2327 &_Local/eximon.conf-_&<&'archtype'&>
2328 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2329 .endd
2330 .cindex "&_Local/eximon.conf_&"
2331 As with Exim itself, the final three files need not exist, and in this case the
2332 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2333 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2334 variables of the same name, preceded by EXIMON_. For example, setting
2335 EXIMON_LOG_DEPTH in the environment overrides the value of
2336 LOG_DEPTH at runtime.
2337 .ecindex IIDbuex
2338
2339
2340 .section "Installing Exim binaries and scripts" "SECID32"
2341 .cindex "installing Exim"
2342 .cindex "BIN_DIRECTORY"
2343 The command &`make install`& runs the &(exim_install)& script with no
2344 arguments. The script copies binaries and utility scripts into the directory
2345 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2346 .cindex "setuid" "installing Exim with"
2347 The install script copies files only if they are newer than the files they are
2348 going to replace. The Exim binary is required to be owned by root and have the
2349 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2350 install`& as root so that it can set up the Exim binary in this way. However, in
2351 some special situations (for example, if a host is doing no local deliveries)
2352 it may be possible to run Exim without making the binary setuid root (see
2353 chapter &<<CHAPsecurity>>& for details).
2354
2355 .cindex "CONFIGURE_FILE"
2356 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2357 in &_Local/Makefile_&. If this names a single file, and the file does not
2358 exist, the default configuration file &_src/configure.default_& is copied there
2359 by the installation script. If a runtime configuration file already exists, it
2360 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2361 alternative files, no default is installed.
2362
2363 .cindex "system aliases file"
2364 .cindex "&_/etc/aliases_&"
2365 One change is made to the default configuration file when it is installed: the
2366 default configuration contains a router that references a system aliases file.
2367 The path to this file is set to the value specified by
2368 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2369 If the system aliases file does not exist, the installation script creates it,
2370 and outputs a comment to the user.
2371
2372 The created file contains no aliases, but it does contain comments about the
2373 aliases a site should normally have. Mail aliases have traditionally been
2374 kept in &_/etc/aliases_&. However, some operating systems are now using
2375 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2376 Exim's configuration if necessary.
2377
2378 The default configuration uses the local host's name as the only local domain,
2379 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2380 running as the local user. System aliases and &_.forward_& files in users' home
2381 directories are supported, but no NIS or NIS+ support is configured. Domains
2382 other than the name of the local host are routed using the DNS, with delivery
2383 over SMTP.
2384
2385 It is possible to install Exim for special purposes (such as building a binary
2386 distribution) in a private part of the file system. You can do this by a
2387 command such as
2388 .code
2389 make DESTDIR=/some/directory/ install
2390 .endd
2391 This has the effect of pre-pending the specified directory to all the file
2392 paths, except the name of the system aliases file that appears in the default
2393 configuration. (If a default alias file is created, its name &'is'& modified.)
2394 For backwards compatibility, ROOT is used if DESTDIR is not set,
2395 but this usage is deprecated.
2396
2397 .cindex "installing Exim" "what is not installed"
2398 Running &'make install'& does not copy the Exim 4 conversion script
2399 &'convert4r4'&. You will probably run this only once if you are
2400 upgrading from Exim 3. None of the documentation files in the &_doc_&
2401 directory are copied, except for the info files when you have set
2402 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2403
2404 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2405 to their names. The Exim binary itself, however, is handled differently. It is
2406 installed under a name that includes the version number and the compile number,
2407 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2408 called &_exim_& to point to the binary. If you are updating a previous version
2409 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2410 from the directory (as seen by other processes).
2411
2412 .cindex "installing Exim" "testing the script"
2413 If you want to see what the &'make install'& will do before running it for
2414 real, you can pass the &%-n%& option to the installation script by this
2415 command:
2416 .code
2417 make INSTALL_ARG=-n install
2418 .endd
2419 The contents of the variable INSTALL_ARG are passed to the installation
2420 script. You do not need to be root to run this test. Alternatively, you can run
2421 the installation script directly, but this must be from within the build
2422 directory. For example, from the top-level Exim directory you could use this
2423 command:
2424 .code
2425 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2426 .endd
2427 .cindex "installing Exim" "install script options"
2428 There are two other options that can be supplied to the installation script.
2429
2430 .ilist
2431 &%-no_chown%& bypasses the call to change the owner of the installed binary
2432 to root, and the call to make it a setuid binary.
2433 .next
2434 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2435 installed binary.
2436 .endlist
2437
2438 INSTALL_ARG can be used to pass these options to the script. For example:
2439 .code
2440 make INSTALL_ARG=-no_symlink install
2441 .endd
2442 The installation script can also be given arguments specifying which files are
2443 to be copied. For example, to install just the Exim binary, and nothing else,
2444 without creating the symbolic link, you could use:
2445 .code
2446 make INSTALL_ARG='-no_symlink exim' install
2447 .endd
2448
2449
2450
2451 .section "Installing info documentation" "SECTinsinfdoc"
2452 .cindex "installing Exim" "&'info'& documentation"
2453 Not all systems use the GNU &'info'& system for documentation, and for this
2454 reason, the Texinfo source of Exim's documentation is not included in the main
2455 distribution. Instead it is available separately from the FTP site (see section
2456 &<<SECTavail>>&).
2457
2458 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2459 source of the documentation is found in the source tree, running &`make
2460 install`& automatically builds the info files and installs them.
2461
2462
2463
2464 .section "Setting up the spool directory" "SECID33"
2465 .cindex "spool directory" "creating"
2466 When it starts up, Exim tries to create its spool directory if it does not
2467 exist. The Exim uid and gid are used for the owner and group of the spool
2468 directory. Sub-directories are automatically created in the spool directory as
2469 necessary.
2470
2471
2472
2473
2474 .section "Testing" "SECID34"
2475 .cindex "testing" "installation"
2476 Having installed Exim, you can check that the runtime configuration file is
2477 syntactically valid by running the following command, which assumes that the
2478 Exim binary directory is within your PATH environment variable:
2479 .code
2480 exim -bV
2481 .endd
2482 If there are any errors in the configuration file, Exim outputs error messages.
2483 Otherwise it outputs the version number and build date,
2484 the DBM library that is being used, and information about which drivers and
2485 other optional code modules are included in the binary.
2486 Some simple routing tests can be done by using the address testing option. For
2487 example,
2488 .display
2489 &`exim -bt`& <&'local username'&>
2490 .endd
2491 should verify that it recognizes a local mailbox, and
2492 .display
2493 &`exim -bt`& <&'remote address'&>
2494 .endd
2495 a remote one. Then try getting it to deliver mail, both locally and remotely.
2496 This can be done by passing messages directly to Exim, without going through a
2497 user agent. For example:
2498 .code
2499 exim -v postmaster@your.domain.example
2500 From: user@your.domain.example
2501 To: postmaster@your.domain.example
2502 Subject: Testing Exim
2503
2504 This is a test message.
2505 ^D
2506 .endd
2507 The &%-v%& option causes Exim to output some verification of what it is doing.
2508 In this case you should see copies of three log lines, one for the message's
2509 arrival, one for its delivery, and one containing &"Completed"&.
2510
2511 .cindex "delivery" "problems with"
2512 If you encounter problems, look at Exim's log files (&'mainlog'& and
2513 &'paniclog'&) to see if there is any relevant information there. Another source
2514 of information is running Exim with debugging turned on, by specifying the
2515 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2516 with debugging turned on by a command of the form
2517 .display
2518 &`exim -d -M`& <&'exim-message-id'&>
2519 .endd
2520 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2521 produces rather a lot of output, but you can cut this down to specific areas.
2522 For example, if you use &%-d-all+route%& only the debugging information
2523 relevant to routing is included. (See the &%-d%& option in chapter
2524 &<<CHAPcommandline>>& for more details.)
2525
2526 .cindex '&"sticky"& bit'
2527 .cindex "lock files"
2528 One specific problem that has shown up on some sites is the inability to do
2529 local deliveries into a shared mailbox directory, because it does not have the
2530 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2531 writing to a mailbox file, and if it cannot create the lock file, the delivery
2532 is deferred. You can get round this either by setting the &"sticky bit"& on the
2533 directory, or by setting a specific group for local deliveries and allowing
2534 that group to create files in the directory (see the comments above the
2535 &(local_delivery)& transport in the default configuration file). Another
2536 approach is to configure Exim not to use lock files, but just to rely on
2537 &[fcntl()]& locking instead. However, you should do this only if all user
2538 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2539 see chapter &<<CHAPappendfile>>&.
2540
2541 One thing that cannot be tested on a system that is already running an MTA is
2542 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2543 &%-oX%& option can be used to run an Exim daemon that listens on some other
2544 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2545 &'exim_checkaccess'& utility can be used to check out policy controls on
2546 incoming SMTP mail.
2547
2548 Testing a new version on a system that is already running Exim can most easily
2549 be done by building a binary with a different CONFIGURE_FILE setting. From
2550 within the runtime configuration, all other file and directory names
2551 that Exim uses can be altered, in order to keep it entirely clear of the
2552 production version.
2553
2554
2555 .section "Replacing another MTA with Exim" "SECID35"
2556 .cindex "replacing another MTA"
2557 Building and installing Exim for the first time does not of itself put it in
2558 general use. The name by which the system's MTA is called by mail user agents
2559 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2560 operating system), and it is necessary to make this name point to the &'exim'&
2561 binary in order to get the user agents to pass messages to Exim. This is
2562 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2563 or &_/usr/lib/sendmail_&
2564 .cindex "symbolic link" "to &'exim'& binary"
2565 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2566 privilege and executable status from the old MTA. It is then necessary to stop
2567 and restart the mailer daemon, if one is running.
2568
2569 .cindex "FreeBSD, MTA indirection"
2570 .cindex "&_/etc/mail/mailer.conf_&"
2571 Some operating systems have introduced alternative ways of switching MTAs. For
2572 example, if you are running FreeBSD, you need to edit the file
2573 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2574 described. A typical example of the contents of this file for running Exim is
2575 as follows:
2576 .code
2577 sendmail            /usr/exim/bin/exim
2578 send-mail           /usr/exim/bin/exim
2579 mailq               /usr/exim/bin/exim -bp
2580 newaliases          /usr/bin/true
2581 .endd
2582 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2583 your Exim installation is &"live"&. Check it by sending a message from your
2584 favourite user agent.
2585
2586 You should consider what to tell your users about the change of MTA. Exim may
2587 have different capabilities to what was previously running, and there are
2588 various operational differences such as the text of messages produced by
2589 command line options and in bounce messages. If you allow your users to make
2590 use of Exim's filtering capabilities, you should make the document entitled
2591 &'Exim's interface to mail filtering'& available to them.
2592
2593
2594
2595 .section "Running the daemon" SECTdaemonLaunch
2596 The most common command line for launching the Exim daemon looks like
2597 .code
2598 exim -bd -q5m
2599 .endd
2600 This starts a daemon which
2601 .ilist
2602 listens for incoming smtp connections, launching handler processes for
2603 each new one
2604 .next
2605 starts a queue-runner process every five minutes, to inspect queued messages
2606 and run delivery attempts on any that have arrived at their retry time
2607 .endlist
2608 Should a queue run take longer than the time between queue-runner starts,
2609 they will run in parallel.
2610 Numbers of jobs of the various types are subject to policy controls
2611 defined in the configuration.
2612
2613
2614 .section "Upgrading Exim" "SECID36"
2615 .cindex "upgrading Exim"
2616 If you are already running Exim on your host, building and installing a new
2617 version automatically makes it available to MUAs, or any other programs that
2618 call the MTA directly. However, if you are running an Exim daemon, you do need
2619 .cindex restart "on HUP signal"
2620 .cindex signal "HUP, to restart"
2621 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2622 new binary. You do not need to stop processing mail in order to install a new
2623 version of Exim. The install script does not modify an existing runtime
2624 configuration file.
2625
2626
2627
2628
2629 .section "Stopping the Exim daemon on Solaris" "SECID37"
2630 .cindex "Solaris" "stopping Exim on"
2631 The standard command for stopping the mailer daemon on Solaris is
2632 .code
2633 /etc/init.d/sendmail stop
2634 .endd
2635 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2636 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2637 for the text &"sendmail"&; this is not present because the actual program name
2638 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2639 solution is to replace the line that finds the process id with something like
2640 .code
2641 pid=`cat /var/spool/exim/exim-daemon.pid`
2642 .endd
2643 to obtain the daemon's pid directly from the file that Exim saves it in.
2644
2645 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2646 still be received from local processes, and if automatic delivery is configured
2647 (the normal case), deliveries will still occur.
2648
2649
2650
2651
2652 . ////////////////////////////////////////////////////////////////////////////
2653 . ////////////////////////////////////////////////////////////////////////////
2654
2655 .chapter "The Exim command line" "CHAPcommandline"
2656 .scindex IIDclo1 "command line" "options"
2657 .scindex IIDclo2 "options" "command line"
2658 Exim's command line takes the standard Unix form of a sequence of options,
2659 each starting with a hyphen character, followed by a number of arguments. The
2660 options are compatible with the main options of Sendmail, and there are also
2661 some additional options, some of which are compatible with Smail 3. Certain
2662 combinations of options do not make sense, and provoke an error if used.
2663 The form of the arguments depends on which options are set.
2664
2665
2666 .section "Setting options by program name" "SECID38"
2667 .cindex "&'mailq'&"
2668 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2669 were present before any other options.
2670 The &%-bp%& option requests a listing of the contents of the mail queue on the
2671 standard output.
2672 This feature is for compatibility with some systems that contain a command of
2673 that name in one of the standard libraries, symbolically linked to
2674 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2675
2676 .cindex "&'rsmtp'&"
2677 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2678 were present before any other options, for compatibility with Smail. The
2679 &%-bS%& option is used for reading in a number of messages in batched SMTP
2680 format.
2681
2682 .cindex "&'rmail'&"
2683 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2684 &%-oee%& options were present before any other options, for compatibility with
2685 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2686
2687 .cindex "&'runq'&"
2688 .cindex "queue runner"
2689 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2690 were present before any other options, for compatibility with Smail. The &%-q%&
2691 option causes a single queue runner process to be started.
2692
2693 .cindex "&'newaliases'&"
2694 .cindex "alias file" "building"
2695 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2696 If Exim is called under the name &'newaliases'& it behaves as if the option
2697 &%-bi%& were present before any other options, for compatibility with Sendmail.
2698 This option is used for rebuilding Sendmail's alias file. Exim does not have
2699 the concept of a single alias file, but can be configured to run a given
2700 command if called with the &%-bi%& option.
2701
2702
2703 .section "Trusted and admin users" "SECTtrustedadmin"
2704 Some Exim options are available only to &'trusted users'& and others are
2705 available only to &'admin users'&. In the description below, the phrases &"Exim
2706 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2707 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2708 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2709
2710 .ilist
2711 .cindex "trusted users" "definition of"
2712 .cindex "user" "trusted definition of"
2713 The trusted users are root, the Exim user, any user listed in the
2714 &%trusted_users%& configuration option, and any user whose current group or any
2715 supplementary group is one of those listed in the &%trusted_groups%&
2716 configuration option. Note that the Exim group is not automatically trusted.
2717
2718 .cindex '&"From"& line'
2719 .cindex "envelope from"
2720 .cindex "envelope sender"
2721 Trusted users are always permitted to use the &%-f%& option or a leading
2722 &"From&~"& line to specify the envelope sender of a message that is passed to
2723 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2724 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2725 users to set envelope senders.
2726
2727 .chindex From:
2728 .chindex Sender:
2729 For a trusted user, there is never any check on the contents of the &'From:'&
2730 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2731 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2732
2733 Trusted users may also specify a host name, host address, interface address,
2734 protocol name, ident value, and authentication data when submitting a message
2735 locally. Thus, they are able to insert messages into Exim's queue locally that
2736 have the characteristics of messages received from a remote host. Untrusted
2737 users may in some circumstances use &%-f%&, but can never set the other values
2738 that are available to trusted users.
2739 .next
2740 .cindex "user" "admin definition of"
2741 .cindex "admin user" "definition of"
2742 The admin users are root, the Exim user, and any user that is a member of the
2743 Exim group or of any group listed in the &%admin_groups%& configuration option.
2744 The current group does not have to be one of these groups.
2745
2746 Admin users are permitted to list the queue, and to carry out certain
2747 operations on messages, for example, to force delivery failures. It is also
2748 necessary to be an admin user in order to see the full information provided by
2749 the Exim monitor, and full debugging output.
2750
2751 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2752 Exim to attempt delivery of messages on its queue is restricted to admin users.
2753 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2754 option false (that is, specifying &%no_prod_requires_admin%&).
2755
2756 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2757 is restricted to admin users unless &%queue_list_requires_admin%& is set
2758 false.
2759 .endlist
2760
2761
2762 &*Warning*&: If you configure your system so that admin users are able to
2763 edit Exim's configuration file, you are giving those users an easy way of
2764 getting root. There is further discussion of this issue at the start of chapter
2765 &<<CHAPconf>>&.
2766
2767
2768
2769
2770 .section "Command line options" "SECID39"
2771 Exim's command line options are described in alphabetical order below. If none
2772 of the options that specifies a specific action (such as starting the daemon or
2773 a queue runner, or testing an address, or receiving a message in a specific
2774 format, or listing the queue) are present, and there is at least one argument
2775 on the command line, &%-bm%& (accept a local message on the standard input,
2776 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2777 outputs a brief message about itself and exits.
2778
2779 . ////////////////////////////////////////////////////////////////////////////
2780 . Insert a stylized XML comment here, to identify the start of the command line
2781 . options. This is for the benefit of the Perl script that automatically
2782 . creates a man page for the options.
2783 . ////////////////////////////////////////////////////////////////////////////
2784
2785 .literal xml
2786 <!-- === Start of command line options === -->
2787 .literal off
2788
2789
2790 .vlist
2791 .cmdopt "--" "--"
2792 .cindex "options" "command line; terminating"
2793 This is a pseudo-option whose only purpose is to terminate the options and
2794 therefore to cause subsequent command line items to be treated as arguments
2795 rather than options, even if they begin with hyphens.
2796
2797 .cmdopt --help
2798 This option causes Exim to output a few sentences stating what it is.
2799 The same output is generated if the Exim binary is called with no options and
2800 no arguments.
2801
2802 .cmdopt --version
2803 This option is an alias for &%-bV%& and causes version information to be
2804 displayed.
2805
2806 .vitem &%-Ac%& &&&
2807        &%-Am%&
2808 .oindex "&%-Ac%&"
2809 .oindex "&%-Am%&"
2810 These options are used by Sendmail for selecting configuration files and are
2811 ignored by Exim.
2812
2813 .cmdopt -B <&'type'&>
2814 .oindex "&%-B%&"
2815 .cindex "8-bit characters"
2816 .cindex "Sendmail compatibility" "8-bit characters"
2817 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2818 clean; it ignores this option.
2819
2820 .cmdopt -bd
2821 .cindex "daemon"
2822 .cindex "SMTP" "listener"
2823 .cindex "queue runner"
2824 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2825 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2826 that the daemon should also initiate periodic queue runs.
2827
2828 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2829 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2830 disconnect from the controlling terminal. When running this way, it can be
2831 stopped by pressing ctrl-C.
2832
2833 By default, Exim listens for incoming connections to the standard SMTP port on
2834 all the host's running interfaces. However, it is possible to listen on other
2835 ports, on multiple ports, and only on specific interfaces. Chapter
2836 &<<CHAPinterfaces>>& contains a description of the options that control this.
2837
2838 When a listening daemon
2839 .cindex "daemon" "process id (pid)"
2840 .cindex "pid (process id)" "of daemon"
2841 is started without the use of &%-oX%& (that is, without overriding the normal
2842 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2843 in Exim's spool directory. This location can be overridden by setting
2844 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2845 running as root.
2846
2847 When &%-oX%& is used on the command line to start a listening daemon, the
2848 process id is not written to the normal pid file path. However, &%-oP%& can be
2849 used to specify a path on the command line if a pid file is required.
2850
2851 The SIGHUP signal
2852 .cindex "SIGHUP"
2853 .cindex restart "on HUP signal"
2854 .cindex signal "HUP, to restart"
2855 .cindex "daemon" "restarting"
2856 .cindex signal "to reload configuration"
2857 .cindex daemon "reload configuration"
2858 .cindex reload configuration
2859 can be used to cause the daemon to re-execute itself. This should be done
2860 whenever Exim's configuration file, or any file that is incorporated into it by
2861 means of the &%.include%& facility, is changed, and also whenever a new version
2862 of Exim is installed. It is not necessary to do this when other files that are
2863 referenced from the configuration (for example, alias files) are changed,
2864 because these are reread each time they are used.
2865
2866 Either a SIGTERM or a SIGINT signal should be used to cause the daemon
2867 to cleanly shut down.
2868 Subprocesses handling recceiving or delivering messages,
2869 or for scanning the queue,
2870 will not be affected by the termination of the daemon process.
2871
2872 .cmdopt -bdf
2873 This option has the same effect as &%-bd%& except that it never disconnects
2874 from the controlling terminal, even when no debugging is specified.
2875
2876 .cmdopt -be
2877 .cindex "testing" "string expansion"
2878 .cindex "expansion" "testing"
2879 Run Exim in expansion testing mode. Exim discards its root privilege, to
2880 prevent ordinary users from using this mode to read otherwise inaccessible
2881 files. If no arguments are given, Exim runs interactively, prompting for lines
2882 of data. Otherwise, it processes each argument in turn.
2883
2884 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2885 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2886 used without command line arguments. If successful, it uses the &[readline()]&
2887 function, which provides extensive line-editing facilities, for reading the
2888 test data. A line history is supported.
2889
2890 Long expansion expressions can be split over several lines by using backslash
2891 continuations. As in Exim's runtime configuration, white space at the start of
2892 continuation lines is ignored. Each argument or data line is passed through the
2893 string expansion mechanism, and the result is output. Variable values from the
2894 configuration file (for example, &$qualify_domain$&) are available, but no
2895 message-specific values (such as &$message_exim_id$&) are set, because no message
2896 is being processed (but see &%-bem%& and &%-Mset%&).
2897
2898 &*Note*&: If you use this mechanism to test lookups, and you change the data
2899 files or databases you are using, you must exit and restart Exim before trying
2900 the same lookup again. Otherwise, because each Exim process caches the results
2901 of lookups, you will just get the same result as before.
2902
2903 Macro processing is done on lines before string-expansion: new macros can be
2904 defined and macros will be expanded.
2905 Because macros in the config file are often used for secrets, those are only
2906 available to admin users.
2907
2908 The word &"set"& at the start of a line, followed by a single space,
2909 is recognised specially as defining a value for a variable.
2910 .cindex "tainted data" "expansion testing"
2911 If the sequence &",t"& is inserted before the space,
2912 the value is marked as tainted.
2913 The syntax is otherwise the same as the ACL modifier &"set ="&.
2914
2915 .cmdopt -bem <&'filename'&>
2916 .cindex "testing" "string expansion"
2917 .cindex "expansion" "testing"
2918 This option operates like &%-be%& except that it must be followed by the name
2919 of a file. For example:
2920 .code
2921 exim -bem /tmp/testmessage
2922 .endd
2923 The file is read as a message (as if receiving a locally-submitted non-SMTP
2924 message) before any of the test expansions are done. Thus, message-specific
2925 variables such as &$message_size$& and &$header_from:$& are available. However,
2926 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2927 recipients are read from the headers in the normal way, and are shown in the
2928 &$recipients$& variable. Note that recipients cannot be given on the command
2929 line, because further arguments are taken as strings to expand (just like
2930 &%-be%&).
2931
2932 .cmdopt -bF <&'filename'&>
2933 .cindex "system filter" "testing"
2934 .cindex "testing" "system filter"
2935 This option is the same as &%-bf%& except that it assumes that the filter being
2936 tested is a system filter. The additional commands that are available only in
2937 system filters are recognized.
2938
2939 .cmdopt -bf <&'filename'&>
2940 .cindex "filter" "testing"
2941 .cindex "testing" "filter file"
2942 .cindex "forward file" "testing"
2943 .cindex "testing" "forward file"
2944 .cindex "Sieve filter" "testing"
2945 This option runs Exim in user filter testing mode; the file is the filter file
2946 to be tested, and a test message must be supplied on the standard input. If
2947 there are no message-dependent tests in the filter, an empty file can be
2948 supplied.
2949
2950 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2951 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2952 filter and a user filter in the same run. For example:
2953 .code
2954 exim -bF /system/filter -bf /user/filter </test/message
2955 .endd
2956 This is helpful when the system filter adds header lines or sets filter
2957 variables that are used by the user filter.
2958
2959 If the test filter file does not begin with one of the special lines
2960 .code
2961 # Exim filter
2962 # Sieve filter
2963 .endd
2964 it is taken to be a normal &_.forward_& file, and is tested for validity under
2965 that interpretation. See sections &<<SECTitenonfilred>>& to
2966 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2967 redirection lists.
2968
2969 The result of an Exim command that uses &%-bf%&, provided no errors are
2970 detected, is a list of the actions that Exim would try to take if presented
2971 with the message for real. More details of filter testing are given in the
2972 separate document entitled &'Exim's interfaces to mail filtering'&.
2973
2974 When testing a filter file,
2975 .cindex "&""From""& line"
2976 .cindex "envelope from"
2977 .cindex "envelope sender"
2978 .oindex "&%-f%&" "for filter testing"
2979 the envelope sender can be set by the &%-f%& option,
2980 or by a &"From&~"& line at the start of the test message. Various parameters
2981 that would normally be taken from the envelope recipient address of the message
2982 can be set by means of additional command line options (see the next four
2983 options).
2984
2985 .cmdopt -bfd <&'domain'&>
2986 .vindex "&$qualify_domain$&"
2987 This sets the domain of the recipient address when a filter file is being
2988 tested by means of the &%-bf%& option. The default is the value of
2989 &$qualify_domain$&.
2990
2991 .cmdopt -bfl <&'local&~part'&>
2992 This sets the local part of the recipient address when a filter file is being
2993 tested by means of the &%-bf%& option. The default is the username of the
2994 process that calls Exim. A local part should be specified with any prefix or
2995 suffix stripped, because that is how it appears to the filter when a message is
2996 actually being delivered.
2997
2998 .cmdopt -bfp <&'prefix'&>
2999 .cindex affix "filter testing"
3000 This sets the prefix of the local part of the recipient address when a filter
3001 file is being tested by means of the &%-bf%& option. The default is an empty
3002 prefix.
3003
3004 .cmdopt -bfs <&'suffix'&>
3005 .cindex affix "filter testing"
3006 This sets the suffix of the local part of the recipient address when a filter
3007 file is being tested by means of the &%-bf%& option. The default is an empty
3008 suffix.
3009
3010 .cmdopt -bh <&'IP&~address'&>
3011 .cindex "testing" "incoming SMTP"
3012 .cindex "SMTP" "testing incoming"
3013 .cindex "testing" "relay control"
3014 .cindex "relaying" "testing configuration"
3015 .cindex "policy control" "testing"
3016 .cindex "debugging" "&%-bh%& option"
3017 This option runs a fake SMTP session as if from the given IP address, using the
3018 standard input and output. The IP address may include a port number at the end,
3019 after a full stop. For example:
3020 .code
3021 exim -bh 10.9.8.7.1234
3022 exim -bh fe80::a00:20ff:fe86:a061.5678
3023 .endd
3024 When an IPv6 address is given, it is converted into canonical form. In the case
3025 of the second example above, the value of &$sender_host_address$& after
3026 conversion to the canonical form is
3027 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
3028
3029 Comments as to what is going on are written to the standard error file. These
3030 include lines beginning with &"LOG"& for anything that would have been logged.
3031 This facility is provided for testing configuration options for incoming
3032 messages, to make sure they implement the required policy. For example, you can
3033 test your relay controls using &%-bh%&.
3034
3035 &*Warning 1*&:
3036 .cindex "RFC 1413"
3037 You can test features of the configuration that rely on ident (RFC 1413)
3038 information by using the &%-oMt%& option. However, Exim cannot actually perform
3039 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3040 connection.
3041
3042 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3043 are also skipped when testing using &%-bh%&. If you want these callouts to
3044 occur, use &%-bhc%& instead.
3045
3046 Messages supplied during the testing session are discarded, and nothing is
3047 written to any of the real log files. There may be pauses when DNS (and other)
3048 lookups are taking place, and of course these may time out. The &%-oMi%& option
3049 can be used to specify a specific IP interface and port if this is important,
3050 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3051 session were authenticated.
3052
3053 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3054 output just states whether a given recipient address from a given host is
3055 acceptable or not. See section &<<SECTcheckaccess>>&.
3056
3057 Features such as authentication and encryption, where the client input is not
3058 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3059 specialized SMTP test program such as
3060 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3061
3062 .cmdopt -bhc <&'IP&~address'&>
3063 This option operates in the same way as &%-bh%&, except that address
3064 verification callouts are performed if required. This includes consulting and
3065 updating the callout cache database.
3066
3067 .cmdopt -bi
3068 .cindex "alias file" "building"
3069 .cindex "building alias file"
3070 .cindex "Sendmail compatibility" "&%-bi%& option"
3071 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3072 Exim does not have the concept of a single alias file, and so it cannot mimic
3073 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3074 tend to appear in various scripts such as NIS make files, so the option must be
3075 recognized.
3076
3077 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3078 configuration option is run, under the uid and gid of the caller of Exim. If
3079 the &%-oA%& option is used, its value is passed to the command as an argument.
3080 The command set by &%bi_command%& may not contain arguments. The command can
3081 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3082 if this is required. If the &%bi_command%& option is not set, calling Exim with
3083 &%-bi%& is a no-op.
3084
3085 . // Keep :help first, then the rest in alphabetical order
3086 .cmdopt -bI:help
3087 .cindex "querying exim information"
3088 We shall provide various options starting &`-bI:`& for querying Exim for
3089 information.  The output of many of these will be intended for machine
3090 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3091 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3092 options shall cause Exim to exit after producing the requested output.
3093
3094 .cmdopt -bI:dscp
3095 .cindex "DSCP" "values"
3096 This option causes Exim to emit an alphabetically sorted list of all
3097 recognised DSCP names.
3098
3099 .cmdopt -bI:sieve
3100 .cindex "Sieve filter" "capabilities"
3101 This option causes Exim to emit an alphabetically sorted list of all supported
3102 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3103 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3104 &`SIEVE`& capability response line.  As the precise list may depend upon
3105 compile-time build options, which this option will adapt to, this is the only
3106 way to guarantee a correct response.
3107
3108 .cmdopt -bm
3109 .cindex "local message reception"
3110 This option runs an Exim receiving process that accepts an incoming,
3111 locally-generated message on the standard input. The recipients are given as the
3112 command arguments (except when &%-t%& is also present &-- see below). Each
3113 argument can be a comma-separated list of RFC 2822 addresses. This is the
3114 default option for selecting the overall action of an Exim call; it is assumed
3115 if no other conflicting option is present.
3116
3117 If any addresses in the message are unqualified (have no domain), they are
3118 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3119 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3120 suppressing this for special cases.
3121
3122 Policy checks on the contents of local messages can be enforced by means of
3123 the non-SMTP ACL. See section &<<SECnonSMTP>>& for details.
3124
3125 .cindex "return code" "for &%-bm%&"
3126 The return code is zero if the message is successfully accepted. Otherwise, the
3127 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3128
3129 The format
3130 .cindex "message" "format"
3131 .cindex "format" "message"
3132 .cindex "&""From""& line"
3133 .cindex "UUCP" "&""From""& line"
3134 .cindex "Sendmail compatibility" "&""From""& line"
3135 of the message must be as defined in RFC 2822, except that, for
3136 compatibility with Sendmail and Smail, a line in one of the forms
3137 .code
3138 From sender Fri Jan  5 12:55 GMT 1997
3139 From sender Fri, 5 Jan 97 12:55:01
3140 .endd
3141 (with the weekday optional, and possibly with additional text after the date)
3142 is permitted to appear at the start of the message. There appears to be no
3143 authoritative specification of the format of this line. Exim recognizes it by
3144 matching against the regular expression defined by the &%uucp_from_pattern%&
3145 option, which can be changed if necessary.
3146
3147 .oindex "&%-f%&" "overriding &""From""& line"
3148 The specified sender is treated as if it were given as the argument to the
3149 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3150 preference to the address taken from the message. The caller of Exim must be a
3151 trusted user for the sender of a message to be set in this way.
3152
3153 .cmdopt -bmalware <&'filename'&>
3154 .cindex "testing", "malware"
3155 .cindex "malware scan test"
3156 This debugging option causes Exim to scan the given file or directory
3157 (depending on the used scanner interface),
3158 using the malware scanning framework.  The option of &%av_scanner%& influences
3159 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3160 the expansion should have defaults which apply to this invocation.  ACLs are
3161 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3162 will never be populated and &%-bmalware%& will fail.
3163
3164 Exim will have changed working directory before resolving the filename, so
3165 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3166 user when it tries to open the file, rather than as the invoking user.
3167 This option requires admin privileges.
3168
3169 The &%-bmalware%& option will not be extended to be more generally useful,
3170 there are better tools for file-scanning.  This option exists to help
3171 administrators verify their Exim and AV scanner configuration.
3172
3173 .cmdopt -bnq
3174 .cindex "address qualification, suppressing"
3175 By default, Exim automatically qualifies unqualified addresses (those
3176 without domains) that appear in messages that are submitted locally (that
3177 is, not over TCP/IP). This qualification applies both to addresses in
3178 envelopes, and addresses in header lines. Sender addresses are qualified using
3179 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3180 defaults to the value of &%qualify_domain%&).
3181
3182 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3183 being used to re-submit messages that originally came from remote hosts after
3184 content scanning, you probably do not want to qualify unqualified addresses in
3185 header lines. (Such lines will be present only if you have not enabled a header
3186 syntax check in the appropriate ACL.)
3187
3188 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3189 messages that originate on the local host. When this is used, unqualified
3190 addresses in the envelope provoke errors (causing message rejection) and
3191 unqualified addresses in header lines are left alone.
3192
3193
3194 .cmdopt -bP
3195 .cindex "configuration options" "extracting"
3196 .cindex "options" "configuration &-- extracting"
3197 If this option is given with no arguments, it causes the values of all Exim's
3198 main configuration options to be written to the standard output. The values
3199 of one or more specific options can be requested by giving their names as
3200 arguments, for example:
3201 .code
3202 exim -bP qualify_domain hold_domains
3203 .endd
3204 .cindex "hiding configuration option values"
3205 .cindex "configuration options" "hiding value of"
3206 .cindex "options" "hiding value of"
3207 However, any option setting that is preceded by the word &"hide"& in the
3208 configuration file is not shown in full, except to an admin user. For other
3209 users, the output is as in this example:
3210 .code
3211 mysql_servers = <value not displayable>
3212 .endd
3213 If &%config%& is given as an argument, the config is
3214 output, as it was parsed, any include file resolved, any comment removed.
3215
3216 If &%config_file%& is given as an argument, the name of the runtime
3217 configuration file is output. (&%configure_file%& works too, for
3218 backward compatibility.)
3219 If a list of configuration files was supplied, the value that is output here
3220 is the name of the file that was actually used.
3221
3222 .cindex "options" "hiding name of"
3223 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3224 name will not be output.
3225
3226 .cindex "daemon" "process id (pid)"
3227 .cindex "pid (process id)" "of daemon"
3228 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3229 directories where log files and daemon pid files are written are output,
3230 respectively. If these values are unset, log files are written in a
3231 sub-directory of the spool directory called &%log%&, and the pid file is
3232 written directly into the spool directory.
3233
3234 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3235 .code
3236 exim -bP +local_domains
3237 .endd
3238 it searches for a matching named list of any type (domain, host, address, or
3239 local part) and outputs what it finds.
3240
3241 .cindex "options" "router &-- extracting"
3242 .cindex "options" "transport &-- extracting"
3243 .cindex "options" "authenticator &-- extracting"
3244 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3245 followed by the name of an appropriate driver instance, the option settings for
3246 that driver are output. For example:
3247 .code
3248 exim -bP transport local_delivery
3249 .endd
3250 The generic driver options are output first, followed by the driver's private
3251 options. A list of the names of drivers of a particular type can be obtained by
3252 using one of the words &%router_list%&, &%transport_list%&, or
3253 &%authenticator_list%&, and a complete list of all drivers with their option
3254 settings can be obtained by using &%routers%&, &%transports%&, or
3255 &%authenticators%&.
3256
3257 .cindex "environment"
3258 If &%environment%& is given as an argument, the set of environment
3259 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3260 variables.
3261
3262 .cindex "options" "macro &-- extracting"
3263 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3264 are available, similarly to the drivers.  Because macros are sometimes used
3265 for storing passwords, this option is restricted.
3266 The output format is one item per line.
3267 For the "-bP macro <name>" form, if no such macro is found
3268 the exit status will be nonzero.
3269
3270 .cmdopt -bp
3271 .cindex "queue" "listing messages in"
3272 .cindex "listing" "messages in the queue"
3273 This option requests a listing of the contents of the mail queue on the
3274 standard output. If the &%-bp%& option is followed by a list of message ids,
3275 just those messages are listed. By default, this option can be used only by an
3276 admin user. However, the &%queue_list_requires_admin%& option can be set false
3277 to allow any user to see the queue.
3278
3279 Each message in the queue is displayed as in the following example:
3280 .code
3281 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3282           red.king@looking-glass.fict.example
3283           <other addresses>
3284 .endd
3285 .cindex "message" "size in queue listing"
3286 .cindex "size" "of message"
3287 The first line contains the length of time the message has been in the queue
3288 (in this case 25 minutes), the size of the message (2.9K), the unique local
3289 identifier for the message, and the message sender, as contained in the
3290 envelope. For bounce messages, the sender address is empty, and appears as
3291 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3292 the default sender address, the user's login name is shown in parentheses
3293 before the sender address.
3294
3295 .cindex "frozen messages" "in queue listing"
3296 If the message is frozen (attempts to deliver it are suspended) then the text
3297 &"*** frozen ***"& is displayed at the end of this line.
3298
3299 The recipients of the message (taken from the envelope, not the headers) are
3300 displayed on subsequent lines. Those addresses to which the message has already
3301 been delivered are marked with the letter D. If an original address gets
3302 expanded into several addresses via an alias or forward file, the original is
3303 displayed with a D only when deliveries for all of its child addresses are
3304 complete.
3305
3306
3307 .cmdopt -bpa
3308 This option operates like &%-bp%&, but in addition it shows delivered addresses
3309 that were generated from the original top level address(es) in each message by
3310 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3311 of just &"D"&.
3312
3313
3314 .cmdopt -bpc
3315 .cindex "queue" "count of messages on"
3316 This option counts the number of messages in the queue, and writes the total
3317 to the standard output. It is restricted to admin users, unless
3318 &%queue_list_requires_admin%& is set false.
3319
3320
3321 .cmdopt -bpi
3322 .cindex queue "list of message IDs"
3323 This option operates like &%-bp%&, but only outputs message ids
3324 (one per line).
3325
3326
3327 .cmdopt -bpr
3328 This option operates like &%-bp%&, but the output is not sorted into
3329 chronological order of message arrival. This can speed it up when there are
3330 lots of messages in the queue, and is particularly useful if the output is
3331 going to be post-processed in a way that doesn't need the sorting.
3332
3333 .cmdopt -bpra
3334 This option is a combination of &%-bpr%& and &%-bpa%&.
3335
3336 .cmdopt -bpri
3337 This option is a combination of &%-bpr%& and &%-bpi%&.
3338
3339 .cmdopt -bpru
3340 This option is a combination of &%-bpr%& and &%-bpu%&.
3341
3342
3343 .cmdopt -bpu
3344 This option operates like &%-bp%& but shows only undelivered top-level
3345 addresses for each message displayed. Addresses generated by aliasing or
3346 forwarding are not shown, unless the message was deferred after processing by a
3347 router with the &%one_time%& option set.
3348
3349
3350 .cmdopt -brt
3351 .cindex "testing" "retry configuration"
3352 .cindex "retry" "configuration testing"
3353 This option is for testing retry rules, and it must be followed by up to three
3354 arguments. It causes Exim to look for a retry rule that matches the values
3355 and to write it to the standard output. For example:
3356 .code
3357 exim -brt bach.comp.mus.example
3358 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3359 .endd
3360 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3361 argument, which is required, can be a complete address in the form
3362 &'local_part@domain'&, or it can be just a domain name. If the second argument
3363 contains a dot, it is interpreted as an optional second domain name; if no
3364 retry rule is found for the first argument, the second is tried. This ties in
3365 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3366 rule is found that matches the host, one that matches the mail domain is
3367 sought. Finally, an argument that is the name of a specific delivery error, as
3368 used in setting up retry rules, can be given. For example:
3369 .code
3370 exim -brt haydn.comp.mus.example quota_3d
3371 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3372 .endd
3373
3374 .cmdopt -brw
3375 .cindex "testing" "rewriting"
3376 .cindex "rewriting" "testing"
3377 This option is for testing address rewriting rules, and it must be followed by
3378 a single argument, consisting of either a local part without a domain, or a
3379 complete address with a fully qualified domain. Exim outputs how this address
3380 would be rewritten for each possible place it might appear. See chapter
3381 &<<CHAPrewrite>>& for further details.
3382
3383 .cmdopt -bS
3384 .cindex "SMTP" "batched incoming"
3385 .cindex "batched SMTP input"
3386 This option is used for batched SMTP input, which is an alternative interface
3387 for non-interactive local message submission. A number of messages can be
3388 submitted in a single run. However, despite its name, this is not really SMTP
3389 input. Exim reads each message's envelope from SMTP commands on the standard
3390 input, but generates no responses. If the caller is trusted, or
3391 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3392 believed; otherwise the sender is always the caller of Exim.
3393
3394 The message itself is read from the standard input, in SMTP format (leading
3395 dots doubled), terminated by a line containing just a single dot. An error is
3396 provoked if the terminating dot is missing. A further message may then follow.
3397
3398 As for other local message submissions, the contents of incoming batch SMTP
3399 messages can be checked using the non-SMTP ACL (see section &<<SECnonSMTP>>&).
3400 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3401 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3402
3403 Some other SMTP commands are recognized in the input. HELO and EHLO act
3404 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3405 QUIT quits, ignoring the rest of the standard input.
3406
3407 .cindex "return code" "for &%-bS%&"
3408 If any error is encountered, reports are written to the standard output and
3409 error streams, and Exim gives up immediately. The return code is 0 if no error
3410 was detected; it is 1 if one or more messages were accepted before the error
3411 was detected; otherwise it is 2.
3412
3413 More details of input using batched SMTP are given in section
3414 &<<SECTincomingbatchedSMTP>>&.
3415
3416 .cmdopt -bs
3417 .cindex "SMTP" "local input"
3418 .cindex "local SMTP input"
3419 This option causes Exim to accept one or more messages by reading SMTP commands
3420 on the standard input, and producing SMTP replies on the standard output. SMTP
3421 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3422 Some user agents use this interface as a way of passing locally-generated
3423 messages to the MTA.
3424
3425 In
3426 .cindex "sender" "source of"
3427 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3428 set, the senders of messages are taken from the SMTP MAIL commands.
3429 Otherwise the content of these commands is ignored and the sender is set up as
3430 the calling user. Unqualified addresses are automatically qualified using
3431 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3432 &%-bnq%& option is used.
3433
3434 .cindex "inetd"
3435 The
3436 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3437 using a listening daemon. Exim can distinguish the two cases by checking
3438 whether the standard input is a TCP/IP socket. When Exim is called from
3439 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3440 above concerning senders and qualification do not apply. In this situation,
3441 Exim behaves in exactly the same way as it does when receiving a message via
3442 the listening daemon.
3443
3444 .cmdopt -bt
3445 .cindex "testing" "addresses"
3446 .cindex "address" "testing"
3447 This option runs Exim in address testing mode, in which each argument is taken
3448 as a recipient address to be tested for deliverability. The results are
3449 written to the standard output. If a test fails, and the caller is not an admin
3450 user, no details of the failure are output, because these might contain
3451 sensitive information such as usernames and passwords for database lookups.
3452
3453 If no arguments are given, Exim runs in an interactive manner, prompting with a
3454 right angle bracket for addresses to be tested.
3455
3456 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3457 &[readline()]& function, because it is running as &'root'& and there are
3458 security issues.
3459
3460 Each address is handled as if it were the recipient address of a message
3461 (compare the &%-bv%& option). It is passed to the routers and the result is
3462 written to the standard output. However, any router that has
3463 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3464 genuine routing tests if your first router passes everything to a scanner
3465 program.
3466
3467 .cindex "return code" "for &%-bt%&"
3468 The return code is 2 if any address failed outright; it is 1 if no address
3469 failed outright but at least one could not be resolved for some reason. Return
3470 code 0 is given only when all addresses succeed.
3471
3472 .cindex "duplicate addresses"
3473 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3474 addresses after routing is complete, so that only one delivery takes place.
3475 This does not happen when testing with &%-bt%&; the full results of routing are
3476 always shown.
3477
3478 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3479 routers in the configuration makes any tests on the sender address of a
3480 message,
3481 .oindex "&%-f%&" "for address testing"
3482 you can use the &%-f%& option to set an appropriate sender when running
3483 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3484 default qualifying domain. However, if you have set up (for example) routers
3485 whose behaviour depends on the contents of an incoming message, you cannot test
3486 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3487 doing such tests.
3488
3489 .cmdopt -bV
3490 .cindex "version number of Exim"
3491 This option causes Exim to write the current version number, compilation
3492 number, and compilation date of the &'exim'& binary to the standard output.
3493 It also lists the DBM library that is being used, the optional modules (such as
3494 specific lookup types), the drivers that are included in the binary, and the
3495 name of the runtime configuration file that is in use.
3496
3497 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3498 configuration file. However, this is a static check only. It cannot check
3499 values that are to be expanded. For example, although a misspelt ACL verb is
3500 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3501 alone to discover (for example) all the typos in the configuration; some
3502 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3503 dynamic testing facilities.
3504
3505 .cmdopt -bv
3506 .cindex "verifying address" "using &%-bv%&"
3507 .cindex "address" "verification"
3508 This option runs Exim in address verification mode, in which each argument is
3509 taken as a recipient address to be verified by the routers. (This does
3510 not involve any verification callouts). During normal operation, verification
3511 happens mostly as a consequence processing a &%verify%& condition in an ACL
3512 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3513 including callouts, see the &%-bh%& and &%-bhc%& options.
3514
3515 If verification fails, and the caller is not an admin user, no details of the
3516 failure are output, because these might contain sensitive information such as
3517 usernames and passwords for database lookups.
3518
3519 If no arguments are given, Exim runs in an interactive manner, prompting with a
3520 right angle bracket for addresses to be verified.
3521
3522 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3523 &[readline()]& function, because it is running as &'exim'& and there are
3524 security issues.
3525
3526 Verification differs from address testing (the &%-bt%& option) in that routers
3527 that have &%no_verify%& set are skipped, and if the address is accepted by a
3528 router that has &%fail_verify%& set, verification fails. The address is
3529 verified as a recipient if &%-bv%& is used; to test verification for a sender
3530 address, &%-bvs%& should be used.
3531
3532 If the &%-v%& option is not set, the output consists of a single line for each
3533 address, stating whether it was verified or not, and giving a reason in the
3534 latter case. Without &%-v%&, generating more than one address by redirection
3535 causes verification to end successfully, without considering the generated
3536 addresses. However, if just one address is generated, processing continues,
3537 and the generated address must verify successfully for the overall verification
3538 to succeed.
3539
3540 When &%-v%& is set, more details are given of how the address has been handled,
3541 and in the case of address redirection, all the generated addresses are also
3542 considered. Verification may succeed for some and fail for others.
3543
3544 The
3545 .cindex "return code" "for &%-bv%&"
3546 return code is 2 if any address failed outright; it is 1 if no address
3547 failed outright but at least one could not be resolved for some reason. Return
3548 code 0 is given only when all addresses succeed.
3549
3550 If any of the routers in the configuration makes any tests on the sender
3551 address of a message, you should use the &%-f%& option to set an appropriate
3552 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3553 calling user at the default qualifying domain.
3554
3555 .cmdopt -bvs
3556 This option acts like &%-bv%&, but verifies the address as a sender rather
3557 than a recipient address. This affects any rewriting and qualification that
3558 might happen.
3559
3560 .cmdopt -bw
3561 .cindex "daemon"
3562 .cindex "inetd"
3563 .cindex "inetd" "wait mode"
3564 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3565 similarly to the &%-bd%& option.  All port specifications on the command-line
3566 and in the configuration file are ignored.  Queue-running may not be specified.
3567
3568 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3569 listening for connections.  This permits the system to start up and have
3570 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3571 each port only when the first connection is received.
3572
3573 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3574 which the daemon will exit, which should cause inetd to listen once more.
3575
3576 .cmdopt -C <&'filelist'&>
3577 .cindex "configuration file" "alternate"
3578 .cindex "CONFIGURE_FILE"
3579 .cindex "alternate configuration file"
3580 This option causes Exim to find the runtime configuration file from the given
3581 list instead of from the list specified by the CONFIGURE_FILE
3582 compile-time setting. Usually, the list will consist of just a single filename,
3583 but it can be a colon-separated list of names. In this case, the first
3584 file that exists is used. Failure to open an existing file stops Exim from
3585 proceeding any further along the list, and an error is generated.
3586
3587 When this option is used by a caller other than root, and the list is different
3588 from the compiled-in list, Exim gives up its root privilege immediately, and
3589 runs with the real and effective uid and gid set to those of the caller.
3590 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3591 file contains a list of full pathnames, one per line, for configuration files
3592 which are trusted. Root privilege is retained for any configuration file so
3593 listed, as long as the caller is the Exim user (or the user specified in the
3594 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3595 not writeable by inappropriate users or groups.
3596
3597 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3598 configuration using &%-C%& right through message reception and delivery,
3599 even if the caller is root. The reception works, but by that time, Exim is
3600 running as the Exim user, so when it re-executes to regain privilege for the
3601 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3602 test reception and delivery using two separate commands (one to put a message
3603 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3604
3605 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3606 prefix string with which any file named in a &%-C%& command line option
3607 must start. In addition, the filename must not contain the sequence &`/../`&.
3608 However, if the value of the &%-C%& option is identical to the value of
3609 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3610 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3611 unset, any filename can be used with &%-C%&.
3612
3613 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3614 to a directory to which only root has access. This prevents someone who has
3615 broken into the Exim account from running a privileged Exim with an arbitrary
3616 configuration file.
3617
3618 The &%-C%& facility is useful for ensuring that configuration files are
3619 syntactically correct, but cannot be used for test deliveries, unless the
3620 caller is privileged, or unless it is an exotic configuration that does not
3621 require privilege. No check is made on the owner or group of the files
3622 specified by this option.
3623
3624
3625 .vitem &%-D%&<&'macro'&>=<&'value'&>
3626 .oindex "&%-D%&"
3627 .cindex "macro" "setting on command line"
3628 This option can be used to override macro definitions in the configuration file
3629 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3630 unprivileged caller, it causes Exim to give up its root privilege.
3631 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3632 completely disabled, and its use causes an immediate error exit.
3633
3634 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3635 colon-separated list of macros which are considered safe and, if &%-D%& only
3636 supplies macros from this list, and the values are acceptable, then Exim will
3637 not give up root privilege if the caller is root, the Exim run-time user, or
3638 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3639 to be removed in the future.  Acceptable values for the macros satisfy the
3640 regexp: &`^[A-Za-z0-9_/.-]*$`&
3641
3642 The entire option (including equals sign if present) must all be within one
3643 command line item. &%-D%& can be used to set the value of a macro to the empty
3644 string, in which case the equals sign is optional. These two commands are
3645 synonymous:
3646 .code
3647 exim -DABC  ...
3648 exim -DABC= ...
3649 .endd
3650 To include spaces in a macro definition item, quotes must be used. If you use
3651 quotes, spaces are permitted around the macro name and the equals sign. For
3652 example:
3653 .code
3654 exim '-D ABC = something' ...
3655 .endd
3656 &%-D%& may be repeated up to 10 times on a command line.
3657 Only macro names up to 22 letters long can be set.
3658
3659
3660 .vitem &%-d%&<&'debug&~options'&>
3661 .oindex "&%-d%&"
3662 .cindex "debugging" "list of selectors"
3663 .cindex "debugging" "&%-d%& option"
3664 This option causes debugging information to be written to the standard
3665 error stream. It is restricted to admin users because debugging output may show
3666 database queries that contain password information. Also, the details of users'
3667 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3668 writes an error message to the standard error stream and exits with a non-zero
3669 return code.
3670
3671 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3672 standard debugging data is output. This can be reduced, or increased to include
3673 some more rarely needed information, by directly following &%-d%& with a string
3674 made up of names preceded by plus or minus characters. These add or remove sets
3675 of debugging data, respectively. For example, &%-d+filter%& adds filter
3676 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3677 no spaces are allowed in the debug setting. The available debugging categories
3678 are:
3679 .itable none 0 0 2 20* left 80* left
3680 .irow acl            "ACL interpretation"
3681 .irow auth           "authenticators"
3682 .irow deliver        "general delivery logic"
3683 .irow dns            "DNS lookups (see also resolver)"
3684 .irow dnsbl          "DNS black list (aka RBL) code"
3685 .irow exec           "arguments for &[execv()]& calls"
3686 .irow expand         "detailed debugging for string expansions"
3687 .irow filter         "filter handling"
3688 .irow hints_lookup   "hints data lookups"
3689 .irow host_lookup    "all types of name-to-IP address handling"
3690 .irow ident          "ident lookup"
3691 .irow interface      "lists of local interfaces"
3692 .irow lists          "matching things in lists"
3693 .irow load           "system load checks"
3694 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3695                     &<<CHAPlocalscan>>&)"
3696 .irow lookup         "general lookup code and all lookups"
3697 .irow memory         "memory handling"
3698 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3699 .irow pid            "modifier: add pid to debug output lines"
3700 .irow process_info   "setting info for the process log"
3701 .irow queue_run      "queue runs"
3702 .irow receive        "general message reception logic"
3703 .irow resolver       "turn on the DNS resolver's debugging output"
3704 .irow retry          "retry handling"
3705 .irow rewrite        "address rewriting""
3706 .irow route          "address routing"
3707 .irow timestamp      "modifier: add timestamp to debug output lines"
3708 .irow tls            "TLS logic"
3709 .irow transport      "transports"
3710 .irow uid            "changes of uid/gid and looking up uid/gid"
3711 .irow verify         "address verification logic"
3712 .irow all            "almost all of the above (see below), and also &%-v%&"
3713 .endtable
3714 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3715 for &`-all`&. The reason for this is that &`+all`& is something that people
3716 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3717 is included, an awful lot of output that is very rarely of interest is
3718 generated, so it now has to be explicitly requested. However, &`-all`& does
3719 turn everything off.
3720
3721 .cindex "resolver, debugging output"
3722 .cindex "DNS resolver, debugging output"
3723 The &`resolver`& option produces output only if the DNS resolver was compiled
3724 with DEBUG enabled. This is not the case in some operating systems. Also,
3725 unfortunately, debugging output from the DNS resolver is written to stdout
3726 rather than stderr.
3727
3728 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3729 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3730 However, the &`pid`& selector is forced when debugging is turned on for a
3731 daemon, which then passes it on to any re-executed Exims. Exim also
3732 automatically adds the pid to debug lines when several remote deliveries are
3733 run in parallel.
3734
3735 The &`timestamp`& selector causes the current time to be inserted at the start
3736 of all debug output lines. This can be useful when trying to track down delays
3737 in processing.
3738
3739 .cindex debugging "UTF-8 in"
3740 .cindex UTF-8 "in debug output"
3741 The &`noutf8`& selector disables the use of
3742 UTF-8 line-drawing characters to group related information.
3743 When disabled. ascii-art is used instead.
3744 Using the &`+all`& option does not set this modifier,
3745
3746 If the &%debug_print%& option is set in any driver, it produces output whenever
3747 any debugging is selected, or if &%-v%& is used.
3748
3749 .vitem &%-dd%&<&'debug&~options'&>
3750 .oindex "&%-dd%&"
3751 This option behaves exactly like &%-d%& except when used on a command that
3752 starts a daemon process. In that case, debugging is turned off for the
3753 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3754 behaviour of the daemon without creating as much output as full debugging does.
3755
3756 .cmdopt -dropcr
3757 This is an obsolete option that is now a no-op. It used to affect the way Exim
3758 handled CR and LF characters in incoming messages. What happens now is
3759 described in section &<<SECTlineendings>>&.
3760
3761 .cmdopt -E
3762 .cindex "bounce message" "generating"
3763 This option specifies that an incoming message is a locally-generated delivery
3764 failure report. It is used internally by Exim when handling delivery failures
3765 and is not intended for external use. Its only effect is to stop Exim
3766 generating certain messages to the postmaster, as otherwise message cascades
3767 could occur in some situations. As part of the same option, a message id may
3768 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3769 new message contains the id, following &"R="&, as a cross-reference.
3770
3771 .vitem &%-e%&&'x'&
3772 .oindex "&%-e%&&'x'&"
3773 There are a number of Sendmail options starting with &%-oe%& which seem to be
3774 called by various programs without the leading &%o%& in the option. For
3775 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3776 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3777
3778 .cmdopt -F <&'string'&>
3779 .cindex "sender" "name"
3780 .cindex "name" "of sender"
3781 This option sets the sender's full name for use when a locally-generated
3782 message is being accepted. In the absence of this option, the user's &'gecos'&
3783 entry from the password data is used. As users are generally permitted to alter
3784 their &'gecos'& entries, no security considerations are involved. White space
3785 between &%-F%& and the <&'string'&> is optional.
3786
3787 .cmdopt -f <&'address'&>
3788 .cindex "sender" "address"
3789 .cindex "address" "sender"
3790 .cindex "trusted users"
3791 .cindex "envelope from"
3792 .cindex "envelope sender"
3793 .cindex "user" "trusted"
3794 This option sets the address of the envelope sender of a locally-generated
3795 message (also known as the return path). The option can normally be used only
3796 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3797 users to use it.
3798
3799 Processes running as root or the Exim user are always trusted. Other
3800 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3801 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3802 of a local message is set to the caller's login name at the default qualify
3803 domain.
3804
3805 There is one exception to the restriction on the use of &%-f%&: an empty sender
3806 can be specified by any user, trusted or not, to create a message that can
3807 never provoke a bounce. An empty sender can be specified either as an empty
3808 string, or as a pair of angle brackets with nothing between them, as in these
3809 examples of shell commands:
3810 .code
3811 exim -f '<>' user@domain
3812 exim -f "" user@domain
3813 .endd
3814 In addition, the use of &%-f%& is not restricted when testing a filter file
3815 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3816 &%-bv%& options.
3817
3818 Allowing untrusted users to change the sender address does not of itself make
3819 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3820 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3821 though this can be overridden by setting &%no_local_from_check%&.
3822
3823 White
3824 .cindex "&""From""& line"
3825 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3826 given as two arguments or one combined argument). The sender of a
3827 locally-generated message can also be set (when permitted) by an initial
3828 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3829 if &%-f%& is also present, it overrides &"From&~"&.
3830
3831 .cmdopt -G
3832 .cindex "submission fixups, suppressing (command-line)"
3833 This option is equivalent to an ACL applying:
3834 .code
3835 control = suppress_local_fixups
3836 .endd
3837 for every message received.  Note that Sendmail will complain about such
3838 bad formatting, where Exim silently just does not fix it up.  This may change
3839 in future.
3840
3841 As this affects audit information, the caller must be a trusted user to use
3842 this option.
3843
3844 .cmdopt -h <&'number'&>
3845 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3846 This option is accepted for compatibility with Sendmail, but has no effect. (In
3847 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3848 headers.)
3849
3850 .cmdopt -i
3851 .cindex "Solaris" "&'mail'& command"
3852 .cindex "dot" "in incoming non-SMTP message"
3853 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3854 line by itself should not terminate an incoming, non-SMTP message.
3855 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3856 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3857 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3858 by its &'mailx'& command.
3859
3860 .cmdopt -L <&'tag'&>
3861 .cindex "syslog" "process name; set with flag"
3862 This option is equivalent to setting &%syslog_processname%& in the config
3863 file and setting &%log_file_path%& to &`syslog`&.
3864 Its use is restricted to administrators.  The configuration file has to be
3865 read and parsed, to determine access rights, before this is set and takes
3866 effect, so early configuration file errors will not honour this flag.
3867
3868 The tag should not be longer than 32 characters.
3869
3870 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3871 .cindex "forcing delivery"
3872 .cindex "delivery" "forcing attempt"
3873 .cindex "frozen messages" "forcing delivery"
3874 This option requests Exim to run a delivery attempt on each message in turn. If
3875 any of the messages are frozen, they are automatically thawed before the
3876 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3877 and &%hold_domains%& are ignored.
3878
3879 Retry
3880 .cindex "hints database" "overriding retry hints"
3881 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3882 the normal retry time has not yet been reached. This option requires the caller
3883 to be an admin user. However, there is an option called &%prod_requires_admin%&
3884 which can be set false to relax this restriction (and also the same requirement
3885 for the &%-q%&, &%-R%&, and &%-S%& options).
3886
3887 The deliveries happen synchronously, that is, the original Exim process does
3888 not terminate until all the delivery attempts have finished. No output is
3889 produced unless there is a serious error. If you want to see what is happening,
3890 use the &%-v%& option as well, or inspect Exim's main log.
3891
3892 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3893 .cindex "message" "adding recipients"
3894 .cindex "recipient" "adding"
3895 This option requests Exim to add the addresses to the list of recipients of the
3896 message (&"ar"& for &"add recipients"&). The first argument must be a message
3897 id, and the remaining ones must be email addresses. However, if the message is
3898 active (in the middle of a delivery attempt), it is not altered. This option
3899 can be used only by an admin user.
3900
3901 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3902         &~<&'host&~IP'&>&&&
3903         &~<&'sequence&~number'&>&&&
3904         &~<&'message&~id'&>"
3905 .oindex "&%-MC%&"
3906 .cindex "SMTP" "passed connection"
3907 .cindex "SMTP" "multiple deliveries"
3908 .cindex "multiple SMTP deliveries"
3909 This option is not intended for use by external callers. It is used internally
3910 by Exim to invoke another instance of itself to deliver a waiting message using
3911 an existing SMTP connection, which is passed as the standard input. Details are
3912 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3913 must be root or the Exim user in order to use it.
3914
3915 .cmdopt -MCA
3916 This option is not intended for use by external callers. It is used internally
3917 by Exim in conjunction with the &%-MC%& option. It signifies that the
3918 connection to the remote host has been authenticated.
3919
3920 .cmdopt -MCD
3921 This option is not intended for use by external callers. It is used internally
3922 by Exim in conjunction with the &%-MC%& option. It signifies that the
3923 remote host supports the ESMTP &_DSN_& extension.
3924
3925 .cmdopt -MCd
3926 This option is not intended for use by external callers. It is used internally
3927 by Exim in conjunction with the &%-d%& option
3928 to pass on an information string on the purpose of the process.
3929
3930 .cmdopt -MCG <&'queue&~name'&>
3931 This option is not intended for use by external callers. It is used internally
3932 by Exim in conjunction with the &%-MC%& option. It signifies that an
3933 alternate queue is used, named by the following argument.
3934
3935 .cmdopt -MCK
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 a
3938 remote host supports the ESMTP &_CHUNKING_& extension.
3939
3940 .cmdopt -MCL
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 server to
3943 which Exim is connected advertised limits on numbers of mails, recipients or
3944 recipient domains.
3945 The limits are given by the following three arguments.
3946
3947 .cmdopt -MCP
3948 This option is not intended for use by external callers. It is used internally
3949 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3950 which Exim is connected supports pipelining.
3951
3952 .cmdopt -MCp
3953 This option is not intended for use by external callers. It is used internally
3954 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3955 t a remote server is via a SOCKS proxy, using addresses and ports given by
3956 the following four arguments.
3957
3958 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3959 This option is not intended for use by external callers. It is used internally
3960 by Exim in conjunction with the &%-MC%& option when the original delivery was
3961 started by a queue runner. It passes on the process id of the queue runner,
3962 together with the file descriptor number of an open pipe. Closure of the pipe
3963 signals the final completion of the sequence of processes that are passing
3964 messages through the same SMTP connection.
3965
3966 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3967 This option is not intended for use by external callers. It is used internally
3968 by Exim to implement quota checking for local users.
3969
3970 .cmdopt -MCS
3971 This option is not intended for use by external callers. It is used internally
3972 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3973 ESMTP SIZE option should be used on messages delivered down the existing
3974 connection.
3975
3976 .cmdopt -MCT
3977 This option is not intended for use by external callers. It is used internally
3978 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3979 host to which Exim is connected supports TLS encryption.
3980
3981 .vitem &%-MCr%&&~<&'SNI'&> &&&
3982        &%-MCs%&&~<&'SNI'&>
3983 .oindex "&%-MCs%&"
3984 .oindex "&%-MCr%&"
3985 These options are not intended for use by external callers. It is used internally
3986 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3987 a TLS Server Name Indication was sent as part of the channel establishment.
3988 The argument gives the SNI string.
3989 The "r" variant indicates a DANE-verified connection.
3990
3991 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3992 This option is not intended for use by external callers. It is used internally
3993 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3994 connection is being proxied by a parent process for handling TLS encryption.
3995 The arguments give the local address and port being proxied, and the TLS cipher.
3996
3997 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
3998 .cindex "hints database" "not overridden by &%-Mc%&"
3999 .cindex "delivery" "manually started &-- not forced"
4000 This option requests Exim to run a delivery attempt on each message, in turn,
4001 but unlike the &%-M%& option, it does check for retry hints, and respects any
4002 that are found. This option is not very useful to external callers. It is
4003 provided mainly for internal use by Exim when it needs to re-invoke itself in
4004 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
4005 However, &%-Mc%& can be useful when testing, in order to run a delivery that
4006 respects retry times and other options such as &%hold_domains%& that are
4007 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
4008 If you want to run a specific delivery as if in a queue run, you should use
4009 &%-q%& with a message id argument. A distinction between queue run deliveries
4010 and other deliveries is made in one or two places.
4011
4012 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
4013 .cindex "message" "changing sender"
4014 .cindex "sender" "changing"
4015 This option requests Exim to change the sender address in the message to the
4016 given address, which must be a fully qualified address or &"<>"& (&"es"& for
4017 &"edit sender"&). There must be exactly two arguments. The first argument must
4018 be a message id, and the second one an email address. However, if the message
4019 is active (in the middle of a delivery attempt), its status is not altered.
4020 This option can be used only by an admin user.
4021
4022 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
4023 .cindex "freezing messages"
4024 .cindex "message" "manually freezing"
4025 This option requests Exim to mark each listed message as &"frozen"&. This
4026 prevents any delivery attempts taking place until the message is &"thawed"&,
4027 either manually or as a result of the &%auto_thaw%& configuration option.
4028 However, if any of the messages are active (in the middle of a delivery
4029 attempt), their status is not altered. This option can be used only by an admin
4030 user.
4031
4032 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
4033 .cindex "giving up on messages"
4034 .cindex "message" "abandoning delivery attempts"
4035 .cindex "delivery" "abandoning further attempts"
4036 This option requests Exim to give up trying to deliver the listed messages,
4037 including any that are frozen. However, if any of the messages are active,
4038 their status is not altered. For non-bounce messages, a delivery error message
4039 is sent to the sender.
4040 Bounce messages are just discarded. This option can be used only by an admin
4041 user.
4042
4043 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4044 .cindex queue named
4045 .cindex "named queues" "moving messages"
4046 .cindex "queue" "moving messages"
4047 This option requests that each listed message be moved from its current
4048 queue to the given named queue.
4049 The destination queue name argument is required, but can be an empty
4050 string to define the default queue.
4051 If the messages are not currently located in the default queue,
4052 a &%-qG<name>%& option will be required to define the source queue.
4053
4054 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
4055 .cindex "delivery" "cancelling all"
4056 This option requests Exim to mark all the recipient addresses in the messages
4057 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4058 message is active (in the middle of a delivery attempt), its status is not
4059 altered. This option can be used only by an admin user.
4060
4061 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4062 .cindex "delivery" "cancelling by address"
4063 .cindex "recipient" "removing"
4064 .cindex "removing recipients"
4065 This option requests Exim to mark the given addresses as already delivered
4066 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4067 the remaining ones must be email addresses. These are matched to recipient
4068 addresses in the message in a case-sensitive manner. If the message is active
4069 (in the middle of a delivery attempt), its status is not altered. This option
4070 can be used only by an admin user.
4071
4072 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4073 .cindex "removing messages"
4074 .cindex "abandoning mail"
4075 .cindex "message" "manually discarding"
4076 This option requests Exim to remove the given messages from the queue. No
4077 bounce messages are sent; each message is simply forgotten. However, if any of
4078 the messages are active, their status is not altered. This option can be used
4079 only by an admin user or by the user who originally caused the message to be
4080 placed in the queue.
4081
4082 . .new
4083 . .vitem &%-MS%&
4084 . .oindex "&%-MS%&"
4085 . .cindex REQUIRETLS
4086 . This option is used to request REQUIRETLS processing on the message.
4087 . It is used internally by Exim in conjunction with -E when generating
4088 . a bounce message.
4089 . .wen
4090
4091 .cmdopt -Mset <&'message&~id'&>
4092 .cindex "testing" "string expansion"
4093 .cindex "expansion" "testing"
4094 This option is useful only in conjunction with &%-be%& (that is, when testing
4095 string expansions). Exim loads the given message from its spool before doing
4096 the test expansions, thus setting message-specific variables such as
4097 &$message_size$& and the header variables. The &$recipients$& variable is made
4098 available. This feature is provided to make it easier to test expansions that
4099 make use of these variables. However, this option can be used only by an admin
4100 user. See also &%-bem%&.
4101
4102 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4103 .cindex "thawing messages"
4104 .cindex "unfreezing messages"
4105 .cindex "frozen messages" "thawing"
4106 .cindex "message" "thawing frozen"
4107 This option requests Exim to &"thaw"& any of the listed messages that are
4108 &"frozen"&, so that delivery attempts can resume. However, if any of the
4109 messages are active, their status is not altered. This option can be used only
4110 by an admin user.
4111
4112 .cmdopt -Mvb <&'message&~id'&>
4113 .cindex "listing" "message body"
4114 .cindex "message" "listing body of"
4115 This option causes the contents of the message body (-D) spool file to be
4116 written to the standard output. This option can be used only by an admin user.
4117
4118 .cmdopt -Mvc <&'message&~id'&>
4119 .cindex "message" "listing in RFC 2822 format"
4120 .cindex "listing" "message in RFC 2822 format"
4121 This option causes a copy of the complete message (header lines plus body) to
4122 be written to the standard output in RFC 2822 format. This option can be used
4123 only by an admin user.
4124
4125 .cmdopt -Mvh <&'message&~id'&>
4126 .cindex "listing" "message headers"
4127 .cindex "header lines" "listing"
4128 .cindex "message" "listing header lines"
4129 This option causes the contents of the message headers (-H) spool file to be
4130 written to the standard output. This option can be used only by an admin user.
4131
4132 .cmdopt -Mvl <&'message&~id'&>
4133 .cindex "listing" "message log"
4134 .cindex "message" "listing message log"
4135 This option causes the contents of the message log spool file to be written to
4136 the standard output. This option can be used only by an admin user.
4137
4138 .cmdopt -m
4139 This is a synonym for &%-om%& that is accepted by Sendmail
4140 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4141 p. 1M-258), so Exim treats it that way too.
4142
4143 .cmdopt -N
4144 .cindex "debugging" "&%-N%& option"
4145 .cindex "debugging" "suppressing delivery"
4146 This is a debugging option that inhibits delivery of a message at the transport
4147 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4148 it just doesn't actually transport the message, but instead behaves as if it
4149 had successfully done so. However, it does not make any updates to the retry
4150 database, and the log entries for deliveries are flagged with &"*>"& rather
4151 than &"=>"&.
4152
4153 Because &%-N%& discards any message to which it applies, only root or the Exim
4154 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4155 words, an ordinary user can use it only when supplying an incoming message to
4156 which it will apply. Although transportation never fails when &%-N%& is set, an
4157 address may be deferred because of a configuration problem on a transport, or a
4158 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4159 the message, and applies to any subsequent delivery attempts that may happen
4160 for that message.
4161
4162 .cmdopt -n
4163 This option is interpreted by Sendmail to mean &"no aliasing"&.
4164 For normal modes of operation, it is ignored by Exim.
4165 When combined with &%-bP%& it makes the output more terse (suppresses
4166 option names, environment values and config pretty printing).
4167
4168 .cmdopt -O <&'data'&>
4169 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4170 Exim.
4171
4172 .cmdopt -oA <&'file&~name'&>
4173 .cindex "Sendmail compatibility" "&%-oA%& option"
4174 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4175 alternative alias filename. Exim handles &%-bi%& differently; see the
4176 description above.
4177
4178 .cmdopt -oB <&'n'&>
4179 .cindex "SMTP" "passed connection"
4180 .cindex "SMTP" "multiple deliveries"
4181 .cindex "multiple SMTP deliveries"
4182 This is a debugging option which limits the maximum number of messages that can
4183 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4184 transport. If <&'n'&> is omitted, the limit is set to 1.
4185
4186 .cmdopt -odb
4187 .cindex "background delivery"
4188 .cindex "delivery" "in the background"
4189 This option applies to all modes in which Exim accepts incoming messages,
4190 including the listening daemon. It requests &"background"& delivery of such
4191 messages, which means that the accepting process automatically starts a
4192 delivery process for each message received, but does not wait for the delivery
4193 processes to finish.
4194
4195 When all the messages have been received, the reception process exits,
4196 leaving the delivery processes to finish in their own time. The standard output
4197 and error streams are closed at the start of each delivery process.
4198 This is the default action if none of the &%-od%& options are present.
4199
4200 If one of the queueing options in the configuration file
4201 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4202 overrides it if &%queue_only_override%& is set true, which is the default
4203 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4204
4205 .cmdopt -odf
4206 .cindex "foreground delivery"
4207 .cindex "delivery" "in the foreground"
4208 This option requests &"foreground"& (synchronous) delivery when Exim has
4209 accepted a locally-generated message. (For the daemon it is exactly the same as
4210 &%-odb%&.) A delivery process is automatically started to deliver the message,
4211 and Exim waits for it to complete before proceeding.
4212
4213 The original Exim reception process does not finish until the delivery
4214 process for the final message has ended. The standard error stream is left open
4215 during deliveries.
4216
4217 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4218 false and one of the queueing options in the configuration file is in effect.
4219
4220 If there is a temporary delivery error during foreground delivery, the
4221 message is left in the queue for later delivery, and the original reception
4222 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4223 restricted configuration that never queues messages.
4224
4225
4226 .cmdopt -odi
4227 This option is synonymous with &%-odf%&. It is provided for compatibility with
4228 Sendmail.
4229
4230 .cmdopt -odq
4231 .cindex "non-immediate delivery"
4232 .cindex "delivery" "suppressing immediate"
4233 .cindex "queueing incoming messages"
4234 This option applies to all modes in which Exim accepts incoming messages,
4235 including the listening daemon. It specifies that the accepting process should
4236 not automatically start a delivery process for each message received. Messages
4237 are placed in the queue, and remain there until a subsequent queue runner
4238 process encounters them. There are several configuration options (such as
4239 &%queue_only%&) that can be used to queue incoming messages under certain
4240 conditions. This option overrides all of them and also &%-odqs%&. It always
4241 forces queueing.
4242
4243 .cmdopt -odqs
4244 .cindex "SMTP" "delaying delivery"
4245 .cindex "first pass routing"
4246 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4247 However, like &%-odb%& and &%-odi%&, this option has no effect if
4248 &%queue_only_override%& is false and one of the queueing options in the
4249 configuration file is in effect.
4250
4251 When &%-odqs%& does operate, a delivery process is started for each incoming
4252 message, in the background by default, but in the foreground if &%-odi%& is
4253 also present. The recipient addresses are routed, and local deliveries are done
4254 in the normal way. However, if any SMTP deliveries are required, they are not
4255 done at this time, so the message remains in the queue until a subsequent queue
4256 runner process encounters it. Because routing was done, Exim knows which
4257 messages are waiting for which hosts, and so a number of messages for the same
4258 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4259 configuration option has the same effect for specific domains. See also the
4260 &%-qq%& option.
4261
4262 .cmdopt -oee
4263 .cindex "error" "reporting"
4264 If an error is detected while a non-SMTP message is being received (for
4265 example, a malformed address), the error is reported to the sender in a mail
4266 message.
4267
4268 .cindex "return code" "for &%-oee%&"
4269 Provided
4270 this error message is successfully sent, the Exim receiving process
4271 exits with a return code of zero. If not, the return code is 2 if the problem
4272 is that the original message has no recipients, or 1 for any other error.
4273 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4274
4275 .cmdopt -oem
4276 .cindex "error" "reporting"
4277 .cindex "return code" "for &%-oem%&"
4278 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4279 return code, whether or not the error message was successfully sent.
4280 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4281
4282 .cmdopt -oep
4283 .cindex "error" "reporting"
4284 If an error is detected while a non-SMTP message is being received, the
4285 error is reported by writing a message to the standard error file (stderr).
4286 .cindex "return code" "for &%-oep%&"
4287 The return code is 1 for all errors.
4288
4289 .cmdopt -oeq
4290 .cindex "error" "reporting"
4291 This option is supported for compatibility with Sendmail, but has the same
4292 effect as &%-oep%&.
4293
4294 .cmdopt -oew
4295 .cindex "error" "reporting"
4296 This option is supported for compatibility with Sendmail, but has the same
4297 effect as &%-oem%&.
4298
4299 .cmdopt -oi
4300 .cindex "dot" "in incoming non-SMTP message"
4301 This option, which has the same effect as &%-i%&, specifies that a dot on a
4302 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4303 single dot does terminate, though Exim does no special processing for other
4304 lines that start with a dot. This option is set by default if Exim is called as
4305 &'rmail'&. See also &%-ti%&.
4306
4307 .cmdopt -oitrue
4308 This option is treated as synonymous with &%-oi%&.
4309
4310 .cmdopt -oMa <&'host&~address'&>
4311 .cindex "sender" "host address, specifying for local message"
4312 A number of options starting with &%-oM%& can be used to set values associated
4313 with remote hosts on locally-submitted messages (that is, messages not received
4314 over TCP/IP). These options can be used by any caller in conjunction with the
4315 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4316 other circumstances, they are ignored unless the caller is trusted.
4317
4318 The &%-oMa%& option sets the sender host address. This may include a port
4319 number at the end, after a full stop (period). For example:
4320 .code
4321 exim -bs -oMa 10.9.8.7.1234
4322 .endd
4323 An alternative syntax is to enclose the IP address in square brackets,
4324 followed by a colon and the port number:
4325 .code
4326 exim -bs -oMa [10.9.8.7]:1234
4327 .endd
4328 The IP address is placed in the &$sender_host_address$& variable, and the
4329 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4330 are present on the command line, the sender host IP address is taken from
4331 whichever one is last.
4332
4333 .cmdopt -oMaa <&'name'&>
4334 .cindex "authentication" "name, specifying for local message"
4335 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4336 option sets the value of &$sender_host_authenticated$& (the authenticator
4337 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4338 This option can be used with &%-bh%& and &%-bs%& to set up an
4339 authenticated SMTP session without actually using the SMTP AUTH command.
4340
4341 .cmdopt -oMai <&'string'&>
4342 .cindex "authentication" "id, specifying for local message"
4343 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4344 option sets the value of &$authenticated_id$& (the id that was authenticated).
4345 This overrides the default value (the caller's login id, except with &%-bh%&,
4346 where there is no default) for messages from local sources. See chapter
4347 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4348
4349 .cmdopt -oMas <&'address'&>
4350 .cindex "authentication" "sender, specifying for local message"
4351 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4352 option sets the authenticated sender value in &$authenticated_sender$&. It
4353 overrides the sender address that is created from the caller's login id for
4354 messages from local sources, except when &%-bh%& is used, when there is no
4355 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4356 specified on a MAIL command overrides this value. See chapter
4357 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4358
4359 .cmdopt -oMi <&'interface&~address'&>
4360 .cindex "interface" "address, specifying for local message"
4361 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4362 option sets the IP interface address value. A port number may be included,
4363 using the same syntax as for &%-oMa%&. The interface address is placed in
4364 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4365
4366 .cmdopt -oMm <&'message&~reference'&>
4367 .cindex "message reference" "message reference, specifying for local message"
4368 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4369 option sets the message reference, e.g. message-id, and is logged during
4370 delivery. This is useful when some kind of audit trail is required to tie
4371 messages together. The format of the message reference is checked and will
4372 abort if the format is invalid. The option will only be accepted if exim is
4373 running in trusted mode, not as any regular user.
4374
4375 The best example of a message reference is when Exim sends a bounce message.
4376 The message reference is the message-id of the original message for which Exim
4377 is sending the bounce.
4378
4379 .cmdopt -oMr <&'protocol&~name'&>
4380 .cindex "protocol, specifying for local message"
4381 .vindex "&$received_protocol$&"
4382 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4383 option sets the received protocol value that is stored in
4384 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4385 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4386 SMTP protocol names (see the description of &$received_protocol$& in section
4387 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4388 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4389 be set by &%-oMr%&. Repeated use of this option is not supported.
4390
4391 .cmdopt -oMs <&'host&~name'&>
4392 .cindex "sender" "host name, specifying for local message"
4393 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4394 option sets the sender host name in &$sender_host_name$&. When this option is
4395 present, Exim does not attempt to look up a host name from an IP address; it
4396 uses the name it is given.
4397
4398 .cmdopt -oMt <&'ident&~string'&>
4399 .cindex "sender" "ident string, specifying for local message"
4400 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4401 option sets the sender ident value in &$sender_ident$&. The default setting for
4402 local callers is the login id of the calling process, except when &%-bh%& is
4403 used, when there is no default.
4404
4405 .cmdopt -om
4406 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4407 In Sendmail, this option means &"me too"&, indicating that the sender of a
4408 message should receive a copy of the message if the sender appears in an alias
4409 expansion. Exim always does this, so the option does nothing.
4410
4411 .cmdopt -oo
4412 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4413 This option is ignored. In Sendmail it specifies &"old style headers"&,
4414 whatever that means.
4415
4416 .cmdopt -oP <&'path'&>
4417 .cindex "pid (process id)" "of daemon"
4418 .cindex "daemon" "process id (pid)"
4419 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4420 value. The option specifies the file to which the process id of the daemon is
4421 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4422 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4423 because in those cases, the normal pid file is not used.
4424
4425 .cmdopt -oPX
4426 .cindex "pid (process id)" "of daemon"
4427 .cindex "daemon" "process id (pid)"
4428 This option is not intended for general use.
4429 The daemon uses it when terminating due to a SIGTEM, possibly in
4430 combination with &%-oP%&&~<&'path'&>.
4431 It causes the pid file to be removed.
4432
4433 .cmdopt -or <&'time'&>
4434 .cindex "timeout" "for non-SMTP input"
4435 This option sets a timeout value for incoming non-SMTP messages. If it is not
4436 set, Exim will wait forever for the standard input. The value can also be set
4437 by the &%receive_timeout%& option. The format used for specifying times is
4438 described in section &<<SECTtimeformat>>&.
4439
4440 .cmdopt -os <&'time'&>
4441 .cindex "timeout" "for SMTP input"
4442 .cindex "SMTP" "input timeout"
4443 This option sets a timeout value for incoming SMTP messages. The timeout
4444 applies to each SMTP command and block of data. The value can also be set by
4445 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4446 for specifying times is described in section &<<SECTtimeformat>>&.
4447
4448 .cmdopt -ov
4449 This option has exactly the same effect as &%-v%&.
4450
4451 .cmdopt -oX <&'number&~or&~string'&>
4452 .cindex "TCP/IP" "setting listening ports"
4453 .cindex "TCP/IP" "setting listening interfaces"
4454 .cindex "port" "receiving TCP/IP"
4455 This option is relevant only when the &%-bd%& (start listening daemon) option
4456 is also given. It controls which ports and interfaces the daemon uses. Details
4457 of the syntax, and how it interacts with configuration file options, are given
4458 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4459 file is written unless &%-oP%& is also present to specify a pid filename.
4460
4461 .cmdopt -oY
4462 .cindex "daemon notifier socket"
4463 This option controls the creation of an inter-process communications endpoint
4464 by the Exim daemon.
4465 It is only relevant when the &%-bd%& (start listening daemon) option is also
4466 given.
4467 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4468 option is also present.
4469 If this option is given then the socket will not be created.  This is required
4470 if the system is running multiple daemons, in which case it should
4471 be used on all.
4472 The features supported by the socket will not be available in such cases.
4473
4474 The socket is currently used for
4475 .ilist
4476 fast ramp-up of queue runner processes
4477 .next
4478 caching compiled regexes
4479 .next
4480 obtaining a current queue size
4481 .endlist
4482
4483 .cmdopt -pd
4484 .cindex "Perl" "starting the interpreter"
4485 This option applies when an embedded Perl interpreter is linked with Exim (see
4486 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4487 option, forcing the starting of the interpreter to be delayed until it is
4488 needed.
4489
4490 .cmdopt -ps
4491 .cindex "Perl" "starting the interpreter"
4492 This option applies when an embedded Perl interpreter is linked with Exim (see
4493 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4494 option, forcing the starting of the interpreter to occur as soon as Exim is
4495 started.
4496
4497 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4498 .oindex "&%-p%&"
4499 For compatibility with Sendmail, this option is equivalent to
4500 .display
4501 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4502 .endd
4503 It sets the incoming protocol and host name (for trusted callers). The
4504 host name and its colon can be omitted when only the protocol is to be set.
4505 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4506 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4507 or &`s`& using this option (but that does not seem a real limitation).
4508 Repeated use of this option is not supported.
4509
4510 .cmdopt -q
4511 .cindex "queue runner" "starting manually"
4512 This option is normally restricted to admin users. However, there is a
4513 configuration option called &%prod_requires_admin%& which can be set false to
4514 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4515 and &%-S%& options).
4516
4517 .cindex "queue runner" "description of operation"
4518 If other commandline options do not specify an action,
4519 the &%-q%& option starts one queue runner process. This scans the queue of
4520 waiting messages, and runs a delivery process for each one in turn. It waits
4521 for each delivery process to finish before starting the next one. A delivery
4522 process may not actually do any deliveries if the retry times for the addresses
4523 have not been reached. Use &%-qf%& (see below) if you want to override this.
4524
4525 If
4526 .cindex "SMTP" "passed connection"
4527 .cindex "SMTP" "multiple deliveries"
4528 .cindex "multiple SMTP deliveries"
4529 the delivery process spawns other processes to deliver other messages down
4530 passed SMTP connections, the queue runner waits for these to finish before
4531 proceeding.
4532
4533 When all the queued messages have been considered, the original queue runner
4534 process terminates. In other words, a single pass is made over the waiting
4535 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4536 this to be repeated periodically.
4537
4538 Exim processes the waiting messages in an unpredictable order. It isn't very
4539 random, but it is likely to be different each time, which is all that matters.
4540 If one particular message screws up a remote MTA, other messages to the same
4541 MTA have a chance of getting through if they get tried first.
4542
4543 It is possible to cause the messages to be processed in lexical message id
4544 order, which is essentially the order in which they arrived, by setting the
4545 &%queue_run_in_order%& option, but this is not recommended for normal use.
4546
4547 .vitem &%-q%&<&'qflags'&>
4548 The &%-q%& option may be followed by one or more flag letters that change its
4549 behaviour. They are all optional, but if more than one is present, they must
4550 appear in the correct order. Each flag is described in a separate item below.
4551
4552 .vitem &%-qq...%&
4553 .oindex "&%-qq%&"
4554 .cindex "queue" "double scanning"
4555 .cindex "queue" "routing"
4556 .cindex "routing" "whole queue before delivery"
4557 .cindex "first pass routing"
4558 .cindex "queue runner" "two phase"
4559 An option starting with &%-qq%& requests a two-stage queue run. In the first
4560 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4561 every domain. Addresses are routed, local deliveries happen, but no remote
4562 transports are run.
4563
4564 Performance will be best if the &%queue_run_in_order%& option is false.
4565 If that is so and
4566 the &%queue_fast_ramp%& option is true
4567 and a daemon-notifier socket is available
4568 then in the first phase of the run,
4569 once a threshold number of messages are routed for a given host,
4570 a delivery process is forked in parallel with the rest of the scan.
4571
4572 .cindex "hints database" "remembering routing"
4573 The hints database that remembers which messages are waiting for specific hosts
4574 is updated, as if delivery to those hosts had been deferred.
4575
4576 After the first queue scan complete,
4577 a second, normal queue scan is done, with routing and delivery taking
4578 place as normal.
4579 Messages that are routed to the same host should mostly be
4580 delivered down a single SMTP
4581 .cindex "SMTP" "passed connection"
4582 .cindex "SMTP" "multiple deliveries"
4583 .cindex "multiple SMTP deliveries"
4584 connection because of the hints that were set up during the first queue scan.
4585
4586 Two-phase queue runs should be used on systems which, even intermittently,
4587 have a large queue (such as mailing-list operators).
4588 They may also be useful for hosts that are connected to the Internet
4589 intermittently.
4590
4591 .vitem &%-q[q]i...%&
4592 .oindex "&%-qi%&"
4593 .cindex "queue" "initial delivery"
4594 If the &'i'& flag is present, the queue runner runs delivery processes only for
4595 those messages that haven't previously been tried. (&'i'& stands for &"initial
4596 delivery"&.) This can be helpful if you are putting messages in the queue using
4597 &%-odq%& and want a queue runner just to process the new messages.
4598
4599 .vitem &%-q[q][i]f...%&
4600 .oindex "&%-qf%&"
4601 .cindex "queue" "forcing delivery"
4602 .cindex "delivery" "forcing in queue run"
4603 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4604 message, whereas without &'f'& only those non-frozen addresses that have passed
4605 their retry times are tried.
4606
4607 .vitem &%-q[q][i]ff...%&
4608 .oindex "&%-qff%&"
4609 .cindex "frozen messages" "forcing delivery"
4610 If &'ff'& is present, a delivery attempt is forced for every message, whether
4611 frozen or not.
4612
4613 .vitem &%-q[q][i][f[f]]l%&
4614 .oindex "&%-ql%&"
4615 .cindex "queue" "local deliveries only"
4616 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4617 be done. If a message requires any remote deliveries, it remains in the queue
4618 for later delivery.
4619
4620 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4621 .oindex "&%-qG%&"
4622 .cindex queue named
4623 .cindex "named queues"  "deliver from"
4624 .cindex "queue" "delivering specific messages"
4625 If the &'G'& flag and a name is present, the queue runner operates on the
4626 queue with the given name rather than the default queue.
4627 The name should not contain a &'/'& character.
4628 For a periodic queue run (see below)
4629 append to the name a slash and a time value.
4630
4631 If other commandline options specify an action, a &'-qG<name>'& option
4632 will specify a queue to operate on.
4633 For example:
4634 .code
4635 exim -bp -qGquarantine
4636 mailq -qGquarantine
4637 exim -qGoffpeak -Rf @special.domain.example
4638 .endd
4639
4640 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4641 When scanning the queue, Exim can be made to skip over messages whose ids are
4642 lexically less than a given value by following the &%-q%& option with a
4643 starting message id. For example:
4644 .code
4645 exim -q 0t5C6f-0000c8-00
4646 .endd
4647 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4648 second message id is given, messages whose ids are lexically greater than it
4649 are also skipped. If the same id is given twice, for example,
4650 .code
4651 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4652 .endd
4653 just one delivery process is started, for that message. This differs from
4654 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4655 that it counts as a delivery from a queue run. Note that the selection
4656 mechanism does not affect the order in which the messages are scanned. There
4657 are also other ways of selecting specific sets of messages for delivery in a
4658 queue run &-- see &%-R%& and &%-S%&.
4659
4660 .vitem &%-q%&<&'qflags'&><&'time'&>
4661 .cindex "queue runner" "starting periodically"
4662 .cindex "periodic queue running"
4663 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4664 starting a queue runner process at intervals specified by the given time value
4665 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4666 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4667 single daemon process handles both functions. A common way of starting up a
4668 combined daemon at system boot time is to use a command such as
4669 .code
4670 /usr/exim/bin/exim -bd -q30m
4671 .endd
4672 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4673 process every 30 minutes.
4674
4675 .cindex "named queues" "queue runners"
4676 It is possible to set up runners for multiple named queues within one daemon,
4677 For example:
4678 .code
4679 exim -qGhipri/2m -q10m -qqGmailinglist/1h
4680 .endd
4681
4682 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4683 pid file is written unless one is explicitly requested by the &%-oP%& option.
4684
4685 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4686 .oindex "&%-qR%&"
4687 This option is synonymous with &%-R%&. It is provided for Sendmail
4688 compatibility.
4689
4690 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4691 .oindex "&%-qS%&"
4692 This option is synonymous with &%-S%&.
4693
4694 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4695 .oindex "&%-R%&"
4696 .cindex "queue runner" "for specific recipients"
4697 .cindex "delivery" "to given domain"
4698 .cindex "domain" "delivery to"
4699 The <&'rsflags'&> may be empty, in which case the white space before the string
4700 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4701 which are the possible values for <&'rsflags'&>. White space is required if
4702 <&'rsflags'&> is not empty.
4703
4704 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4705 perform a single queue run, except that, when scanning the messages on the
4706 queue, Exim processes only those that have at least one undelivered recipient
4707 address containing the given string, which is checked in a case-independent
4708 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4709 regular expression; otherwise it is a literal string.
4710
4711 If you want to do periodic queue runs for messages with specific recipients,
4712 you can combine &%-R%& with &%-q%& and a time value. For example:
4713 .code
4714 exim -q25m -R @special.domain.example
4715 .endd
4716 This example does a queue run for messages with recipients in the given domain
4717 every 25 minutes. Any additional flags that are specified with &%-q%& are
4718 applied to each queue run.
4719
4720 Once a message is selected for delivery by this mechanism, all its addresses
4721 are processed. For the first selected message, Exim overrides any retry
4722 information and forces a delivery attempt for each undelivered address. This
4723 means that if delivery of any address in the first message is successful, any
4724 existing retry information is deleted, and so delivery attempts for that
4725 address in subsequently selected messages (which are processed without forcing)
4726 will run. However, if delivery of any address does not succeed, the retry
4727 information is updated, and in subsequently selected messages, the failing
4728 address will be skipped.
4729
4730 .cindex "frozen messages" "forcing delivery"
4731 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4732 all selected messages, not just the first; frozen messages are included when
4733 &'ff'& is present.
4734
4735 The &%-R%& option makes it straightforward to initiate delivery of all messages
4736 to a given domain after a host has been down for some time. When the SMTP
4737 command ETRN is accepted by its ACL (see section &<<SECTETRN>>&), its default
4738 effect is to run Exim with the &%-R%& option, but it can be configured to run
4739 an arbitrary command instead.
4740
4741 .cmdopt -r
4742 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4743
4744 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4745 .oindex "&%-S%&"
4746 .cindex "delivery" "from given sender"
4747 .cindex "queue runner" "for specific senders"
4748 This option acts like &%-R%& except that it checks the string against each
4749 message's sender instead of against the recipients. If &%-R%& is also set, both
4750 conditions must be met for a message to be selected. If either of the options
4751 has &'f'& or &'ff'& in its flags, the associated action is taken.
4752
4753 .cmdopt -Tqt <&'times'&>
4754 This is an option that is exclusively for use by the Exim testing suite. It is not
4755 recognized when Exim is run normally. It allows for the setting up of explicit
4756 &"queue times"& so that various warning/retry features can be tested.
4757
4758 .cmdopt -t
4759 .cindex "recipient" "extracting from header lines"
4760 .chindex Bcc:
4761 .chindex Cc:
4762 .chindex To:
4763 When Exim is receiving a locally-generated, non-SMTP message on its standard
4764 input, the &%-t%& option causes the recipients of the message to be obtained
4765 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4766 from the command arguments. The addresses are extracted before any rewriting
4767 takes place and the &'Bcc:'& header line, if present, is then removed.
4768
4769 .cindex "Sendmail compatibility" "&%-t%& option"
4770 If the command has any arguments, they specify addresses to which the message
4771 is &'not'& to be delivered. That is, the argument addresses are removed from
4772 the recipients list obtained from the headers. This is compatible with Smail 3
4773 and in accordance with the documented behaviour of several versions of
4774 Sendmail, as described in man pages on a number of operating systems (e.g.
4775 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4776 argument addresses to those obtained from the headers, and the O'Reilly
4777 Sendmail book documents it that way. Exim can be made to add argument addresses
4778 instead of subtracting them by setting the option
4779 &%extract_addresses_remove_arguments%& false.
4780
4781 .cindex "&%Resent-%& header lines" "with &%-t%&"
4782 If there are any &%Resent-%& header lines in the message, Exim extracts
4783 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4784 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4785 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4786 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4787
4788 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4789 message is resent several times). The RFC also specifies that they should be
4790 added at the front of the message, and separated by &'Received:'& lines. It is
4791 not at all clear how &%-t%& should operate in the present of multiple sets,
4792 nor indeed exactly what constitutes a &"set"&.
4793 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4794 are often added at the end of the header, and if a message is resent more than
4795 once, it is common for the original set of &%Resent-%& headers to be renamed as
4796 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4797
4798 .cmdopt -ti
4799 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4800 compatibility with Sendmail.
4801
4802 .cmdopt -tls-on-connect
4803 .cindex "TLS" "use without STARTTLS"
4804 .cindex "TLS" "automatic start"
4805 This option is available when Exim is compiled with TLS support. It forces all
4806 incoming SMTP connections to behave as if the incoming port is listed in the
4807 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4808 &<<CHAPTLS>>& for further details.
4809
4810
4811 .cmdopt -U
4812 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4813 Sendmail uses this option for &"initial message submission"&, and its
4814 documentation states that in future releases, it may complain about
4815 syntactically invalid messages rather than fixing them when this flag is not
4816 set. Exim ignores this option.
4817
4818 .cmdopt -v
4819 This option causes Exim to write information to the standard error stream,
4820 describing what it is doing. In particular, it shows the log lines for
4821 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4822 dialogue is shown. Some of the log lines shown may not actually be written to
4823 the log if the setting of &%log_selector%& discards them. Any relevant
4824 selectors are shown with each log line. If none are shown, the logging is
4825 unconditional.
4826
4827 .cmdopt -x
4828 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4829 National Language Support extended characters in the body of the mail item"&).
4830 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4831 this option.
4832
4833 .cmdopt -X <&'logfile'&>
4834 This option is interpreted by Sendmail to cause debug information to be sent
4835 to the named file.  It is ignored by Exim.
4836
4837 .cmdopt -z <&'log-line'&>
4838 This option writes its argument to Exim's logfile.
4839 Use is restricted to administrators; the intent is for operational notes.
4840 Quotes should be used to maintain a multi-word item as a single argument,
4841 under most shells.
4842 .endlist
4843
4844 .ecindex IIDclo1
4845 .ecindex IIDclo2
4846
4847
4848 . ////////////////////////////////////////////////////////////////////////////
4849 . Insert a stylized DocBook comment here, to identify the end of the command
4850 . line options. This is for the benefit of the Perl script that automatically
4851 . creates a man page for the options.
4852 . ////////////////////////////////////////////////////////////////////////////
4853
4854 .literal xml
4855 <!-- === End of command line options === -->
4856 .literal off
4857
4858
4859
4860
4861
4862 . ////////////////////////////////////////////////////////////////////////////
4863 . ////////////////////////////////////////////////////////////////////////////
4864
4865
4866 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4867          "The runtime configuration file"
4868
4869 .cindex "runtime configuration"
4870 .cindex "configuration file" "general description"
4871 .cindex "CONFIGURE_FILE"
4872 .cindex "configuration file" "errors in"
4873 .cindex "error" "in configuration file"
4874 .cindex "return code" "for bad configuration"
4875 Exim uses a single runtime configuration file that is read whenever an Exim
4876 binary is executed. Note that in normal operation, this happens frequently,
4877 because Exim is designed to operate in a distributed manner, without central
4878 control.
4879
4880 If a syntax error is detected while reading the configuration file, Exim
4881 writes a message on the standard error, and exits with a non-zero return code.
4882 The message is also written to the panic log. &*Note*&: Only simple syntax
4883 errors can be detected at this time. The values of any expanded options are
4884 not checked until the expansion happens, even when the expansion does not
4885 actually alter the string.
4886
4887 The name of the configuration file is compiled into the binary for security
4888 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4889 most configurations, this specifies a single file. However, it is permitted to
4890 give a colon-separated list of filenames, in which case Exim uses the first
4891 existing file in the list.
4892
4893 .cindex "EXIM_USER"
4894 .cindex "EXIM_GROUP"
4895 .cindex "CONFIGURE_OWNER"
4896 .cindex "CONFIGURE_GROUP"
4897 .cindex "configuration file" "ownership"
4898 .cindex "ownership" "configuration file"
4899 The runtime configuration file must be owned by root or by the user that is
4900 specified at compile time by the CONFIGURE_OWNER option (if set). The
4901 configuration file must not be world-writeable, or group-writeable unless its
4902 group is the root group or the one specified at compile time by the
4903 CONFIGURE_GROUP option.
4904
4905 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4906 to root, anybody who is able to edit the runtime configuration file has an
4907 easy way to run commands as root. If you specify a user or group in the
4908 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4909 who are members of that group will trivially be able to obtain root privileges.
4910
4911 Up to Exim version 4.72, the runtime configuration file was also permitted to
4912 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4913 since it offered a simple privilege escalation for any attacker who managed to
4914 compromise the Exim user account.
4915
4916 A default configuration file, which will work correctly in simple situations,
4917 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4918 defines just one filename, the installation process copies the default
4919 configuration to a new file of that name if it did not previously exist. If
4920 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4921 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4922 configuration.
4923
4924
4925
4926 .section "Using a different configuration file" "SECID40"
4927 .cindex "configuration file" "alternate"
4928 A one-off alternate configuration can be specified by the &%-C%& command line
4929 option, which may specify a single file or a list of files. However, when
4930 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4931 unless the argument for &%-C%& is identical to the built-in value from
4932 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4933 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4934 is useful mainly for checking the syntax of configuration files before
4935 installing them. No owner or group checks are done on a configuration file
4936 specified by &%-C%&, if root privilege has been dropped.
4937
4938 Even the Exim user is not trusted to specify an arbitrary configuration file
4939 with the &%-C%& option to be used with root privileges, unless that file is
4940 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4941 testing a configuration using &%-C%& right through message reception and
4942 delivery, even if the caller is root. The reception works, but by that time,
4943 Exim is running as the Exim user, so when it re-execs to regain privilege for
4944 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4945 can test reception and delivery using two separate commands (one to put a
4946 message in the queue, using &%-odq%&, and another to do the delivery, using
4947 &%-M%&).
4948
4949 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4950 prefix string with which any file named in a &%-C%& command line option must
4951 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4952 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4953 filename can be used with &%-C%&.
4954
4955 One-off changes to a configuration can be specified by the &%-D%& command line
4956 option, which defines and overrides values for macros used inside the
4957 configuration file. However, like &%-C%&, the use of this option by a
4958 non-privileged user causes Exim to discard its root privilege.
4959 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4960 completely disabled, and its use causes an immediate error exit.
4961
4962 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4963 to declare certain macro names trusted, such that root privilege will not
4964 necessarily be discarded.
4965 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4966 considered safe and, if &%-D%& only supplies macros from this list, and the
4967 values are acceptable, then Exim will not give up root privilege if the caller
4968 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4969 transition mechanism and is expected to be removed in the future.  Acceptable
4970 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4971
4972 Some sites may wish to use the same Exim binary on different machines that
4973 share a file system, but to use different configuration files on each machine.
4974 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4975 looks for a file whose name is the configuration filename followed by a dot
4976 and the machine's node name, as obtained from the &[uname()]& function. If this
4977 file does not exist, the standard name is tried. This processing occurs for
4978 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4979
4980 In some esoteric situations different versions of Exim may be run under
4981 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4982 help with this. See the comments in &_src/EDITME_& for details.
4983
4984
4985
4986 .section "Configuration file format" "SECTconffilfor"
4987 .cindex "configuration file" "format of"
4988 .cindex "format" "configuration file"
4989 Exim's configuration file is divided into a number of different parts. General
4990 option settings must always appear at the start of the file. The other parts
4991 are all optional, and may appear in any order. Each part other than the first
4992 is introduced by the word &"begin"& followed by at least one literal
4993 space, and the name of the part. The optional parts are:
4994
4995 .ilist
4996 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4997 &<<CHAPACL>>&).
4998 .next
4999 .cindex "AUTH" "configuration"
5000 &'authenticators'&: Configuration settings for the authenticator drivers. These
5001 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
5002 .next
5003 &'routers'&: Configuration settings for the router drivers. Routers process
5004 addresses and determine how the message is to be delivered (see chapters
5005 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
5006 .next
5007 &'transports'&: Configuration settings for the transport drivers. Transports
5008 define mechanisms for copying messages to destinations (see chapters
5009 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
5010 .next
5011 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
5012 If there is no retry section, or if it is empty (that is, no retry rules are
5013 defined), Exim will not retry deliveries. In this situation, temporary errors
5014 are treated the same as permanent errors. Retry rules are discussed in chapter
5015 &<<CHAPretry>>&.
5016 .next
5017 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
5018 when new addresses are generated during delivery. Rewriting is discussed in
5019 chapter &<<CHAPrewrite>>&.
5020 .next
5021 &'local_scan'&: Private options for the &[local_scan()]& function. If you
5022 want to use this feature, you must set
5023 .code
5024 LOCAL_SCAN_HAS_OPTIONS=yes
5025 .endd
5026 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5027 facility are given in chapter &<<CHAPlocalscan>>&.
5028 .endlist
5029
5030 .cindex "configuration file" "leading white space in"
5031 .cindex "configuration file" "trailing white space in"
5032 .cindex "white space" "in configuration file"
5033 Leading and trailing white space in configuration lines is always ignored.
5034
5035 Blank lines in the file, and lines starting with a # character (ignoring
5036 leading white space) are treated as comments and are ignored. &*Note*&: A
5037 # character other than at the beginning of a line is not treated specially,
5038 and does not introduce a comment.
5039
5040 Any non-comment line can be continued by ending it with a backslash. Note that
5041 the general rule for white space means that trailing white space after the
5042 backslash and leading white space at the start of continuation
5043 lines is ignored. Comment lines beginning with # (but not empty lines) may
5044 appear in the middle of a sequence of continuation lines.
5045
5046 A convenient way to create a configuration file is to start from the
5047 default, which is supplied in &_src/configure.default_&, and add, delete, or
5048 change settings as required.
5049
5050 The ACLs, retry rules, and rewriting rules have their own syntax which is
5051 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5052 respectively. The other parts of the configuration file have some syntactic
5053 items in common, and these are described below, from section &<<SECTcos>>&
5054 onwards. Before that, the inclusion, macro, and conditional facilities are
5055 described.
5056
5057
5058
5059 .section "File inclusions in the configuration file" "SECID41"
5060 .cindex "inclusions in configuration file"
5061 .cindex "configuration file" "including other files"
5062 .cindex "&`.include`& in configuration file"
5063 .cindex "&`.include_if_exists`& in configuration file"
5064 You can include other files inside Exim's runtime configuration file by
5065 using this syntax:
5066 .display
5067 &`.include`& <&'filename'&>
5068 &`.include_if_exists`& <&'filename'&>
5069 .endd
5070 on a line by itself. Double quotes round the filename are optional. If you use
5071 the first form, a configuration error occurs if the file does not exist; the
5072 second form does nothing for non-existent files.
5073 The first form allows a relative name. It is resolved relative to
5074 the directory of the including file. For the second form an absolute filename
5075 is required.
5076
5077 Includes may be nested to any depth, but remember that Exim reads its
5078 configuration file often, so it is a good idea to keep them to a minimum.
5079 If you change the contents of an included file, you must HUP the daemon,
5080 because an included file is read only when the configuration itself is read.
5081
5082 The processing of inclusions happens early, at a physical line level, so, like
5083 comment lines, an inclusion can be used in the middle of an option setting,
5084 for example:
5085 .code
5086 hosts_lookup = a.b.c \
5087                .include /some/file
5088 .endd
5089 Include processing happens after macro processing (see below). Its effect is to
5090 process the lines of the included file as if they occurred inline where the
5091 inclusion appears.
5092
5093
5094
5095 .section "Macros in the configuration file" "SECTmacrodefs"
5096 .cindex "macro" "description of"
5097 .cindex "configuration file" "macros"
5098 If a line in the main part of the configuration (that is, before the first
5099 &"begin"& line) begins with an upper case letter, it is taken as a macro
5100 definition, and must be of the form
5101 .display
5102 <&'name'&> = <&'rest of line'&>
5103 .endd
5104 The name must consist of letters, digits, and underscores, and need not all be
5105 in upper case, though that is recommended. The rest of the line, including any
5106 continuations, is the replacement text, and has leading and trailing white
5107 space removed. Quotes are not removed. The replacement text can never end with
5108 a backslash character, but this doesn't seem to be a serious limitation.
5109
5110 Macros may also be defined between router, transport, authenticator, or ACL
5111 definitions. They may not, however, be defined within an individual driver or
5112 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5113
5114 .section "Macro substitution" "SECID42"
5115 Once a macro is defined, all subsequent lines in the file (and any included
5116 files) are scanned for the macro name; if there are several macros, the line is
5117 scanned for each, in turn, in the order in which the macros are defined. The
5118 replacement text is not re-scanned for the current macro, though it is scanned
5119 for subsequently defined macros. For this reason, a macro name may not contain
5120 the name of a previously defined macro as a substring. You could, for example,
5121 define
5122 .display
5123 &`ABCD_XYZ = `&<&'something'&>
5124 &`ABCD = `&<&'something else'&>
5125 .endd
5126 but putting the definitions in the opposite order would provoke a configuration
5127 error. Macro expansion is applied to individual physical lines from the file,
5128 before checking for line continuation or file inclusion (see above). If a line
5129 consists solely of a macro name, and the expansion of the macro is empty, the
5130 line is ignored. A macro at the start of a line may turn the line into a
5131 comment line or a &`.include`& line.
5132
5133
5134 .section "Redefining macros" "SECID43"
5135 Once defined, the value of a macro can be redefined later in the configuration
5136 (or in an included file). Redefinition is specified by using &'=='& instead of
5137 &'='&. For example:
5138 .code
5139 MAC =  initial value
5140 ...
5141 MAC == updated value
5142 .endd
5143 Redefinition does not alter the order in which the macros are applied to the
5144 subsequent lines of the configuration file. It is still the same order in which
5145 the macros were originally defined. All that changes is the macro's value.
5146 Redefinition makes it possible to accumulate values. For example:
5147 .code
5148 MAC =  initial value
5149 ...
5150 MAC == MAC and something added
5151 .endd
5152 This can be helpful in situations where the configuration file is built
5153 from a number of other files.
5154
5155 .section "Overriding macro values" "SECID44"
5156 The values set for macros in the configuration file can be overridden by the
5157 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5158 used, unless called by root or the Exim user. A definition on the command line
5159 using the &%-D%& option causes all definitions and redefinitions within the
5160 file to be ignored.
5161
5162
5163
5164 .section "Example of macro usage" "SECID45"
5165 As an example of macro usage, consider a configuration where aliases are looked
5166 up in a MySQL database. It helps to keep the file less cluttered if long
5167 strings such as SQL statements are defined separately as macros, for example:
5168 .code
5169 ALIAS_QUERY = select mailbox from user where \
5170               login='${quote_mysql:$local_part}';
5171 .endd
5172 This can then be used in a &(redirect)& router setting like this:
5173 .code
5174 data = ${lookup mysql{ALIAS_QUERY}}
5175 .endd
5176 In earlier versions of Exim macros were sometimes used for domain, host, or
5177 address lists. In Exim 4 these are handled better by named lists &-- see
5178 section &<<SECTnamedlists>>&.
5179
5180
5181 .section "Builtin macros" "SECTbuiltinmacros"
5182 Exim defines some macros depending on facilities available, which may
5183 differ due to build-time definitions and from one release to another.
5184 All of these macros start with an underscore.
5185 They can be used to conditionally include parts of a configuration
5186 (see below).
5187
5188 The following classes of macros are defined:
5189 .display
5190 &` _HAVE_*                    `&  build-time defines
5191 &` _DRIVER_ROUTER_*           `&  router drivers
5192 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5193 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5194 &` _EXP_COND_*                `&  expansion conditions
5195 &` _EXP_ITEM_*                `&  expansion items
5196 &` _EXP_OP_*                  `&  expansion operators
5197 &` _EXP_VAR_*                 `&  expansion variables
5198 &` _LOG_*                     `&  log_selector values
5199 &` _OPT_MAIN_*                `&  main config options
5200 &` _OPT_ROUTERS_*             `&  generic router options
5201 &` _OPT_TRANSPORTS_*          `&  generic transport options
5202 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5203 &` _OPT_ROUTER_*_*            `&  private router options
5204 &` _OPT_TRANSPORT_*_*         `&  private transport options
5205 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5206 .endd
5207
5208 Use an &"exim -bP macros"& command to get the list of macros.
5209
5210
5211 .section "Conditional skips in the configuration file" "SECID46"
5212 .cindex "configuration file" "conditional skips"
5213 .cindex "&`.ifdef`&"
5214 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5215 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5216 portions of the configuration file. The processing happens whenever the file is
5217 read (that is, when an Exim binary starts to run).
5218
5219 The implementation is very simple. Instances of the first four directives must
5220 be followed by text that includes the names of one or macros. The condition
5221 that is tested is whether or not any macro substitution has taken place in the
5222 line. Thus:
5223 .code
5224 .ifdef AAA
5225 message_size_limit = 50M
5226 .else
5227 message_size_limit = 100M
5228 .endif
5229 .endd
5230 sets a message size limit of 50M if the macro &`AAA`& is defined
5231 (or &`A`& or &`AA`&), and 100M
5232 otherwise. If there is more than one macro named on the line, the condition
5233 is true if any of them are defined. That is, it is an &"or"& condition. To
5234 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5235
5236 Although you can use a macro expansion to generate one of these directives,
5237 it is not very useful, because the condition &"there was a macro substitution
5238 in this line"& will always be true.
5239
5240 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5241 to clarify complicated nestings.
5242
5243
5244
5245 .section "Common option syntax" "SECTcos"
5246 .cindex "common option syntax"
5247 .cindex "syntax of common options"
5248 .cindex "configuration file" "common option syntax"
5249 For the main set of options, driver options, and &[local_scan()]& options,
5250 each setting is on a line by itself, and starts with a name consisting of
5251 lower-case letters and underscores. Many options require a data value, and in
5252 these cases the name must be followed by an equals sign (with optional white
5253 space) and then the value. For example:
5254 .code
5255 qualify_domain = mydomain.example.com
5256 .endd
5257 .cindex "hiding configuration option values"
5258 .cindex "configuration options" "hiding value of"
5259 .cindex "options" "hiding value of"
5260 Some option settings may contain sensitive data, for example, passwords for
5261 accessing databases. To stop non-admin users from using the &%-bP%& command
5262 line option to read these values, you can precede the option settings with the
5263 word &"hide"&. For example:
5264 .code
5265 hide mysql_servers = localhost/users/admin/secret-password
5266 .endd
5267 For non-admin users, such options are displayed like this:
5268 .code
5269 mysql_servers = <value not displayable>
5270 .endd
5271 If &"hide"& is used on a driver option, it hides the value of that option on
5272 all instances of the same driver.
5273
5274 The following sections describe the syntax used for the different data types
5275 that are found in option settings.
5276
5277
5278 .section "Boolean options" "SECID47"
5279 .cindex "format" "boolean"
5280 .cindex "boolean configuration values"
5281 .oindex "&%no_%&&'xxx'&"
5282 .oindex "&%not_%&&'xxx'&"
5283 Options whose type is given as boolean are on/off switches. There are two
5284 different ways of specifying such options: with and without a data value. If
5285 the option name is specified on its own without data, the switch is turned on;
5286 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5287 boolean options may be followed by an equals sign and one of the words
5288 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5289 the following two settings have exactly the same effect:
5290 .code
5291 queue_only
5292 queue_only = true
5293 .endd
5294 The following two lines also have the same (opposite) effect:
5295 .code
5296 no_queue_only
5297 queue_only = false
5298 .endd
5299 You can use whichever syntax you prefer.
5300
5301
5302
5303
5304 .section "Integer values" "SECID48"
5305 .cindex "integer configuration values"
5306 .cindex "format" "integer"
5307 If an option's type is given as &"integer"&, the value can be given in decimal,
5308 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5309 number is assumed. Otherwise, it is treated as an octal number unless it starts
5310 with the characters &"0x"&, in which case the remainder is interpreted as a
5311 hexadecimal number.
5312
5313 If an integer value is followed by the letter K, it is multiplied by 1024; if
5314 it is followed by the letter M, it is multiplied by 1024x1024;
5315 if by the letter G, 1024x1024x1024.
5316 When the values
5317 of integer option settings are output, values which are an exact multiple of
5318 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5319 and M. The printing style is independent of the actual input format that was
5320 used.
5321
5322
5323 .section "Octal integer values" "SECID49"
5324 .cindex "integer format"
5325 .cindex "format" "octal integer"
5326 If an option's type is given as &"octal integer"&, its value is always
5327 interpreted as an octal number, whether or not it starts with the digit zero.
5328 Such options are always output in octal.
5329
5330
5331 .section "Fixed point numbers" "SECID50"
5332 .cindex "fixed point configuration values"
5333 .cindex "format" "fixed point"
5334 If an option's type is given as &"fixed-point"&, its value must be a decimal
5335 integer, optionally followed by a decimal point and up to three further digits.
5336
5337
5338
5339 .section "Time intervals" "SECTtimeformat"
5340 .cindex "time interval" "specifying in configuration"
5341 .cindex "format" "time interval"
5342 A time interval is specified as a sequence of numbers, each followed by one of
5343 the following letters, with no intervening white space:
5344
5345 .table2 30pt
5346 .irow &%s%& seconds
5347 .irow &%m%& minutes
5348 .irow &%h%& hours
5349 .irow &%d%& days
5350 .irow &%w%& weeks
5351 .endtable
5352
5353 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5354 intervals are output in the same format. Exim does not restrict the values; it
5355 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5356
5357
5358
5359 .section "String values" "SECTstrings"
5360 .cindex "string" "format of configuration values"
5361 .cindex "format" "string"
5362 If an option's type is specified as &"string"&, the value can be specified with
5363 or without double-quotes. If it does not start with a double-quote, the value
5364 consists of the remainder of the line plus any continuation lines, starting at
5365 the first character after any leading white space, with trailing white space
5366 removed, and with no interpretation of the characters in the string. Because
5367 Exim removes comment lines (those beginning with #) at an early stage, they can
5368 appear in the middle of a multi-line string. The following two settings are
5369 therefore equivalent:
5370 .code
5371 trusted_users = uucp:mail
5372 trusted_users = uucp:\
5373                 # This comment line is ignored
5374                 mail
5375 .endd
5376 .cindex "string" "quoted"
5377 .cindex "escape characters in quoted strings"
5378 If a string does start with a double-quote, it must end with a closing
5379 double-quote, and any backslash characters other than those used for line
5380 continuation are interpreted as escape characters, as follows:
5381
5382 .table2 100pt
5383 .irow &`\\`&                     "single backslash"
5384 .irow &`\n`&                     "newline"
5385 .irow &`\r`&                     "carriage return"
5386 .irow &`\t`&                     "tab"
5387 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5388 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5389                                    character"
5390 .endtable
5391
5392 If a backslash is followed by some other character, including a double-quote
5393 character, that character replaces the pair.
5394
5395 Quoting is necessary only if you want to make use of the backslash escapes to
5396 insert special characters, or if you need to specify a value with leading or
5397 trailing spaces. These cases are rare, so quoting is almost never needed in
5398 current versions of Exim. In versions of Exim before 3.14, quoting was required
5399 in order to continue lines, so you may come across older configuration files
5400 and examples that apparently quote unnecessarily.
5401
5402
5403 .section "Expanded strings" "SECID51"
5404 .cindex "expansion" "definition of"
5405 Some strings in the configuration file are subjected to &'string expansion'&,
5406 by which means various parts of the string may be changed according to the
5407 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5408 is as just described; in particular, the handling of backslashes in quoted
5409 strings is done as part of the input process, before expansion takes place.
5410 However, backslash is also an escape character for the expander, so any
5411 backslashes that are required for that reason must be doubled if they are
5412 within a quoted configuration string.
5413
5414
5415 .section "User and group names" "SECID52"
5416 .cindex "user name" "format of"
5417 .cindex "format" "user name"
5418 .cindex "groups" "name format"
5419 .cindex "format" "group name"
5420 User and group names are specified as strings, using the syntax described
5421 above, but the strings are interpreted specially. A user or group name must
5422 either consist entirely of digits, or be a name that can be looked up using the
5423 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5424
5425
5426 .section "List construction" "SECTlistconstruct"
5427 .cindex "list" "syntax of in configuration"
5428 .cindex "format" "list item in configuration"
5429 .cindex "string" "list, definition of"
5430 The data for some configuration options is a list of items, with colon as the
5431 default separator. Many of these options are shown with type &"string list"& in
5432 the descriptions later in this document. Others are listed as &"domain list"&,
5433 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5434 are all the same; however, those other than &"string list"& are subject to
5435 particular kinds of interpretation, as described in chapter
5436 &<<CHAPdomhosaddlists>>&.
5437
5438 In all these cases, the entire list is treated as a single string as far as the
5439 input syntax is concerned. The &%trusted_users%& setting in section
5440 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5441 in a list, it must be entered as two colons. Leading and trailing white space
5442 on each item in a list is ignored. This makes it possible to include items that
5443 start with a colon, and in particular, certain forms of IPv6 address. For
5444 example, the list
5445 .code
5446 local_interfaces = 127.0.0.1 : ::::1
5447 .endd
5448 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5449
5450 &*Note*&: Although leading and trailing white space is ignored in individual
5451 list items, it is not ignored when parsing the list. The spaces around the first
5452 colon in the example above are necessary. If they were not there, the list would
5453 be interpreted as the two items 127.0.0.1:: and 1.
5454
5455 .section "Changing list separators" "SECTlistsepchange"
5456 .cindex "list separator" "changing"
5457 .cindex "IPv6" "addresses in lists"
5458 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5459 introduced to allow the separator character to be changed. If a list begins
5460 with a left angle bracket, followed by any punctuation character, that
5461 character is used instead of colon as the list separator. For example, the list
5462 above can be rewritten to use a semicolon separator like this:
5463 .code
5464 local_interfaces = <; 127.0.0.1 ; ::1
5465 .endd
5466 This facility applies to all lists, with the exception of the list in
5467 &%log_file_path%&. It is recommended that the use of non-colon separators be
5468 confined to circumstances where they really are needed.
5469
5470 .cindex "list separator" "newline as"
5471 .cindex "newline" "as list separator"
5472 It is also possible to use newline and other control characters (those with
5473 code values less than 32, plus DEL) as separators in lists. Such separators
5474 must be provided literally at the time the list is processed. For options that
5475 are string-expanded, you can write the separator using a normal escape
5476 sequence. This will be processed by the expander before the string is
5477 interpreted as a list. For example, if a newline-separated list of domains is
5478 generated by a lookup, you can process it directly by a line such as this:
5479 .code
5480 domains = <\n ${lookup mysql{.....}}
5481 .endd
5482 This avoids having to change the list separator in such data. You are unlikely
5483 to want to use a control character as a separator in an option that is not
5484 expanded, because the value is literal text. However, it can be done by giving
5485 the value in quotes. For example:
5486 .code
5487 local_interfaces = "<\n 127.0.0.1 \n ::1"
5488 .endd
5489 Unlike printing character separators, which can be included in list items by
5490 doubling, it is not possible to include a control character as data when it is
5491 set as the separator. Two such characters in succession are interpreted as
5492 enclosing an empty list item.
5493
5494
5495
5496 .section "Empty items in lists" "SECTempitelis"
5497 .cindex "list" "empty item in"
5498 An empty item at the end of a list is always ignored. In other words, trailing
5499 separator characters are ignored. Thus, the list in
5500 .code
5501 senders = user@domain :
5502 .endd
5503 contains only a single item. If you want to include an empty string as one item
5504 in a list, it must not be the last item. For example, this list contains three
5505 items, the second of which is empty:
5506 .code
5507 senders = user1@domain : : user2@domain
5508 .endd
5509 &*Note*&: There must be white space between the two colons, as otherwise they
5510 are interpreted as representing a single colon data character (and the list
5511 would then contain just one item). If you want to specify a list that contains
5512 just one, empty item, you can do it as in this example:
5513 .code
5514 senders = :
5515 .endd
5516 In this case, the first item is empty, and the second is discarded because it
5517 is at the end of the list.
5518
5519
5520
5521
5522 .section "Format of driver configurations" "SECTfordricon"
5523 .cindex "drivers" "configuration format"
5524 There are separate parts in the configuration for defining routers, transports,
5525 and authenticators. In each part, you are defining a number of driver
5526 instances, each with its own set of options. Each driver instance is defined by
5527 a sequence of lines like this:
5528 .display
5529 <&'instance name'&>:
5530   <&'option'&>
5531   ...
5532   <&'option'&>
5533 .endd
5534 In the following example, the instance name is &(localuser)&, and it is
5535 followed by three options settings:
5536 .code
5537 localuser:
5538   driver = accept
5539   check_local_user
5540   transport = local_delivery
5541 .endd
5542 For each driver instance, you specify which Exim code module it uses &-- by the
5543 setting of the &%driver%& option &-- and (optionally) some configuration
5544 settings. For example, in the case of transports, if you want a transport to
5545 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5546 a local file you would use the &(appendfile)& driver. Each of the drivers is
5547 described in detail in its own separate chapter later in this manual.
5548
5549 You can have several routers, transports, or authenticators that are based on
5550 the same underlying driver (each must have a different instance name).
5551
5552 The order in which routers are defined is important, because addresses are
5553 passed to individual routers one by one, in order. The order in which
5554 transports are defined does not matter at all. The order in which
5555 authenticators are defined is used only when Exim, as a client, is searching
5556 them to find one that matches an authentication mechanism offered by the
5557 server.
5558
5559 .cindex "generic options"
5560 .cindex "options" "generic &-- definition of"
5561 Within a driver instance definition, there are two kinds of option: &'generic'&
5562 and &'private'&. The generic options are those that apply to all drivers of the
5563 same type (that is, all routers, all transports or all authenticators). The
5564 &%driver%& option is a generic option that must appear in every definition.
5565 .cindex "private options"
5566 The private options are special for each driver, and none need appear, because
5567 they all have default values.
5568
5569 The options may appear in any order, except that the &%driver%& option must
5570 precede any private options, since these depend on the particular driver. For
5571 this reason, it is recommended that &%driver%& always be the first option.
5572
5573 Driver instance names, which are used for reference in log entries and
5574 elsewhere, can be any sequence of letters, digits, and underscores (starting
5575 with a letter) and must be unique among drivers of the same type. A router and
5576 a transport (for example) can each have the same name, but no two router
5577 instances can have the same name. The name of a driver instance should not be
5578 confused with the name of the underlying driver module. For example, the
5579 configuration lines:
5580 .code
5581 remote_smtp:
5582   driver = smtp
5583 .endd
5584 create an instance of the &(smtp)& transport driver whose name is
5585 &(remote_smtp)&. The same driver code can be used more than once, with
5586 different instance names and different option settings each time. A second
5587 instance of the &(smtp)& transport, with different options, might be defined
5588 thus:
5589 .code
5590 special_smtp:
5591   driver = smtp
5592   port = 1234
5593   command_timeout = 10s
5594 .endd
5595 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5596 these transport instances from routers, and these names would appear in log
5597 lines.
5598
5599 Comment lines may be present in the middle of driver specifications. The full
5600 list of option settings for any particular driver instance, including all the
5601 defaulted values, can be extracted by making use of the &%-bP%& command line
5602 option.
5603
5604
5605
5606
5607
5608
5609 . ////////////////////////////////////////////////////////////////////////////
5610 . ////////////////////////////////////////////////////////////////////////////
5611
5612 .chapter "The default configuration file" "CHAPdefconfil"
5613 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5614 .cindex "default" "configuration file &""walk through""&"
5615 The default configuration file supplied with Exim as &_src/configure.default_&
5616 is sufficient for a host with simple mail requirements. As an introduction to
5617 the way Exim is configured, this chapter &"walks through"& the default
5618 configuration, giving brief explanations of the settings. Detailed descriptions
5619 of the options are given in subsequent chapters. The default configuration file
5620 itself contains extensive comments about ways you might want to modify the
5621 initial settings. However, note that there are many options that are not
5622 mentioned at all in the default configuration.
5623
5624
5625
5626 .section "Macros" "SECTdefconfmacros"
5627 All macros should be defined before any options.
5628
5629 One macro is specified, but commented out, in the default configuration:
5630 .code
5631 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5632 .endd
5633 If all off-site mail is expected to be delivered to a "smarthost", then set the
5634 hostname here and uncomment the macro.  This will affect which router is used
5635 later on.  If this is left commented out, then Exim will perform direct-to-MX
5636 deliveries using a &(dnslookup)& router.
5637
5638 In addition to macros defined here, Exim includes a number of built-in macros
5639 to enable configuration to be guarded by a binary built with support for a
5640 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5641
5642
5643 .section "Main configuration settings" "SECTdefconfmain"
5644 The main (global) configuration option settings section must always come first
5645 in the file, after the macros.
5646 The first thing you'll see in the file, after some initial comments, is the line
5647 .code
5648 # primary_hostname =
5649 .endd
5650 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5651 to know the official, fully qualified name of your host, and this is where you
5652 can specify it. However, in most cases you do not need to set this option. When
5653 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5654
5655 The first three non-comment configuration lines are as follows:
5656 .code
5657 domainlist local_domains    = @
5658 domainlist relay_to_domains =
5659 hostlist   relay_from_hosts = 127.0.0.1
5660 .endd
5661 These are not, in fact, option settings. They are definitions of two named
5662 domain lists and one named host list. Exim allows you to give names to lists of
5663 domains, hosts, and email addresses, in order to make it easier to manage the
5664 configuration file (see section &<<SECTnamedlists>>&).
5665
5666 The first line defines a domain list called &'local_domains'&; this is used
5667 later in the configuration to identify domains that are to be delivered
5668 on the local host.
5669
5670 .cindex "@ in a domain list"
5671 There is just one item in this list, the string &"@"&. This is a special form
5672 of entry which means &"the name of the local host"&. Thus, if the local host is
5673 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5674 be delivered locally. Because the local host's name is referenced indirectly,
5675 the same configuration file can be used on different hosts.
5676
5677 The second line defines a domain list called &'relay_to_domains'&, but the
5678 list itself is empty. Later in the configuration we will come to the part that
5679 controls mail relaying through the local host; it allows relaying to any
5680 domains in this list. By default, therefore, no relaying on the basis of a mail
5681 domain is permitted.
5682
5683 The third line defines a host list called &'relay_from_hosts'&. This list is
5684 used later in the configuration to permit relaying from any host or IP address
5685 that matches the list. The default contains just the IP address of the IPv4
5686 loopback interface, which means that processes on the local host are able to
5687 submit mail for relaying by sending it over TCP/IP to that interface. No other
5688 hosts are permitted to submit messages for relaying.
5689
5690 Just to be sure there's no misunderstanding: at this point in the configuration
5691 we aren't actually setting up any controls. We are just defining some domains
5692 and hosts that will be used in the controls that are specified later.
5693
5694 The next two configuration lines are genuine option settings:
5695 .code
5696 acl_smtp_rcpt = acl_check_rcpt
5697 acl_smtp_data = acl_check_data
5698 .endd
5699 These options specify &'Access Control Lists'& (ACLs) that are to be used
5700 during an incoming SMTP session for every recipient of a message (every RCPT
5701 command), and after the contents of the message have been received,
5702 respectively. The names of the lists are &'acl_check_rcpt'& and
5703 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5704 section of the configuration. The RCPT ACL controls which recipients are
5705 accepted for an incoming message &-- if a configuration does not provide an ACL
5706 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5707 contents of a message to be checked.
5708
5709 Two commented-out option settings are next:
5710 .code
5711 # av_scanner = clamd:/tmp/clamd
5712 # spamd_address = 127.0.0.1 783
5713 .endd
5714 These are example settings that can be used when Exim is compiled with the
5715 content-scanning extension. The first specifies the interface to the virus
5716 scanner, and the second specifies the interface to SpamAssassin. Further
5717 details are given in chapter &<<CHAPexiscan>>&.
5718
5719 Three more commented-out option settings follow:
5720 .code
5721 # tls_advertise_hosts = *
5722 # tls_certificate = /etc/ssl/exim.crt
5723 # tls_privatekey = /etc/ssl/exim.pem
5724 .endd
5725 These are example settings that can be used when Exim is compiled with
5726 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5727 first one specifies the list of clients that are allowed to use TLS when
5728 connecting to this server; in this case, the wildcard means all clients. The
5729 other options specify where Exim should find its TLS certificate and private
5730 key, which together prove the server's identity to any clients that connect.
5731 More details are given in chapter &<<CHAPTLS>>&.
5732
5733 Another two commented-out option settings follow:
5734 .code
5735 # daemon_smtp_ports = 25 : 465 : 587
5736 # tls_on_connect_ports = 465
5737 .endd
5738 .cindex "port" "465 and 587"
5739 .cindex "port" "for message submission"
5740 .cindex "message" "submission, ports for"
5741 .cindex "submissions protocol"
5742 .cindex "smtps protocol"
5743 .cindex "ssmtp protocol"
5744 .cindex "SMTP" "submissions protocol"
5745 .cindex "SMTP" "ssmtp protocol"
5746 .cindex "SMTP" "smtps protocol"
5747 These options provide better support for roaming users who wish to use this
5748 server for message submission. They are not much use unless you have turned on
5749 TLS (as described in the previous paragraph) and authentication (about which
5750 more in section &<<SECTdefconfauth>>&).
5751 Mail submission from mail clients (MUAs) should be separate from inbound mail
5752 to your domain (MX delivery) for various good reasons (eg, ability to impose
5753 much saner TLS protocol and ciphersuite requirements without unintended
5754 consequences).
5755 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5756 which uses STARTTLS, so this is the &"submission"& port.
5757 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5758 which should be used in preference to 587.
5759 You should also consider deploying SRV records to help clients find
5760 these ports.
5761 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5762
5763 Two more commented-out options settings follow:
5764 .code
5765 # qualify_domain =
5766 # qualify_recipient =
5767 .endd
5768 The first of these specifies a domain that Exim uses when it constructs a
5769 complete email address from a local login name. This is often needed when Exim
5770 receives a message from a local process. If you do not set &%qualify_domain%&,
5771 the value of &%primary_hostname%& is used. If you set both of these options,
5772 you can have different qualification domains for sender and recipient
5773 addresses. If you set only the first one, its value is used in both cases.
5774
5775 .cindex "domain literal" "recognizing format"
5776 The following line must be uncommented if you want Exim to recognize
5777 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5778 (an IP address within square brackets) instead of a named domain.
5779 .code
5780 # allow_domain_literals
5781 .endd
5782 The RFCs still require this form, but many people think that in the modern
5783 Internet it makes little sense to permit mail to be sent to specific hosts by
5784 quoting their IP addresses. This ancient format has been used by people who
5785 try to abuse hosts by using them for unwanted relaying. However, some
5786 people believe there are circumstances (for example, messages addressed to
5787 &'postmaster'&) where domain literals are still useful.
5788
5789 The next configuration line is a kind of trigger guard:
5790 .code
5791 never_users = root
5792 .endd
5793 It specifies that no delivery must ever be run as the root user. The normal
5794 convention is to set up &'root'& as an alias for the system administrator. This
5795 setting is a guard against slips in the configuration.
5796 The list of users specified by &%never_users%& is not, however, the complete
5797 list; the build-time configuration in &_Local/Makefile_& has an option called
5798 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5799 contents of &%never_users%& are added to this list. By default
5800 FIXED_NEVER_USERS also specifies root.
5801
5802 When a remote host connects to Exim in order to send mail, the only information
5803 Exim has about the host's identity is its IP address. The next configuration
5804 line,
5805 .code
5806 host_lookup = *
5807 .endd
5808 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5809 in order to get a host name. This improves the quality of the logging
5810 information, but if you feel it is too expensive, you can remove it entirely,
5811 or restrict the lookup to hosts on &"nearby"& networks.
5812 Note that it is not always possible to find a host name from an IP address,
5813 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5814 unreachable.
5815
5816 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5817 1413 (hence their names):
5818 .code
5819 rfc1413_hosts = *
5820 rfc1413_query_timeout = 0s
5821 .endd
5822 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5823 Few hosts offer RFC1413 service these days; calls have to be
5824 terminated by a timeout and this needlessly delays the startup
5825 of an incoming SMTP connection.
5826 If you have hosts for which you trust RFC1413 and need this
5827 information, you can change this.
5828
5829 This line enables an efficiency SMTP option.  It is negotiated by clients
5830 and not expected to cause problems but can be disabled if needed.
5831 .code
5832 prdr_enable = true
5833 .endd
5834
5835 When Exim receives messages over SMTP connections, it expects all addresses to
5836 be fully qualified with a domain, as required by the SMTP definition. However,
5837 if you are running a server to which simple clients submit messages, you may
5838 find that they send unqualified addresses. The two commented-out options:
5839 .code
5840 # sender_unqualified_hosts =
5841 # recipient_unqualified_hosts =
5842 .endd
5843 show how you can specify hosts that are permitted to send unqualified sender
5844 and recipient addresses, respectively.
5845
5846 The &%log_selector%& option is used to increase the detail of logging
5847 over the default:
5848 .code
5849 log_selector = +smtp_protocol_error +smtp_syntax_error \
5850                +tls_certificate_verified
5851 .endd
5852
5853 The &%percent_hack_domains%& option is also commented out:
5854 .code
5855 # percent_hack_domains =
5856 .endd
5857 It provides a list of domains for which the &"percent hack"& is to operate.
5858 This is an almost obsolete form of explicit email routing. If you do not know
5859 anything about it, you can safely ignore this topic.
5860
5861 The next two settings in the main part of the default configuration are
5862 concerned with messages that have been &"frozen"& on Exim's queue. When a
5863 message is frozen, Exim no longer continues to try to deliver it. Freezing
5864 occurs when a bounce message encounters a permanent failure because the sender
5865 address of the original message that caused the bounce is invalid, so the
5866 bounce cannot be delivered. This is probably the most common case, but there
5867 are also other conditions that cause freezing, and frozen messages are not
5868 always bounce messages.
5869 .code
5870 ignore_bounce_errors_after = 2d
5871 timeout_frozen_after = 7d
5872 .endd
5873 The first of these options specifies that failing bounce messages are to be
5874 discarded after 2 days in the queue. The second specifies that any frozen
5875 message (whether a bounce message or not) is to be timed out (and discarded)
5876 after a week. In this configuration, the first setting ensures that no failing
5877 bounce message ever lasts a week.
5878
5879 Exim queues it's messages in a spool directory. If you expect to have
5880 large queues, you may consider using this option. It splits the spool
5881 directory into subdirectories to avoid file system degradation from
5882 many files in a single directory, resulting in better performance.
5883 Manual manipulation of queued messages becomes more complex (though fortunately
5884 not often needed).
5885 .code
5886 # split_spool_directory = true
5887 .endd
5888
5889 In an ideal world everybody follows the standards. For non-ASCII
5890 messages RFC 2047 is a standard, allowing a maximum line length of 76
5891 characters. Exim adheres that standard and won't process messages which
5892 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5893 In particular, the Exim maintainers have had multiple reports of
5894 problems from Russian administrators of issues until they disable this
5895 check, because of some popular, yet buggy, mail composition software.
5896 .code
5897 # check_rfc2047_length = false
5898 .endd
5899
5900 If you need to be strictly RFC compliant you may wish to disable the
5901 8BITMIME advertisement. Use this, if you exchange mails with systems
5902 that are not 8-bit clean.
5903 .code
5904 # accept_8bitmime = false
5905 .endd
5906
5907 Libraries you use may depend on specific environment settings.  This
5908 imposes a security risk (e.g. PATH). There are two lists:
5909 &%keep_environment%& for the variables to import as they are, and
5910 &%add_environment%& for variables we want to set to a fixed value.
5911 Note that TZ is handled separately, by the &%timezone%& runtime
5912 option and by the TIMEZONE_DEFAULT buildtime option.
5913 .code
5914 # keep_environment = ^LDAP
5915 # add_environment = PATH=/usr/bin::/bin
5916 .endd
5917
5918
5919 .section "ACL configuration" "SECID54"
5920 .cindex "default" "ACLs"
5921 .cindex "&ACL;" "default configuration"
5922 In the default configuration, the ACL section follows the main configuration.
5923 It starts with the line
5924 .code
5925 begin acl
5926 .endd
5927 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5928 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5929 and &%acl_smtp_data%& above.
5930
5931 .cindex "RCPT" "ACL for"
5932 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5933 RCPT command specifies one of the message's recipients. The ACL statements
5934 are considered in order, until the recipient address is either accepted or
5935 rejected. The RCPT command is then accepted or rejected, according to the
5936 result of the ACL processing.
5937 .code
5938 acl_check_rcpt:
5939 .endd
5940 This line, consisting of a name terminated by a colon, marks the start of the
5941 ACL, and names it.
5942 .code
5943 accept  hosts = :
5944 .endd
5945 This ACL statement accepts the recipient if the sending host matches the list.
5946 But what does that strange list mean? It doesn't actually contain any host
5947 names or IP addresses. The presence of the colon puts an empty item in the
5948 list; Exim matches this only if the incoming message did not come from a remote
5949 host, because in that case, the remote hostname is empty. The colon is
5950 important. Without it, the list itself is empty, and can never match anything.
5951
5952 What this statement is doing is to accept unconditionally all recipients in
5953 messages that are submitted by SMTP from local processes using the standard
5954 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5955 manner.
5956 .code
5957 deny    domains       = +local_domains
5958         local_parts   = ^[.] : ^.*[@%!/|]
5959         message       = Restricted characters in address
5960
5961 deny    domains       = !+local_domains
5962         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5963         message       = Restricted characters in address
5964 .endd
5965 These statements are concerned with local parts that contain any of the
5966 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5967 Although these characters are entirely legal in local parts (in the case of
5968 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5969 in Internet mail addresses.
5970
5971 The first three have in the past been associated with explicitly routed
5972 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5973 option). Addresses containing these characters are regularly tried by spammers
5974 in an attempt to bypass relaying restrictions, and also by open relay testing
5975 programs. Unless you really need them it is safest to reject these characters
5976 at this early stage. This configuration is heavy-handed in rejecting these
5977 characters for all messages it accepts from remote hosts. This is a deliberate
5978 policy of being as safe as possible.
5979
5980 The first rule above is stricter, and is applied to messages that are addressed
5981 to one of the local domains handled by this host. This is implemented by the
5982 first condition, which restricts it to domains that are listed in the
5983 &'local_domains'& domain list. The &"+"& character is used to indicate a
5984 reference to a named list. In this configuration, there is just one domain in
5985 &'local_domains'&, but in general there may be many.
5986
5987 The second condition on the first statement uses two regular expressions to
5988 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5989 or &"|"&. If you have local accounts that include these characters, you will
5990 have to modify this rule.
5991
5992 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5993 allows them because they have been encountered in practice. (Consider the
5994 common convention of local parts constructed as
5995 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5996 the author of Exim, who has no second initial.) However, a local part starting
5997 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5998 filename (for example, for a mailing list). This is also true for local parts
5999 that contain slashes. A pipe symbol can also be troublesome if the local part
6000 is incorporated unthinkingly into a shell command line.
6001
6002 The second rule above applies to all other domains, and is less strict. This
6003 allows your own users to send outgoing messages to sites that use slashes
6004 and vertical bars in their local parts. It blocks local parts that begin
6005 with a dot, slash, or vertical bar, but allows these characters within the
6006 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
6007 and &"!"& is blocked, as before. The motivation here is to prevent your users
6008 (or your users' viruses) from mounting certain kinds of attack on remote sites.
6009 .code
6010 accept  local_parts   = postmaster
6011         domains       = +local_domains
6012 .endd
6013 This statement, which has two conditions, accepts an incoming address if the
6014 local part is &'postmaster'& and the domain is one of those listed in the
6015 &'local_domains'& domain list. The &"+"& character is used to indicate a
6016 reference to a named list. In this configuration, there is just one domain in
6017 &'local_domains'&, but in general there may be many.
6018
6019 The presence of this statement means that mail to postmaster is never blocked
6020 by any of the subsequent tests. This can be helpful while sorting out problems
6021 in cases where the subsequent tests are incorrectly denying access.
6022 .code
6023 require verify        = sender
6024 .endd
6025 This statement requires the sender address to be verified before any subsequent
6026 ACL statement can be used. If verification fails, the incoming recipient
6027 address is refused. Verification consists of trying to route the address, to
6028 see if a bounce message could be delivered to it. In the case of remote
6029 addresses, basic verification checks only the domain, but &'callouts'& can be
6030 used for more verification if required. Section &<<SECTaddressverification>>&
6031 discusses the details of address verification.
6032 .code
6033 accept  hosts         = +relay_from_hosts
6034         control       = submission
6035 .endd
6036 This statement accepts the address if the message is coming from one of the
6037 hosts that are defined as being allowed to relay through this host. Recipient
6038 verification is omitted here, because in many cases the clients are dumb MUAs
6039 that do not cope well with SMTP error responses. For the same reason, the
6040 second line specifies &"submission mode"& for messages that are accepted. This
6041 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6042 messages that are deficient in some way, for example, because they lack a
6043 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6044 probably add recipient verification here, and disable submission mode.
6045 .code
6046 accept  authenticated = *
6047         control       = submission
6048 .endd
6049 This statement accepts the address if the client host has authenticated itself.
6050 Submission mode is again specified, on the grounds that such messages are most
6051 likely to come from MUAs. The default configuration does not define any
6052 authenticators, though it does include some nearly complete commented-out
6053 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6054 fact authenticate until you complete the authenticator definitions.
6055 .code
6056 require message = relay not permitted
6057         domains = +local_domains : +relay_to_domains
6058 .endd
6059 This statement rejects the address if its domain is neither a local domain nor
6060 one of the domains for which this host is a relay.
6061 .code
6062 require verify = recipient
6063 .endd
6064 This statement requires the recipient address to be verified; if verification
6065 fails, the address is rejected.
6066 .code
6067 # deny    dnslists    = black.list.example
6068 #         message     = rejected because $sender_host_address \
6069 #                       is in a black list at $dnslist_domain\n\
6070 #                       $dnslist_text
6071 #
6072 # warn    dnslists    = black.list.example
6073 #         add_header  = X-Warning: $sender_host_address is in \
6074 #                       a black list at $dnslist_domain
6075 #         log_message = found in $dnslist_domain
6076 .endd
6077 These commented-out lines are examples of how you could configure Exim to check
6078 sending hosts against a DNS black list. The first statement rejects messages
6079 from blacklisted hosts, whereas the second just inserts a warning header
6080 line.
6081 .code
6082 # require verify = csa
6083 .endd
6084 This commented-out line is an example of how you could turn on client SMTP
6085 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6086 records.
6087 .code
6088 accept
6089 .endd
6090 The final statement in the first ACL unconditionally accepts any recipient
6091 address that has successfully passed all the previous tests.
6092 .code
6093 acl_check_data:
6094 .endd
6095 This line marks the start of the second ACL, and names it. Most of the contents
6096 of this ACL are commented out:
6097 .code
6098 # deny    malware   = *
6099 #         message   = This message contains a virus \
6100 #                     ($malware_name).
6101 .endd
6102 These lines are examples of how to arrange for messages to be scanned for
6103 viruses when Exim has been compiled with the content-scanning extension, and a
6104 suitable virus scanner is installed. If the message is found to contain a
6105 virus, it is rejected with the given custom error message.
6106 .code
6107 # warn    spam      = nobody
6108 #         message   = X-Spam_score: $spam_score\n\
6109 #                     X-Spam_score_int: $spam_score_int\n\
6110 #                     X-Spam_bar: $spam_bar\n\
6111 #                     X-Spam_report: $spam_report
6112 .endd
6113 These lines are an example of how to arrange for messages to be scanned by
6114 SpamAssassin when Exim has been compiled with the content-scanning extension,
6115 and SpamAssassin has been installed. The SpamAssassin check is run with
6116 &`nobody`& as its user parameter, and the results are added to the message as a
6117 series of extra header line. In this case, the message is not rejected,
6118 whatever the spam score.
6119 .code
6120 accept
6121 .endd
6122 This final line in the DATA ACL accepts the message unconditionally.
6123
6124
6125 .section "Router configuration" "SECID55"
6126 .cindex "default" "routers"
6127 .cindex "routers" "default"
6128 The router configuration comes next in the default configuration, introduced
6129 by the line
6130 .code
6131 begin routers
6132 .endd
6133 Routers are the modules in Exim that make decisions about where to send
6134 messages. An address is passed to each router, in turn, until it is either
6135 accepted, or failed. This means that the order in which you define the routers
6136 matters. Each router is fully described in its own chapter later in this
6137 manual. Here we give only brief overviews.
6138 .code
6139 # domain_literal:
6140 #   driver = ipliteral
6141 #   domains = !+local_domains
6142 #   transport = remote_smtp
6143 .endd
6144 .cindex "domain literal" "default router"
6145 This router is commented out because the majority of sites do not want to
6146 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6147 you uncomment this router, you also need to uncomment the setting of
6148 &%allow_domain_literals%& in the main part of the configuration.
6149
6150 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6151 macro has been defined, per
6152 .code
6153 .ifdef ROUTER_SMARTHOST
6154 smarthost:
6155 #...
6156 .else
6157 dnslookup:
6158 #...
6159 .endif
6160 .endd
6161
6162 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6163 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6164 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6165 skip these routers because of the &%domains%& option.
6166
6167 .code
6168 smarthost:
6169   driver = manualroute
6170   domains = ! +local_domains
6171   transport = smarthost_smtp
6172   route_data = ROUTER_SMARTHOST
6173   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6174   no_more
6175 .endd
6176 This router only handles mail which is not to any local domains; this is
6177 specified by the line
6178 .code
6179 domains = ! +local_domains
6180 .endd
6181 The &%domains%& option lists the domains to which this router applies, but the
6182 exclamation mark is a negation sign, so the router is used only for domains
6183 that are not in the domain list called &'local_domains'& (which was defined at
6184 the start of the configuration). The plus sign before &'local_domains'&
6185 indicates that it is referring to a named list. Addresses in other domains are
6186 passed on to the following routers.
6187
6188 The name of the router driver is &(manualroute)& because we are manually
6189 specifying how mail should be routed onwards, instead of using DNS MX.
6190 While the name of this router instance is arbitrary, the &%driver%& option must
6191 be one of the driver modules that is in the Exim binary.
6192
6193 With no pre-conditions other than &%domains%&, all mail for non-local domains
6194 will be handled by this router, and the &%no_more%& setting will ensure that no
6195 other routers will be used for messages matching the pre-conditions.  See
6196 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6197 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6198 and the macro supplies the value; the address is then queued for the
6199 &(smarthost_smtp)& transport.
6200
6201 .code
6202 dnslookup:
6203   driver = dnslookup
6204   domains = ! +local_domains
6205   transport = remote_smtp
6206   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6207   no_more
6208 .endd
6209 The &%domains%& option behaves as per smarthost, above.
6210
6211 The name of the router driver is &(dnslookup)&,
6212 and is specified by the &%driver%& option. Do not be confused by the fact that
6213 the name of this router instance is the same as the name of the driver. The
6214 instance name is arbitrary, but the name set in the &%driver%& option must be
6215 one of the driver modules that is in the Exim binary.
6216
6217 The &(dnslookup)& router routes addresses by looking up their domains in the
6218 DNS in order to obtain a list of hosts to which the address is routed. If the
6219 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6220 specified by the &%transport%& option. If the router does not find the domain
6221 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6222 the address fails and is bounced.
6223
6224 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6225 be entirely ignored. This option is present because a number of cases have been
6226 encountered where MX records in the DNS point to host names
6227 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6228 Completely ignoring these IP addresses causes Exim to fail to route the
6229 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6230 continue to try to deliver the message periodically until the address timed
6231 out.
6232 .code
6233 system_aliases:
6234   driver = redirect
6235   allow_fail
6236   allow_defer
6237   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6238 # user = exim
6239   file_transport = address_file
6240   pipe_transport = address_pipe
6241 .endd
6242 Control reaches this and subsequent routers only for addresses in the local
6243 domains. This router checks to see whether the local part is defined as an
6244 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6245 data that it looks up from that file. If no data is found for the local part,
6246 the value of the &%data%& option is empty, causing the address to be passed to
6247 the next router.
6248
6249 &_/etc/aliases_& is a conventional name for the system aliases file that is
6250 often used. That is why it is referenced by from the default configuration
6251 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6252 &_Local/Makefile_& before building Exim.
6253 .code
6254 userforward:
6255   driver = redirect
6256   check_local_user
6257 # local_part_suffix = +* : -*
6258 # local_part_suffix_optional
6259   file = $home/.forward
6260 # allow_filter
6261   no_verify
6262   no_expn
6263   check_ancestor
6264   file_transport = address_file
6265   pipe_transport = address_pipe
6266   reply_transport = address_reply
6267 .endd
6268 This is the most complicated router in the default configuration. It is another
6269 redirection router, but this time it is looking for forwarding data set up by
6270 individual users. The &%check_local_user%& setting specifies a check that the
6271 local part of the address is the login name of a local user. If it is not, the
6272 router is skipped. The two commented options that follow &%check_local_user%&,
6273 namely:
6274 .code
6275 # local_part_suffix = +* : -*
6276 # local_part_suffix_optional
6277 .endd
6278 .vindex "&$local_part_suffix$&"
6279 show how you can specify the recognition of local part suffixes. If the first
6280 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6281 by any sequence of characters, is removed from the local part and placed in the
6282 variable &$local_part_suffix$&. The second suffix option specifies that the
6283 presence of a suffix in the local part is optional. When a suffix is present,
6284 the check for a local login uses the local part with the suffix removed.
6285
6286 When a local user account is found, the file called &_.forward_& in the user's
6287 home directory is consulted. If it does not exist, or is empty, the router
6288 declines. Otherwise, the contents of &_.forward_& are interpreted as
6289 redirection data (see chapter &<<CHAPredirect>>& for more details).
6290
6291 .cindex "Sieve filter" "enabling in default router"
6292 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6293 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6294 is commented out by default), the contents of the file are interpreted as a set
6295 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6296 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6297 separate document entitled &'Exim's interfaces to mail filtering'&.
6298
6299 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6300 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6301 There are two reasons for doing this:
6302
6303 .olist
6304 Whether or not a local user has a &_.forward_& file is not really relevant when
6305 checking an address for validity; it makes sense not to waste resources doing
6306 unnecessary work.
6307 .next
6308 More importantly, when Exim is verifying addresses or handling an EXPN
6309 command during an SMTP session, it is running as the Exim user, not as root.
6310 The group is the Exim group, and no additional groups are set up.
6311 It may therefore not be possible for Exim to read users' &_.forward_& files at
6312 this time.
6313 .endlist
6314
6315 The setting of &%check_ancestor%& prevents the router from generating a new
6316 address that is the same as any previous address that was redirected. (This
6317 works round a problem concerning a bad interaction between aliasing and
6318 forwarding &-- see section &<<SECTredlocmai>>&).
6319
6320 The final three option settings specify the transports that are to be used when
6321 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6322 auto-reply, respectively. For example, if a &_.forward_& file contains
6323 .code
6324 a.nother@elsewhere.example, /home/spqr/archive
6325 .endd
6326 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6327 transport.
6328 .code
6329 localuser:
6330   driver = accept
6331   check_local_user
6332 # local_part_suffix = +* : -*
6333 # local_part_suffix_optional
6334   transport = local_delivery
6335 .endd
6336 The final router sets up delivery into local mailboxes, provided that the local
6337 part is the name of a local login, by accepting the address and assigning it to
6338 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6339 routers, so the address is bounced. The commented suffix settings fulfil the
6340 same purpose as they do for the &(userforward)& router.
6341
6342
6343 .section "Transport configuration" "SECID56"
6344 .cindex "default" "transports"
6345 .cindex "transports" "default"
6346 Transports define mechanisms for actually delivering messages. They operate
6347 only when referenced from routers, so the order in which they are defined does
6348 not matter. The transports section of the configuration starts with
6349 .code
6350 begin transports
6351 .endd
6352 Two remote transports and four local transports are defined.
6353 .code
6354 remote_smtp:
6355   driver = smtp
6356   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6357 .ifdef _HAVE_PRDR
6358   hosts_try_prdr = *
6359 .endif
6360 .endd
6361 This transport is used for delivering messages over SMTP connections.
6362 The list of remote hosts comes from the router.
6363 The &%message_size_limit%& usage is a hack to avoid sending on messages
6364 with over-long lines.
6365
6366 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6367 negotiated between client and server and not expected to cause problems
6368 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6369 use of the &%hosts_try_prdr%& configuration option.
6370
6371 The other remote transport is used when delivering to a specific smarthost
6372 with whom there must be some kind of existing relationship, instead of the
6373 usual federated system.
6374
6375 .code
6376 smarthost_smtp:
6377   driver = smtp
6378   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6379   multi_domain
6380   #
6381 .ifdef _HAVE_TLS
6382   # Comment out any of these which you have to, then file a Support
6383   # request with your smarthost provider to get things fixed:
6384   hosts_require_tls = *
6385   tls_verify_hosts = *
6386   # As long as tls_verify_hosts is enabled, this this will have no effect,
6387   # but if you have to comment it out then this will at least log whether
6388   # you succeed or not:
6389   tls_try_verify_hosts = *
6390   #
6391   # The SNI name should match the name which we'll expect to verify;
6392   # many mail systems don't use SNI and this doesn't matter, but if it does,
6393   # we need to send a name which the remote site will recognize.
6394   # This _should_ be the name which the smarthost operators specified as
6395   # the hostname for sending your mail to.
6396   tls_sni = ROUTER_SMARTHOST
6397   #
6398 .ifdef _HAVE_OPENSSL
6399   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6400 .endif
6401 .ifdef _HAVE_GNUTLS
6402   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6403 .endif
6404 .endif
6405 .ifdef _HAVE_PRDR
6406   hosts_try_prdr = *
6407 .endif
6408 .endd
6409 After the same &%message_size_limit%& hack, we then specify that this Transport
6410 can handle messages to multiple domains in one run.  The assumption here is
6411 that you're routing all non-local mail to the same place and that place is
6412 happy to take all messages from you as quickly as possible.
6413 All other options depend upon built-in macros; if Exim was built without TLS support
6414 then no other options are defined.
6415 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6416 and versions using the &%tls_require_ciphers%& option, where the value to be
6417 used depends upon the library providing TLS.
6418 Beyond that, the options adopt the stance that you should have TLS support available
6419 from your smarthost on today's Internet, so we turn on requiring TLS for the
6420 mail to be delivered, and requiring that the certificate be valid, and match
6421 the expected hostname.  The &%tls_sni%& option can be used by service providers
6422 to select an appropriate certificate to present to you and here we re-use the
6423 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6424 You want to specify the hostname which you'll expect to validate for, and that
6425 should not be subject to insecure tampering via DNS results.
6426
6427 For the &%hosts_try_prdr%& option see the previous transport.
6428
6429 All other options are defaulted.
6430 .code
6431 local_delivery:
6432   driver = appendfile
6433   file = /var/mail/$local_part_data
6434   delivery_date_add
6435   envelope_to_add
6436   return_path_add
6437 # group = mail
6438 # mode = 0660
6439 .endd
6440 This &(appendfile)& transport is used for local delivery to user mailboxes in
6441 traditional BSD mailbox format.
6442
6443 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6444 as it is provided by a potential bad actor.
6445 Instead we use &$local_part_data$&,
6446 the result of looking up &$local_part$& in the user database
6447 (done by using &%check_local_user%& in the the router).
6448
6449 By default &(appendfile)& runs under the uid and gid of the
6450 local user, which requires the sticky bit to be set on the &_/var/mail_&
6451 directory. Some systems use the alternative approach of running mail deliveries
6452 under a particular group instead of using the sticky bit. The commented options
6453 show how this can be done.
6454
6455 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6456 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6457 similarly-named options above.
6458 .code
6459 address_pipe:
6460   driver = pipe
6461   return_output
6462 .endd
6463 This transport is used for handling deliveries to pipes that are generated by
6464 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6465 option specifies that any output on stdout or stderr generated by the pipe is to
6466 be returned to the sender.
6467 .code
6468 address_file:
6469   driver = appendfile
6470   delivery_date_add
6471   envelope_to_add
6472   return_path_add
6473 .endd
6474 This transport is used for handling deliveries to files that are generated by
6475 redirection. The name of the file is not specified in this instance of
6476 &(appendfile)&, because it comes from the &(redirect)& router.
6477 .code
6478 address_reply:
6479   driver = autoreply
6480 .endd
6481 This transport is used for handling automatic replies generated by users'
6482 filter files.
6483
6484
6485
6486 .section "Default retry rule" "SECID57"
6487 .cindex "retry" "default rule"
6488 .cindex "default" "retry rule"
6489 The retry section of the configuration file contains rules which affect the way
6490 Exim retries deliveries that cannot be completed at the first attempt. It is
6491 introduced by the line
6492 .code
6493 begin retry
6494 .endd
6495 In the default configuration, there is just one rule, which applies to all
6496 errors:
6497 .code
6498 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6499 .endd
6500 This causes any temporarily failing address to be retried every 15 minutes for
6501 2 hours, then at intervals starting at one hour and increasing by a factor of
6502 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6503 is not delivered after 4 days of temporary failure, it is bounced. The time is
6504 measured from first failure, not from the time the message was received.
6505
6506 If the retry section is removed from the configuration, or is empty (that is,
6507 if no retry rules are defined), Exim will not retry deliveries. This turns
6508 temporary errors into permanent errors.
6509
6510
6511 .section "Rewriting configuration" "SECID58"
6512 The rewriting section of the configuration, introduced by
6513 .code
6514 begin rewrite
6515 .endd
6516 contains rules for rewriting addresses in messages as they arrive. There are no
6517 rewriting rules in the default configuration file.
6518
6519
6520
6521 .section "Authenticators configuration" "SECTdefconfauth"
6522 .cindex "AUTH" "configuration"
6523 The authenticators section of the configuration, introduced by
6524 .code
6525 begin authenticators
6526 .endd
6527 defines mechanisms for the use of the SMTP AUTH command. The default
6528 configuration file contains two commented-out example authenticators
6529 which support plaintext username/password authentication using the
6530 standard PLAIN mechanism and the traditional but non-standard LOGIN
6531 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6532 to support most MUA software.
6533
6534 The example PLAIN authenticator looks like this:
6535 .code
6536 #PLAIN:
6537 #  driver                  = plaintext
6538 #  server_set_id           = $auth2
6539 #  server_prompts          = :
6540 #  server_condition        = Authentication is not yet configured
6541 #  server_advertise_condition = ${if def:tls_in_cipher }
6542 .endd
6543 And the example LOGIN authenticator looks like this:
6544 .code
6545 #LOGIN:
6546 #  driver                  = plaintext
6547 #  server_set_id           = $auth1
6548 #  server_prompts          = <| Username: | Password:
6549 #  server_condition        = Authentication is not yet configured
6550 #  server_advertise_condition = ${if def:tls_in_cipher }
6551 .endd
6552
6553 The &%server_set_id%& option makes Exim remember the authenticated username
6554 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6555 &%server_prompts%& option configures the &(plaintext)& authenticator so
6556 that it implements the details of the specific authentication mechanism,
6557 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6558 when Exim offers authentication to clients; in the examples, this is only
6559 when TLS or SSL has been started, so to enable the authenticators you also
6560 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6561
6562 The &%server_condition%& setting defines how to verify that the username and
6563 password are correct. In the examples it just produces an error message.
6564 To make the authenticators work, you can use a string expansion
6565 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6566
6567 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6568 usercode and password are in different positions.
6569 Chapter &<<CHAPplaintext>>& covers both.
6570
6571 .ecindex IIDconfiwal
6572
6573
6574
6575 . ////////////////////////////////////////////////////////////////////////////
6576 . ////////////////////////////////////////////////////////////////////////////
6577
6578 .chapter "Regular expressions" "CHAPregexp"
6579
6580 .cindex "regular expressions" "library"
6581 .cindex "PCRE2"
6582 Exim supports the use of regular expressions in many of its options. It
6583 uses the PCRE2 regular expression library; this provides regular expression
6584 matching that is compatible with Perl 5. The syntax and semantics of
6585 regular expressions is discussed in
6586 online Perl manpages, in
6587 many Perl reference books, and also in
6588 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6589 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6590 . --- the http: URL here redirects to another page with the ISBN in the URL
6591 . --- where trying to use https: just redirects back to http:, so sticking
6592 . --- to the old URL for now.  2018-09-07.
6593
6594 The documentation for the syntax and semantics of the regular expressions that
6595 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6596 description is included here. The PCRE2 functions are called from Exim using
6597 the default option settings (that is, with no PCRE2 options set), except that
6598 the PCRE2_CASELESS option is set when the matching is required to be
6599 case-insensitive.
6600
6601 In most cases, when a regular expression is required in an Exim configuration,
6602 it has to start with a circumflex, in order to distinguish it from plain text
6603 or an &"ends with"& wildcard. In this example of a configuration setting, the
6604 second item in the colon-separated list is a regular expression.
6605 .code
6606 domains = a.b.c : ^\\d{3} : *.y.z : ...
6607 .endd
6608 The doubling of the backslash is required because of string expansion that
6609 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6610 of this issue, and a way of avoiding the need for doubling backslashes. The
6611 regular expression that is eventually used in this example contains just one
6612 backslash. The circumflex is included in the regular expression, and has the
6613 normal effect of &"anchoring"& it to the start of the string that is being
6614 matched.
6615
6616 There are, however, two cases where a circumflex is not required for the
6617 recognition of a regular expression: these are the &%match%& condition in a
6618 string expansion, and the &%matches%& condition in an Exim filter file. In
6619 these cases, the relevant string is always treated as a regular expression; if
6620 it does not start with a circumflex, the expression is not anchored, and can
6621 match anywhere in the subject string.
6622
6623 In all cases, if you want a regular expression to match at the end of a string,
6624 you must code the $ metacharacter to indicate this. For example:
6625 .code
6626 domains = ^\\d{3}\\.example
6627 .endd
6628 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6629 You need to use:
6630 .code
6631 domains = ^\\d{3}\\.example\$
6632 .endd
6633 if you want &'example'& to be the top-level domain. The backslash before the
6634 $ is needed because string expansion also interprets dollar characters.
6635
6636
6637
6638 . ////////////////////////////////////////////////////////////////////////////
6639 . ////////////////////////////////////////////////////////////////////////////
6640
6641 .chapter "File and database lookups" "CHAPfdlookup"
6642 .scindex IIDfidalo1 "file" "lookups"
6643 .scindex IIDfidalo2 "database" "lookups"
6644 .cindex "lookup" "description of"
6645 Exim can be configured to look up data in files or databases as it processes
6646 messages. Two different kinds of syntax are used:
6647
6648 .olist
6649 A string that is to be expanded may contain explicit lookup requests. These
6650 cause parts of the string to be replaced by data that is obtained from the
6651 lookup. Lookups of this type are conditional expansion items. Different results
6652 can be defined for the cases of lookup success and failure. See chapter
6653 &<<CHAPexpand>>&, where string expansions are described in detail.
6654 The key for the lookup is &*specified*& as part of the string to be expanded.
6655 .next
6656 Lists of domains, hosts, and email addresses can contain lookup requests as a
6657 way of avoiding excessively long linear lists. In this case, the data that is
6658 returned by the lookup is often (but not always) discarded; whether the lookup
6659 succeeds or fails is what really counts. These kinds of list are described in
6660 chapter &<<CHAPdomhosaddlists>>&.
6661 Depending on the lookup type (see below)
6662 the key for the lookup may need to be &*specified*& as above
6663 or may be &*implicit*&,
6664 given by the context in which the list is being checked.
6665 .endlist
6666
6667 String expansions, lists, and lookups interact with each other in such a way
6668 that there is no order in which to describe any one of them that does not
6669 involve references to the others. Each of these three chapters makes more sense
6670 if you have read the other two first. If you are reading this for the first
6671 time, be aware that some of it will make a lot more sense after you have read
6672 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6673
6674 .section "Examples of different lookup syntax" "SECID60"
6675 It is easy to confuse the two different kinds of lookup, especially as the
6676 lists that may contain the second kind are always expanded before being
6677 processed as lists. Therefore, they may also contain lookups of the first kind.
6678 Be careful to distinguish between the following two examples:
6679 .code
6680 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6681 domains = lsearch;/some/file
6682 .endd
6683 .ilist
6684 The first uses a string expansion, the result of which must be a domain list.
6685 The key for an expansion-style lookup must be given explicitly.
6686 No strings have been specified for a successful or a failing lookup; the
6687 defaults in this case are the looked-up data and an empty string, respectively.
6688 The expansion takes place before the string is processed as a list, and the
6689 file that is searched could contain lines like this:
6690 .code
6691 192.168.3.4: domain1:domain2:...
6692 192.168.1.9: domain3:domain4:...
6693 .endd
6694 When the lookup succeeds, the result of the expansion is a list of domains (and
6695 possibly other types of item that are allowed in domain lists).
6696 .cindex "tainted data" "de-tainting"
6697 .cindex "de-tainting" "using a lookup expansion"
6698 The result of the expansion is not tainted.
6699
6700 .next
6701 In the second example, the lookup is a single item in a domain list. It causes
6702 Exim to use a lookup to see if the domain that is being processed can be found
6703 in the file.
6704 The file could contains lines like this:
6705 .code
6706 domain1:
6707 domain2:
6708 .endd
6709 Any data that follows the keys is not relevant when checking that the domain
6710 matches the list item.
6711
6712 The key for a list-style lookup is implicit, from the lookup context, if
6713 the lookup is a single-key type (see below).
6714 For query-style lookup types the query must be given explicitly.
6715 .endlist
6716
6717 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6718 Consider a file containing lines like this:
6719 .code
6720 192.168.5.6: lsearch;/another/file
6721 .endd
6722 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6723 first &%domains%& setting above generates the second setting, which therefore
6724 causes a second lookup to occur.
6725
6726 The lookup type may optionally be followed by a comma
6727 and a comma-separated list of options.
6728 Each option is a &"name=value"& pair.
6729 Whether an option is meaningful depends on the lookup type.
6730
6731 All lookups support the option &"cache=no_rd"&.
6732 If this is given then the cache that Exim manages for lookup results
6733 is not checked before doing the lookup.
6734 The result of the lookup is still written to the cache.
6735
6736 The rest of this chapter describes the different lookup types that are
6737 available. Any of them can be used in any part of the configuration where a
6738 lookup is permitted.
6739
6740
6741 .section "Lookup types" "SECID61"
6742 .cindex "lookup" "types of"
6743 .cindex "single-key lookup" "definition of"
6744 Two different types of data lookup are implemented:
6745
6746 .ilist
6747 The &'single-key'& type requires the specification of a file in which to look,
6748 and a single key to search for. The key must be a non-empty string for the
6749 lookup to succeed. The lookup type determines how the file is searched.
6750 .cindex "tainted data" "single-key lookups"
6751 The file string may not be tainted.
6752
6753 .cindex "tainted data" "de-tainting"
6754 .cindex "de-tainting" "using a single-key lookup"
6755 All single-key lookups support the option &"ret=key"&.
6756 If this is given and the lookup
6757 (either underlying implementation or cached value)
6758 returns data, the result is replaced with a non-tainted
6759 version of the lookup key.
6760
6761 .next
6762 .cindex "query-style lookup" "definition of"
6763 The &'query-style'& type accepts a generalized database query. No particular
6764 key value is assumed by Exim for query-style lookups. You can use whichever
6765 Exim variables you need to construct the database query.
6766
6767 For the string-expansion kind of lookups, the query is given in the first
6768 bracketed argument of the &${lookup ...}$& expansion.
6769 For the list-argument kind of lookup the query is given by the remainder of the
6770 list item after the first semicolon.
6771
6772 .cindex "tainted data" "quoting for lookups"
6773 If tainted data is used in the query then it should be quoted by
6774 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6775 appropriate for the lookup.
6776 .endlist
6777
6778 The code for each lookup type is in a separate source file that is included in
6779 the binary of Exim only if the corresponding compile-time option is set. The
6780 default settings in &_src/EDITME_& are:
6781 .code
6782 LOOKUP_DBM=yes
6783 LOOKUP_LSEARCH=yes
6784 .endd
6785 which means that only linear searching and DBM lookups are included by default.
6786 For some types of lookup (e.g. SQL databases), you need to install appropriate
6787 libraries and header files before building Exim.
6788
6789
6790
6791
6792 .section "Single-key lookup types" "SECTsinglekeylookups"
6793 .cindex "lookup" "single-key types"
6794 .cindex "single-key lookup" "list of types"
6795 The following single-key lookup types are implemented:
6796
6797 .subsection cdb
6798 .cindex "cdb" "description of"
6799 .cindex "lookup" "cdb"
6800 .cindex "binary zero" "in lookup key"
6801 The given file is searched as a Constant DataBase file, using the key
6802 string without a terminating binary zero. The cdb format is designed for
6803 indexed files that are read frequently and never updated, except by total
6804 re-creation. As such, it is particularly suitable for large files containing
6805 aliases or other indexed data referenced by an MTA. Information about cdb and
6806 tools for building the files can be found in several places:
6807 .display
6808 &url(https://cr.yp.to/cdb.html)
6809 &url(https://www.corpit.ru/mjt/tinycdb.html)
6810 &url(https://packages.debian.org/stable/utils/freecdb)
6811 &url(https://github.com/philpennock/cdbtools) (in Go)
6812 .endd
6813 A cdb distribution is not needed in order to build Exim with cdb support,
6814 because the code for reading cdb files is included directly in Exim itself.
6815 However, no means of building or testing cdb files is provided with Exim, so
6816 you need to obtain a cdb distribution in order to do this.
6817
6818 .subsection dbm
6819 .cindex "DBM" "lookup type"
6820 .cindex "lookup" "dbm"
6821 .cindex "binary zero" "in lookup key"
6822 Calls to DBM library functions are used to extract data from the given
6823 DBM file by looking up the record with the given key. A terminating binary
6824 zero is included in the key that is passed to the DBM library. See section
6825 &<<SECTdb>>& for a discussion of DBM libraries.
6826
6827 .cindex "Berkeley DB library" "file format"
6828 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6829 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6830 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6831 the DB_UNKNOWN option. This enables it to handle any of the types of database
6832 that the library supports, and can be useful for accessing DBM files created by
6833 other applications. (For earlier DB versions, DB_HASH is always used.)
6834
6835 .subsection dbmjz
6836 .cindex "lookup" "dbmjz"
6837 .cindex "lookup" "dbm &-- embedded NULs"
6838 .cindex "sasldb2"
6839 .cindex "dbmjz lookup type"
6840 This is the same as &(dbm)&, except that the lookup key is
6841 interpreted as an Exim list; the elements of the list are joined together with
6842 ASCII NUL characters to form the lookup key.  An example usage would be to
6843 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6844 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6845 &(cram_md5)& authenticator.
6846
6847 .subsection dbmnz
6848 .cindex "lookup" "dbmnz"
6849 .cindex "lookup" "dbm &-- terminating zero"
6850 .cindex "binary zero" "in lookup key"
6851 .cindex "Courier"
6852 .cindex "&_/etc/userdbshadow.dat_&"
6853 .cindex "dbmnz lookup type"
6854 This is the same as &(dbm)&, except that a terminating binary zero
6855 is not included in the key that is passed to the DBM library. You may need this
6856 if you want to look up data in files that are created by or shared with some
6857 other application that does not use terminating zeros. For example, you need to
6858 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6859 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6860 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6861 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6862
6863 .subsection dsearch
6864 .cindex "lookup" "dsearch"
6865 .cindex "dsearch lookup type"
6866 The given file must be an absolute directory path; this is searched for an entry
6867 whose name is the key by calling the &[lstat()]& function.
6868 Unless the options (below) permit a path,
6869 the key may not contain any forward slash characters.
6870 If &[lstat()]& succeeds then so does the lookup.
6871 .cindex "tainted data" "dsearch result"
6872 The result is regarded as untainted.
6873
6874 Options for the lookup can be given by appending them after the word "dsearch",
6875 separated by a comma.  Options, if present, are a comma-separated list having
6876 each element starting with a tag name and an equals.
6877
6878 Three options are supported, for the return value and for filtering match
6879 candidates.
6880 The "ret" option requests an alternate result value of
6881 the entire path for the entry. Example:
6882 .code
6883 ${lookup {passwd} dsearch,ret=full {/etc}}
6884 .endd
6885 The default result is just the requested entry.
6886
6887 The "filter" option requests that only directory entries of a given type
6888 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6889 not matching "." or ".."). Example:
6890 .code
6891 ${lookup {passwd} dsearch,filter=file {/etc}}
6892 .endd
6893 The default matching is for any entry type, including directories
6894 and symlinks.
6895
6896 The "key" option relaxes the restriction that only a simple path component can
6897 be searched for, to permit a sequence of path components. Example:
6898 .code
6899 ${lookup {foo/bar} dsearch,key=path {/etc}}
6900 .endd
6901 If this option is used, a ".." component in the key is specifically disallowed.
6902 The default operation is that the key may only be a single path component.
6903
6904 An example of how this
6905 lookup can be used to support virtual domains is given in section
6906 &<<SECTvirtualdomains>>&.
6907
6908 .subsection iplsearch
6909 .cindex "lookup" "iplsearch"
6910 .cindex "iplsearch lookup type"
6911 The given file is a text file containing keys and data. A key is
6912 terminated by a colon or white space or the end of the line. The keys in the
6913 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6914 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6915 being interpreted as a key terminator. For example:
6916 .code
6917 1.2.3.4:           data for 1.2.3.4
6918 192.168.0.0/16:    data for 192.168.0.0/16
6919 "abcd::cdab":      data for abcd::cdab
6920 "abcd:abcd::/32"   data for abcd:abcd::/32
6921 .endd
6922 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6923 file is searched linearly, using the CIDR masks where present, until a matching
6924 key is found. The first key that matches is used; there is no attempt to find a
6925 &"best"& match. Apart from the way the keys are matched, the processing for
6926 &(iplsearch)& is the same as for &(lsearch)&.
6927
6928 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6929 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6930 lookup types support only literal keys.
6931
6932 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6933 the implicit key is the host's IP address rather than its name
6934 (see section &<<SECThoslispatsikey>>&).
6935
6936 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6937 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6938 notation before executing the lookup.)
6939
6940 One option is supported, "ret=full", to request the return of the entire line
6941 rather than omitting the key portion.
6942 Note however that the key portion will have been de-quoted.
6943
6944 .subsection json
6945 .cindex lookup json
6946 .cindex json "lookup type"
6947 .cindex JSON expansions
6948 The given file is a text file with a JSON structure.
6949 An element of the structure is extracted, defined by the search key.
6950 The key is a list of subelement selectors
6951 (colon-separated by default but changeable in the usual way)
6952 which are applied in turn to select smaller and smaller portions
6953 of the JSON structure.
6954 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6955 nunbered array element is selected.
6956 Otherwise it must apply to a JSON object; the named element is selected.
6957 The final resulting element can be a simple JSON type or a JSON object
6958 or array; for the latter two a string-representation of the JSON
6959 is returned.
6960 For elements of type string, the returned value is de-quoted.
6961
6962
6963 .subsection lmdb
6964 .cindex LMDB
6965 .cindex lookup lmdb
6966 .cindex database lmdb
6967 The given file is an LMDB database.
6968 LMDB is a memory-mapped key-value store,
6969 with API modeled loosely on that of BerkeleyDB.
6970 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6971 for the feature set and operation modes.
6972
6973 Exim provides read-only access via the LMDB C library.
6974 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6975 or your operating system package repository.
6976 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6977
6978 You will need to separately create the LMDB database file,
6979 possibly using the &"mdb_load"& utility.
6980
6981
6982 .subsection lsearch
6983 .cindex "linear search"
6984 .cindex "lookup" "lsearch"
6985 .cindex "lsearch lookup type"
6986 .cindex "case sensitivity" "in lsearch lookup"
6987 The given file is a text file that is searched linearly for a
6988 line beginning with the search key, terminated by a colon or white space or the
6989 end of the line. The search is case-insensitive; that is, upper and lower case
6990 letters are treated as the same. The first occurrence of the key that is found
6991 in the file is used.
6992
6993 White space between the key and the colon is permitted. The remainder of the
6994 line, with leading and trailing white space removed, is the data. This can be
6995 continued onto subsequent lines by starting them with any amount of white
6996 space, but only a single space character is included in the data at such a
6997 junction. If the data begins with a colon, the key must be terminated by a
6998 colon, for example:
6999 .code
7000 baduser:  :fail:
7001 .endd
7002 Empty lines and lines beginning with # are ignored, even if they occur in the
7003 middle of an item. This is the traditional textual format of alias files. Note
7004 that the keys in an &(lsearch)& file are literal strings. There is no
7005 wildcarding of any kind.
7006
7007 .cindex "lookup" "lsearch &-- colons in keys"
7008 .cindex "white space" "in lsearch key"
7009 In most &(lsearch)& files, keys are not required to contain colons or #
7010 characters, or white space. However, if you need this feature, it is available.
7011 If a key begins with a doublequote character, it is terminated only by a
7012 matching quote (or end of line), and the normal escaping rules apply to its
7013 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
7014 quoted keys (exactly as for unquoted keys). There is no special handling of
7015 quotes for the data part of an &(lsearch)& line.
7016
7017 .subsection nis
7018 .cindex "NIS lookup type"
7019 .cindex "lookup" "NIS"
7020 .cindex "binary zero" "in lookup key"
7021 The given file is the name of a NIS map, and a NIS lookup is done with
7022 the given key, without a terminating binary zero. There is a variant called
7023 &(nis0)& which does include the terminating binary zero in the key. This is
7024 reportedly needed for Sun-style alias files. Exim does not recognize NIS
7025 aliases; the full map names must be used.
7026
7027 .subsection (n)wildlsearch
7028 .cindex "wildlsearch lookup type"
7029 .cindex "lookup" "wildlsearch"
7030 .cindex "nwildlsearch lookup type"
7031 .cindex "lookup" "nwildlsearch"
7032 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
7033 &(lsearch)&, but instead of being interpreted as a literal string, each key in
7034 the file may be wildcarded. The difference between these two lookup types is
7035 that for &(wildlsearch)&, each key in the file is string-expanded before being
7036 used, whereas for &(nwildlsearch)&, no expansion takes place.
7037
7038 .cindex "case sensitivity" "in (n)wildlsearch lookup"
7039 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
7040 file that are regular expressions can be made case-sensitive by the use of
7041 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7042
7043 .olist
7044 The string may begin with an asterisk to mean &"ends with"&. For example:
7045 .code
7046 *.a.b.c       data for anything.a.b.c
7047 *fish         data for anythingfish
7048 .endd
7049 .next
7050 The string may begin with a circumflex to indicate a regular expression. For
7051 example, for &(wildlsearch)&:
7052 .code
7053 ^\N\d+\.a\.b\N    data for <digits>.a.b
7054 .endd
7055 Note the use of &`\N`& to disable expansion of the contents of the regular
7056 expression. If you are using &(nwildlsearch)&, where the keys are not
7057 string-expanded, the equivalent entry is:
7058 .code
7059 ^\d+\.a\.b        data for <digits>.a.b
7060 .endd
7061 The case-insensitive flag is set at the start of compiling the regular
7062 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7063 For example, to make the entire pattern case-sensitive:
7064 .code
7065 ^(?-i)\d+\.a\.b        data for <digits>.a.b
7066 .endd
7067
7068 If the regular expression contains white space or colon characters, you must
7069 either quote it (see &(lsearch)& above), or represent these characters in other
7070 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7071 colon. This may be easier than quoting, because if you quote, you have to
7072 escape all the backslashes inside the quotes.
7073
7074 &*Note*&: It is not possible to capture substrings in a regular expression
7075 match for later use, because the results of all lookups are cached. If a lookup
7076 is repeated, the result is taken from the cache, and no actual pattern matching
7077 takes place. The values of all the numeric variables are unset after a
7078 &((n)wildlsearch)& match.
7079
7080 .next
7081 Although I cannot see it being of much use, the general matching function that
7082 is used to implement &((n)wildlsearch)& means that the string may begin with a
7083 lookup name terminated by a semicolon, and followed by lookup data. For
7084 example:
7085 .code
7086 cdb;/some/file  data for keys that match the file
7087 .endd
7088 The data that is obtained from the nested lookup is discarded.
7089 .endlist olist
7090
7091 Keys that do not match any of these patterns are interpreted literally. The
7092 continuation rules for the data are the same as for &(lsearch)&, and keys may
7093 be followed by optional colons.
7094
7095 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7096 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7097 lookup types support only literal keys.
7098
7099 .subsection spf
7100 .cindex "spf lookup type"
7101 .cindex "lookup" "spf"
7102 If Exim is built with SPF support, manual lookups can be done
7103 (as opposed to the standard ACL condition method).
7104 For details see section &<<SECSPF>>&.
7105
7106
7107 .section "Query-style lookup types" "SECTquerystylelookups"
7108 .cindex "lookup" "query-style types"
7109 .cindex "query-style lookup" "list of types"
7110 The supported query-style lookup types are listed below. Further details about
7111 many of them are given in later sections.
7112
7113 .subsection dnsdb
7114 .cindex "DNS" "as a lookup type"
7115 .cindex "lookup" "DNS"
7116 This does a DNS search for one or more records whose domain names
7117 are given in the supplied query. The resulting data is the contents of the
7118 records. See section &<<SECTdnsdb>>&.
7119
7120 .subsection ibase
7121 .cindex "InterBase lookup type"
7122 .cindex "lookup" "InterBase"
7123 This does a lookup in an InterBase database.
7124
7125 .subsection ldap
7126 .cindex "LDAP" "lookup type"
7127 .cindex "lookup" "LDAP"
7128 This does an LDAP lookup using a query in the form of a URL, and
7129 returns attributes from a single entry. There is a variant called &(ldapm)&
7130 that permits values from multiple entries to be returned. A third variant
7131 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7132 any attribute values. See section &<<SECTldap>>&.
7133
7134 .subsection mysql
7135 .cindex "MySQL" "lookup type"
7136 .cindex "lookup" "MySQL"
7137 The format of the query is an SQL statement that is passed to a
7138 MySQL database. See section &<<SECTsql>>&.
7139
7140 .subsection nisplus
7141 .cindex "NIS+ lookup type"
7142 .cindex "lookup" "NIS+"
7143 This does a NIS+ lookup using a query that can specify the name of
7144 the field to be returned. See section &<<SECTnisplus>>&.
7145
7146 .subsection oracle
7147 .cindex "Oracle" "lookup type"
7148 .cindex "lookup" "Oracle"
7149 The format of the query is an SQL statement that is passed to an
7150 Oracle database. See section &<<SECTsql>>&.
7151
7152 .subsection passwd
7153 .cindex "lookup" "passwd"
7154 .cindex "passwd lookup type"
7155 .cindex "&_/etc/passwd_&"
7156 This is a query-style lookup with queries that are just user names. The
7157 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7158 success, the result string is the same as you would get from an &(lsearch)&
7159 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7160 password value. For example:
7161 .code
7162 *:42:42:King Rat:/home/kr:/bin/bash
7163 .endd
7164
7165 .subsection pgsql
7166 .cindex "PostgreSQL lookup type"
7167 .cindex "lookup" "PostgreSQL"
7168 The format of the query is an SQL statement that is passed to a
7169 PostgreSQL database. See section &<<SECTsql>>&.
7170
7171 .subsection redis
7172 .cindex "Redis lookup type"
7173 .cindex lookup Redis
7174 The format of the query is either a simple get or simple set,
7175 passed to a Redis database. See section &<<SECTsql>>&.
7176
7177 .subsection sqlite
7178 .cindex "sqlite lookup type"
7179 .cindex "lookup" "sqlite"
7180 The format of the query is
7181 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7182
7183 .subsection testdb
7184 This is a lookup type that is used for testing Exim. It is
7185 not likely to be useful in normal operation.
7186
7187 .subsection whoson
7188 .cindex "whoson lookup type"
7189 .cindex "lookup" "whoson"
7190 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7191 allows a server to check whether a particular (dynamically allocated) IP
7192 address is currently allocated to a known (trusted) user and, optionally, to
7193 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7194 at one time for &"POP before SMTP"& authentication, but that approach has been
7195 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7196 &"POP before SMTP"& checking using ACL statements such as
7197 .code
7198 require condition = \
7199   ${lookup whoson {$sender_host_address}{yes}{no}}
7200 .endd
7201 The query consists of a single IP address. The value returned is the name of
7202 the authenticated user, which is stored in the variable &$value$&. However, in
7203 this example, the data in &$value$& is not used; the result of the lookup is
7204 one of the fixed strings &"yes"& or &"no"&.
7205
7206
7207
7208 .section "Temporary errors in lookups" "SECID63"
7209 .cindex "lookup" "temporary error in"
7210 Lookup functions can return temporary error codes if the lookup cannot be
7211 completed. For example, an SQL or LDAP database might be unavailable. For this
7212 reason, it is not advisable to use a lookup that might do this for critical
7213 options such as a list of local domains.
7214
7215 When a lookup cannot be completed in a router or transport, delivery
7216 of the message (to the relevant address) is deferred, as for any other
7217 temporary error. In other circumstances Exim may assume the lookup has failed,
7218 or may give up altogether.
7219
7220
7221
7222 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7223 .cindex "wildcard lookups"
7224 .cindex "lookup" "default values"
7225 .cindex "lookup" "wildcard"
7226 .cindex "lookup" "* added to type"
7227 .cindex "default" "in single-key lookups"
7228 In this context, a &"default value"& is a value specified by the administrator
7229 that is to be used if a lookup fails.
7230
7231 &*Note:*& This section applies only to single-key lookups. For query-style
7232 lookups, the facilities of the query language must be used. An attempt to
7233 specify a default for a query-style lookup provokes an error.
7234
7235 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7236 and the initial lookup fails, the key &"*"& is looked up in the file to
7237 provide a default value. See also the section on partial matching below.
7238
7239 .cindex "*@ with single-key lookup"
7240 .cindex "lookup" "*@ added to type"
7241 .cindex "alias file" "per-domain default"
7242 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7243 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7244 character, a second lookup is done with everything before the last @ replaced
7245 by *. This makes it possible to provide per-domain defaults in alias files
7246 that include the domains in the keys. If the second lookup fails (or doesn't
7247 take place because there is no @ in the key), &"*"& is looked up.
7248 For example, a &(redirect)& router might contain:
7249 .code
7250 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7251 .endd
7252 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7253 looks up these keys, in this order:
7254 .code
7255 jane@eyre.example
7256 *@eyre.example
7257 *
7258 .endd
7259 The data is taken from whichever key it finds first. &*Note*&: In an
7260 &(lsearch)& file, this does not mean the first of these keys in the file. A
7261 complete scan is done for each key, and only if it is not found at all does
7262 Exim move on to try the next key.
7263
7264
7265
7266 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7267 .cindex "partial matching"
7268 .cindex "wildcard lookups"
7269 .cindex "lookup" "partial matching"
7270 .cindex "lookup" "wildcard"
7271 .cindex "asterisk" "in search type"
7272 The normal operation of a single-key lookup is to search the file for an exact
7273 match with the given key. However, in a number of situations where domains are
7274 being looked up, it is useful to be able to do partial matching. In this case,
7275 information in the file that has a key starting with &"*."& is matched by any
7276 domain that ends with the components that follow the full stop. For example, if
7277 a key in a DBM file is
7278 .code
7279 *.dates.fict.example
7280 .endd
7281 then when partial matching is enabled this is matched by (amongst others)
7282 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7283 by &'dates.fict.example'&, if that does not appear as a separate key in the
7284 file.
7285
7286 &*Note*&: Partial matching is not available for query-style lookups. It is
7287 also not available for any lookup items in address lists (see section
7288 &<<SECTaddresslist>>&).
7289
7290 Partial matching is implemented by doing a series of separate lookups using
7291 keys constructed by modifying the original subject key. This means that it can
7292 be used with any of the single-key lookup types, provided that
7293 partial matching keys
7294 beginning with a special prefix (default &"*."&) are included in the data file.
7295 Keys in the file that do not begin with the prefix are matched only by
7296 unmodified subject keys when partial matching is in use.
7297
7298 Partial matching is requested by adding the string &"partial-"& to the front of
7299 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7300 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7301 is added at the start of the subject key, and it is looked up again. If that
7302 fails, further lookups are tried with dot-separated components removed from the
7303 start of the subject key, one-by-one, and &"*."& added on the front of what
7304 remains.
7305
7306 A minimum number of two non-* components are required. This can be adjusted
7307 by including a number before the hyphen in the search type. For example,
7308 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7309 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7310 subject key is &'2250.dates.fict.example'& then the following keys are looked
7311 up when the minimum number of non-* components is two:
7312 .code
7313 2250.dates.fict.example
7314 *.2250.dates.fict.example
7315 *.dates.fict.example
7316 *.fict.example
7317 .endd
7318 As soon as one key in the sequence is successfully looked up, the lookup
7319 finishes.
7320
7321 .cindex "lookup" "partial matching &-- changing prefix"
7322 .cindex "prefix" "for partial matching"
7323 The use of &"*."& as the partial matching prefix is a default that can be
7324 changed. The motivation for this feature is to allow Exim to operate with file
7325 formats that are used by other MTAs. A different prefix can be supplied in
7326 parentheses instead of the hyphen after &"partial"&. For example:
7327 .code
7328 domains = partial(.)lsearch;/some/file
7329 .endd
7330 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7331 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7332 components is unchanged). The prefix may consist of any punctuation characters
7333 other than a closing parenthesis. It may be empty, for example:
7334 .code
7335 domains = partial1()cdb;/some/file
7336 .endd
7337 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7338 &`a.b.c`&, &`b.c`&, and &`c`&.
7339
7340 If &"partial0"& is specified, what happens at the end (when the lookup with
7341 just one non-wild component has failed, and the original key is shortened right
7342 down to the null string) depends on the prefix:
7343
7344 .ilist
7345 If the prefix has zero length, the whole lookup fails.
7346 .next
7347 If the prefix has length 1, a lookup for just the prefix is done. For
7348 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7349 .next
7350 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7351 remainder is looked up. With the default prefix, therefore, the final lookup is
7352 for &"*"& on its own.
7353 .next
7354 Otherwise, the whole prefix is looked up.
7355 .endlist
7356
7357
7358 If the search type ends in &"*"& or &"*@"& (see section
7359 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7360 this implies happens after all partial lookups have failed. If &"partial0"& is
7361 specified, adding &"*"& to the search type has no effect with the default
7362 prefix, because the &"*"& key is already included in the sequence of partial
7363 lookups. However, there might be a use for lookup types such as
7364 &"partial0(.)lsearch*"&.
7365
7366 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7367 in domain lists and the like. Partial matching works only in terms of
7368 dot-separated components; a key such as &`*fict.example`&
7369 in a database file is useless, because the asterisk in a partial matching
7370 subject key is always followed by a dot.
7371
7372 When the lookup is done from a string-expansion,
7373 the variables &$1$& and &$2$& contain the wild and non-wild parts of the key
7374 during the expansion of the replacement text.
7375 They return to their previous values at the end of the lookup item.
7376
7377
7378
7379
7380 .section "Lookup caching" "SECID64"
7381 .cindex "lookup" "caching"
7382 .cindex "caching" "lookup data"
7383 Exim caches all lookup results in order to avoid needless repetition of
7384 lookups. However, because (apart from the daemon) Exim operates as a collection
7385 of independent, short-lived processes, this caching applies only within a
7386 single Exim process. There is no inter-process lookup caching facility.
7387
7388 If an option &"cache=no_rd"& is used on the lookup then
7389 the cache is only written to, cached data is not used for the operation
7390 and a real lookup is done.
7391
7392 For single-key lookups, Exim keeps the relevant files open in case there is
7393 another lookup that needs them. In some types of configuration this can lead to
7394 many files being kept open for messages with many recipients. To avoid hitting
7395 the operating system limit on the number of simultaneously open files, Exim
7396 closes the least recently used file when it needs to open more files than its
7397 own internal limit, which can be changed via the &%lookup_open_max%& option.
7398
7399 The single-key lookup files are closed and the lookup caches are flushed at
7400 strategic points during delivery &-- for example, after all routing is
7401 complete.
7402
7403
7404
7405
7406 .section "Quoting lookup data" "SECID65"
7407 .cindex "lookup" "quoting"
7408 .cindex "quoting" "in lookups"
7409 When data from an incoming message is included in a query-style lookup, there
7410 is the possibility of special characters in the data messing up the syntax of
7411 the query. For example, a NIS+ query that contains
7412 .code
7413 [name=$local_part]
7414 .endd
7415 will be broken if the local part happens to contain a closing square bracket.
7416 For NIS+, data can be enclosed in double quotes like this:
7417 .code
7418 [name="$local_part"]
7419 .endd
7420 but this still leaves the problem of a double quote in the data. The rule for
7421 NIS+ is that double quotes must be doubled. Other lookup types have different
7422 rules, and to cope with the differing requirements, an expansion operator
7423 of the following form is provided:
7424 .code
7425 ${quote_<lookup-type>:<string>}
7426 .endd
7427 For example, the way to write the NIS+ query is
7428 .code
7429 [name="${quote_nisplus:$local_part}"]
7430 .endd
7431 .cindex "tainted data" "in lookups"
7432 &*All*& tainted data used in a query-style lookup must be quoted
7433 using a mechanism appropriate for the lookup type.
7434 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7435 operator can be used for all lookup types, but has no effect for single-key
7436 lookups, since no quoting is ever needed in their key strings.
7437
7438
7439
7440
7441 .section "More about dnsdb" "SECTdnsdb"
7442 .cindex "dnsdb lookup"
7443 .cindex "lookup" "dnsdb"
7444 .cindex "DNS" "as a lookup type"
7445 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7446 of a record type and a domain name, separated by an equals sign. For example,
7447 an expansion string could contain:
7448 .code
7449 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7450 .endd
7451 If the lookup succeeds, the result is placed in &$value$&, which in this case
7452 is used on its own as the result. If the lookup does not succeed, the
7453 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7454 &<<SECTforexpfai>>& for an explanation of what this means.
7455
7456 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7457 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7458 If no type is given, TXT is assumed.
7459
7460 For any record type, if multiple records are found, the data is returned as a
7461 concatenation, with newline as the default separator. The order, of course,
7462 depends on the DNS resolver. You can specify a different separator character
7463 between multiple records by putting a right angle-bracket followed immediately
7464 by the new separator at the start of the query. For example:
7465 .code
7466 ${lookup dnsdb{>: a=host1.example}}
7467 .endd
7468 It is permitted to specify a space as the separator character. Further
7469 white space is ignored.
7470 For lookup types that return multiple fields per record,
7471 an alternate field separator can be specified using a comma after the main
7472 separator character, followed immediately by the field separator.
7473
7474 .cindex "PTR record" "in &(dnsdb)& lookup"
7475 When the type is PTR,
7476 the data can be an IP address, written as normal; inversion and the addition of
7477 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7478 .code
7479 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7480 .endd
7481 If the data for a PTR record is not a syntactically valid IP address, it is not
7482 altered and nothing is added.
7483
7484 .cindex "MX record" "in &(dnsdb)& lookup"
7485 .cindex "SRV record" "in &(dnsdb)& lookup"
7486 For an MX lookup, both the preference value and the host name are returned for
7487 each record, separated by a space. For an SRV lookup, the priority, weight,
7488 port, and host name are returned for each record, separated by spaces.
7489 The field separator can be modified as above.
7490
7491 .cindex "TXT record" "in &(dnsdb)& lookup"
7492 .cindex "SPF record" "in &(dnsdb)& lookup"
7493 For TXT records with multiple items of data, only the first item is returned,
7494 unless a field separator is specified.
7495 To concatenate items without a separator, use a semicolon instead.
7496 For SPF records the
7497 default behaviour is to concatenate multiple items without using a separator.
7498 .code
7499 ${lookup dnsdb{>\n,: txt=a.b.example}}
7500 ${lookup dnsdb{>\n; txt=a.b.example}}
7501 ${lookup dnsdb{spf=example.org}}
7502 .endd
7503 It is permitted to specify a space as the separator character. Further
7504 white space is ignored.
7505
7506 .cindex "SOA record" "in &(dnsdb)& lookup"
7507 For an SOA lookup, while no result is obtained the lookup is redone with
7508 successively more leading components dropped from the given domain.
7509 Only the primary-nameserver field is returned unless a field separator is
7510 specified.
7511 .code
7512 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7513 .endd
7514
7515 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7516 .cindex "dnsdb modifiers"
7517 .cindex "modifiers" "dnsdb"
7518 .cindex "options" "dnsdb"
7519 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7520 each followed by a comma,
7521 that may appear before the record type.
7522
7523 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7524 temporary DNS error for any of them, the behaviour is controlled by
7525 a defer-option modifier.
7526 The possible keywords are
7527 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7528 With &"strict"& behaviour, any temporary DNS error causes the
7529 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7530 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7531 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7532 error causes the whole lookup to defer only if none of the other lookups
7533 succeed. The default is &"lax"&, so the following lookups are equivalent:
7534 .code
7535 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7536 ${lookup dnsdb{a=one.host.com:two.host.com}}
7537 .endd
7538 Thus, in the default case, as long as at least one of the DNS lookups
7539 yields some data, the lookup succeeds.
7540
7541 .cindex "DNSSEC" "dns lookup"
7542 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7543 The possible keywords are
7544 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7545 With &"strict"& or &"lax"& DNSSEC information is requested
7546 with the lookup.
7547 With &"strict"& a response from the DNS resolver that
7548 is not labelled as authenticated data
7549 is treated as equivalent to a temporary DNS error.
7550 The default is &"lax"&.
7551
7552 See also the &$lookup_dnssec_authenticated$& variable.
7553
7554 .cindex timeout "dns lookup"
7555 .cindex "DNS" timeout
7556 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7557 The form is &"retrans_VAL"& where VAL is an Exim time specification
7558 (e.g. &"5s"&).
7559 The default value is set by the main configuration option &%dns_retrans%&.
7560
7561 Retries for the dnsdb lookup can be controlled by a retry modifier.
7562 The form if &"retry_VAL"& where VAL is an integer.
7563 The default count is set by the main configuration option &%dns_retry%&.
7564
7565 .cindex caching "of dns lookup"
7566 .cindex TTL "of dns lookup"
7567 .cindex DNS TTL
7568 Dnsdb lookup results are cached within a single process (and its children).
7569 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7570 value of the set of returned DNS records.
7571
7572
7573 .subsection "Pseudo dnsdb record types" SECID66
7574 .cindex "MX record" "in &(dnsdb)& lookup"
7575 By default, both the preference value and the host name are returned for
7576 each MX record, separated by a space. If you want only host names, you can use
7577 the pseudo-type MXH:
7578 .code
7579 ${lookup dnsdb{mxh=a.b.example}}
7580 .endd
7581 In this case, the preference values are omitted, and just the host names are
7582 returned.
7583
7584 .cindex "name server for enclosing domain"
7585 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7586 records on the given domain, but if none are found, it removes the first
7587 component of the domain name, and tries again. This process continues until NS
7588 records are found or there are no more components left (or there is a DNS
7589 error). In other words, it may return the name servers for a top-level domain,
7590 but it never returns the root name servers. If there are no NS records for the
7591 top-level domain, the lookup fails. Consider these examples:
7592 .code
7593 ${lookup dnsdb{zns=xxx.quercite.com}}
7594 ${lookup dnsdb{zns=xxx.edu}}
7595 .endd
7596 Assuming that in each case there are no NS records for the full domain name,
7597 the first returns the name servers for &%quercite.com%&, and the second returns
7598 the name servers for &%edu%&.
7599
7600 You should be careful about how you use this lookup because, unless the
7601 top-level domain does not exist, the lookup always returns some host names. The
7602 sort of use to which this might be put is for seeing if the name servers for a
7603 given domain are on a blacklist. You can probably assume that the name servers
7604 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7605 such a list.
7606
7607 .cindex "CSA" "in &(dnsdb)& lookup"
7608 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7609 records according to the CSA rules, which are described in section
7610 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7611 not sufficient because of the extra parent domain search behaviour of CSA. The
7612 result of a successful lookup such as:
7613 .code
7614 ${lookup dnsdb {csa=$sender_helo_name}}
7615 .endd
7616 has two space-separated fields: an authorization code and a target host name.
7617 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7618 authorization required but absent, or &"?"& for unknown.
7619
7620 .cindex "A+" "in &(dnsdb)& lookup"
7621 The pseudo-type A+ performs an AAAA
7622 and then an A lookup.  All results are returned; defer processing
7623 (see below) is handled separately for each lookup.  Example:
7624 .code
7625 ${lookup dnsdb {>; a+=$sender_helo_name}}
7626 .endd
7627
7628
7629 .subsection "Multiple dnsdb lookups" SECID67
7630 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7631 However, you can specify a list of domains or IP addresses in a single
7632 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7633 the default separator, but with the ability to change this. For example:
7634 .code
7635 ${lookup dnsdb{one.domain.com:two.domain.com}}
7636 ${lookup dnsdb{a=one.host.com:two.host.com}}
7637 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7638 .endd
7639 In order to retain backwards compatibility, there is one special case: if
7640 the lookup type is PTR and no change of separator is specified, Exim looks
7641 to see if the rest of the string is precisely one IPv6 address. In this
7642 case, it does not treat it as a list.
7643
7644 The data from each lookup is concatenated, with newline separators by default,
7645 in the same way that multiple DNS records for a single item are handled. A
7646 different separator can be specified, as described above.
7647
7648
7649
7650
7651 .section "More about LDAP" "SECTldap"
7652 .cindex "LDAP" "lookup, more about"
7653 .cindex "lookup" "LDAP"
7654 .cindex "Solaris" "LDAP"
7655 The original LDAP implementation came from the University of Michigan; this has
7656 become &"Open LDAP"&, and there are now two different releases. Another
7657 implementation comes from Netscape, and Solaris 7 and subsequent releases
7658 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7659 the lookup function level, their error handling is different. For this reason
7660 it is necessary to set a compile-time variable when building Exim with LDAP, to
7661 indicate which LDAP library is in use. One of the following should appear in
7662 your &_Local/Makefile_&:
7663 .code
7664 LDAP_LIB_TYPE=UMICHIGAN
7665 LDAP_LIB_TYPE=OPENLDAP1
7666 LDAP_LIB_TYPE=OPENLDAP2
7667 LDAP_LIB_TYPE=NETSCAPE
7668 LDAP_LIB_TYPE=SOLARIS
7669 .endd
7670 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7671 same interface as the University of Michigan version.
7672
7673 There are three LDAP lookup types in Exim. These behave slightly differently in
7674 the way they handle the results of a query:
7675
7676 .ilist
7677 &(ldap)& requires the result to contain just one entry; if there are more, it
7678 gives an error.
7679 .next
7680 &(ldapdn)& also requires the result to contain just one entry, but it is the
7681 Distinguished Name that is returned rather than any attribute values.
7682 .next
7683 &(ldapm)& permits the result to contain more than one entry; the attributes
7684 from all of them are returned.
7685 .endlist
7686
7687
7688 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7689 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7690 the data returned by a successful lookup is described in the next section.
7691 First we explain how LDAP queries are coded.
7692
7693
7694 .subsection "Format of LDAP queries" SECTforldaque
7695 .cindex "LDAP" "query format"
7696 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7697 the configuration of a &(redirect)& router one might have this setting:
7698 .code
7699 data = ${lookup ldap \
7700   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7701   c=UK?mailbox?base?}}
7702 .endd
7703 .cindex "LDAP" "with TLS"
7704 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7705 secure (encrypted) LDAP connections. The second of these ensures that an
7706 encrypted TLS connection is used.
7707
7708 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7709 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7710 See the &%ldap_start_tls%& option.
7711
7712 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7713 controlled. Every part of the TLS configuration can be configured by settings in
7714 &_exim.conf_&. Depending on the version of the client libraries installed on
7715 your system, some of the initialization may have required setting options in
7716 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7717 certificates. This revealed a nuance where the current UID that exim was
7718 running as could affect which config files it read. With Exim 4.83, these
7719 methods become optional, only taking effect if not specifically set in
7720 &_exim.conf_&.
7721
7722
7723 .subsection "LDAP quoting" SECID68
7724 .cindex "LDAP" "quoting"
7725 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7726 and the second because the LDAP query is represented as a URL. Furthermore,
7727 within an LDAP query, two different kinds of quoting are required. For this
7728 reason, there are two different LDAP-specific quoting operators.
7729
7730 The &%quote_ldap%& operator is designed for use on strings that are part of
7731 filter specifications. Conceptually, it first does the following conversions on
7732 the string:
7733 .code
7734 *   =>   \2A
7735 (   =>   \28
7736 )   =>   \29
7737 \   =>   \5C
7738 .endd
7739 in accordance with RFC 2254. The resulting string is then quoted according
7740 to the rules for URLs, that is, all non-alphanumeric characters except
7741 .code
7742 ! $ ' - . _ ( ) * +
7743 .endd
7744 are converted to their hex values, preceded by a percent sign. For example:
7745 .code
7746 ${quote_ldap: a(bc)*, a<yz>; }
7747 .endd
7748 yields
7749 .code
7750 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7751 .endd
7752 Removing the URL quoting, this is (with a leading and a trailing space):
7753 .code
7754 a\28bc\29\2A, a<yz>;
7755 .endd
7756 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7757 base DN specifications in queries. Conceptually, it first converts the string
7758 by inserting a backslash in front of any of the following characters:
7759 .code
7760 , + " \ < > ;
7761 .endd
7762 It also inserts a backslash before any leading spaces or # characters, and
7763 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7764 is then quoted according to the rules for URLs. For example:
7765 .code
7766 ${quote_ldap_dn: a(bc)*, a<yz>; }
7767 .endd
7768 yields
7769 .code
7770 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7771 .endd
7772 Removing the URL quoting, this is (with a trailing space):
7773 .code
7774 \ a(bc)*\, a\<yz\>\;\
7775 .endd
7776 There are some further comments about quoting in the section on LDAP
7777 authentication below.
7778
7779
7780 .subsection "LDAP connections" SECID69
7781 .cindex "LDAP" "connections"
7782 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7783 is in use, via a Unix domain socket. The example given above does not specify
7784 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7785 by starting it with
7786 .code
7787 ldap://<hostname>:<port>/...
7788 .endd
7789 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7790 used. When no server is specified in a query, a list of default servers is
7791 taken from the &%ldap_default_servers%& configuration option. This supplies a
7792 colon-separated list of servers which are tried in turn until one successfully
7793 handles a query, or there is a serious error. Successful handling either
7794 returns the requested data, or indicates that it does not exist. Serious errors
7795 are syntactical, or multiple values when only a single value is expected.
7796 Errors which cause the next server to be tried are connection failures, bind
7797 failures, and timeouts.
7798
7799 For each server name in the list, a port number can be given. The standard way
7800 of specifying a host and port is to use a colon separator (RFC 1738). Because
7801 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7802 doubled. For example
7803 .code
7804 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7805 .endd
7806 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7807 to the LDAP library with no server name, and the library's default (normally
7808 the local host) is used.
7809
7810 If you are using the OpenLDAP library, you can connect to an LDAP server using
7811 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7812 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7813 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7814 not available.
7815
7816 For this type of connection, instead of a host name for the server, a pathname
7817 for the socket is required, and the port number is not relevant. The pathname
7818 can be specified either as an item in &%ldap_default_servers%&, or inline in
7819 the query. In the former case, you can have settings such as
7820 .code
7821 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7822 .endd
7823 When the pathname is given in the query, you have to escape the slashes as
7824 &`%2F`& to fit in with the LDAP URL syntax. For example:
7825 .code
7826 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7827 .endd
7828 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7829 a pathname, it uses the Unix domain socket code, even if the query actually
7830 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7831 socket connection. This behaviour means that you can use a setting of
7832 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7833 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7834 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7835 backup host.
7836
7837 If an explicit &`ldapi`& type is given in a query when a host name is
7838 specified, an error is diagnosed. However, if there are more items in
7839 &%ldap_default_servers%&, they are tried. In other words:
7840
7841 .ilist
7842 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7843 interface.
7844 .next
7845 Using &`ldapi`& with a host name causes an error.
7846 .endlist
7847
7848
7849 Using &`ldapi`& with no host or path in the query, and no setting of
7850 &%ldap_default_servers%&, does whatever the library does by default.
7851
7852
7853
7854 .subsection "LDAP authentication and control information" SECID70
7855 .cindex "LDAP" "authentication"
7856 The LDAP URL syntax provides no way of passing authentication and other control
7857 information to the server. To make this possible, the URL in an LDAP query may
7858 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7859 spaces. If a value contains spaces it must be enclosed in double quotes, and
7860 when double quotes are used, backslash is interpreted in the usual way inside
7861 them. The following names are recognized:
7862 .itable none 0 0 2 20* left 80* left
7863 .irow DEREFERENCE "set the dereferencing parameter"
7864 .irow NETTIME     "set a timeout for a network operation"
7865 .irow USER        "set the DN, for authenticating the LDAP bind"
7866 .irow PASS        "set the password, likewise"
7867 .irow REFERRALS   "set the referrals parameter"
7868 .irow SERVERS     "set alternate server list for this query only"
7869 .irow SIZE        "set the limit for the number of entries returned"
7870 .irow TIME        "set the maximum waiting time for a query"
7871 .endtable
7872 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7873 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7874 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7875 library from trying to follow referrals issued by the LDAP server.
7876
7877 .cindex LDAP timeout
7878 .cindex timeout "LDAP lookup"
7879 The name CONNECT is an obsolete name for NETTIME, retained for
7880 backwards compatibility. This timeout (specified as a number of seconds) is
7881 enforced from the client end for operations that can be carried out over a
7882 network. Specifically, it applies to network connections and calls to the
7883 &'ldap_result()'& function. If the value is greater than zero, it is used if
7884 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7885 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7886 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7887 Netscape SDK; for OpenLDAP no action is taken.
7888
7889 The TIME parameter (also a number of seconds) is passed to the server to
7890 set a server-side limit on the time taken to complete a search.
7891
7892 The SERVERS parameter allows you to specify an alternate list of ldap servers
7893 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7894 default list of ldap servers, and a single lookup can specify a single ldap
7895 server to use.  But when you need to do a lookup with a list of servers that is
7896 different than the default list (maybe different order, maybe a completely
7897 different set of servers), the SERVERS parameter allows you to specify this
7898 alternate list (colon-separated).
7899
7900 Here is an example of an LDAP query in an Exim lookup that uses some of these
7901 values. This is a single line, folded to fit on the page:
7902 .code
7903 ${lookup ldap
7904   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7905   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7906   {$value}fail}
7907 .endd
7908 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7909 any of the auxiliary data. Exim configuration settings that include lookups
7910 which contain password information should be preceded by &"hide"& to prevent
7911 non-admin users from using the &%-bP%& option to see their values.
7912
7913 The auxiliary data items may be given in any order. The default is no
7914 connection timeout (the system timeout is used), no user or password, no limit
7915 on the number of entries returned, and no time limit on queries.
7916
7917 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7918 removes any URL quoting that it may contain before passing it to the LDAP library.
7919 Apparently
7920 some libraries do this for themselves, but some do not. Removing the URL
7921 quoting has two advantages:
7922
7923 .ilist
7924 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7925 DNs as with DNs inside actual queries.
7926 .next
7927 It permits spaces inside USER= DNs.
7928 .endlist
7929
7930 For example, a setting such as
7931 .code
7932 USER=cn=${quote_ldap_dn:$1}
7933 .endd
7934 should work even if &$1$& contains spaces.
7935
7936 Expanded data for the PASS= value should be quoted using the &%quote%&
7937 expansion operator, rather than the LDAP quote operators. The only reason this
7938 field needs quoting is to ensure that it conforms to the Exim syntax, which
7939 does not allow unquoted spaces. For example:
7940 .code
7941 PASS=${quote:$3}
7942 .endd
7943 The LDAP authentication mechanism can be used to check passwords as part of
7944 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7945 &<<CHAPexpand>>&.
7946
7947
7948
7949 .subsection "Format of data returned by LDAP" SECID71
7950 .cindex "LDAP" "returned data formats"
7951 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7952 as a sequence of values, for example
7953 .code
7954 cn=manager,o=University of Cambridge,c=UK
7955 .endd
7956 The &(ldap)& lookup type generates an error if more than one entry matches the
7957 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7958 the result between the data from different entries. It is possible for multiple
7959 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7960 you know that whatever values are returned all came from a single entry in the
7961 directory.
7962
7963 In the common case where you specify a single attribute in your LDAP query, the
7964 result is not quoted, and does not contain the attribute name. If the attribute
7965 has multiple values, they are separated by commas. Any comma that is
7966 part of an attribute's value is doubled.
7967
7968 If you specify multiple attributes, the result contains space-separated, quoted
7969 strings, each preceded by the attribute name and an equals sign. Within the
7970 quotes, the quote character, backslash, and newline are escaped with
7971 backslashes, and commas are used to separate multiple values for the attribute.
7972 Any commas in attribute values are doubled
7973 (permitting treatment of the values as a comma-separated list).
7974 Apart from the escaping, the string within quotes takes the same form as the
7975 output when a single attribute is requested. Specifying no attributes is the
7976 same as specifying all of an entry's attributes.
7977
7978 Here are some examples of the output format. The first line of each pair is an
7979 LDAP query, and the second is the data that is returned. The attribute called
7980 &%attr1%& has two values, one of them with an embedded comma, whereas
7981 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7982 (they have SUP &%attr%& in their schema definitions).
7983
7984 .code
7985 ldap:///o=base?attr1?sub?(uid=fred)
7986 value1.1,value1,,2
7987
7988 ldap:///o=base?attr2?sub?(uid=fred)
7989 value two
7990
7991 ldap:///o=base?attr?sub?(uid=fred)
7992 value1.1,value1,,2,value two
7993
7994 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7995 attr1="value1.1,value1,,2" attr2="value two"
7996
7997 ldap:///o=base??sub?(uid=fred)
7998 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7999 .endd
8000 You can
8001 make use of Exim's &%-be%& option to run expansion tests and thereby check the
8002 results of LDAP lookups.
8003 The &%extract%& operator in string expansions can be used to pick out
8004 individual fields from data that consists of &'key'&=&'value'& pairs.
8005 The &%listextract%& operator should be used to pick out individual values
8006 of attributes, even when only a single value is expected.
8007 The doubling of embedded commas allows you to use the returned data as a
8008 comma separated list (using the "<," syntax for changing the input list separator).
8009
8010
8011
8012
8013 .section "More about NIS+" "SECTnisplus"
8014 .cindex "NIS+ lookup type"
8015 .cindex "lookup" "NIS+"
8016 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
8017 and field name. If this is given, the result of a successful query is the
8018 contents of the named field; otherwise the result consists of a concatenation
8019 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
8020 values containing spaces are quoted. For example, the query
8021 .code
8022 [name=mg1456],passwd.org_dir
8023 .endd
8024 might return the string
8025 .code
8026 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
8027 home=/home/mg1456 shell=/bin/bash shadow=""
8028 .endd
8029 (split over two lines here to fit on the page), whereas
8030 .code
8031 [name=mg1456],passwd.org_dir:gcos
8032 .endd
8033 would just return
8034 .code
8035 Martin Guerre
8036 .endd
8037 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8038 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8039 operator is to double any quote characters within the text.
8040
8041
8042
8043 .section "SQL lookups" "SECTsql"
8044 .cindex "SQL lookup types"
8045 .cindex "MySQL" "lookup type"
8046 .cindex "PostgreSQL lookup type"
8047 .cindex "lookup" "MySQL"
8048 .cindex "lookup" "PostgreSQL"
8049 .cindex "Oracle" "lookup type"
8050 .cindex "lookup" "Oracle"
8051 .cindex "InterBase lookup type"
8052 .cindex "lookup" "InterBase"
8053 .cindex "Redis lookup type"
8054 .cindex lookup Redis
8055 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8056 and SQLite
8057 databases. Queries for these databases contain SQL statements, so an example
8058 might be
8059 .code
8060 ${lookup mysql{select mailbox from users where id='userx'}\
8061   {$value}fail}
8062 .endd
8063 If the result of the query contains more than one field, the data for each
8064 field in the row is returned, preceded by its name, so the result of
8065 .code
8066 ${lookup pgsql{select home,name from users where id='userx'}\
8067   {$value}}
8068 .endd
8069 might be
8070 .code
8071 home=/home/userx name="Mister X"
8072 .endd
8073 Empty values and values containing spaces are double quoted, with embedded
8074 quotes escaped by a backslash. If the result of the query contains just one
8075 field, the value is passed back verbatim, without a field name, for example:
8076 .code
8077 Mister X
8078 .endd
8079 If the result of the query yields more than one row, it is all concatenated,
8080 with a newline between the data for each row.
8081
8082
8083 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
8084 .cindex "MySQL" "lookup type"
8085 .cindex "PostgreSQL lookup type"
8086 .cindex "lookup" "MySQL"
8087 .cindex "lookup" "PostgreSQL"
8088 .cindex "Oracle" "lookup type"
8089 .cindex "lookup" "Oracle"
8090 .cindex "InterBase lookup type"
8091 .cindex "lookup" "InterBase"
8092 .cindex "Redis lookup type"
8093 .cindex lookup Redis
8094 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8095 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8096 or &%redis_servers%&
8097 option (as appropriate) must be set to a colon-separated list of server
8098 information.
8099 .oindex &%mysql_servers%&
8100 .oindex &%pgsql_servers%&
8101 .oindex &%oracle_servers%&
8102 .oindex &%ibase_servers%&
8103 .oindex &%redis_servers%&
8104 (For MySQL and PostgreSQL, the global option need not be set if all
8105 queries contain their own server information &-- see section
8106 &<<SECTspeserque>>&.)
8107 For all but Redis
8108 each item in the list is a slash-separated list of four
8109 items: host name, database name, user name, and password. In the case of
8110 Oracle, the host name field is used for the &"service name"&, and the database
8111 name field is not used and should be empty. For example:
8112 .code
8113 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8114 .endd
8115 Because password data is sensitive, you should always precede the setting with
8116 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8117 option. Here is an example where two MySQL servers are listed:
8118 .code
8119 hide mysql_servers = localhost/users/root/secret:\
8120                      otherhost/users/root/othersecret
8121 .endd
8122 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8123 because this is a colon-separated list, the colon has to be doubled. For each
8124 query, these parameter groups are tried in order until a connection is made and
8125 a query is successfully processed. The result of a query may be that no data is
8126 found, but that is still a successful query. In other words, the list of
8127 servers provides a backup facility, not a list of different places to look.
8128
8129 For Redis the global option need not be specified if all queries contain their
8130 own server information &-- see section &<<SECTspeserque>>&.
8131 If specified, the option must be set to a colon-separated list of server
8132 information.
8133 Each item in the list is a slash-separated list of three items:
8134 host, database number, and password.
8135 .olist
8136 The host is required and may be either an IPv4 address and optional
8137 port number (separated by a colon, which needs doubling due to the
8138 higher-level list), or a Unix socket pathname enclosed in parentheses
8139 .next
8140 The database number is optional; if present that number is selected in the backend
8141 .next
8142 The password is optional; if present it is used to authenticate to the backend
8143 .endlist
8144
8145 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8146 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8147 respectively, and the characters single-quote, double-quote, and backslash
8148 itself are escaped with backslashes.
8149
8150 The &%quote_redis%& expansion operator
8151 escapes whitespace and backslash characters with a backslash.
8152
8153 .subsection "Specifying the server in the query" SECTspeserque
8154 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8155 it is possible to specify a list of servers with an individual query. This is
8156 done by appending a comma-separated option to the query type:
8157 .display
8158 &`,servers=`&&'server1:server2:server3:...'&
8159 .endd
8160 Each item in the list may take one of two forms:
8161 .olist
8162 If it contains no slashes it is assumed to be just a host name. The appropriate
8163 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8164 of the same name, and the remaining parameters (database, user, password) are
8165 taken from there.
8166 .next
8167 If it contains any slashes, it is taken as a complete parameter set.
8168 .endlist
8169 The list of servers is used in exactly the same way as the global list.
8170 Once a connection to a server has happened and a query has been
8171 successfully executed, processing of the lookup ceases.
8172
8173 This feature is intended for use in master/slave situations where updates
8174 are occurring and you want to update the master rather than a slave. If the
8175 master is in the list as a backup for reading, you might have a global setting
8176 like this:
8177 .code
8178 mysql_servers = slave1/db/name/pw:\
8179                 slave2/db/name/pw:\
8180                 master/db/name/pw
8181 .endd
8182 In an updating lookup, you could then write:
8183 .code
8184 ${lookup mysql,servers=master {UPDATE ...} }
8185 .endd
8186 That query would then be sent only to the master server. If, on the other hand,
8187 the master is not to be used for reading, and so is not present in the global
8188 option, you can still update it by a query of this form:
8189 .code
8190 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8191 .endd
8192
8193 A now-deprecated syntax places the servers specification before the query,
8194 semicolon separated:
8195 .code
8196 ${lookup mysql{servers=master; UPDATE ...} }
8197 .endd
8198 The new version avoids issues with tainted
8199 arguments explicitly expanded as part of the query.
8200 The entire string within the braces becomes tainted,
8201 including the server sepcification - which is not permissible.
8202 If the older sytax is used, a warning message will be logged.
8203 This syntax will be removed in a future release.
8204
8205 &*Note*&: server specifications in list-style lookups are still problematic.
8206
8207
8208 .subsection "Special MySQL features" SECID73
8209 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8210 causes a connection to the server on the local host by means of a Unix domain
8211 socket. An alternate socket can be specified in parentheses.
8212 An option group name for MySQL option files can be specified in square brackets;
8213 the default value is &"exim"&.
8214 The full syntax of each item in &%mysql_servers%& is:
8215 .display
8216 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8217   <&'database'&>/<&'user'&>/<&'password'&>
8218 .endd
8219 Any of the four sub-parts of the first field can be omitted. For normal use on
8220 the local host it can be left blank or set to just &"localhost"&.
8221
8222 No database need be supplied &-- but if it is absent here, it must be given in
8223 the queries.
8224
8225 If a MySQL query is issued that does not request any data (an insert, update,
8226 or delete command), the result of the lookup is the number of rows affected.
8227
8228 &*Warning*&: This can be misleading. If an update does not actually change
8229 anything (for example, setting a field to the value it already has), the result
8230 is zero because no rows are affected.
8231
8232 To get an encryted connection, use a Mysql option file with the required
8233 parameters for the connection.
8234
8235
8236 .subsection "Special PostgreSQL features" SECID74
8237 PostgreSQL lookups can also use Unix domain socket connections to the database.
8238 This is usually faster and costs less CPU time than a TCP/IP connection.
8239 However it can be used only if the mail server runs on the same machine as the
8240 database server. A configuration line for PostgreSQL via Unix domain sockets
8241 looks like this:
8242 .code
8243 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8244 .endd
8245 In other words, instead of supplying a host name, a path to the socket is
8246 given. The path name is enclosed in parentheses so that its slashes aren't
8247 visually confused with the delimiters for the other server parameters.
8248
8249 If a PostgreSQL query is issued that does not request any data (an insert,
8250 update, or delete command), the result of the lookup is the number of rows
8251 affected.
8252
8253 .subsection "More about SQLite" SECTsqlite
8254 .cindex "lookup" "SQLite"
8255 .cindex "sqlite lookup type"
8256 SQLite is different to the other SQL lookups because a filename is required in
8257 addition to the SQL query. An SQLite database is a single file, and there is no
8258 daemon as in the other SQL databases.
8259
8260 .oindex &%sqlite_dbfile%&
8261 There are two ways of
8262 specifying the file.
8263 The first is by using the &%sqlite_dbfile%& main option.
8264 The second, which allows separate files for each query,
8265 is to use an option appended, comma-separated, to the &"sqlite"&
8266 lookup type word.  The option is the word &"file"&, then an equals,
8267 then the filename.
8268 The filename in this case cannot contain whitespace or open-brace charachters.
8269
8270 A deprecated method is available, prefixing the query with the filename
8271 separated by white space.
8272 This means that
8273 .cindex "tainted data" "sqlite file"
8274 the query cannot use any tainted values, as that taints
8275 the entire query including the filename - resulting in a refusal to open
8276 the file.
8277
8278 In all the above cases the filename must be an absolute path.
8279
8280 Here is a lookup expansion example:
8281 .code
8282 sqlite_dbfile = /some/thing/sqlitedb
8283 ...
8284 ${lookup sqlite {select name from aliases where id='userx';}}
8285 .endd
8286 In a list, the syntax is similar. For example:
8287 .code
8288 domainlist relay_to_domains = sqlite;\
8289    select * from relays where ip='$sender_host_address';
8290 .endd
8291 The only character affected by the &%quote_sqlite%& operator is a single
8292 quote, which it doubles.
8293
8294 .cindex timeout SQLite
8295 .cindex sqlite "lookup timeout"
8296 The SQLite library handles multiple simultaneous accesses to the database
8297 internally. Multiple readers are permitted, but only one process can
8298 update at once. Attempts to access the database while it is being updated
8299 are rejected after a timeout period, during which the SQLite library
8300 waits for the lock to be released. In Exim, the default timeout is set
8301 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8302 option.
8303
8304 .subsection "More about Redis" SECTredis
8305 .cindex "lookup" "Redis"
8306 .cindex "redis lookup type"
8307 Redis is a non-SQL database. Commands are simple get and set.
8308 Examples:
8309 .code
8310 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8311 ${lookup redis{get keyname}}
8312 .endd
8313
8314 As of release 4.91, "lightweight" support for Redis Cluster is available.
8315 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8316 of which must be reachable from the running exim instance. If the cluster has
8317 master/slave replication, the list must contain all the master and slave
8318 servers.
8319
8320 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8321 immediately follow the redirection but treats the response as a DEFER, moving on
8322 to the next server in the &%redis_servers%& list until the correct server is
8323 reached.
8324
8325 .ecindex IIDfidalo1
8326 .ecindex IIDfidalo2
8327
8328
8329 . ////////////////////////////////////////////////////////////////////////////
8330 . ////////////////////////////////////////////////////////////////////////////
8331
8332 .chapter "Domain, host, address, and local part lists" &&&
8333          "CHAPdomhosaddlists" &&&
8334          "Domain, host, and address lists"
8335 .scindex IIDdohoadli "lists of domains; hosts; etc."
8336 A number of Exim configuration options contain lists of domains, hosts,
8337 email addresses, or local parts. For example, the &%hold_domains%& option
8338 contains a list of domains whose delivery is currently suspended. These lists
8339 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8340 arguments to expansion conditions such as &%match_domain%&.
8341
8342 Each item in one of these lists is a pattern to be matched against a domain,
8343 host, email address, or local part, respectively. In the sections below, the
8344 different types of pattern for each case are described, but first we cover some
8345 general facilities that apply to all four kinds of list.
8346
8347 Note that other parts of Exim use a &'string list'& which does not
8348 support all the complexity available in
8349 domain, host, address and local part lists.
8350
8351
8352
8353 .section "Results of list checking" SECTlistresults
8354 The primary result of doing a list check is a truth value.
8355 In some contexts additional information is stored
8356 about the list element that matched:
8357 .vlist
8358 .vitem hosts
8359 A &%hosts%& ACL condition
8360 will store a result in the &$host_data$& variable.
8361 .vitem local_parts
8362 A &%local_parts%& router option or &%local_parts%& ACL condition
8363 will store a result in the &$local_part_data$& variable.
8364 .vitem domains
8365 A &%domains%& router option or &%domains%& ACL condition
8366 will store a result in the &$domain_data$& variable.
8367 .vitem senders
8368 A &%senders%& router option or &%senders%& ACL condition
8369 will store a result in the &$sender_data$& variable.
8370 .vitem recipients
8371 A &%recipients%& ACL condition
8372 will store a result in the &$recipient_data$& variable.
8373 .endlist
8374
8375 The detail of the additional information depends on the
8376 type of match and is given below as the &*value*& information.
8377
8378
8379
8380
8381 .section "Expansion of lists" "SECTlistexpand"
8382 .cindex "expansion" "of lists"
8383 Each list is expanded as a single string before it is used.
8384 .cindex "tainted data" tracking
8385 &*Note*&: As a result, if any componend was tainted then the
8386 entire result string becomes tainted.
8387
8388 &'Exception: the router headers_remove option, where list-item
8389 splitting is done before string-expansion.'&
8390
8391 The result of
8392 expansion must be a list, possibly containing empty items, which is split up
8393 into separate items for matching. By default, colon is the separator character,
8394 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8395 &<<SECTempitelis>>& for details of the list syntax; the second of these
8396 discusses the way to specify empty list items.
8397
8398
8399 If the string expansion is forced to fail, Exim behaves as if the item it is
8400 testing (domain, host, address, or local part) is not in the list. Other
8401 expansion failures cause temporary errors.
8402
8403 If an item in a list is a regular expression, backslashes, dollars and possibly
8404 other special characters in the expression must be protected against
8405 misinterpretation by the string expander. The easiest way to do this is to use
8406 the &`\N`& expansion feature to indicate that the contents of the regular
8407 expression should not be expanded. For example, in an ACL you might have:
8408 .code
8409 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8410                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8411 .endd
8412 The first item is a regular expression that is protected from expansion by
8413 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8414 senders based on the receiving domain.
8415
8416
8417
8418
8419 .subsection "Negated items in lists" SECID76
8420 .cindex "list" "negation"
8421 .cindex "negation" "in lists"
8422 Items in a list may be positive or negative. Negative items are indicated by a
8423 leading exclamation mark, which may be followed by optional white space. A list
8424 defines a set of items (domains, etc). When Exim processes one of these lists,
8425 it is trying to find out whether a domain, host, address, or local part
8426 (respectively) is in the set that is defined by the list. It works like this:
8427
8428 The list is scanned from left to right. If a positive item is matched, the
8429 subject that is being checked is in the set; if a negative item is matched, the
8430 subject is not in the set. If the end of the list is reached without the
8431 subject having matched any of the patterns, it is in the set if the last item
8432 was a negative one, but not if it was a positive one. For example, the list in
8433 .code
8434 domainlist relay_to_domains = !a.b.c : *.b.c
8435 .endd
8436 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8437 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8438 list is positive. However, if the setting were
8439 .code
8440 domainlist relay_to_domains = !a.b.c
8441 .endd
8442 then all domains other than &'a.b.c'& would match because the last item in the
8443 list is negative. In other words, a list that ends with a negative item behaves
8444 as if it had an extra item &`:*`& on the end.
8445
8446 Another way of thinking about positive and negative items in lists is to read
8447 the connector as &"or"& after a positive item and as &"and"& after a negative
8448 item.
8449
8450
8451
8452 .subsection "File names in lists" SECTfilnamlis
8453 .cindex "list" "filename in"
8454 If an item in a domain, host, address, or local part list is an absolute
8455 filename (beginning with a slash character), each line of the file is read and
8456 processed as if it were an independent item in the list, except that further
8457 filenames are not allowed,
8458 and no expansion of the data from the file takes place.
8459 Empty lines in the file are ignored, and the file may also contain comment
8460 lines:
8461
8462 .ilist
8463 For domain and host lists, if a # character appears anywhere in a line of the
8464 file, it and all following characters are ignored.
8465 .next
8466 Because local parts may legitimately contain # characters, a comment in an
8467 address list or local part list file is recognized only if # is preceded by
8468 white space or the start of the line. For example:
8469 .code
8470 not#comment@x.y.z   # but this is a comment
8471 .endd
8472 .endlist
8473
8474 Putting a filename in a list has the same effect as inserting each line of the
8475 file as an item in the list (blank lines and comments excepted). However, there
8476 is one important difference: the file is read each time the list is processed,
8477 so if its contents vary over time, Exim's behaviour changes.
8478
8479 If a filename is preceded by an exclamation mark, the sense of any match
8480 within the file is inverted. For example, if
8481 .code
8482 hold_domains = !/etc/nohold-domains
8483 .endd
8484 and the file contains the lines
8485 .code
8486 !a.b.c
8487 *.b.c
8488 .endd
8489 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8490 any domain matching &`*.b.c`& is not.
8491
8492
8493
8494 .subsection "An lsearch file is not an out-of-line list" SECID77
8495 As will be described in the sections that follow, lookups can be used in lists
8496 to provide indexed methods of checking list membership. There has been some
8497 confusion about the way &(lsearch)& lookups work in lists. Because
8498 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8499 sometimes thought that it is allowed to contain wild cards and other kinds of
8500 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8501 always fixed strings, just as for any other single-key lookup type.
8502
8503 If you want to use a file to contain wild-card patterns that form part of a
8504 list, just give the filename on its own, without a search type, as described
8505 in the previous section. You could also use the &(wildlsearch)& or
8506 &(nwildlsearch)&, but there is no advantage in doing this.
8507
8508
8509
8510
8511 .subsection "Named lists" SECTnamedlists
8512 .cindex "named lists"
8513 .cindex "list" "named"
8514 A list of domains, hosts, email addresses, or local parts can be given a name
8515 which is then used to refer to the list elsewhere in the configuration. This is
8516 particularly convenient if the same list is required in several different
8517 places. It also allows lists to be given meaningful names, which can improve
8518 the readability of the configuration. For example, it is conventional to define
8519 a domain list called &'local_domains'& for all the domains that are handled
8520 locally on a host, using a configuration line such as
8521 .code
8522 domainlist local_domains = localhost:my.dom.example
8523 .endd
8524 Named lists are referenced by giving their name preceded by a plus sign, so,
8525 for example, a router that is intended to handle local domains would be
8526 configured with the line
8527 .code
8528 domains = +local_domains
8529 .endd
8530 The first router in a configuration is often one that handles all domains
8531 except the local ones, using a configuration with a negated item like this:
8532 .code
8533 dnslookup:
8534   driver = dnslookup
8535   domains = ! +local_domains
8536   transport = remote_smtp
8537   no_more
8538 .endd
8539 The four kinds of named list are created by configuration lines starting with
8540 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8541 respectively. Then there follows the name that you are defining, followed by an
8542 equals sign and the list itself. For example:
8543 .code
8544 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8545 addresslist bad_senders = cdb;/etc/badsenders
8546 .endd
8547 A named list may refer to other named lists:
8548 .code
8549 domainlist  dom1 = first.example : second.example
8550 domainlist  dom2 = +dom1 : third.example
8551 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8552 .endd
8553 &*Warning*&: If the last item in a referenced list is a negative one, the
8554 effect may not be what you intended, because the negation does not propagate
8555 out to the higher level. For example, consider:
8556 .code
8557 domainlist  dom1 = !a.b
8558 domainlist  dom2 = +dom1 : *.b
8559 .endd
8560 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8561 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8562 means it matches the second list as well. The effect is not the same as
8563 .code
8564 domainlist  dom2 = !a.b : *.b
8565 .endd
8566 where &'x.y'& does not match. It's best to avoid negation altogether in
8567 referenced lists if you can.
8568
8569 .cindex "hiding named list values"
8570 .cindex "named lists" "hiding value of"
8571 Some named list definitions may contain sensitive data, for example, passwords for
8572 accessing databases. To stop non-admin users from using the &%-bP%& command
8573 line option to read these values, you can precede the definition with the
8574 word &"hide"&. For example:
8575 .code
8576 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8577 .endd
8578
8579
8580 Named lists may have a performance advantage. When Exim is routing an
8581 address or checking an incoming message, it caches the result of tests on named
8582 lists. So, if you have a setting such as
8583 .code
8584 domains = +local_domains
8585 .endd
8586 on several of your routers
8587 or in several ACL statements,
8588 the actual test is done only for the first one. However, the caching works only
8589 if there are no expansions within the list itself or any sublists that it
8590 references. In other words, caching happens only for lists that are known to be
8591 the same each time they are referenced.
8592
8593 By default, there may be up to 16 named lists of each type. This limit can be
8594 extended by changing a compile-time variable. The use of domain and host lists
8595 is recommended for concepts such as local domains, relay domains, and relay
8596 hosts. The default configuration is set up like this.
8597
8598
8599
8600 .subsection "Named lists compared with macros" SECID78
8601 .cindex "list" "named compared with macro"
8602 .cindex "macro" "compared with named list"
8603 At first sight, named lists might seem to be no different from macros in the
8604 configuration file. However, macros are just textual substitutions. If you
8605 write
8606 .code
8607 ALIST = host1 : host2
8608 auth_advertise_hosts = !ALIST
8609 .endd
8610 it probably won't do what you want, because that is exactly the same as
8611 .code
8612 auth_advertise_hosts = !host1 : host2
8613 .endd
8614 Notice that the second host name is not negated. However, if you use a host
8615 list, and write
8616 .code
8617 hostlist alist = host1 : host2
8618 auth_advertise_hosts = ! +alist
8619 .endd
8620 the negation applies to the whole list, and so that is equivalent to
8621 .code
8622 auth_advertise_hosts = !host1 : !host2
8623 .endd
8624
8625
8626 .subsection "Named list caching" SECID79
8627 .cindex "list" "caching of named"
8628 .cindex "caching" "named lists"
8629 While processing a message, Exim caches the result of checking a named list if
8630 it is sure that the list is the same each time. In practice, this means that
8631 the cache operates only if the list contains no $ characters, which guarantees
8632 that it will not change when it is expanded. Sometimes, however, you may have
8633 an expanded list that you know will be the same each time within a given
8634 message. For example:
8635 .code
8636 domainlist special_domains = \
8637            ${lookup{$sender_host_address}cdb{/some/file}}
8638 .endd
8639 This provides a list of domains that depends only on the sending host's IP
8640 address. If this domain list is referenced a number of times (for example,
8641 in several ACL lines, or in several routers) the result of the check is not
8642 cached by default, because Exim does not know that it is going to be the
8643 same list each time.
8644
8645 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8646 cache the result anyway. For example:
8647 .code
8648 domainlist_cache special_domains = ${lookup{...
8649 .endd
8650 If you do this, you should be absolutely sure that caching is going to do
8651 the right thing in all cases. When in doubt, leave it out.
8652
8653
8654
8655 .section "Domain lists" "SECTdomainlist"
8656 .cindex "domain list" "patterns for"
8657 .cindex "list" "domain list"
8658 Domain lists contain patterns that are to be matched against a mail domain.
8659 The following types of item may appear in domain lists:
8660
8661 .ilist
8662 .cindex "primary host name"
8663 .cindex "host name" "matched in domain list"
8664 .oindex "&%primary_hostname%&"
8665 .cindex "domain list" "matching primary host name"
8666 .cindex "@ in a domain list"
8667 If a pattern consists of a single @ character, it matches the local host name,
8668 as set by the &%primary_hostname%& option (or defaulted). This makes it
8669 possible to use the same configuration file on several different hosts that
8670 differ only in their names.
8671
8672 The value for a match will be the primary host name.
8673
8674
8675 .next
8676 .cindex "@[] in a domain list"
8677 .cindex "domain list" "matching local IP interfaces"
8678 .cindex "domain literal"
8679 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8680 in square brackets (as in an email address that contains a domain literal), but
8681 only if that IP address is recognized as local for email routing purposes. The
8682 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8683 control which of a host's several IP addresses are treated as local.
8684 In today's Internet, the use of domain literals is controversial;
8685 see the &%allow_domain_literals%& main option.
8686
8687 The value for a match will be the string &`@[]`&.
8688
8689
8690 .next
8691 .cindex "@mx_any"
8692 .cindex "@mx_primary"
8693 .cindex "@mx_secondary"
8694 .cindex "domain list" "matching MX pointers to local host"
8695 If a pattern consists of the string &`@mx_any`& it matches any domain that
8696 has an MX record pointing to the local host or to any host that is listed in
8697 .oindex "&%hosts_treat_as_local%&"
8698 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8699 are similar, except that the first matches only when a primary MX target is the
8700 local host, and the second only when no primary MX target is the local host,
8701 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8702 preference value &-- there may of course be more than one of them.
8703
8704 The MX lookup that takes place when matching a pattern of this type is
8705 performed with the resolver options for widening names turned off. Thus, for
8706 example, a single-component domain will &'not'& be expanded by adding the
8707 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8708 options of the &(dnslookup)& router for a discussion of domain widening.
8709
8710 Sometimes you may want to ignore certain IP addresses when using one of these
8711 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8712 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8713 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8714 on a router). For example:
8715 .code
8716 domains = @mx_any/ignore=127.0.0.1
8717 .endd
8718 This example matches any domain that has an MX record pointing to one of
8719 the local host's IP addresses other than 127.0.0.1.
8720
8721 The list of IP addresses is in fact processed by the same code that processes
8722 host lists, so it may contain CIDR-coded network specifications and it may also
8723 contain negative items.
8724
8725 Because the list of IP addresses is a sublist within a domain list, you have to
8726 be careful about delimiters if there is more than one address. Like any other
8727 list, the default delimiter can be changed. Thus, you might have:
8728 .code
8729 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8730           an.other.domain : ...
8731 .endd
8732 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8733 involved, it is easiest to change the delimiter for the main list as well:
8734 .code
8735 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8736           an.other.domain ? ...
8737 .endd
8738 The value for a match will be the list element string (starting &`@mx_`&).
8739
8740
8741 .next
8742 .cindex "asterisk" "in domain list"
8743 .cindex "domain list" "asterisk in"
8744 .cindex "domain list" "matching &""ends with""&"
8745 If a pattern starts with an asterisk, the remaining characters of the pattern
8746 are compared with the terminating characters of the domain. The use of &"*"& in
8747 domain lists differs from its use in partial matching lookups. In a domain
8748 list, the character following the asterisk need not be a dot, whereas partial
8749 matching works only in terms of dot-separated components. For example, a domain
8750 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8751 &'cipher.key.ex'&.
8752
8753 The value for a match will be the list element string (starting with the asterisk).
8754 Additionally, &$0$& will be set to the matched string
8755 and &$1$& to the variable portion which the asterisk matched.
8756
8757 .next
8758 .cindex "regular expressions" "in domain list"
8759 .cindex "domain list" "matching regular expression"
8760 If a pattern starts with a circumflex character, it is treated as a regular
8761 expression, and matched against the domain using a regular expression matching
8762 function. The circumflex is treated as part of the regular expression.
8763 Email domains are case-independent, so this regular expression match is by
8764 default case-independent, but you can make it case-dependent by starting it
8765 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8766 are given in chapter &<<CHAPregexp>>&.
8767
8768 &*Warning*&: Because domain lists are expanded before being processed, you
8769 must escape any backslash and dollar characters in the regular expression, or
8770 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8771 it is not to be expanded (unless you really do want to build a regular
8772 expression by expansion, of course).
8773
8774 The value for a match will be the list element string (starting with the circumflex).
8775 Additionally, &$0$& will be set to the string matching the regular expression,
8776 and &$1$& (onwards) to any submatches identified by parentheses.
8777
8778
8779
8780 .next
8781 .cindex "lookup" "in domain list"
8782 .cindex "domain list" "matching by lookup"
8783 If a pattern starts with the name of a single-key lookup type followed by a
8784 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8785 must be a filename in a suitable format for the lookup type. For example, for
8786 &"cdb;"& it must be an absolute path:
8787 .code
8788 domains = cdb;/etc/mail/local_domains.cdb
8789 .endd
8790 The appropriate type of lookup is done on the file using the domain name as the
8791 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8792 only in whether or not the key is present in the file. However, when a lookup
8793 is used for the &%domains%& option on a router
8794 or a &%domains%& condition in an ACL statement, the value is preserved in the
8795 &$domain_data$& variable and can be referred to in other router options or
8796 other statements in the same ACL.
8797 .cindex "tainted data" "de-tainting"
8798 .cindex "de-tainting" "using ACL domains condition"
8799 The value will be untainted.
8800
8801 &*Note*&: If the data result of the lookup (as opposed to the key)
8802 is empty, then this empty value is stored in &$domain_data$&.
8803 The option to return the key for the lookup, as the value,
8804 may be what is wanted.
8805
8806
8807 .next
8808 Any of the single-key lookup type names may be preceded by
8809 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8810 .code
8811 domains = partial-dbm;/partial/domains
8812 .endd
8813 This causes partial matching logic to be invoked; a description of how this
8814 works is given in section &<<SECTpartiallookup>>&.
8815
8816 .next
8817 .cindex "asterisk" "in lookup type"
8818 Any of the single-key lookup types may be followed by an asterisk. This causes
8819 a default lookup for a key consisting of a single asterisk to be done if the
8820 original lookup fails. This is not a useful feature when using a domain list to
8821 select particular domains (because any domain would match), but it might have
8822 value if the result of the lookup is being used via the &$domain_data$&
8823 expansion variable.
8824
8825 .next
8826 If the pattern starts with the name of a query-style lookup type followed by a
8827 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8828 pattern must be an appropriate query for the lookup type, as described in
8829 chapter &<<CHAPfdlookup>>&. For example:
8830 .code
8831 hold_domains = mysql;select domain from holdlist \
8832   where domain = '${quote_mysql:$domain}';
8833 .endd
8834 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8835 example, it doesn't matter what field you select). Exim is interested only in
8836 whether or not the query succeeds. However, when a lookup is used for the
8837 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8838 variable and can be referred to in other options.
8839 .cindex "tainted data" "de-tainting"
8840 .cindex "de-tainting" "using router domains option"
8841 The value will be untainted.
8842
8843 .next
8844 If the pattern starts with the name of a lookup type
8845 of either kind (single-key or query-style) it may be
8846 followed by a comma and options,
8847 The options are lookup-type specific and consist of a comma-separated list.
8848 Each item starts with a tag and and equals "=" sign.
8849
8850 .next
8851 .cindex "domain list" "matching literal domain name"
8852 If none of the above cases apply, a caseless textual comparison is made
8853 between the pattern and the domain.
8854
8855 The value for a match will be the list element string.
8856 .cindex "tainted data" "de-tainting"
8857 Note that this is commonly untainted
8858 (depending on the way the list was created).
8859 Specifically, explicit text in the configuration file in not tainted.
8860 This is a useful way of obtaining an untainted equivalent to
8861 the domain, for later operations.
8862
8863 However if the list (including one-element lists)
8864 is created by expanding a variable containing tainted data,
8865 it is tainted and so will the match value be.
8866 .endlist
8867
8868
8869 Here is an example that uses several different kinds of pattern:
8870 .code
8871 domainlist funny_domains = \
8872   @ : \
8873   lib.unseen.edu : \
8874   *.foundation.fict.example : \
8875   \N^[1-2]\d{3}\.fict\.example$\N : \
8876   partial-dbm;/opt/data/penguin/book : \
8877   nis;domains.byname : \
8878   nisplus;[name=$domain,status=local],domains.org_dir
8879 .endd
8880 There are obvious processing trade-offs among the various matching modes. Using
8881 an asterisk is faster than a regular expression, and listing a few names
8882 explicitly probably is too. The use of a file or database lookup is expensive,
8883 but may be the only option if hundreds of names are required. Because the
8884 patterns are tested in order, it makes sense to put the most commonly matched
8885 patterns earlier.
8886
8887
8888
8889 .section "Host lists" "SECThostlist"
8890 .cindex "host list" "patterns in"
8891 .cindex "list" "host list"
8892 Host lists are used to control what remote hosts are allowed to do. For
8893 example, some hosts may be allowed to use the local host as a relay, and some
8894 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8895 two different ways, by name or by IP address. In a host list, some types of
8896 pattern are matched to a host name, and some are matched to an IP address.
8897 You need to be particularly careful with this when single-key lookups are
8898 involved, to ensure that the right value is being used as the key.
8899
8900
8901 .subsection "Special host list patterns" SECID80
8902 .cindex "empty item in hosts list"
8903 .cindex "host list" "empty string in"
8904 If a host list item is the empty string, it matches only when no remote host is
8905 involved. This is the case when a message is being received from a local
8906 process using SMTP on the standard input, that is, when a TCP/IP connection is
8907 not used.
8908
8909 .cindex "asterisk" "in host list"
8910 The special pattern &"*"& in a host list matches any host or no host. Neither
8911 the IP address nor the name is actually inspected.
8912
8913
8914
8915 .subsection "Host list patterns that match by IP address" SECThoslispatip
8916 .cindex "host list" "matching IP addresses"
8917 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8918 the incoming address actually appears in the IPv6 host as
8919 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8920 list, it is converted into a traditional IPv4 address first. (Not all operating
8921 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8922 concerns.)
8923
8924 The following types of pattern in a host list check the remote host by
8925 inspecting its IP address:
8926
8927 .ilist
8928 If the pattern is a plain domain name (not a regular expression, not starting
8929 with *, not a lookup of any kind), Exim calls the operating system function
8930 to find the associated IP address(es). Exim uses the newer
8931 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8932 This typically causes a forward DNS lookup of the name. The result is compared
8933 with the IP address of the subject host.
8934
8935 If there is a temporary problem (such as a DNS timeout) with the host name
8936 lookup, a temporary error occurs. For example, if the list is being used in an
8937 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8938 temporary SMTP error code. If no IP address can be found for the host name,
8939 what happens is described in section &<<SECTbehipnot>>& below.
8940
8941 .next
8942 .cindex "@ in a host list"
8943 If the pattern is &"@"&, the primary host name is substituted and used as a
8944 domain name, as just described.
8945
8946 .next
8947 If the pattern is an IP address, it is matched against the IP address of the
8948 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8949 IPv6 addresses can be given in colon-separated format, but the colons have to
8950 be doubled so as not to be taken as item separators when the default list
8951 separator is used. IPv6 addresses are recognized even when Exim is compiled
8952 without IPv6 support. This means that if they appear in a host list on an
8953 IPv4-only host, Exim will not treat them as host names. They are just addresses
8954 that can never match a client host.
8955
8956 .next
8957 .cindex "@[] in a host list"
8958 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8959 the local host. For example, if the local host is an IPv4 host with one
8960 interface address 10.45.23.56, these two ACL statements have the same effect:
8961 .code
8962 accept hosts = 127.0.0.1 : 10.45.23.56
8963 accept hosts = @[]
8964 .endd
8965 .next
8966 .cindex "CIDR notation"
8967 If the pattern is an IP address followed by a slash and a mask length, for
8968 example
8969 .code
8970 10.11.42.0/24
8971 .endd
8972 , it is matched against the IP address of the subject
8973 host under the given mask. This allows an entire network of hosts to be
8974 included (or excluded) by a single item. The mask uses CIDR notation; it
8975 specifies the number of address bits that must match, starting from the most
8976 significant end of the address.
8977
8978 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8979 of a range of addresses. It is the number of bits in the network portion of the
8980 address. The above example specifies a 24-bit netmask, so it matches all 256
8981 addresses in the 10.11.42.0 network. An item such as
8982 .code
8983 192.168.23.236/31
8984 .endd
8985 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8986 32 for an IPv4 address is the same as no mask at all; just a single address
8987 matches.
8988
8989 Here is another example which shows an IPv4 and an IPv6 network:
8990 .code
8991 recipient_unqualified_hosts = 192.168.0.0/16: \
8992                               3ffe::ffff::836f::::/48
8993 .endd
8994 The doubling of list separator characters applies only when these items
8995 appear inline in a host list. It is not required when indirecting via a file.
8996 For example:
8997 .code
8998 recipient_unqualified_hosts = /opt/exim/unqualnets
8999 .endd
9000 could make use of a file containing
9001 .code
9002 172.16.0.0/12
9003 3ffe:ffff:836f::/48
9004 .endd
9005 to have exactly the same effect as the previous example. When listing IPv6
9006 addresses inline, it is usually more convenient to use the facility for
9007 changing separator characters. This list contains the same two networks:
9008 .code
9009 recipient_unqualified_hosts = <; 172.16.0.0/12; \
9010                                  3ffe:ffff:836f::/48
9011 .endd
9012 The separator is changed to semicolon by the leading &"<;"& at the start of the
9013 list.
9014 .endlist
9015
9016
9017
9018 .subsection "Host list patterns for single-key lookups by host address" &&&
9019          SECThoslispatsikey
9020 .cindex "host list" "lookup of IP address"
9021 When a host is to be identified by a single-key lookup of its complete IP
9022 address, the pattern takes this form:
9023 .display
9024 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9025 .endd
9026 For example:
9027 .code
9028 hosts_lookup = net-cdb;/hosts-by-ip.db
9029 .endd
9030 The text form of the IP address of the subject host is used as the lookup key.
9031 IPv6 addresses are converted to an unabbreviated form, using lower case
9032 letters, with dots as separators because colon is the key terminator in
9033 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9034 quoting the keys, but this is a facility that was added later.] The data
9035 returned by the lookup is not used.
9036
9037 .cindex "IP address" "masking"
9038 .cindex "host list" "masked IP address"
9039 Single-key lookups can also be performed using masked IP addresses, using
9040 patterns of this form:
9041 .display
9042 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9043 .endd
9044 For example:
9045 .code
9046 net24-dbm;/networks.db
9047 .endd
9048 The IP address of the subject host is masked using <&'number'&> as the mask
9049 length. A textual string is constructed from the masked value, followed by the
9050 mask, and this is used as the lookup key. For example, if the host's IP address
9051 is 192.168.34.6, the key that is looked up for the above example is
9052 &"192.168.34.0/24"&.
9053
9054 When an IPv6 address is converted to a string, dots are normally used instead
9055 of colons, so that keys in &(lsearch)& files need not contain colons (which
9056 terminate &(lsearch)& keys). This was implemented some time before the ability
9057 to quote keys was made available in &(lsearch)& files. However, the more
9058 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9059 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9060 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9061 converted using colons and not dots.
9062 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9063 addresses are always used.
9064 The latter are converted to IPv4 addresses, in dotted-quad form.
9065
9066 Ideally, it would be nice to tidy up this anomalous situation by changing to
9067 colons in all cases, given that quoting is now available for &(lsearch)&.
9068 However, this would be an incompatible change that might break some existing
9069 configurations.
9070
9071 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9072 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9073 the former case the key strings include the mask value, whereas in the latter
9074 case the IP address is used on its own.
9075
9076
9077
9078 .subsection "Host list patterns that match by host name" SECThoslispatnam
9079 .cindex "host" "lookup failures"
9080 .cindex "unknown host name"
9081 .cindex "host list" "matching host name"
9082 There are several types of pattern that require Exim to know the name of the
9083 remote host. These are either wildcard patterns or lookups by name. (If a
9084 complete hostname is given without any wildcarding, it is used to find an IP
9085 address to match against, as described in section &<<SECThoslispatip>>&
9086 above.)
9087
9088 If the remote host name is not already known when Exim encounters one of these
9089 patterns, it has to be found from the IP address.
9090 Although many sites on the Internet are conscientious about maintaining reverse
9091 DNS data for their hosts, there are also many that do not do this.
9092 Consequently, a name cannot always be found, and this may lead to unwanted
9093 effects. Take care when configuring host lists with wildcarded name patterns.
9094 Consider what will happen if a name cannot be found.
9095
9096 Because of the problems of determining host names from IP addresses, matching
9097 against host names is not as common as matching against IP addresses.
9098
9099 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9100 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9101 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9102 are done can be changed by setting the &%host_lookup_order%& option. For
9103 security, once Exim has found one or more names, it looks up the IP addresses
9104 for these names and compares them with the IP address that it started with.
9105 Only those names whose IP addresses match are accepted. Any other names are
9106 discarded. If no names are left, Exim behaves as if the host name cannot be
9107 found. In the most common case there is only one name and one IP address.
9108
9109 There are some options that control what happens if a host name cannot be
9110 found. These are described in section &<<SECTbehipnot>>& below.
9111
9112 .cindex "host" "alias for"
9113 .cindex "alias for host"
9114 As a result of aliasing, hosts may have more than one name. When processing any
9115 of the following types of pattern, all the host's names are checked:
9116
9117 .ilist
9118 .cindex "asterisk" "in host list"
9119 If a pattern starts with &"*"& the remainder of the item must match the end of
9120 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9121 &'.b.c'&. This special simple form is provided because this is a very common
9122 requirement. Other kinds of wildcarding require the use of a regular
9123 expression.
9124 .next
9125 .cindex "regular expressions" "in host list"
9126 .cindex "host list" "regular expression in"
9127 If the item starts with &"^"& it is taken to be a regular expression which is
9128 matched against the host name. Host names are case-independent, so this regular
9129 expression match is by default case-independent, but you can make it
9130 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9131 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9132 example,
9133 .code
9134 ^(a|b)\.c\.d$
9135 .endd
9136 is a regular expression that matches either of the two hosts &'a.c.d'& or
9137 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9138 that backslash and dollar characters are not misinterpreted as part of the
9139 string expansion. The simplest way to do this is to use &`\N`& to mark that
9140 part of the string as non-expandable. For example:
9141 .code
9142 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9143 .endd
9144 &*Warning*&: If you want to match a complete host name, you must include the
9145 &`$`& terminating metacharacter in the regular expression, as in the above
9146 example. Without it, a match at the start of the host name is all that is
9147 required.
9148 .endlist
9149
9150
9151
9152
9153 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9154 .cindex "host" "lookup failures, permanent"
9155 While processing a host list, Exim may need to look up an IP address from a
9156 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9157 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9158 behaviour when it fails to find the information it is seeking is the same.
9159
9160 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9161 apply to temporary DNS errors, whose handling is described in the next section.
9162
9163 .cindex "&`+include_unknown`&"
9164 .cindex "&`+ignore_unknown`&"
9165 Exim parses a host list from left to right. If it encounters a permanent
9166 lookup failure in any item in the host list before it has found a match,
9167 Exim treats it as a failure and the default behavior is as if the host
9168 does not match the list. This may not always be what you want to happen.
9169 To change Exim's behaviour, the special items &`+include_unknown`& or
9170 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9171 not recognized in an indirected file).
9172
9173 .ilist
9174 If any item that follows &`+include_unknown`& requires information that
9175 cannot found, Exim behaves as if the host does match the list. For example,
9176 .code
9177 host_reject_connection = +include_unknown:*.enemy.ex
9178 .endd
9179 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9180 any hosts whose name it cannot find.
9181
9182 .next
9183 If any item that follows &`+ignore_unknown`& requires information that cannot
9184 be found, Exim ignores that item and proceeds to the rest of the list. For
9185 example:
9186 .code
9187 accept hosts = +ignore_unknown : friend.example : \
9188                192.168.4.5
9189 .endd
9190 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9191 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9192 name can be found for 192.168.4.5, it is rejected.
9193 .endlist
9194
9195 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9196 list. The effect of each one lasts until the next, or until the end of the
9197 list.
9198
9199 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9200          SECTmixwilhos
9201 .cindex "host list" "mixing names and addresses in"
9202
9203 This section explains the host/ip processing logic with the same concepts
9204 as the previous section, but specifically addresses what happens when a
9205 wildcarded hostname is one of the items in the hostlist.
9206
9207 .ilist
9208 If you have name lookups or wildcarded host names and
9209 IP addresses in the same host list, you should normally put the IP
9210 addresses first. For example, in an ACL you could have:
9211 .code
9212 accept hosts = 10.9.8.7 : *.friend.example
9213 .endd
9214 The reason you normally would order it this way lies in the
9215 left-to-right way that Exim processes lists.  It can test IP addresses
9216 without doing any DNS lookups, but when it reaches an item that requires
9217 a host name, it fails if it cannot find a host name to compare with the
9218 pattern. If the above list is given in the opposite order, the
9219 &%accept%& statement fails for a host whose name cannot be found, even
9220 if its IP address is 10.9.8.7.
9221
9222 .next
9223 If you really do want to do the name check first, and still recognize the IP
9224 address, you can rewrite the ACL like this:
9225 .code
9226 accept hosts = *.friend.example
9227 accept hosts = 10.9.8.7
9228 .endd
9229 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9230 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9231 &`+ignore_unknown`&, which was discussed in depth in the first example in
9232 this section.
9233 .endlist
9234
9235
9236 .subsection "Temporary DNS errors when looking up host information" &&&
9237          SECTtemdnserr
9238 .cindex "host" "lookup failures, temporary"
9239 .cindex "&`+include_defer`&"
9240 .cindex "&`+ignore_defer`&"
9241 A temporary DNS lookup failure normally causes a defer action (except when
9242 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9243 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9244 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9245 section. These options should be used with care, probably only in non-critical
9246 host lists such as whitelists.
9247
9248
9249
9250 .subsection "Host list patterns for single-key lookups by host name" &&&
9251          SECThoslispatnamsk
9252 .cindex "unknown host name"
9253 .cindex "host list" "matching host name"
9254 If a pattern is of the form
9255 .display
9256 <&'single-key-search-type'&>;<&'search-data'&>
9257 .endd
9258 for example
9259 .code
9260 dbm;/host/accept/list
9261 .endd
9262 a single-key lookup is performed, using the host name as its key. If the
9263 lookup succeeds, the host matches the item. The actual data that is looked up
9264 is not used.
9265
9266 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9267 keys in the file, not IP addresses. If you want to do lookups based on IP
9268 addresses, you must precede the search type with &"net-"&
9269 (see section &<<SECThoslispatsikey>>&).
9270 There is, however, no reason why you could not use
9271 two items in the same list, one doing an address lookup and one doing a name
9272 lookup, both using the same file.
9273
9274
9275
9276 .subsection "Host list patterns for query-style lookups" SECID81
9277 If a pattern is of the form
9278 .display
9279 <&'query-style-search-type'&>;<&'query'&>
9280 .endd
9281 the query is obeyed, and if it succeeds, the host matches the item. The actual
9282 data that is looked up is not used. The variables &$sender_host_address$& and
9283 &$sender_host_name$& can be used in the query. For example:
9284 .code
9285 hosts_lookup = pgsql;\
9286   select ip from hostlist where ip='$sender_host_address'
9287 .endd
9288 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9289 can use the &%sg%& expansion item to change this if you need to. If you want to
9290 use masked IP addresses in database queries, you can use the &%mask%& expansion
9291 operator.
9292
9293 If the query contains a reference to &$sender_host_name$&, Exim automatically
9294 looks up the host name if it has not already done so. (See section
9295 &<<SECThoslispatnam>>& for comments on finding host names.)
9296
9297 Historical note: prior to release 4.30, Exim would always attempt to find a
9298 host name before running the query, unless the search type was preceded by
9299 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9300 still recognized for query-style lookups, but its presence or absence has no
9301 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9302 See section &<<SECThoslispatsikey>>&.)
9303
9304
9305
9306
9307
9308 .section "Address lists" "SECTaddresslist"
9309 .cindex "list" "address list"
9310 .cindex "address list" "empty item"
9311 .cindex "address list" "patterns"
9312 Address lists contain patterns that are matched against mail addresses. There
9313 is one special case to be considered: the sender address of a bounce message is
9314 always empty. You can test for this by providing an empty item in an address
9315 list. For example, you can set up a router to process bounce messages by
9316 using this option setting:
9317 .code
9318 senders = :
9319 .endd
9320 The presence of the colon creates an empty item. If you do not provide any
9321 data, the list is empty and matches nothing. The empty sender can also be
9322 detected by a regular expression that matches an empty string,
9323 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9324
9325 Non-empty items in an address list can be straightforward email addresses. For
9326 example:
9327 .code
9328 senders = jbc@askone.example : hs@anacreon.example
9329 .endd
9330 A certain amount of wildcarding is permitted. If a pattern contains an @
9331 character, but is not a regular expression and does not begin with a
9332 semicolon-terminated lookup type (described below), the local part of the
9333 subject address is compared with the local part of the pattern, which may start
9334 with an asterisk. If the local parts match, the domain is checked in exactly
9335 the same way as for a pattern in a domain list. For example, the domain can be
9336 wildcarded, refer to a named list, or be a lookup:
9337 .code
9338 deny senders = *@*.spamming.site:\
9339                *@+hostile_domains:\
9340                bozo@partial-lsearch;/list/of/dodgy/sites:\
9341                *@dbm;/bad/domains.db
9342 .endd
9343 .cindex "local part" "starting with !"
9344 .cindex "address list" "local part starting with !"
9345 If a local part that begins with an exclamation mark is required, it has to be
9346 specified using a regular expression, because otherwise the exclamation mark is
9347 treated as a sign of negation, as is standard in lists.
9348
9349 If a non-empty pattern that is not a regular expression or a lookup does not
9350 contain an @ character, it is matched against the domain part of the subject
9351 address. The only two formats that are recognized this way are a literal
9352 domain, or a domain pattern that starts with *. In both these cases, the effect
9353 is the same as if &`*@`& preceded the pattern. For example:
9354 .code
9355 deny senders = enemy.domain : *.enemy.domain
9356 .endd
9357
9358 The following kinds of more complicated address list pattern can match any
9359 address, including the empty address that is characteristic of bounce message
9360 senders:
9361
9362 .ilist
9363 .cindex "regular expressions" "in address list"
9364 .cindex "address list" "regular expression in"
9365 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9366 done against the complete address, with the pattern as the regular expression.
9367 You must take care that backslash and dollar characters are not misinterpreted
9368 as part of the string expansion. The simplest way to do this is to use &`\N`&
9369 to mark that part of the string as non-expandable. For example:
9370 .code
9371 deny senders = \N^.*this.*@example\.com$\N : \
9372                \N^\d{8}.+@spamhaus.example$\N : ...
9373 .endd
9374 The &`\N`& sequences are removed by the expansion, so these items do indeed
9375 start with &"^"& by the time they are being interpreted as address patterns.
9376
9377 .next
9378 .cindex "address list" "lookup for complete address"
9379 Complete addresses can be looked up by using a pattern that starts with a
9380 lookup type terminated by a semicolon, followed by the data for the lookup. For
9381 example:
9382 .code
9383 deny senders = cdb;/etc/blocked.senders : \
9384   mysql;select address from blocked where \
9385   address='${quote_mysql:$sender_address}'
9386 .endd
9387 Both query-style and single-key lookup types can be used. For a single-key
9388 lookup type, Exim uses the complete address as the key. However, empty keys are
9389 not supported for single-key lookups, so a match against the empty address
9390 always fails. This restriction does not apply to query-style lookups.
9391
9392 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9393 cannot be used, and is ignored if specified, with an entry being written to the
9394 panic log.
9395 .cindex "*@ with single-key lookup"
9396 However, you can configure lookup defaults, as described in section
9397 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9398 default. For example, with this lookup:
9399 .code
9400 accept senders = lsearch*@;/some/file
9401 .endd
9402 the file could contains lines like this:
9403 .code
9404 user1@domain1.example
9405 *@domain2.example
9406 .endd
9407 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9408 that are tried is:
9409 .code
9410 nimrod@jaeger.example
9411 *@jaeger.example
9412 *
9413 .endd
9414 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9415 would mean that every address matches, thus rendering the test useless.
9416
9417 &*Warning 2*&: Do not confuse these two kinds of item:
9418 .code
9419 deny recipients = dbm*@;/some/file
9420 deny recipients = *@dbm;/some/file
9421 .endd
9422 The first does a whole address lookup, with defaulting, as just described,
9423 because it starts with a lookup type. The second matches the local part and
9424 domain independently, as described in a bullet point below.
9425 .endlist
9426
9427
9428 The following kinds of address list pattern can match only non-empty addresses.
9429 If the subject address is empty, a match against any of these pattern types
9430 always fails.
9431
9432
9433 .ilist
9434 .cindex "@@ with single-key lookup"
9435 .cindex "address list" "@@ lookup type"
9436 .cindex "address list" "split local part and domain"
9437 If a pattern starts with &"@@"& followed by a single-key lookup item
9438 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9439 split into a local part and a domain. The domain is looked up in the file. If
9440 it is not found, there is no match. If it is found, the data that is looked up
9441 from the file is treated as a colon-separated list of local part patterns, each
9442 of which is matched against the subject local part in turn.
9443
9444 .cindex "asterisk" "in address list"
9445 The lookup may be a partial one, and/or one involving a search for a default
9446 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9447 patterns that are looked up can be regular expressions or begin with &"*"&, or
9448 even be further lookups. They may also be independently negated. For example,
9449 with
9450 .code
9451 deny senders = @@dbm;/etc/reject-by-domain
9452 .endd
9453 the data from which the DBM file is built could contain lines like
9454 .code
9455 baddomain.com:  !postmaster : *
9456 .endd
9457 to reject all senders except &%postmaster%& from that domain.
9458
9459 .cindex "local part" "starting with !"
9460 If a local part that actually begins with an exclamation mark is required, it
9461 has to be specified using a regular expression. In &(lsearch)& files, an entry
9462 may be split over several lines by indenting the second and subsequent lines,
9463 but the separating colon must still be included at line breaks. White space
9464 surrounding the colons is ignored. For example:
9465 .code
9466 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9467   spammer3 : spammer4
9468 .endd
9469 As in all colon-separated lists in Exim, a colon can be included in an item by
9470 doubling.
9471
9472 If the last item in the list starts with a right angle-bracket, the remainder
9473 of the item is taken as a new key to look up in order to obtain a continuation
9474 list of local parts. The new key can be any sequence of characters. Thus one
9475 might have entries like
9476 .code
9477 aol.com: spammer1 : spammer 2 : >*
9478 xyz.com: spammer3 : >*
9479 *:       ^\d{8}$
9480 .endd
9481 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9482 local parts for all domains, in addition to the specific local parts listed for
9483 each domain. Of course, using this feature costs another lookup each time a
9484 chain is followed, but the effort needed to maintain the data is reduced.
9485
9486 .cindex "loop" "in lookups"
9487 It is possible to construct loops using this facility, and in order to catch
9488 them, the chains may be no more than fifty items long.
9489
9490 .next
9491 The @@<&'lookup'&> style of item can also be used with a query-style
9492 lookup, but in this case, the chaining facility is not available. The lookup
9493 can only return a single list of local parts.
9494 .endlist
9495
9496 &*Warning*&: There is an important difference between the address list items
9497 in these two examples:
9498 .code
9499 senders = +my_list
9500 senders = *@+my_list
9501 .endd
9502 In the first one, &`my_list`& is a named address list, whereas in the second
9503 example it is a named domain list.
9504
9505
9506
9507
9508 .subsection "Case of letters in address lists" SECTcasletadd
9509 .cindex "case of local parts"
9510 .cindex "address list" "case forcing"
9511 .cindex "case forcing in address lists"
9512 Domains in email addresses are always handled caselessly, but for local parts
9513 case may be significant on some systems (see &%caseful_local_part%& for how
9514 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9515 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9516 blocking lists should be done in a case-independent manner. Since most address
9517 lists in Exim are used for this kind of control, Exim attempts to do this by
9518 default.
9519
9520 The domain portion of an address is always lowercased before matching it to an
9521 address list. The local part is lowercased by default, and any string
9522 comparisons that take place are done caselessly. This means that the data in
9523 the address list itself, in files included as plain filenames, and in any file
9524 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9525 keys in files that are looked up by a search type other than &(lsearch)& (which
9526 works caselessly) must be in lower case, because these lookups are not
9527 case-independent.
9528
9529 .cindex "&`+caseful`&"
9530 To allow for the possibility of caseful address list matching, if an item in
9531 an address list is the string &"+caseful"&, the original case of the local
9532 part is restored for any comparisons that follow, and string comparisons are no
9533 longer case-independent. This does not affect the domain, which remains in
9534 lower case. However, although independent matches on the domain alone are still
9535 performed caselessly, regular expressions that match against an entire address
9536 become case-sensitive after &"+caseful"& has been seen.
9537
9538
9539
9540 .section "Local part lists" "SECTlocparlis"
9541 .cindex "list" "local part list"
9542 .cindex "local part" "list"
9543 These behave in the same way as domain and host lists, with the following
9544 changes:
9545
9546 Case-sensitivity in local part lists is handled in the same way as for address
9547 lists, as just described. The &"+caseful"& item can be used if required. In a
9548 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9549 set false, the subject is lowercased and the matching is initially
9550 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9551 matching in the local part list, but not elsewhere in the router. If
9552 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9553 option is case-sensitive from the start.
9554
9555 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9556 comments are handled in the same way as address lists &-- they are recognized
9557 only if the # is preceded by white space or the start of the line.
9558 Otherwise, local part lists are matched in the same way as domain lists, except
9559 that the special items that refer to the local host (&`@`&, &`@[]`&,
9560 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9561 Refer to section &<<SECTdomainlist>>& for details of the other available item
9562 types.
9563 .ecindex IIDdohoadli
9564
9565
9566
9567
9568 . ////////////////////////////////////////////////////////////////////////////
9569 . ////////////////////////////////////////////////////////////////////////////
9570
9571 .chapter "String expansions" "CHAPexpand"
9572 .scindex IIDstrexp "expansion" "of strings"
9573 Many strings in Exim's runtime configuration are expanded before use. Some of
9574 them are expanded every time they are used; others are expanded only once.
9575
9576 When a string is being expanded it is copied verbatim from left to right except
9577 .cindex expansion "string concatenation"
9578 when a dollar or backslash character is encountered. A dollar specifies the
9579 start of a portion of the string that is interpreted and replaced as described
9580 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9581 escape character, as described in the following section.
9582
9583 .cindex "tainted data" tracking
9584 If any porttion of the result string is tainted, the entire result is.
9585
9586 Whether a string is expanded depends upon the context.  Usually this is solely
9587 dependent upon the option for which a value is sought; in this documentation,
9588 options for which string expansion is performed are marked with &dagger; after
9589 the data type.  ACL rules always expand strings.  A couple of expansion
9590 conditions do not expand some of the brace-delimited branches, for security
9591 reasons,
9592 .cindex "tainted data" expansion
9593 .cindex "tainted data" definition
9594 .cindex expansion "tainted data"
9595 and expansion of data deriving from the sender (&"tainted data"&)
9596 is not permitted (including acessing a file using a tainted name).
9597
9598 Common ways of obtaining untainted equivalents of variables with
9599 tainted values
9600 .cindex "tainted data" "de-tainting"
9601 come down to using the tainted value as a lookup key in a trusted database.
9602 This database could be the filesystem structure,
9603 or the password file,
9604 or accessed via a DBMS.
9605 Specific methods are indexed under &"de-tainting"&.
9606
9607
9608
9609 .section "Literal text in expanded strings" "SECTlittext"
9610 .cindex "expansion" "including literal text"
9611 An uninterpreted dollar can be included in an expanded string by putting a
9612 backslash in front of it. A backslash can be used to prevent any special
9613 character being treated specially in an expansion, including backslash itself.
9614 If the string appears in quotes in the configuration file, two backslashes are
9615 required because the quotes themselves cause interpretation of backslashes when
9616 the string is read in (see section &<<SECTstrings>>&).
9617
9618 .cindex "expansion" "non-expandable substrings"
9619 A portion of the string can specified as non-expandable by placing it between
9620 two occurrences of &`\N`&. This is particularly useful for protecting regular
9621 expressions, which often contain backslashes and dollar signs. For example:
9622 .code
9623 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9624 .endd
9625 On encountering the first &`\N`&, the expander copies subsequent characters
9626 without interpretation until it reaches the next &`\N`& or the end of the
9627 string.
9628
9629
9630
9631 .section "Character escape sequences in expanded strings" "SECID82"
9632 .cindex "expansion" "escape sequences"
9633 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9634 expanded string is recognized as an escape sequence for the character newline,
9635 carriage return, or tab, respectively. A backslash followed by up to three
9636 octal digits is recognized as an octal encoding for a single character, and a
9637 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9638 encoding.
9639
9640 These escape sequences are also recognized in quoted strings when they are read
9641 in. Their interpretation in expansions as well is useful for unquoted strings,
9642 and for other cases such as looked-up strings that are then expanded.
9643
9644
9645 .section "Testing string expansions" "SECID83"
9646 .cindex "expansion" "testing"
9647 .cindex "testing" "string expansion"
9648 .oindex "&%-be%&"
9649 Many expansions can be tested by calling Exim with the &%-be%& option. This
9650 takes the command arguments, or lines from the standard input if there are no
9651 arguments, runs them through the string expansion code, and writes the results
9652 to the standard output. Variables based on configuration values are set up, but
9653 since no message is being processed, variables such as &$local_part$& have no
9654 value. Nevertheless the &%-be%& option can be useful for checking out file and
9655 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9656 and &%nhash%&.
9657
9658 When reading lines from the standard input,
9659 macros can be defined and ACL variables can be set.
9660 For example:
9661 .code
9662 MY_MACRO = foo
9663 set acl_m_myvar = bar
9664 .endd
9665 Such macros and variables can then be used in later input lines.
9666
9667 Exim gives up its root privilege when it is called with the &%-be%& option, and
9668 instead runs under the uid and gid it was called with, to prevent users from
9669 using &%-be%& for reading files to which they do not have access.
9670
9671 .oindex "&%-bem%&"
9672 If you want to test expansions that include variables whose values are taken
9673 from a message, there are two other options that can be used. The &%-bem%&
9674 option is like &%-be%& except that it is followed by a filename. The file is
9675 read as a message before doing the test expansions. For example:
9676 .code
9677 exim -bem /tmp/test.message '$h_subject:'
9678 .endd
9679 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9680 Exim message identifier. For example:
9681 .code
9682 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9683 .endd
9684 This loads the message from Exim's spool before doing the test expansions, and
9685 is therefore restricted to admin users.
9686
9687
9688 .section "Forced expansion failure" "SECTforexpfai"
9689 .cindex "expansion" "forced failure"
9690 A number of expansions that are described in the following section have
9691 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9692 (which are sometimes called &"curly brackets"&). Which of the two strings is
9693 used depends on some condition that is evaluated as part of the expansion. If,
9694 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9695 the entire string expansion fails in a way that can be detected by the code
9696 that requested the expansion. This is called &"forced expansion failure"&, and
9697 its consequences depend on the circumstances. In some cases it is no different
9698 from any other expansion failure, but in others a different action may be
9699 taken. Such variations are mentioned in the documentation of the option that is
9700 being expanded.
9701
9702
9703
9704
9705 .section "Expansion items" "SECTexpansionitems"
9706 The following items are recognized in expanded strings. White space may be used
9707 between sub-items that are keywords or substrings enclosed in braces inside an
9708 outer set of braces, to improve readability. &*Warning*&: Within braces,
9709 white space is significant.
9710
9711 .vlist
9712 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9713 .cindex "expansion" "variables"
9714 Substitute the contents of the named variable, for example:
9715 .code
9716 $local_part
9717 ${domain}
9718 .endd
9719 The second form can be used to separate the name from subsequent alphanumeric
9720 characters. This form (using braces) is available only for variables; it does
9721 &'not'& apply to message headers. The names of the variables are given in
9722 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9723 given, the expansion fails.
9724
9725 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9726 .cindex "expansion" "operators"
9727 The string is first itself expanded, and then the operation specified by
9728 <&'op'&> is applied to it. For example:
9729 .code
9730 ${lc:$local_part}
9731 .endd
9732 The string starts with the first character after the colon, which may be
9733 leading white space. A list of operators is given in section &<<SECTexpop>>&
9734 below. The operator notation is used for simple expansion items that have just
9735 one argument, because it reduces the number of braces and therefore makes the
9736 string easier to understand.
9737
9738 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9739 This item inserts &"basic"& header lines. It is described with the &%header%&
9740 expansion item below.
9741
9742
9743 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9744 .cindex "expansion" "calling an acl"
9745 .cindex "&%acl%&" "call from expansion"
9746 The name and zero to nine argument strings are first expanded separately.  The expanded
9747 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9748 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9749 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9750 and may use the variables; if another acl expansion is used the values
9751 are restored after it returns.  If the ACL sets
9752 a value using a "message =" modifier and returns accept or deny, the value becomes
9753 the result of the expansion.
9754 If no message is set and the ACL returns accept or deny
9755 the expansion result is an empty string.
9756 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9757
9758
9759 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9760 .cindex authentication "results header"
9761 .chindex Authentication-Results:
9762 .cindex authentication "expansion item"
9763 This item returns a string suitable for insertion as an
9764 &'Authentication-Results:'&
9765 header line.
9766 The given <&'authserv-id'&> is included in the result; typically this
9767 will be a domain name identifying the system performing the authentications.
9768 Methods that might be present in the result include:
9769 .code
9770 none
9771 iprev
9772 auth
9773 spf
9774 dkim
9775 .endd
9776
9777 Example use (as an ACL modifier):
9778 .code
9779       add_header = :at_start:${authresults {$primary_hostname}}
9780 .endd
9781 This is safe even if no authentication results are available
9782 and would generally be placed in the DATA ACL.
9783
9784
9785 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9786        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9787 .cindex "expansion" "extracting certificate fields"
9788 .cindex "&%certextract%&" "certificate fields"
9789 .cindex "certificate" "extracting fields"
9790 The <&'certificate'&> must be a variable of type certificate.
9791 The field name is expanded and used to retrieve the relevant field from
9792 the certificate.  Supported fields are:
9793 .display
9794 &`version        `&
9795 &`serial_number  `&
9796 &`subject        `& RFC4514 DN
9797 &`issuer         `& RFC4514 DN
9798 &`notbefore      `& time
9799 &`notafter       `& time
9800 &`sig_algorithm  `&
9801 &`signature      `&
9802 &`subj_altname   `& tagged list
9803 &`ocsp_uri       `& list
9804 &`crl_uri        `& list
9805 .endd
9806 If the field is found,
9807 <&'string2'&> is expanded, and replaces the whole item;
9808 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9809 variable &$value$& contains the value that has been extracted. Afterwards, it
9810 is restored to any previous value it might have had.
9811
9812 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9813 key is not found. If {<&'string2'&>} is also omitted, the value that was
9814 extracted is used.
9815
9816 Some field names take optional modifiers, appended and separated by commas.
9817
9818 The field selectors marked as "RFC4514" above
9819 output a Distinguished Name string which is
9820 not quite
9821 parseable by Exim as a comma-separated tagged list
9822 (the exceptions being elements containing commas).
9823 RDN elements of a single type may be selected by
9824 a modifier of the type label; if so the expansion
9825 result is a list (newline-separated by default).
9826 The separator may be changed by another modifier of
9827 a right angle-bracket followed immediately by the new separator.
9828 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9829
9830 The field selectors marked as "time" above
9831 take an optional modifier of "int"
9832 for which the result is the number of seconds since epoch.
9833 Otherwise the result is a human-readable string
9834 in the timezone selected by the main "timezone" option.
9835
9836 The field selectors marked as "list" above return a list,
9837 newline-separated by default,
9838 (embedded separator characters in elements are doubled).
9839 The separator may be changed by a modifier of
9840 a right angle-bracket followed immediately by the new separator.
9841
9842 The field selectors marked as "tagged" above
9843 prefix each list element with a type string and an equals sign.
9844 Elements of only one type may be selected by a modifier
9845 which is one of "dns", "uri" or "mail";
9846 if so the element tags are omitted.
9847
9848 If not otherwise noted field values are presented in human-readable form.
9849
9850 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9851        {*&<&'arg'&>&*}...}*&"
9852 .cindex &%dlfunc%&
9853 This expansion dynamically loads and then calls a locally-written C function.
9854 This functionality is available only if Exim is compiled with
9855 .code
9856 EXPAND_DLFUNC=yes
9857 .endd
9858 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9859 object so that it doesn't reload the same object file in the same Exim process
9860 (but of course Exim does start new processes frequently).
9861
9862 There may be from zero to eight arguments to the function.
9863
9864 When compiling
9865 a local function that is to be called in this way,
9866 first &_DLFUNC_IMPL_& should be defined,
9867 and second &_local_scan.h_& should be included.
9868 The Exim variables and functions that are defined by that API
9869 are also available for dynamically loaded functions. The function itself
9870 must have the following type:
9871 .code
9872 int dlfunction(uschar **yield, int argc, uschar *argv[])
9873 .endd
9874 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9875 function should return one of the following values:
9876
9877 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9878 into the expanded string that is being built.
9879
9880 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9881 from &'yield'&, if it is set.
9882
9883 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9884 taken from &'yield'& if it is set.
9885
9886 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9887
9888 When compiling a function that is to be used in this way with gcc,
9889 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9890 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9891
9892
9893 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9894 .cindex "expansion" "extracting value from environment"
9895 .cindex "environment" "values from"
9896 The key is first expanded separately, and leading and trailing white space
9897 removed.
9898 This is then searched for as a name in the environment.
9899 If a variable is found then its value is placed in &$value$&
9900 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9901
9902 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9903 appear, for example:
9904 .code
9905 ${env{USER}{$value} fail }
9906 .endd
9907 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9908 {<&'string1'&>} must be present for &"fail"& to be recognized.
9909
9910 If {<&'string2'&>} is omitted an empty string is substituted on
9911 search failure.
9912 If {<&'string1'&>} is omitted the search result is substituted on
9913 search success.
9914
9915 The environment is adjusted by the &%keep_environment%& and
9916 &%add_environment%& main section options.
9917
9918
9919 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9920        {*&<&'string3'&>&*}}*&"
9921 .cindex "expansion" "extracting substrings by key"
9922 .cindex "&%extract%&" "substrings by key"
9923 The key and <&'string1'&> are first expanded separately. Leading and trailing
9924 white space is removed from the key (but not from any of the strings). The key
9925 must not be empty and must not consist entirely of digits.
9926 The expanded <&'string1'&> must be of the form:
9927 .display
9928 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9929 .endd
9930 .vindex "&$value$&"
9931 where the equals signs and spaces (but not both) are optional. If any of the
9932 values contain white space, they must be enclosed in double quotes, and any
9933 values that are enclosed in double quotes are subject to escape processing as
9934 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9935 for the value that corresponds to the key. The search is case-insensitive. If
9936 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9937 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9938 variable &$value$& contains the value that has been extracted. Afterwards, it
9939 is restored to any previous value it might have had.
9940
9941 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9942 key is not found. If {<&'string2'&>} is also omitted, the value that was
9943 extracted is used. Thus, for example, these two expansions are identical, and
9944 yield &"2001"&:
9945 .code
9946 ${extract{gid}{uid=1984 gid=2001}}
9947 ${extract{gid}{uid=1984 gid=2001}{$value}}
9948 .endd
9949 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9950 appear, for example:
9951 .code
9952 ${extract{Z}{A=... B=...}{$value} fail }
9953 .endd
9954 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9955 {<&'string2'&>} must be present for &"fail"& to be recognized.
9956
9957 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9958        {*&<&'string3'&>&*}}*&" &&&
9959        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9960        {*&<&'string3'&>&*}}*&"
9961 .cindex "expansion" "extracting from JSON object"
9962 .cindex JSON expansions
9963 The key and <&'string1'&> are first expanded separately. Leading and trailing
9964 white space is removed from the key (but not from any of the strings). The key
9965 must not be empty and must not consist entirely of digits.
9966 The expanded <&'string1'&> must be of the form:
9967 .display
9968 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9969 .endd
9970 .vindex "&$value$&"
9971 The braces, commas and colons, and the quoting of the member name are required;
9972 the spaces are optional.
9973 Matching of the key against the member names is done case-sensitively.
9974 For the &"json"& variant,
9975 if a returned value is a JSON string, it retains its leading and
9976 trailing quotes.
9977 For the &"jsons"& variant, which is intended for use with JSON strings, the
9978 leading and trailing quotes are removed from the returned value.
9979 . XXX should be a UTF-8 compare
9980
9981 The results of matching are handled as above.
9982
9983
9984 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9985         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9986 .cindex "expansion" "extracting substrings by number"
9987 .cindex "&%extract%&" "substrings by number"
9988 The <&'number'&> argument must consist entirely of decimal digits,
9989 apart from leading and trailing white space, which is ignored.
9990 This is what distinguishes this form of &%extract%& from the previous kind. It
9991 behaves in the same way, except that, instead of extracting a named field, it
9992 extracts from <&'string1'&> the field whose number is given as the first
9993 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9994 <&'string3'&> as before.
9995
9996 The fields in the string are separated by any one of the characters in the
9997 separator string. These may include space or tab characters.
9998 The first field is numbered one. If the number is negative, the fields are
9999 counted from the end of the string, with the rightmost one numbered -1. If the
10000 number given is zero, the entire string is returned. If the modulus of the
10001 number is greater than the number of fields in the string, the result is the
10002 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
10003 provided. For example:
10004 .code
10005 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
10006 .endd
10007 yields &"42"&, and
10008 .code
10009 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
10010 .endd
10011 yields &"99"&. Two successive separators mean that the field between them is
10012 empty (for example, the fifth field above).
10013
10014
10015 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
10016         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
10017        "&*${extract jsons{*&<&'number'&>&*}}&&&
10018         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10019 .cindex "expansion" "extracting from JSON array"
10020 .cindex JSON expansions
10021 The <&'number'&> argument must consist entirely of decimal digits,
10022 apart from leading and trailing white space, which is ignored.
10023
10024 Field selection and result handling is as above;
10025 there is no choice of field separator.
10026 For the &"json"& variant,
10027 if a returned value is a JSON string, it retains its leading and
10028 trailing quotes.
10029 For the &"jsons"& variant, which is intended for use with JSON strings, the
10030 leading and trailing quotes are removed from the returned value.
10031
10032
10033 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
10034 .cindex "list" "selecting by condition"
10035 .cindex "expansion" "selecting from list by condition"
10036 .vindex "&$item$&"
10037 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10038 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10039 For each item
10040 in this list, its value is placed in &$item$&, and then the condition is
10041 evaluated.
10042 Any modification of &$value$& by this evaluation is discarded.
10043 If the condition is true, &$item$& is added to the output as an
10044 item in a new list; if the condition is false, the item is discarded. The
10045 separator used for the output list is the same as the one used for the
10046 input, but a separator setting is not included in the output. For example:
10047 .code
10048 ${filter{a:b:c}{!eq{$item}{b}}}
10049 .endd
10050 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10051 to what it was before.
10052 See also the &%map%& and &%reduce%& expansion items.
10053
10054
10055 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10056 .cindex "hash function" "textual"
10057 .cindex "expansion" "textual hash"
10058 This is a textual hashing function, and was the first to be implemented in
10059 early versions of Exim. In current releases, there are other hashing functions
10060 (numeric, MD5, and SHA-1), which are described below.
10061
10062 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10063 <&'n'&>. If you are using fixed values for these numbers, that is, if
10064 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10065 use the simpler operator notation that avoids some of the braces:
10066 .code
10067 ${hash_<n>_<m>:<string>}
10068 .endd
10069 The second number is optional (in both notations). If <&'n'&> is greater than
10070 or equal to the length of the string, the expansion item returns the string.
10071 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10072 function to the string. The new string consists of characters taken from the
10073 first <&'m'&> characters of the string
10074 .code
10075 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10076 .endd
10077 If <&'m'&> is not present the value 26 is used, so that only lower case
10078 letters appear. For example:
10079 .display
10080 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10081 &`$hash{5}{monty}}           `&   yields  &`monty`&
10082 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10083 .endd
10084
10085 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10086         &*$h_*&<&'header&~name'&>&*:*&" &&&
10087        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10088         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10089        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10090         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10091        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10092         &*$rh_*&<&'header&~name'&>&*:*&"
10093 .cindex "expansion" "header insertion"
10094 .vindex "&$header_$&"
10095 .vindex "&$bheader_$&"
10096 .vindex "&$lheader_$&"
10097 .vindex "&$rheader_$&"
10098 .cindex "header lines" "in expansion strings"
10099 .cindex "header lines" "character sets"
10100 .cindex "header lines" "decoding"
10101 Substitute the contents of the named message header line, for example
10102 .code
10103 $header_reply-to:
10104 .endd
10105 The newline that terminates a header line is not included in the expansion, but
10106 internal newlines (caused by splitting the header line over several physical
10107 lines) may be present.
10108
10109 The difference between the four pairs of expansions is in the way
10110 the data in the header line is interpreted.
10111
10112 .ilist
10113 .cindex "white space" "in header lines"
10114 &%rheader%& gives the original &"raw"& content of the header line, with no
10115 processing at all, and without the removal of leading and trailing white space.
10116
10117 .next
10118 .cindex "list" "of header lines"
10119 &%lheader%& gives a colon-separated list, one element per header when there
10120 are multiple headers with a given name.
10121 Any embedded colon characters within an element are doubled, so normal Exim
10122 list-processing facilities can be used.
10123 The terminating newline of each element is removed; in other respects
10124 the content is &"raw"&.
10125
10126 .next
10127 .cindex "base64 encoding" "in header lines"
10128 &%bheader%& removes leading and trailing white space, and then decodes base64
10129 or quoted-printable MIME &"words"& within the header text, but does no
10130 character set translation. If decoding of what looks superficially like a MIME
10131 &"word"& fails, the raw string is returned. If decoding
10132 .cindex "binary zero" "in header line"
10133 produces a binary zero character, it is replaced by a question mark &-- this is
10134 what Exim does for binary zeros that are actually received in header lines.
10135
10136 .next
10137 &%header%& tries to translate the string as decoded by &%bheader%& to a
10138 standard character set. This is an attempt to produce the same string as would
10139 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10140 returned. Translation is attempted only on operating systems that support the
10141 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10142 a system Makefile or in &_Local/Makefile_&.
10143 .endlist ilist
10144
10145 In a filter file, the target character set for &%header%& can be specified by a
10146 command of the following form:
10147 .code
10148 headers charset "UTF-8"
10149 .endd
10150 This command affects all references to &$h_$& (or &$header_$&) expansions in
10151 subsequently obeyed filter commands. In the absence of this command, the target
10152 character set in a filter is taken from the setting of the &%headers_charset%&
10153 option in the runtime configuration. The value of this option defaults to the
10154 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10155 ISO-8859-1.
10156
10157 Header names follow the syntax of RFC 2822, which states that they may contain
10158 any printing characters except space and colon. Consequently, curly brackets
10159 &'do not'& terminate header names, and should not be used to enclose them as
10160 if they were variables. Attempting to do so causes a syntax error.
10161
10162 Only header lines that are common to all copies of a message are visible to
10163 this mechanism. These are the original header lines that are received with the
10164 message, and any that are added by an ACL statement or by a system
10165 filter. Header lines that are added to a particular copy of a message by a
10166 router or transport are not accessible.
10167
10168 For incoming SMTP messages, no header lines are visible in
10169 ACLs that are obeyed before the data phase completes,
10170 because the header structure is not set up until the message is received.
10171 They are visible in DKIM, PRDR and DATA ACLs.
10172 Header lines that are added in a RCPT ACL (for example)
10173 are saved until the message's incoming header lines are available, at which
10174 point they are added.
10175 When any of the above ACLs are
10176 running, however, header lines added by earlier ACLs are visible.
10177
10178 Upper case and lower case letters are synonymous in header names. If the
10179 following character is white space, the terminating colon may be omitted, but
10180 this is not recommended, because you may then forget it when it is needed. When
10181 white space terminates the header name, this white space is included in the
10182 expanded string.  If the message does not contain the given header, the
10183 expansion item is replaced by an empty string. (See the &%def%& condition in
10184 section &<<SECTexpcond>>& for a means of testing for the existence of a
10185 header.)
10186
10187 If there is more than one header with the same name, they are all concatenated
10188 to form the substitution string, up to a maximum length of 64K. Unless
10189 &%rheader%& is being used, leading and trailing white space is removed from
10190 each header before concatenation, and a completely empty header is ignored. A
10191 newline character is then inserted between non-empty headers, but there is no
10192 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10193 those headers that contain lists of addresses, a comma is also inserted at the
10194 junctions between headers. This does not happen for the &%rheader%& expansion.
10195
10196 .cindex "tainted data" "message headers"
10197 When the headers are from an incoming message,
10198 the result of expanding any of these variables is tainted.
10199
10200
10201 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10202 .cindex "expansion" "hmac hashing"
10203 .cindex &%hmac%&
10204 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10205 shared secret and some text into a message authentication code, as specified in
10206 RFC 2104. This differs from &`${md5:secret_text...}`& or
10207 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10208 cryptographic hash, allowing for authentication that is not possible with MD5
10209 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10210 present. For example:
10211 .code
10212 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10213 .endd
10214 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10215 produces:
10216 .code
10217 dd97e3ba5d1a61b5006108f8c8252953
10218 .endd
10219 As an example of how this might be used, you might put in the main part of
10220 an Exim configuration:
10221 .code
10222 SPAMSCAN_SECRET=cohgheeLei2thahw
10223 .endd
10224 In a router or a transport you could then have:
10225 .code
10226 headers_add = \
10227   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10228   ${hmac{md5}{SPAMSCAN_SECRET}\
10229   {${primary_hostname},${message_exim_id},$h_message-id:}}
10230 .endd
10231 Then given a message, you can check where it was scanned by looking at the
10232 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10233 this header line is authentic by recomputing the authentication code from the
10234 host name, message ID and the &'Message-id:'& header line. This can be done
10235 using Exim's &%-be%& option, or by other means, for example, by using the
10236 &'hmac_md5_hex()'& function in Perl.
10237
10238
10239 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10240 .cindex "expansion" "conditional"
10241 .cindex "&%if%&, expansion item"
10242 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10243 item; otherwise <&'string2'&> is used. The available conditions are described
10244 in section &<<SECTexpcond>>& below. For example:
10245 .code
10246 ${if eq {$local_part}{postmaster} {yes}{no} }
10247 .endd
10248 The second string need not be present; if it is not and the condition is not
10249 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10250 be present instead of the second string (without any curly brackets). In this
10251 case, the expansion is forced to fail if the condition is not true (see section
10252 &<<SECTforexpfai>>&).
10253
10254 If both strings are omitted, the result is the string &`true`& if the condition
10255 is true, and the empty string if the condition is false. This makes it less
10256 cumbersome to write custom ACL and router conditions. For example, instead of
10257 .code
10258 condition = ${if >{$acl_m4}{3}{true}{false}}
10259 .endd
10260 you can use
10261 .code
10262 condition = ${if >{$acl_m4}{3}}
10263 .endd
10264
10265
10266
10267 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10268 .cindex expansion "imap folder"
10269 .cindex "&%imapfolder%& expansion item"
10270 This item converts a (possibly multilevel, or with non-ASCII characters)
10271 folder specification to a Maildir name for filesystem use.
10272 For information on internationalisation support see &<<SECTi18nMDA>>&.
10273
10274
10275
10276 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10277 .cindex "expansion" "string truncation"
10278 .cindex "&%length%& expansion item"
10279 The &%length%& item is used to extract the initial portion of a string. Both
10280 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10281 you are using a fixed value for the number, that is, if <&'string1'&> does not
10282 change when expanded, you can use the simpler operator notation that avoids
10283 some of the braces:
10284 .code
10285 ${length_<n>:<string>}
10286 .endd
10287 The result of this item is either the first <&'n'&> bytes or the whole
10288 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10289 &%strlen%&, which gives the length of a string.
10290 All measurement is done in bytes and is not UTF-8 aware.
10291
10292
10293 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10294         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10295 .cindex "expansion" "extracting list elements by number"
10296 .cindex "&%listextract%&" "extract list elements by number"
10297 .cindex "list" "extracting elements by number"
10298 The <&'number'&> argument must consist entirely of decimal digits,
10299 apart from an optional leading minus,
10300 and leading and trailing white space (which is ignored).
10301
10302 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10303 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10304
10305 The first field of the list is numbered one.
10306 If the number is negative, the fields are
10307 counted from the end of the list, with the rightmost one numbered -1.
10308 The numbered element of the list is extracted and placed in &$value$&,
10309 then <&'string2'&> is expanded as the result.
10310
10311 If the modulus of the
10312 number is zero or greater than the number of fields in the string,
10313 the result is the expansion of <&'string3'&>.
10314
10315 For example:
10316 .code
10317 ${listextract{2}{x:42:99}}
10318 .endd
10319 yields &"42"&, and
10320 .code
10321 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10322 .endd
10323 yields &"result: 42"&.
10324
10325 If {<&'string3'&>} is omitted, an empty string is used for string3.
10326 If {<&'string2'&>} is also omitted, the value that was
10327 extracted is used.
10328 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10329
10330
10331 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10332 .cindex quoting "for list"
10333 .cindex list quoting
10334 This item doubles any occurrence of the separator character
10335 in the given string.
10336 An empty string is replaced with a single space.
10337 This converts the string into a safe form for use as a list element,
10338 in a list using the given separator.
10339
10340
10341 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10342         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10343        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10344         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10345 .cindex "expansion" "lookup in"
10346 .cindex "file" "lookups"
10347 .cindex "lookup" "in expanded string"
10348 The two forms of lookup item specify data lookups in files and databases, as
10349 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10350 lookups, and the second is used for query-style lookups. The <&'key'&>,
10351 <&'file'&>, and <&'query'&> strings are expanded before use.
10352
10353 If there is any white space in a lookup item which is part of a filter command,
10354 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10355 other place where white space is significant, the lookup item must be enclosed
10356 in double quotes. The use of data lookups in users' filter files may be locked
10357 out by the system administrator.
10358
10359 .vindex "&$value$&"
10360 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10361 During its expansion, the variable &$value$& contains the data returned by the
10362 lookup. Afterwards it reverts to the value it had previously (at the outer
10363 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10364 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10365 string on failure. If <&'string2'&> is provided, it can itself be a nested
10366 lookup, thus providing a mechanism for looking up a default value when the
10367 original lookup fails.
10368
10369 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10370 data for the outer lookup while the parameters of the second lookup are
10371 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10372 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10373 appear, and in this case, if the lookup fails, the entire expansion is forced
10374 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10375 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10376 successful lookup, and nothing in the case of failure.
10377
10378 For single-key lookups, the string &"partial"& is permitted to precede the
10379 search type in order to do partial matching, and * or *@ may follow a search
10380 type to request default lookups if the key does not match (see sections
10381 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10382
10383 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10384 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10385 and non-wild parts of the key during the expansion of the replacement text.
10386 They return to their previous values at the end of the lookup item.
10387
10388 This example looks up the postmaster alias in the conventional alias file:
10389 .code
10390 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10391 .endd
10392 This example uses NIS+ to look up the full name of the user corresponding to
10393 the local part of an address, forcing the expansion to fail if it is not found:
10394 .code
10395 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10396   {$value}fail}
10397 .endd
10398
10399
10400 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10401 .cindex "expansion" "list creation"
10402 .vindex "&$item$&"
10403 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10404 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10405 For each item
10406 in this list, its value is place in &$item$&, and then <&'string2'&> is
10407 expanded and added to the output as an item in a new list. The separator used
10408 for the output list is the same as the one used for the input, but a separator
10409 setting is not included in the output. For example:
10410 .code
10411 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10412 .endd
10413 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10414 value of &$item$& is restored to what it was before. See also the &%filter%&
10415 and &%reduce%& expansion items.
10416
10417 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10418 .cindex "expansion" "numeric hash"
10419 .cindex "hash function" "numeric"
10420 The three strings are expanded; the first two must yield numbers. Call them
10421 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10422 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10423 can use the simpler operator notation that avoids some of the braces:
10424 .code
10425 ${nhash_<n>_<m>:<string>}
10426 .endd
10427 The second number is optional (in both notations). If there is only one number,
10428 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10429 processed by a div/mod hash function that returns two numbers, separated by a
10430 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10431 example,
10432 .code
10433 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10434 .endd
10435 returns the string &"6/33"&.
10436
10437
10438
10439 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10440 .cindex "Perl" "use in expanded string"
10441 .cindex "expansion" "calling Perl from"
10442 This item is available only if Exim has been built to include an embedded Perl
10443 interpreter. The subroutine name and the arguments are first separately
10444 expanded, and then the Perl subroutine is called with those arguments. No
10445 additional arguments need be given; the maximum number permitted, including the
10446 name of the subroutine, is nine.
10447
10448 The return value of the subroutine is inserted into the expanded string, unless
10449 the return value is &%undef%&. In that case, the entire expansion is
10450 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10451 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10452 in a scalar context, thus the return value is a scalar.  For example, if you
10453 return a Perl vector, the return value is the size of the vector,
10454 not its contents.
10455
10456 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10457 with the error message that was passed to &%die%&. More details of the embedded
10458 Perl facility are given in chapter &<<CHAPperl>>&.
10459
10460 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10461 out the use of this expansion item in filter files.
10462
10463
10464 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10465 .cindex "&%prvs%& expansion item"
10466 The first argument is a complete email address and the second is secret
10467 keystring. The third argument, specifying a key number, is optional. If absent,
10468 it defaults to 0. The result of the expansion is a prvs-signed email address,
10469 to be typically used with the &%return_path%& option on an &(smtp)& transport
10470 as part of a bounce address tag validation (BATV) scheme. For more discussion
10471 and an example, see section &<<SECTverifyPRVS>>&.
10472
10473 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10474         {*&<&'string'&>&*}}*&"
10475 .cindex "&%prvscheck%& expansion item"
10476 This expansion item is the complement of the &%prvs%& item. It is used for
10477 checking prvs-signed addresses. If the expansion of the first argument does not
10478 yield a syntactically valid prvs-signed address, the whole item expands to the
10479 empty string. When the first argument does expand to a syntactically valid
10480 prvs-signed address, the second argument is expanded, with the prvs-decoded
10481 version of the address and the key number extracted from the address in the
10482 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10483
10484 These two variables can be used in the expansion of the second argument to
10485 retrieve the secret. The validity of the prvs-signed address is then checked
10486 against the secret. The result is stored in the variable &$prvscheck_result$&,
10487 which is empty for failure or &"1"& for success.
10488
10489 The third argument is optional; if it is missing, it defaults to an empty
10490 string. This argument is now expanded. If the result is an empty string, the
10491 result of the expansion is the decoded version of the address. This is the case
10492 whether or not the signature was valid. Otherwise, the result of the expansion
10493 is the expansion of the third argument.
10494
10495 All three variables can be used in the expansion of the third argument.
10496 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10497 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10498
10499 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10500 .cindex "expansion" "inserting an entire file"
10501 .cindex "file" "inserting into expansion"
10502 .cindex "&%readfile%& expansion item"
10503 The filename and end-of-line (eol) string are first expanded separately. The file is
10504 then read, and its contents replace the entire item. All newline characters in
10505 the file are replaced by the end-of-line string if it is present. Otherwise,
10506 newlines are left in the string.
10507 String expansion is not applied to the contents of the file. If you want this,
10508 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10509 the string expansion fails.
10510
10511 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10512 locks out the use of this expansion item in filter files.
10513
10514
10515
10516 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10517         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10518 .cindex "expansion" "inserting from a socket"
10519 .cindex "socket, use of in expansion"
10520 .cindex "&%readsocket%& expansion item"
10521 This item inserts data from a Unix domain or TCP socket into the expanded
10522 string. The minimal way of using it uses just two arguments, as in these
10523 examples:
10524 .code
10525 ${readsocket{/socket/name}{request string}}
10526 ${readsocket{inet:some.host:1234}{request string}}
10527 .endd
10528 For a Unix domain socket, the first substring must be the path to the socket.
10529 For an Internet socket, the first substring must contain &`inet:`& followed by
10530 a host name or IP address, followed by a colon and a port, which can be a
10531 number or the name of a TCP port in &_/etc/services_&. An IP address may
10532 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10533 example:
10534 .code
10535 ${readsocket{inet:[::1]:1234}{request string}}
10536 .endd
10537 Only a single host name may be given, but if looking it up yields more than
10538 one IP address, they are each tried in turn until a connection is made. For
10539 both kinds of socket, Exim makes a connection, writes the request string
10540 (unless it is an empty string; no terminating NUL is ever sent)
10541 and reads from the socket until an end-of-file
10542 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10543 extend what can be done. Firstly, you can vary the timeout. For example:
10544 .code
10545 ${readsocket{/socket/name}{request string}{3s}}
10546 .endd
10547
10548 The third argument is a list of options, of which the first element is the timeout
10549 and must be present if any options are given.
10550 Further elements are options of form &'name=value'&.
10551 Example:
10552 .code
10553 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10554 .endd
10555
10556 The following option names are recognised:
10557 .ilist
10558 &*cache*&
10559 Defines if the result data can be cached for use by a later identical
10560 request in the same process.
10561 Values are &"yes"& or &"no"& (the default).
10562 If not, all cached results for this connection specification
10563 will be invalidated.
10564
10565 .next
10566 &*shutdown*&
10567 Defines whether or not a write-shutdown is done on the connection after
10568 sending the request. Values are &"yes"& (the default) or &"no"&
10569 (preferred, eg. by some webservers).
10570
10571 .next
10572 &*sni*&
10573 Controls the use of Server Name Identification on the connection.
10574 Any nonempty value will be the SNI sent; TLS will be forced.
10575
10576 .next
10577 &*tls*&
10578 Controls the use of TLS on the connection.
10579 Values are &"yes"& or &"no"& (the default).
10580 If it is enabled, a shutdown as described above is never done.
10581 .endlist
10582
10583
10584 A fourth argument allows you to change any newlines that are in the data
10585 that is read, in the same way as for &%readfile%& (see above). This example
10586 turns them into spaces:
10587 .code
10588 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10589 .endd
10590 As with all expansions, the substrings are expanded before the processing
10591 happens. Errors in these sub-expansions cause the expansion to fail. In
10592 addition, the following errors can occur:
10593
10594 .ilist
10595 Failure to create a socket file descriptor;
10596 .next
10597 Failure to connect the socket;
10598 .next
10599 Failure to write the request string;
10600 .next
10601 Timeout on reading from the socket.
10602 .endlist
10603
10604 By default, any of these errors causes the expansion to fail. However, if
10605 you supply a fifth substring, it is expanded and used when any of the above
10606 errors occurs. For example:
10607 .code
10608 ${readsocket{/socket/name}{request string}{3s}{\n}\
10609   {socket failure}}
10610 .endd
10611 You can test for the existence of a Unix domain socket by wrapping this
10612 expansion in &`${if exists`&, but there is a race condition between that test
10613 and the actual opening of the socket, so it is safer to use the fifth argument
10614 if you want to be absolutely sure of avoiding an expansion error for a
10615 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10616
10617 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10618 locks out the use of this expansion item in filter files.
10619
10620
10621 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10622 .cindex "expansion" "reducing a list to a scalar"
10623 .cindex "list" "reducing to a scalar"
10624 .vindex "&$value$&"
10625 .vindex "&$item$&"
10626 This operation reduces a list to a single, scalar string. After expansion,
10627 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10628 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10629 Then <&'string2'&> is expanded and
10630 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10631 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10632 them. The result of that expansion is assigned to &$value$& before the next
10633 iteration. When the end of the list is reached, the final value of &$value$& is
10634 added to the expansion output. The &%reduce%& expansion item can be used in a
10635 number of ways. For example, to add up a list of numbers:
10636 .code
10637 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10638 .endd
10639 The result of that expansion would be &`6`&. The maximum of a list of numbers
10640 can be found:
10641 .code
10642 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10643 .endd
10644 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10645 restored to what they were before. See also the &%filter%& and &%map%&
10646 expansion items.
10647
10648 . A bit of a special-case logic error in writing an expansion;
10649 . probably not worth including in the mainline of documentation.
10650 . If only we had footnotes (the html output variant is the problem).
10651 .
10652 . .new
10653 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10654 . and that condition modifies &$value$&,
10655 . then the string expansions dependent on the condition cannot use
10656 . the &$value$& of the reduce iteration.
10657 . .wen
10658
10659 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10660 This item inserts &"raw"& header lines. It is described with the &%header%&
10661 expansion item in section &<<SECTexpansionitems>>& above.
10662
10663 .vitem "&*${run<&'options'&> {*&<&'command&~string'&>&*}{*&<&'string1'&>&*}&&&
10664         {*&<&'string2'&>&*}}*&"
10665 .cindex "expansion" "running a command"
10666 .cindex "&%run%& expansion item"
10667 This item runs an external command, as a subprocess.
10668 One option is supported after the word &'run'&, comma-separated
10669 and without whitespace.
10670
10671 If the option &'preexpand'& is not used,
10672 the command string before expansion is split into individual arguments by spaces
10673 and then each argument is separately expanded.
10674 Then the command is run
10675 in a separate process, but under the same uid and gid.  As in other command
10676 executions from Exim, a shell is not used by default. If the command requires
10677 a shell, you must explicitly code it.
10678 The command name may not be tainted, but the remaining arguments can be.
10679
10680 &*Note*&: if tainted arguments are used, they are supplied by a
10681 potential attacker;
10682 a careful assessment for security vulnerabilities should be done.
10683
10684 If the option &'preexpand'& is used,
10685 the command string is first expanded as a whole.
10686 The expansion result is split apart into individual arguments by spaces,
10687 and then the command is run as above.
10688 Since the arguments are split by spaces, when there is a variable expansion
10689 which has an empty result, it will cause the situation that the argument will
10690 simply be omitted when the program is actually executed by Exim. If the
10691 script/program requires a specific number of arguments and the expanded
10692 variable could possibly result in this empty expansion, the variable must be
10693 quoted. This is more difficult if the expanded variable itself could result
10694 in a string containing quotes, because it would interfere with the quotes
10695 around the command arguments. A possible guard against this is to wrap the
10696 variable in the &%sg%& operator to change any quote marks to some other
10697 character.
10698 Neither the command nor any argument may be tainted.
10699
10700 The standard input for the command exists, but is empty. The standard output
10701 and standard error are set to the same file descriptor.
10702 .cindex "return code" "from &%run%& expansion"
10703 .vindex "&$value$&"
10704 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10705 and replaces the entire item; during this expansion, the standard output/error
10706 from the command is in the variable &$value$&. If the command fails,
10707 <&'string2'&>, if present, is expanded and used. Once again, during the
10708 expansion, the standard output/error from the command is in the variable
10709 &$value$&.
10710
10711 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10712 can be the word &"fail"& (not in braces) to force expansion failure if the
10713 command does not succeed. If both strings are omitted, the result is contents
10714 of the standard output/error on success, and nothing on failure.
10715
10716 .vindex "&$run_in_acl$&"
10717 The standard output/error of the command is put in the variable &$value$&.
10718 In this ACL example, the output of a command is logged for the admin to
10719 troubleshoot:
10720 .code
10721 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10722       log_message  = Output of id: $value
10723 .endd
10724 If the command requires shell idioms, such as the > redirect operator, the
10725 shell must be invoked directly, such as with:
10726 .code
10727 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10728 .endd
10729 Note that &$value$& will not persist beyond the reception of a single message.
10730
10731 .vindex "&$runrc$&"
10732 The return code from the command is put in the variable &$runrc$&, and this
10733 remains set afterwards, so in a filter file you can do things like this:
10734 .code
10735 if "${run{x y z}{}}$runrc" is 1 then ...
10736   elif $runrc is 2 then ...
10737   ...
10738 endif
10739 .endd
10740 If execution of the command fails (for example, the command does not exist),
10741 the return code is 127 &-- the same code that shells use for non-existent
10742 commands.
10743
10744 &*Warning*&: In a router or transport, you cannot assume the order in which
10745 option values are expanded, except for those preconditions whose order of
10746 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10747 by the expansion of one option, and use it in another.
10748
10749 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10750 out the use of this expansion item in filter files.
10751
10752
10753 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10754 .cindex "expansion" "string substitution"
10755 .cindex "&%sg%& expansion item"
10756 This item works like Perl's substitution operator (s) with the global (/g)
10757 option; hence its name. However, unlike the Perl equivalent, Exim does not
10758 modify the subject string; instead it returns the modified string for insertion
10759 into the overall expansion. The item takes three arguments: the subject string,
10760 a regular expression, and a substitution string. For example:
10761 .code
10762 ${sg{abcdefabcdef}{abc}{xyz}}
10763 .endd
10764 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10765 if any $, } or \ characters are required in the regular expression or in the
10766 substitution string, they have to be escaped. For example:
10767 .code
10768 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10769 .endd
10770 yields &"defabc"&, and
10771 .code
10772 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10773 .endd
10774 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10775 the regular expression from string expansion.
10776
10777 The regular expression is compiled in 8-bit mode, working against bytes
10778 rather than any Unicode-aware character handling.
10779
10780
10781 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10782 .cindex sorting "a list"
10783 .cindex list sorting
10784 .cindex expansion "list sorting"
10785 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10786 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10787 The <&'comparator'&> argument is interpreted as the operator
10788 of a two-argument expansion condition.
10789 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10790 The comparison should return true when applied to two values
10791 if the first value should sort before the second value.
10792 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10793 the element being placed in &$item$&,
10794 to give values for comparison.
10795
10796 The item result is a sorted list,
10797 with the original list separator,
10798 of the list elements (in full) of the original.
10799
10800 Examples:
10801 .code
10802 ${sort{3:2:1:4}{<}{$item}}
10803 .endd
10804 sorts a list of numbers, and
10805 .code
10806 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10807 .endd
10808 will sort an MX lookup into priority order.
10809
10810
10811
10812 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10813 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10814
10815
10816
10817 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10818 .cindex "&%substr%& expansion item"
10819 .cindex "substring extraction"
10820 .cindex "expansion" "substring extraction"
10821 The three strings are expanded; the first two must yield numbers. Call them
10822 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10823 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10824 can use the simpler operator notation that avoids some of the braces:
10825 .code
10826 ${substr_<n>_<m>:<subject>}
10827 .endd
10828 The second number is optional (in both notations).
10829 If it is absent in the simpler format, the preceding underscore must also be
10830 omitted.
10831
10832 The &%substr%& item can be used to extract more general substrings than
10833 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10834 length required. For example
10835 .code
10836 ${substr{3}{2}{$local_part}}
10837 .endd
10838 If the starting offset is greater than the string length the result is the
10839 null string; if the length plus starting offset is greater than the string
10840 length, the result is the right-hand part of the string, starting from the
10841 given offset. The first byte (character) in the string has offset zero.
10842
10843 The &%substr%& expansion item can take negative offset values to count
10844 from the right-hand end of its operand. The last byte (character) is offset -1,
10845 the second-last is offset -2, and so on. Thus, for example,
10846 .code
10847 ${substr{-5}{2}{1234567}}
10848 .endd
10849 yields &"34"&. If the absolute value of a negative offset is greater than the
10850 length of the string, the substring starts at the beginning of the string, and
10851 the length is reduced by the amount of overshoot. Thus, for example,
10852 .code
10853 ${substr{-5}{2}{12}}
10854 .endd
10855 yields an empty string, but
10856 .code
10857 ${substr{-3}{2}{12}}
10858 .endd
10859 yields &"1"&.
10860
10861 When the second number is omitted from &%substr%&, the remainder of the string
10862 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10863 string preceding the offset point are taken. For example, an offset of -1 and
10864 no length, as in these semantically identical examples:
10865 .code
10866 ${substr_-1:abcde}
10867 ${substr{-1}{abcde}}
10868 .endd
10869 yields all but the last character of the string, that is, &"abcd"&.
10870
10871 All measurement is done in bytes and is not UTF-8 aware.
10872
10873
10874
10875 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10876         {*&<&'replacements'&>&*}}*&"
10877 .cindex "expansion" "character translation"
10878 .cindex "&%tr%& expansion item"
10879 This item does single-character (in bytes) translation on its subject string. The second
10880 argument is a list of characters to be translated in the subject string. Each
10881 matching character is replaced by the corresponding character from the
10882 replacement list. For example
10883 .code
10884 ${tr{abcdea}{ac}{13}}
10885 .endd
10886 yields &`1b3de1`&. If there are duplicates in the second character string, the
10887 last occurrence is used. If the third string is shorter than the second, its
10888 last character is replicated. However, if it is empty, no translation takes
10889 place.
10890
10891 All character handling is done in bytes and is not UTF-8 aware.
10892
10893 .endlist
10894
10895
10896
10897 .section "Expansion operators" "SECTexpop"
10898 .cindex "expansion" "operators"
10899 For expansion items that perform transformations on a single argument string,
10900 the &"operator"& notation is used because it is simpler and uses fewer braces.
10901 The substring is first expanded before the operation is applied to it. The
10902 following operations can be performed:
10903
10904 .vlist
10905 .vitem &*${address:*&<&'string'&>&*}*&
10906 .cindex "expansion" "RFC 2822 address handling"
10907 .cindex "&%address%& expansion item"
10908 The string is interpreted as an RFC 2822 address, as it might appear in a
10909 header line, and the effective address is extracted from it. If the string does
10910 not parse successfully, the result is empty.
10911
10912 The parsing correctly handles SMTPUTF8 Unicode in the string.
10913
10914
10915 .vitem &*${addresses:*&<&'string'&>&*}*&
10916 .cindex "expansion" "RFC 2822 address handling"
10917 .cindex "&%addresses%& expansion item"
10918 The string (after expansion) is interpreted as a list of addresses in RFC
10919 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10920 operative address (&'local-part@domain'&) is extracted from each item, and the
10921 result of the expansion is a colon-separated list, with appropriate
10922 doubling of colons should any happen to be present in the email addresses.
10923 Syntactically invalid RFC2822 address items are omitted from the output.
10924
10925 It is possible to specify a character other than colon for the output
10926 separator by starting the string with > followed by the new separator
10927 character. For example:
10928 .code
10929 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10930 .endd
10931 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10932 first, so if the expanded string starts with >, it may change the output
10933 separator unintentionally. This can be avoided by setting the output
10934 separator explicitly:
10935 .code
10936 ${addresses:>:$h_from:}
10937 .endd
10938
10939 Compare the &%address%& (singular)
10940 expansion item, which extracts the working address from a single RFC2822
10941 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10942 processing lists.
10943
10944 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10945 a strict interpretation of header line formatting.  Exim parses the bare,
10946 unquoted portion of an email address and if it finds a comma, treats it as an
10947 email address separator. For the example header line:
10948 .code
10949 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10950 .endd
10951 The first example below demonstrates that Q-encoded email addresses are parsed
10952 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10953 It does not see the comma because it's still encoded as "=2C".  The second
10954 example below is passed the contents of &`$header_from:`&, meaning it gets
10955 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10956 The third example shows that the presence of a comma is skipped when it is
10957 quoted.  The fourth example shows SMTPUTF8 handling.
10958 .code
10959 # exim -be '${addresses:From: \
10960 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10961 user@example.com
10962 # exim -be '${addresses:From: Last, First <user@example.com>}'
10963 Last:user@example.com
10964 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10965 user@example.com
10966 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10967 フィリップ@example.jp
10968 .endd
10969
10970 .vitem &*${base32:*&<&'digits'&>&*}*&
10971 .cindex "&%base32%& expansion item"
10972 .cindex "expansion" "conversion to base 32"
10973 The string must consist entirely of decimal digits. The number is converted to
10974 base 32 and output as a (empty, for zero) string of characters.
10975 Only lowercase letters are used.
10976
10977 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10978 .cindex "&%base32d%& expansion item"
10979 .cindex "expansion" "conversion to base 32"
10980 The string must consist entirely of base-32 digits.
10981 The number is converted to decimal and output as a string.
10982
10983 .vitem &*${base62:*&<&'digits'&>&*}*&
10984 .cindex "&%base62%& expansion item"
10985 .cindex "expansion" "conversion to base 62"
10986 The string must consist entirely of decimal digits. The number is converted to
10987 base 62 and output as a string of six characters, including leading zeros. In
10988 the few operating environments where Exim uses base 36 instead of base 62 for
10989 its message identifiers (because those systems do not have case-sensitive
10990 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10991 to be absolutely clear: this is &'not'& base64 encoding.
10992
10993 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10994 .cindex "&%base62d%& expansion item"
10995 .cindex "expansion" "conversion to base 62"
10996 The string must consist entirely of base-62 digits, or, in operating
10997 environments where Exim uses base 36 instead of base 62 for its message
10998 identifiers, base-36 digits. The number is converted to decimal and output as a
10999 string.
11000
11001 .vitem &*${base64:*&<&'string'&>&*}*&
11002 .cindex "expansion" "base64 encoding"
11003 .cindex "base64 encoding" "in string expansion"
11004 .cindex "&%base64%& expansion item"
11005 .cindex certificate "base64 of DER"
11006 This operator converts a string into one that is base64 encoded.
11007
11008 If the string is a single variable of type certificate,
11009 returns the base64 encoding of the DER form of the certificate.
11010
11011
11012 .vitem &*${base64d:*&<&'string'&>&*}*&
11013 .cindex "expansion" "base64 decoding"
11014 .cindex "base64 decoding" "in string expansion"
11015 .cindex "&%base64d%& expansion item"
11016 This operator converts a base64-encoded string into the un-coded form.
11017
11018
11019 .vitem &*${domain:*&<&'string'&>&*}*&
11020 .cindex "domain" "extraction"
11021 .cindex "expansion" "domain extraction"
11022 The string is interpreted as an RFC 2822 address and the domain is extracted
11023 from it. If the string does not parse successfully, the result is empty.
11024
11025
11026 .vitem &*${escape:*&<&'string'&>&*}*&
11027 .cindex "expansion" "escaping non-printing characters"
11028 .cindex "&%escape%& expansion item"
11029 If the string contains any non-printing characters, they are converted to
11030 escape sequences starting with a backslash. Whether characters with the most
11031 significant bit set (so-called &"8-bit characters"&) count as printing or not
11032 is controlled by the &%print_topbitchars%& option.
11033
11034 .vitem &*${escape8bit:*&<&'string'&>&*}*&
11035 .cindex "expansion" "escaping 8-bit characters"
11036 .cindex "&%escape8bit%& expansion item"
11037 If the string contains any characters with the most significant bit set,
11038 they are converted to escape sequences starting with a backslash.
11039 Backslashes and DEL characters are also converted.
11040
11041
11042 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
11043 .cindex "expansion" "expression evaluation"
11044 .cindex "expansion" "arithmetic expression"
11045 .cindex "&%eval%& expansion item"
11046 These items supports simple arithmetic and bitwise logical operations in
11047 expansion strings. The string (after expansion) must be a conventional
11048 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
11049 logical operators, and parentheses. All operations are carried out using
11050 integer arithmetic. The operator priorities are as follows (the same as in the
11051 C programming language):
11052 .table2 70pt 300pt
11053 .irow &'highest:'& "not (~), negate (-)"
11054 .irow ""   "multiply (*), divide (/), remainder (%)"
11055 .irow ""   "plus (+), minus (-)"
11056 .irow ""   "shift-left (<<), shift-right (>>)"
11057 .irow ""   "and (&&)"
11058 .irow ""   "xor (^)"
11059 .irow &'lowest:'&  "or (|)"
11060 .endtable
11061 Binary operators with the same priority are evaluated from left to right. White
11062 space is permitted before or after operators.
11063
11064 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11065 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11066 decimal, even if they start with a leading zero; hexadecimal numbers are not
11067 permitted. This can be useful when processing numbers extracted from dates or
11068 times, which often do have leading zeros.
11069
11070 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11071 or 1024*1024*1024,
11072 respectively. Negative numbers are supported. The result of the computation is
11073 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11074
11075 .display
11076 &`${eval:1+1}            `&  yields 2
11077 &`${eval:1+2*3}          `&  yields 7
11078 &`${eval:(1+2)*3}        `&  yields 9
11079 &`${eval:2+42%5}         `&  yields 4
11080 &`${eval:0xc&amp;5}          `&  yields 4
11081 &`${eval:0xc|5}          `&  yields 13
11082 &`${eval:0xc^5}          `&  yields 9
11083 &`${eval:0xc>>1}         `&  yields 6
11084 &`${eval:0xc<<1}         `&  yields 24
11085 &`${eval:~255&amp;0x1234}    `&  yields 4608
11086 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11087 .endd
11088
11089 As a more realistic example, in an ACL you might have
11090 .code
11091 deny   condition =                    \
11092          ${if and {                   \
11093            {>{$rcpt_count}{10}}       \
11094            {                          \
11095            <                          \
11096              {$recipients_count}      \
11097              {${eval:$rcpt_count/2}}  \
11098            }                          \
11099          }{yes}{no}}
11100        message = Too many bad recipients
11101 .endd
11102 The condition is true if there have been more than 10 RCPT commands and
11103 fewer than half of them have resulted in a valid recipient.
11104
11105
11106 .vitem &*${expand:*&<&'string'&>&*}*&
11107 .cindex "expansion" "re-expansion of substring"
11108 The &%expand%& operator causes a string to be expanded for a second time. For
11109 example,
11110 .code
11111 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11112 .endd
11113 first looks up a string in a file while expanding the operand for &%expand%&,
11114 and then re-expands what it has found.
11115
11116
11117 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11118 .cindex "Unicode"
11119 .cindex "UTF-8" "conversion from"
11120 .cindex "expansion" "UTF-8 conversion"
11121 .cindex "&%from_utf8%& expansion item"
11122 The world is slowly moving towards Unicode, although there are no standards for
11123 email yet. However, other applications (including some databases) are starting
11124 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11125 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11126 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11127 the result is an undefined sequence of bytes.
11128
11129 Unicode code points with values less than 256 are compatible with ASCII and
11130 ISO-8859-1 (also known as Latin-1).
11131 For example, character 169 is the copyright symbol in both cases, though the
11132 way it is encoded is different. In UTF-8, more than one byte is needed for
11133 characters with code values greater than 127, whereas ISO-8859-1 is a
11134 single-byte encoding (but thereby limited to 256 characters). This makes
11135 translation from UTF-8 to ISO-8859-1 straightforward.
11136
11137
11138 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11139 .cindex "hash function" "textual"
11140 .cindex "expansion" "textual hash"
11141 The &%hash%& operator is a simpler interface to the hashing function that can
11142 be used when the two parameters are fixed numbers (as opposed to strings that
11143 change when expanded). The effect is the same as
11144 .code
11145 ${hash{<n>}{<m>}{<string>}}
11146 .endd
11147 See the description of the general &%hash%& item above for details. The
11148 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11149
11150
11151
11152 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11153 .cindex header "wrapping operator"
11154 .cindex expansion "header wrapping"
11155 This operator line-wraps its argument in a way useful for headers.
11156 The &'cols'& value gives the column number to wrap after,
11157 the &'limit'& gives a limit number of result characters to truncate at.
11158 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11159 the defaults are 80 and 998.
11160 Wrapping will be inserted at a space if possible before the
11161 column number is reached.
11162 Whitespace at a chosen wrap point is removed.
11163 A line-wrap consists of a newline followed by a tab,
11164 and the tab is counted as 8 columns.
11165
11166
11167
11168 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11169 .cindex "base64 encoding" "conversion from hex"
11170 .cindex "expansion" "hex to base64"
11171 .cindex "&%hex2b64%& expansion item"
11172 This operator converts a hex string into one that is base64 encoded. This can
11173 be useful for processing the output of the various hashing functions.
11174
11175
11176
11177 .vitem &*${hexquote:*&<&'string'&>&*}*&
11178 .cindex "quoting" "hex-encoded unprintable characters"
11179 .cindex "&%hexquote%& expansion item"
11180 This operator converts non-printable characters in a string into a hex
11181 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11182 as is, and other byte values are converted to &`\xNN`&, for example, a
11183 byte value 127 is converted to &`\x7f`&.
11184
11185
11186 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11187 .cindex "&%ipv6denorm%& expansion item"
11188 .cindex "IP address" normalisation
11189 This expands an IPv6 address to a full eight-element colon-separated set
11190 of hex digits including leading zeroes.
11191 A trailing ipv4-style dotted-decimal set is converted to hex.
11192 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11193
11194 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11195 .cindex "&%ipv6norm%& expansion item"
11196 .cindex "IP address" normalisation
11197 .cindex "IP address" "canonical form"
11198 This converts an IPv6 address to canonical form.
11199 Leading zeroes of groups are omitted, and the longest
11200 set of zero-valued groups is replaced with a double colon.
11201 A trailing ipv4-style dotted-decimal set is converted to hex.
11202 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11203
11204
11205 .vitem &*${lc:*&<&'string'&>&*}*&
11206 .cindex "case forcing in strings"
11207 .cindex "string" "case forcing"
11208 .cindex "lower casing"
11209 .cindex "expansion" "case forcing"
11210 .cindex "&%lc%& expansion item"
11211 This forces the letters in the string into lower-case, for example:
11212 .code
11213 ${lc:$local_part}
11214 .endd
11215 Case is defined per the system C locale.
11216
11217 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11218 .cindex "expansion" "string truncation"
11219 .cindex "&%length%& expansion item"
11220 The &%length%& operator is a simpler interface to the &%length%& function that
11221 can be used when the parameter is a fixed number (as opposed to a string that
11222 changes when expanded). The effect is the same as
11223 .code
11224 ${length{<number>}{<string>}}
11225 .endd
11226 See the description of the general &%length%& item above for details. Note that
11227 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11228 when &%length%& is used as an operator.
11229 All measurement is done in bytes and is not UTF-8 aware.
11230
11231
11232 .vitem &*${listcount:*&<&'string'&>&*}*&
11233 .cindex "expansion" "list item count"
11234 .cindex "list" "item count"
11235 .cindex "list" "count of items"
11236 .cindex "&%listcount%& expansion item"
11237 The string is interpreted as a list and the number of items is returned.
11238
11239
11240 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11241 .cindex "expansion" "named list"
11242 .cindex "&%listnamed%& expansion item"
11243 The name is interpreted as a named list and the content of the list is returned,
11244 expanding any referenced lists, re-quoting as needed for colon-separation.
11245 If the optional type is given it must be one of "a", "d", "h" or "l"
11246 and selects address-, domain-, host- or localpart- lists to search among respectively.
11247 Otherwise all types are searched in an undefined order and the first
11248 matching list is returned.
11249 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11250 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11251
11252
11253 .vitem &*${local_part:*&<&'string'&>&*}*&
11254 .cindex "expansion" "local part extraction"
11255 .cindex "&%local_part%& expansion item"
11256 The string is interpreted as an RFC 2822 address and the local part is
11257 extracted from it. If the string does not parse successfully, the result is
11258 empty.
11259 The parsing correctly handles SMTPUTF8 Unicode in the string.
11260
11261
11262 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11263        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11264 .cindex "masked IP address"
11265 .cindex "IP address" "masking"
11266 .cindex "CIDR notation"
11267 .cindex "expansion" "IP address masking"
11268 .cindex "&%mask%& expansion item"
11269 If the form of the string to be operated on is not an IP address followed by a
11270 slash and an integer (that is, a network address in CIDR notation), the
11271 expansion fails. Otherwise, this operator converts the IP address to binary,
11272 masks off the least significant bits according to the bit count, and converts
11273 the result back to text, with mask appended. For example,
11274 .code
11275 ${mask:10.111.131.206/28}
11276 .endd
11277 returns the string &"10.111.131.192/28"&.
11278
11279 Since this operation is expected to
11280 be mostly used for looking up masked addresses in files, the
11281 normal
11282 result for an IPv6
11283 address uses dots to separate components instead of colons, because colon
11284 terminates a key string in lsearch files. So, for example,
11285 .code
11286 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11287 .endd
11288 returns the string
11289 .code
11290 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11291 .endd
11292 If the optional form &*mask_n*& is used, IPv6 address result are instead
11293 returned in normailsed form, using colons and with zero-compression.
11294 Letters in IPv6 addresses are always output in lower case.
11295
11296
11297 .vitem &*${md5:*&<&'string'&>&*}*&
11298 .cindex "MD5 hash"
11299 .cindex "expansion" "MD5 hash"
11300 .cindex certificate fingerprint
11301 .cindex "&%md5%& expansion item"
11302 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11303 as a 32-digit hexadecimal number, in which any letters are in lower case.
11304
11305 If the string is a single variable of type certificate,
11306 returns the MD5 hash fingerprint of the certificate.
11307
11308
11309 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11310 .cindex "expansion" "numeric hash"
11311 .cindex "hash function" "numeric"
11312 The &%nhash%& operator is a simpler interface to the numeric hashing function
11313 that can be used when the two parameters are fixed numbers (as opposed to
11314 strings that change when expanded). The effect is the same as
11315 .code
11316 ${nhash{<n>}{<m>}{<string>}}
11317 .endd
11318 See the description of the general &%nhash%& item above for details.
11319
11320
11321 .vitem &*${quote:*&<&'string'&>&*}*&
11322 .cindex "quoting" "in string expansions"
11323 .cindex "expansion" "quoting"
11324 .cindex "&%quote%& expansion item"
11325 The &%quote%& operator puts its argument into double quotes if it
11326 is an empty string or
11327 contains anything other than letters, digits, underscores, dots, and hyphens.
11328 Any occurrences of double quotes and backslashes are escaped with a backslash.
11329 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11330 respectively For example,
11331 .code
11332 ${quote:ab"*"cd}
11333 .endd
11334 becomes
11335 .code
11336 "ab\"*\"cd"
11337 .endd
11338 The place where this is useful is when the argument is a substitution from a
11339 variable or a message header.
11340
11341 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11342 .cindex "&%quote_local_part%& expansion item"
11343 This operator is like &%quote%&, except that it quotes the string only if
11344 required to do so by the rules of RFC 2822 for quoting local parts. For
11345 example, a plus sign would not cause quoting (but it would for &%quote%&).
11346 If you are creating a new email address from the contents of &$local_part$&
11347 (or any other unknown data), you should always use this operator.
11348
11349 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11350 will likely use the quoting form.
11351 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11352
11353
11354 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11355 .cindex "quoting" "lookup-specific"
11356 This operator applies lookup-specific quoting rules to the string. Each
11357 query-style lookup type has its own quoting rules which are described with
11358 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11359 .code
11360 ${quote_ldap:two * two}
11361 .endd
11362 returns
11363 .code
11364 two%20%5C2A%20two
11365 .endd
11366 For single-key lookup types, no quoting is ever necessary and this operator
11367 yields an unchanged string.
11368
11369
11370 .vitem &*${randint:*&<&'n'&>&*}*&
11371 .cindex "random number"
11372 This operator returns a somewhat random number which is less than the
11373 supplied number and is at least 0.  The quality of this randomness depends
11374 on how Exim was built; the values are not suitable for keying material.
11375 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11376 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11377 for versions of GnuTLS with that function.
11378 Otherwise, the implementation may be arc4random(), random() seeded by
11379 srandomdev() or srandom(), or a custom implementation even weaker than
11380 random().
11381
11382
11383 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11384 .cindex "expansion" "IP address"
11385 This operator reverses an IP address; for IPv4 addresses, the result is in
11386 dotted-quad decimal form, while for IPv6 addresses the result is in
11387 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11388 for DNS.  For example,
11389 .code
11390 ${reverse_ip:192.0.2.4}
11391 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11392 .endd
11393 returns
11394 .code
11395 4.2.0.192
11396 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
11397 .endd
11398
11399
11400 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11401 .cindex "expansion" "RFC 2047"
11402 .cindex "RFC 2047" "expansion operator"
11403 .cindex "&%rfc2047%& expansion item"
11404 This operator encodes text according to the rules of RFC 2047. This is an
11405 encoding that is used in header lines to encode non-ASCII characters. It is
11406 assumed that the input string is in the encoding specified by the
11407 &%headers_charset%& option, which gets its default at build time. If the string
11408 contains only characters in the range 33&--126, and no instances of the
11409 characters
11410 .code
11411 ? = ( ) < > @ , ; : \ " . [ ] _
11412 .endd
11413 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11414 string, using as many &"encoded words"& as necessary to encode all the
11415 characters.
11416
11417
11418 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11419 .cindex "expansion" "RFC 2047"
11420 .cindex "RFC 2047" "decoding"
11421 .cindex "&%rfc2047d%& expansion item"
11422 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11423 bytes are replaced by question marks. Characters are converted into the
11424 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11425 not recognized unless &%check_rfc2047_length%& is set false.
11426
11427 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11428 access a header line, RFC 2047 decoding is done automatically. You do not need
11429 to use this operator as well.
11430
11431
11432
11433 .vitem &*${rxquote:*&<&'string'&>&*}*&
11434 .cindex "quoting" "in regular expressions"
11435 .cindex "regular expressions" "quoting"
11436 .cindex "&%rxquote%& expansion item"
11437 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11438 characters in its argument. This is useful when substituting the values of
11439 variables or headers inside regular expressions.
11440
11441
11442 .vitem &*${sha1:*&<&'string'&>&*}*&
11443 .cindex "SHA-1 hash"
11444 .cindex "expansion" "SHA-1 hashing"
11445 .cindex certificate fingerprint
11446 .cindex "&%sha1%& expansion item"
11447 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11448 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11449
11450 If the string is a single variable of type certificate,
11451 returns the SHA-1 hash fingerprint of the certificate.
11452
11453
11454 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11455        &*${sha2:*&<&'string'&>&*}*& &&&
11456        &*${sha2_<n>:*&<&'string'&>&*}*&
11457 .cindex "SHA-256 hash"
11458 .cindex "SHA-2 hash"
11459 .cindex certificate fingerprint
11460 .cindex "expansion" "SHA-256 hashing"
11461 .cindex "&%sha256%& expansion item"
11462 .cindex "&%sha2%& expansion item"
11463 The &%sha256%& operator computes the SHA-256 hash value of the string
11464 and returns
11465 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11466
11467 If the string is a single variable of type certificate,
11468 returns the SHA-256 hash fingerprint of the certificate.
11469
11470 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11471 (except for certificates, which are not supported).
11472 Finally, if an underbar
11473 and a number is appended it specifies the output length, selecting a
11474 member of the SHA-2 family of hash functions.
11475 Values of 256, 384 and 512 are accepted, with 256 being the default.
11476
11477
11478 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11479        &*${sha3_<n>:*&<&'string'&>&*}*&
11480 .cindex "SHA3 hash"
11481 .cindex "expansion" "SHA3 hashing"
11482 .cindex "&%sha3%& expansion item"
11483 The &%sha3%& operator computes the SHA3-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 a number is appended, separated by an underbar, it specifies
11488 the output length.  Values of 224, 256, 384 and 512 are accepted;
11489 with 256 being the default.
11490
11491 The &%sha3%& expansion item is only supported if Exim has been
11492 compiled with GnuTLS 3.5.0 or later,
11493 or OpenSSL 1.1.1 or later.
11494 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11495
11496
11497 .vitem &*${stat:*&<&'string'&>&*}*&
11498 .cindex "expansion" "statting a file"
11499 .cindex "file" "extracting characteristics"
11500 .cindex "&%stat%& expansion item"
11501 The string, after expansion, must be a file path. A call to the &[stat()]&
11502 function is made for this path. If &[stat()]& fails, an error occurs and the
11503 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11504 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11505 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11506 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11507 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11508 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11509 can extract individual fields using the &%extract%& expansion item.
11510
11511 The use of the &%stat%& expansion in users' filter files can be locked out by
11512 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11513 systems for files larger than 2GB.
11514
11515 .vitem &*${str2b64:*&<&'string'&>&*}*&
11516 .cindex "&%str2b64%& expansion item"
11517 Now deprecated, a synonym for the &%base64%& expansion operator.
11518
11519
11520
11521 .vitem &*${strlen:*&<&'string'&>&*}*&
11522 .cindex "expansion" "string length"
11523 .cindex "string" "length in expansion"
11524 .cindex "&%strlen%& expansion item"
11525 The item is replaced by the length of the expanded string, expressed as a
11526 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11527 All measurement is done in bytes and is not UTF-8 aware.
11528
11529
11530 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11531 .cindex "&%substr%& expansion item"
11532 .cindex "substring extraction"
11533 .cindex "expansion" "substring expansion"
11534 The &%substr%& operator is a simpler interface to the &%substr%& function that
11535 can be used when the two parameters are fixed numbers (as opposed to strings
11536 that change when expanded). The effect is the same as
11537 .code
11538 ${substr{<start>}{<length>}{<string>}}
11539 .endd
11540 See the description of the general &%substr%& item above for details. The
11541 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11542 All measurement is done in bytes and is not UTF-8 aware.
11543
11544 .vitem &*${time_eval:*&<&'string'&>&*}*&
11545 .cindex "&%time_eval%& expansion item"
11546 .cindex "time interval" "decoding"
11547 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11548 seconds.
11549
11550 .vitem &*${time_interval:*&<&'string'&>&*}*&
11551 .cindex "&%time_interval%& expansion item"
11552 .cindex "time interval" "formatting"
11553 The argument (after sub-expansion) must be a sequence of decimal digits that
11554 represents an interval of time as a number of seconds. It is converted into a
11555 number of larger units and output in Exim's normal time format, for example,
11556 &`1w3d4h2m6s`&.
11557
11558 .vitem &*${uc:*&<&'string'&>&*}*&
11559 .cindex "case forcing in strings"
11560 .cindex "string" "case forcing"
11561 .cindex "upper casing"
11562 .cindex "expansion" "case forcing"
11563 .cindex "&%uc%& expansion item"
11564 This forces the letters in the string into upper-case.
11565 Case is defined per the system C locale.
11566
11567 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11568 .cindex "correction of invalid utf-8 sequences in strings"
11569 .cindex "utf-8" "utf-8 sequences"
11570 .cindex "incorrect utf-8"
11571 .cindex "expansion" "utf-8 forcing"
11572 .cindex "&%utf8clean%& expansion item"
11573 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11574 In versions of Exim before 4.92, this did not correctly do so for a truncated
11575 final codepoint's encoding, and the character would be silently dropped.
11576 If you must handle detection of this scenario across both sets of Exim behavior,
11577 the complexity will depend upon the task.
11578 For instance, to detect if the first character is multibyte and a 1-byte
11579 extraction can be successfully used as a path component (as is common for
11580 dividing up delivery folders), you might use:
11581 .code
11582 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11583 .endd
11584 (which will false-positive if the first character of the local part is a
11585 literal question mark).
11586
11587 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11588        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11589        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11590        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11591 .cindex expansion UTF-8
11592 .cindex UTF-8 expansion
11593 .cindex EAI
11594 .cindex internationalisation
11595 .cindex "&%utf8_domain_to_alabel%& expansion item"
11596 .cindex "&%utf8_domain_from_alabel%& expansion item"
11597 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11598 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11599 These convert EAI mail name components between UTF-8 and a-label forms.
11600 For information on internationalisation support see &<<SECTi18nMTA>>&.
11601
11602
11603 .vitem &*${xtextd:*&<&'string'&>&*}*&
11604 .cindex "text forcing in strings"
11605 .cindex "string" "xtext decoding"
11606 .cindex "xtext"
11607 .cindex "&%xtextd%& expansion item"
11608 This performs xtext decoding of the string (per RFC 3461 section 4).
11609
11610
11611
11612 .endlist
11613
11614
11615
11616
11617
11618
11619 .section "Expansion conditions" "SECTexpcond"
11620 .scindex IIDexpcond "expansion" "conditions"
11621 The following conditions are available for testing by the &%${if%& construct
11622 while expanding strings:
11623
11624 .vlist
11625 .vitem &*!*&<&'condition'&>
11626 .cindex "expansion" "negating a condition"
11627 .cindex "negation" "in expansion condition"
11628 Preceding any condition with an exclamation mark negates the result of the
11629 condition.
11630
11631 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11632 .cindex "numeric comparison"
11633 .cindex "expansion" "numeric comparison"
11634 There are a number of symbolic operators for doing numeric comparisons. They
11635 are:
11636 .itable none 0 0 2 10* left 90* left
11637 .irow "=   " "equal"
11638 .irow "==  " "equal"
11639 .irow ">   " "greater"
11640 .irow ">=  " "greater or equal"
11641 .irow "<   " "less"
11642 .irow "<=  " "less or equal"
11643 .endtable
11644 For example:
11645 .code
11646 ${if >{$message_size}{10M} ...
11647 .endd
11648 Note that the general negation operator provides for inequality testing. The
11649 two strings must take the form of optionally signed decimal integers,
11650 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11651 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11652 As a special case, the numerical value of an empty string is taken as
11653 zero.
11654
11655 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11656 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11657 10M, not if 10M is larger than &$message_size$&.
11658
11659
11660 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11661         {*&<&'arg2'&>&*}...}*&
11662 .cindex "expansion" "calling an acl"
11663 .cindex "&%acl%&" "expansion condition"
11664 The name and zero to nine argument strings are first expanded separately.  The expanded
11665 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11666 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11667 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11668 and may use the variables; if another acl expansion is used the values
11669 are restored after it returns.  If the ACL sets
11670 a value using a "message =" modifier the variable $value becomes
11671 the result of the expansion, otherwise it is empty.
11672 If the ACL returns accept the condition is true; if deny, false.
11673 If the ACL returns defer the result is a forced-fail.
11674
11675 .vitem &*bool&~{*&<&'string'&>&*}*&
11676 .cindex "expansion" "boolean parsing"
11677 .cindex "&%bool%& expansion condition"
11678 This condition turns a string holding a true or false representation into
11679 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11680 (case-insensitively); also integer numbers map to true if non-zero,
11681 false if zero.
11682 An empty string is treated as false.
11683 Leading and trailing whitespace is ignored;
11684 thus a string consisting only of whitespace is false.
11685 All other string values will result in expansion failure.
11686
11687 When combined with ACL variables, this expansion condition will let you
11688 make decisions in one place and act on those decisions in another place.
11689 For example:
11690 .code
11691 ${if bool{$acl_m_privileged_sender} ...
11692 .endd
11693
11694
11695 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11696 .cindex "expansion" "boolean parsing"
11697 .cindex "&%bool_lax%& expansion condition"
11698 Like &%bool%&, this condition turns a string into a boolean state.  But
11699 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11700 loose definition that the Router &%condition%& option uses.  The empty string
11701 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11702 true.  Leading and trailing whitespace is ignored.
11703
11704 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11705
11706 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11707 .cindex "expansion" "encrypted comparison"
11708 .cindex "encrypted strings, comparing"
11709 .cindex "&%crypteq%& expansion condition"
11710 This condition is included in the Exim binary if it is built to support any
11711 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11712 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11713 included in the binary.
11714
11715 The &%crypteq%& condition has two arguments. The first is encrypted and
11716 compared against the second, which is already encrypted. The second string may
11717 be in the LDAP form for storing encrypted strings, which starts with the
11718 encryption type in curly brackets, followed by the data. If the second string
11719 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11720 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11721 Typically this will be a field from a password file. An example of an encrypted
11722 string in LDAP form is:
11723 .code
11724 {md5}CY9rzUYh03PK3k6DJie09g==
11725 .endd
11726 If such a string appears directly in an expansion, the curly brackets have to
11727 be quoted, because they are part of the expansion syntax. For example:
11728 .code
11729 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11730 .endd
11731 The following encryption types (whose names are matched case-independently) are
11732 supported:
11733
11734 .ilist
11735 .cindex "MD5 hash"
11736 .cindex "base64 encoding" "in encrypted password"
11737 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11738 printable characters to compare with the remainder of the second string. If the
11739 length of the comparison string is 24, Exim assumes that it is base64 encoded
11740 (as in the above example). If the length is 32, Exim assumes that it is a
11741 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11742 comparison fails.
11743
11744 .next
11745 .cindex "SHA-1 hash"
11746 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11747 printable characters to compare with the remainder of the second string. If the
11748 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11749 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11750 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11751
11752 .next
11753 .cindex "&[crypt()]&"
11754 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11755 only the first eight characters of the password. However, in modern operating
11756 systems this is no longer true, and in many cases the entire password is used,
11757 whatever its length.
11758
11759 .next
11760 .cindex "&[crypt16()]&"
11761 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11762 use up to 16 characters of the password in some operating systems. Again, in
11763 modern operating systems, more characters may be used.
11764 .endlist
11765 Exim has its own version of &[crypt16()]&, which is just a double call to
11766 &[crypt()]&. For operating systems that have their own version, setting
11767 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11768 operating system version instead of its own. This option is set by default in
11769 the OS-dependent &_Makefile_& for those operating systems that are known to
11770 support &[crypt16()]&.
11771
11772 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11773 it was not using the same algorithm as some operating systems' versions. It
11774 turns out that as well as &[crypt16()]& there is a function called
11775 &[bigcrypt()]& in some operating systems. This may or may not use the same
11776 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11777
11778 However, since there is now a move away from the traditional &[crypt()]&
11779 functions towards using SHA1 and other algorithms, tidying up this area of
11780 Exim is seen as very low priority.
11781
11782 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11783 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11784 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11785 default is &`{crypt}`&. Whatever the default, you can always use either
11786 function by specifying it explicitly in curly brackets.
11787
11788 .vitem &*def:*&<&'variable&~name'&>
11789 .cindex "expansion" "checking for empty variable"
11790 .cindex "&%def%& expansion condition"
11791 The &%def%& condition must be followed by the name of one of the expansion
11792 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11793 variable does not contain the empty string. For example:
11794 .code
11795 ${if def:sender_ident {from $sender_ident}}
11796 .endd
11797 Note that the variable name is given without a leading &%$%& character. If the
11798 variable does not exist, the expansion fails.
11799
11800 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11801         &~&*def:h_*&<&'header&~name'&>&*:*&"
11802 .cindex "expansion" "checking header line existence"
11803 This condition is true if a message is being processed and the named header
11804 exists in the message. For example,
11805 .code
11806 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11807 .endd
11808 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11809 the header name must be terminated by a colon if white space does not follow.
11810
11811 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11812        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11813 .cindex "string" "comparison"
11814 .cindex "expansion" "string comparison"
11815 .cindex "&%eq%& expansion condition"
11816 .cindex "&%eqi%& expansion condition"
11817 The two substrings are first expanded. The condition is true if the two
11818 resulting strings are identical. For &%eq%& the comparison includes the case of
11819 letters, whereas for &%eqi%& the comparison is case-independent, where
11820 case is defined per the system C locale.
11821
11822 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11823 .cindex "expansion" "file existence test"
11824 .cindex "file" "existence test"
11825 .cindex "&%exists%&, expansion condition"
11826 The substring is first expanded and then interpreted as an absolute path. The
11827 condition is true if the named file (or directory) exists. The existence test
11828 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11829 users' filter files may be locked out by the system administrator.
11830
11831 &*Note:*& Testing a path using this condition is not a sufficient way of
11832 de-tainting it.
11833 Consider using a dsearch lookup.
11834
11835 .vitem &*first_delivery*&
11836 .cindex "delivery" "first"
11837 .cindex "first delivery"
11838 .cindex "expansion" "first delivery test"
11839 .cindex "&%first_delivery%& expansion condition"
11840 .cindex retry condition
11841 This condition, which has no data, is true during a message's first delivery
11842 attempt. It is false during any subsequent delivery attempts.
11843
11844
11845 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11846        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11847 .cindex "list" "iterative conditions"
11848 .cindex "expansion" "&*forall*& condition"
11849 .cindex "expansion" "&*forany*& condition"
11850 .vindex "&$item$&"
11851 These conditions iterate over a list. The first argument is expanded to form
11852 the list. By default, the list separator is a colon, but it can be changed by
11853 the normal method (&<<SECTlistsepchange>>&).
11854 The second argument is interpreted as a condition that is to
11855 be applied to each item in the list in turn. During the interpretation of the
11856 condition, the current list item is placed in a variable called &$item$&.
11857 .ilist
11858 For &*forany*&, interpretation stops if the condition is true for any item, and
11859 the result of the whole condition is true. If the condition is false for all
11860 items in the list, the overall condition is false.
11861 .next
11862 For &*forall*&, interpretation stops if the condition is false for any item,
11863 and the result of the whole condition is false. If the condition is true for
11864 all items in the list, the overall condition is true.
11865 .endlist
11866 Note that negation of &*forany*& means that the condition must be false for all
11867 items for the overall condition to succeed, and negation of &*forall*& means
11868 that the condition must be false for at least one item.
11869
11870 Example:
11871 .code
11872 ${if forany{$recipients_list}{match{$item}{^user3@}}{yes}{no}}
11873 .endd
11874 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11875 being processed, to enable these expansion items to be nested.
11876
11877 To scan a named list, expand it with the &*listnamed*& operator.
11878
11879 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11880        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11881        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11882        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11883 .cindex JSON "iterative conditions"
11884 .cindex JSON expansions
11885 .cindex expansion "&*forall_json*& condition"
11886 .cindex expansion "&*forany_json*& condition"
11887 .cindex expansion "&*forall_jsons*& condition"
11888 .cindex expansion "&*forany_jsons*& condition"
11889 As for the above, except that the first argument must, after expansion,
11890 be a JSON array.
11891 The array separator is not changeable.
11892 For the &"jsons"& variants the elements are expected to be JSON strings
11893 and have their quotes removed before the evaluation of the condition.
11894
11895
11896
11897 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11898        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11899 .cindex "string" "comparison"
11900 .cindex "expansion" "string comparison"
11901 .cindex "&%ge%& expansion condition"
11902 .cindex "&%gei%& expansion condition"
11903 The two substrings are first expanded. The condition is true if the first
11904 string is lexically greater than or equal to the second string. For &%ge%& the
11905 comparison includes the case of letters, whereas for &%gei%& the comparison is
11906 case-independent.
11907 Case and collation order are defined per the system C locale.
11908
11909 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11910        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11911 .cindex "string" "comparison"
11912 .cindex "expansion" "string comparison"
11913 .cindex "&%gt%& expansion condition"
11914 .cindex "&%gti%& expansion condition"
11915 The two substrings are first expanded. The condition is true if the first
11916 string is lexically greater than the second string. For &%gt%& the comparison
11917 includes the case of letters, whereas for &%gti%& the comparison is
11918 case-independent.
11919 Case and collation order are defined per the system C locale.
11920
11921
11922 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11923 SRS decode.  See SECT &<<SECTSRS>>& for details.
11924
11925
11926 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11927        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11928 .cindex "string" "comparison"
11929 .cindex "list" "iterative conditions"
11930 Both strings are expanded; the second string is treated as a list of simple
11931 strings; if the first string is a member of the second, then the condition
11932 is true.
11933 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11934
11935 These are simpler to use versions of the more powerful &*forany*& condition.
11936 Examples, and the &*forany*& equivalents:
11937 .code
11938 ${if inlist{needle}{foo:needle:bar}}
11939   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11940 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11941   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11942 .endd
11943
11944 The variable &$value$& will be set for a successful match and can be
11945 used in the success clause of an &%if%& expansion item using the condition.
11946 .cindex "tainted data" "de-tainting"
11947 .cindex "de-tainting" "using an inlist expansion condition"
11948 It will have the same taint status as the list; expansions such as
11949 .code
11950 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11951 .endd
11952 can be used for de-tainting.
11953 Any previous &$value$& is restored after the if.
11954
11955
11956 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11957        &*isip4&~{*&<&'string'&>&*}*& &&&
11958        &*isip6&~{*&<&'string'&>&*}*&
11959 .cindex "IP address" "testing string format"
11960 .cindex "string" "testing for IP address"
11961 .cindex "&%isip%& expansion condition"
11962 .cindex "&%isip4%& expansion condition"
11963 .cindex "&%isip6%& expansion condition"
11964 The substring is first expanded, and then tested to see if it has the form of
11965 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11966 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11967
11968 For an IPv4 address, the test is for four dot-separated components, each of
11969 which consists of from one to three digits. For an IPv6 address, up to eight
11970 colon-separated components are permitted, each containing from one to four
11971 hexadecimal digits. There may be fewer than eight components if an empty
11972 component (adjacent colons) is present. Only one empty component is permitted.
11973
11974 &*Note*&: The checks used to be just on the form of the address; actual numerical
11975 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11976 check.
11977 This is no longer the case.
11978
11979 The main use of these tests is to distinguish between IP addresses and
11980 host names, or between IPv4 and IPv6 addresses. For example, you could use
11981 .code
11982 ${if isip4{$sender_host_address}...
11983 .endd
11984 to test which IP version an incoming SMTP connection is using.
11985
11986 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11987 .cindex "LDAP" "use for authentication"
11988 .cindex "expansion" "LDAP authentication test"
11989 .cindex "&%ldapauth%& expansion condition"
11990 This condition supports user authentication using LDAP. See section
11991 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11992 queries. For this use, the query must contain a user name and password. The
11993 query itself is not used, and can be empty. The condition is true if the
11994 password is not empty, and the user name and password are accepted by the LDAP
11995 server. An empty password is rejected without calling LDAP because LDAP binds
11996 with an empty password are considered anonymous regardless of the username, and
11997 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11998 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11999 this can be used.
12000
12001
12002 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
12003        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12004 .cindex "string" "comparison"
12005 .cindex "expansion" "string comparison"
12006 .cindex "&%le%& expansion condition"
12007 .cindex "&%lei%& expansion condition"
12008 The two substrings are first expanded. The condition is true if the first
12009 string is lexically less than or equal to the second string. For &%le%& the
12010 comparison includes the case of letters, whereas for &%lei%& the comparison is
12011 case-independent.
12012 Case and collation order are defined per the system C locale.
12013
12014 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
12015        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12016 .cindex "string" "comparison"
12017 .cindex "expansion" "string comparison"
12018 .cindex "&%lt%& expansion condition"
12019 .cindex "&%lti%& expansion condition"
12020 The two substrings are first expanded. The condition is true if the first
12021 string is lexically less than the second string. For &%lt%& the comparison
12022 includes the case of letters, whereas for &%lti%& the comparison is
12023 case-independent.
12024 Case and collation order are defined per the system C locale.
12025
12026
12027 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12028 .cindex "expansion" "regular expression comparison"
12029 .cindex "regular expressions" "match in expanded string"
12030 .cindex "&%match%& expansion condition"
12031 The two substrings are first expanded. The second is then treated as a regular
12032 expression and applied to the first. Because of the pre-expansion, if the
12033 regular expression contains dollar, or backslash characters, they must be
12034 escaped. Care must also be taken if the regular expression contains braces
12035 (curly brackets). A closing brace must be escaped so that it is not taken as a
12036 premature termination of <&'string2'&>. The easiest approach is to use the
12037 &`\N`& feature to disable expansion of the regular expression.
12038 For example,
12039 .code
12040 ${if match {$local_part}{\N^\d{3}\N} ...
12041 .endd
12042 If the whole expansion string is in double quotes, further escaping of
12043 backslashes is also required.
12044
12045 The condition is true if the regular expression match succeeds.
12046 The regular expression is not required to begin with a circumflex
12047 metacharacter, but if there is no circumflex, the expression is not anchored,
12048 and it may match anywhere in the subject, not just at the start. If you want
12049 the pattern to match at the end of the subject, you must include the &`$`&
12050 metacharacter at an appropriate point.
12051 All character handling is done in bytes and is not UTF-8 aware,
12052 but we might change this in a future Exim release.
12053
12054 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
12055 At the start of an &%if%& expansion the values of the numeric variable
12056 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
12057 succeeds causes them to be reset to the substrings of that condition and they
12058 will have these values during the expansion of the success string. At the end
12059 of the &%if%& expansion, the previous values are restored. After testing a
12060 combination of conditions using &%or%&, the subsequent values of the numeric
12061 variables are those of the condition that succeeded.
12062
12063 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12064 .cindex "&%match_address%& expansion condition"
12065 See &*match_local_part*&.
12066
12067 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12068 .cindex "&%match_domain%& expansion condition"
12069 See &*match_local_part*&.
12070
12071 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12072 .cindex "&%match_ip%& expansion condition"
12073 This condition matches an IP address to a list of IP address patterns. It must
12074 be followed by two argument strings. The first (after expansion) must be an IP
12075 address or an empty string. The second (not expanded) is a restricted host
12076 list that can match only an IP address, not a host name. For example:
12077 .code
12078 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12079 .endd
12080 The specific types of host list item that are permitted in the list are:
12081
12082 .ilist
12083 An IP address, optionally with a CIDR mask.
12084 .next
12085 A single asterisk, which matches any IP address.
12086 .next
12087 An empty item, which matches only if the IP address is empty. This could be
12088 useful for testing for a locally submitted message or one from specific hosts
12089 in a single test such as
12090 . ==== As this is a nested list, any displays it contains must be indented
12091 . ==== as otherwise they are too far to the left. This comment applies to
12092 . ==== the use of xmlto plus fop. There's no problem when formatting with
12093 . ==== sdop, with or without the extra indent.
12094 .code
12095   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12096 .endd
12097 where the first item in the list is the empty string.
12098 .next
12099 The item @[] matches any of the local host's interface addresses.
12100 .next
12101 Single-key lookups are assumed to be like &"net-"& style lookups in host lists
12102 (see section &<<SECThoslispatsikey>>&),
12103 even if &`net-`& is not specified. There is never any attempt to turn the IP
12104 address into a host name. The most common type of linear search for
12105 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12106 masks. For example:
12107 .code
12108   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12109 .endd
12110 It is of course possible to use other kinds of lookup, and in such a case, you
12111 do need to specify the &`net-`& prefix if you want to specify a specific
12112 address mask, for example:
12113 .code
12114   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12115 .endd
12116 However, unless you are combining a &%match_ip%& condition with others, it is
12117 just as easy to use the fact that a lookup is itself a condition, and write:
12118 .code
12119   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12120 .endd
12121 .endlist ilist
12122
12123 Note that <&'string2'&> is not itself subject to string expansion, unless
12124 Exim was built with the EXPAND_LISTMATCH_RHS option.
12125
12126 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12127
12128 The variable &$value$& will be set for a successful match and can be
12129 used in the success clause of an &%if%& expansion item using the condition.
12130 Any previous &$value$& is restored after the if.
12131
12132 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12133 .cindex "domain list" "in expansion condition"
12134 .cindex "address list" "in expansion condition"
12135 .cindex "local part" "list, in expansion condition"
12136 .cindex "&%match_local_part%& expansion condition"
12137 This condition, together with &%match_address%& and &%match_domain%&, make it
12138 possible to test domain, address, and local part lists within expansions. Each
12139 condition requires two arguments: an item and a list to match. A trivial
12140 example is:
12141 .code
12142 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12143 .endd
12144 In each case, the second argument may contain any of the allowable items for a
12145 list of the appropriate type. Also, because the second argument
12146 is a standard form of list, it is possible to refer to a named list.
12147 Thus, you can use conditions like this:
12148 .code
12149 ${if match_domain{$domain}{+local_domains}{...
12150 .endd
12151 .cindex "&`+caseful`&"
12152 For address lists, the matching starts off caselessly, but the &`+caseful`&
12153 item can be used, as in all address lists, to cause subsequent items to
12154 have their local parts matched casefully. Domains are always matched
12155 caselessly.
12156
12157 The variable &$value$& will be set for a successful match and can be
12158 used in the success clause of an &%if%& expansion item using the condition.
12159 .cindex "tainted data" "de-tainting"
12160 .cindex "de-tainting" "using a match_local_part expansion condition"
12161 It will have the same taint status as the list; expansions such as
12162 .code
12163 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12164 .endd
12165 can be used for de-tainting.
12166 Any previous &$value$& is restored after the if.
12167
12168 Note that <&'string2'&> is not itself subject to string expansion, unless
12169 Exim was built with the EXPAND_LISTMATCH_RHS option.
12170
12171 &*Note*&: Host lists are &'not'& supported in this way. This is because
12172 hosts have two identities: a name and an IP address, and it is not clear
12173 how to specify cleanly how such a test would work. However, IP addresses can be
12174 matched using &%match_ip%&.
12175
12176 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12177 .cindex "PAM authentication"
12178 .cindex "AUTH" "with PAM"
12179 .cindex "Solaris" "PAM support"
12180 .cindex "expansion" "PAM authentication test"
12181 .cindex "&%pam%& expansion condition"
12182 &'Pluggable Authentication Modules'&
12183 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12184 available in Solaris
12185 and in some GNU/Linux distributions.
12186 The Exim support, which is intended for use in conjunction with
12187 the SMTP AUTH command, is available only if Exim is compiled with
12188 .code
12189 SUPPORT_PAM=yes
12190 .endd
12191 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12192 in some releases of GNU/Linux &%-ldl%& is also needed.
12193
12194 The argument string is first expanded, and the result must be a
12195 colon-separated list of strings. Leading and trailing white space is ignored.
12196 The PAM module is initialized with the service name &"exim"& and the user name
12197 taken from the first item in the colon-separated data string (<&'string1'&>).
12198 The remaining items in the data string are passed over in response to requests
12199 from the authentication function. In the simple case there will only be one
12200 request, for a password, so the data consists of just two strings.
12201
12202 There can be problems if any of the strings are permitted to contain colon
12203 characters. In the usual way, these have to be doubled to avoid being taken as
12204 separators.
12205 The &%listquote%& expansion item can be used for this.
12206 For example, the configuration
12207 of a LOGIN authenticator might contain this setting:
12208 .code
12209 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12210 .endd
12211 In some operating systems, PAM authentication can be done only from a process
12212 running as root. Since Exim is running as the Exim user when receiving
12213 messages, this means that PAM cannot be used directly in those systems.
12214 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12215
12216
12217 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12218 .cindex "&'pwcheck'& daemon"
12219 .cindex "Cyrus"
12220 .cindex "expansion" "&'pwcheck'& authentication test"
12221 .cindex "&%pwcheck%& expansion condition"
12222 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12223 This is one way of making it possible for passwords to be checked by a process
12224 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12225 deprecated. Its replacement is &'saslauthd'& (see below).
12226
12227 The pwcheck support is not included in Exim by default. You need to specify
12228 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12229 building Exim. For example:
12230 .code
12231 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12232 .endd
12233 You do not need to install the full Cyrus software suite in order to use
12234 the pwcheck daemon. You can compile and install just the daemon alone
12235 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12236 access to the &_/var/pwcheck_& directory.
12237
12238 The &%pwcheck%& condition takes one argument, which must be the user name and
12239 password, separated by a colon. For example, in a LOGIN authenticator
12240 configuration, you might have this:
12241 .code
12242 server_condition = ${if pwcheck{$auth1:$auth2}}
12243 .endd
12244 Again, for a PLAIN authenticator configuration, this would be:
12245 .code
12246 server_condition = ${if pwcheck{$auth2:$auth3}}
12247 .endd
12248 .vitem &*queue_running*&
12249 .cindex "queue runner" "detecting when delivering from"
12250 .cindex "expansion" "queue runner test"
12251 .cindex "&%queue_running%& expansion condition"
12252 This condition, which has no data, is true during delivery attempts that are
12253 initiated by queue runner processes, and false otherwise.
12254
12255
12256 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12257 .cindex "Radius"
12258 .cindex "expansion" "Radius authentication"
12259 .cindex "&%radius%& expansion condition"
12260 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12261 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12262 the Radius client configuration file in order to build Exim with Radius
12263 support.
12264
12265 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12266 library, using the original API. If you are using release 0.4.0 or later of
12267 this library, you need to set
12268 .code
12269 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12270 .endd
12271 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12272 &%libradius%& library that comes with FreeBSD. To do this, set
12273 .code
12274 RADIUS_LIB_TYPE=RADLIB
12275 .endd
12276 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12277 You may also have to supply a suitable setting in EXTRALIBS so that the
12278 Radius library can be found when Exim is linked.
12279
12280 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12281 Radius client library, which calls the Radius server. The condition is true if
12282 the authentication is successful. For example:
12283 .code
12284 server_condition = ${if radius{<arguments>}}
12285 .endd
12286
12287
12288 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12289         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12290 .cindex "&'saslauthd'& daemon"
12291 .cindex "Cyrus"
12292 .cindex "expansion" "&'saslauthd'& authentication test"
12293 .cindex "&%saslauthd%& expansion condition"
12294 This condition supports user authentication using the Cyrus &'saslauthd'&
12295 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12296 Using this daemon is one way of making it possible for passwords to be checked
12297 by a process that is not running as root.
12298
12299 The saslauthd support is not included in Exim by default. You need to specify
12300 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12301 building Exim. For example:
12302 .code
12303 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12304 .endd
12305 You do not need to install the full Cyrus software suite in order to use
12306 the saslauthd daemon. You can compile and install just the daemon alone
12307 from the Cyrus SASL library.
12308
12309 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12310 two are mandatory. For example:
12311 .code
12312 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12313 .endd
12314 The service and the realm are optional (which is why the arguments are enclosed
12315 in their own set of braces). For details of the meaning of the service and
12316 realm, and how to run the daemon, consult the Cyrus documentation.
12317 .endlist vlist
12318
12319
12320
12321 .section "Combining expansion conditions" "SECID84"
12322 .cindex "expansion" "combining conditions"
12323 Several conditions can be tested at once by combining them using the &%and%&
12324 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12325 conditions on their own, and precede their lists of sub-conditions. Each
12326 sub-condition must be enclosed in braces within the overall braces that contain
12327 the list. No repetition of &%if%& is used.
12328
12329
12330 .vlist
12331 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12332 .cindex "&""or""& expansion condition"
12333 .cindex "expansion" "&""or""& of conditions"
12334 The sub-conditions are evaluated from left to right. The condition is true if
12335 any one of the sub-conditions is true.
12336 For example,
12337 .code
12338 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12339 .endd
12340 When a true sub-condition is found, the following ones are parsed but not
12341 evaluated. If there are several &"match"& sub-conditions the values of the
12342 numeric variables afterwards are taken from the first one that succeeds.
12343
12344 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12345 .cindex "&""and""& expansion condition"
12346 .cindex "expansion" "&""and""& of conditions"
12347 The sub-conditions are evaluated from left to right. The condition is true if
12348 all of the sub-conditions are true. If there are several &"match"&
12349 sub-conditions, the values of the numeric variables afterwards are taken from
12350 the last one. When a false sub-condition is found, the following ones are
12351 parsed but not evaluated.
12352 .endlist
12353 .ecindex IIDexpcond
12354
12355
12356
12357
12358 .section "Expansion variables" "SECTexpvar"
12359 .cindex "expansion" "variables, list of"
12360 This section contains an alphabetical list of all the expansion variables. Some
12361 of them are available only when Exim is compiled with specific options such as
12362 support for TLS or the content scanning extension.
12363 .cindex "tainted data"
12364 Variables marked as &'tainted'& are likely to carry data supplied by
12365 a potential attacker.
12366 Variables without such marking may also, depending on how their
12367 values are created.
12368 Such variables should not be further expanded,
12369 used as filenames
12370 or used as command-line arguments for external commands.
12371
12372 .vlist
12373 .vitem "&$0$&, &$1$&, etc"
12374 .cindex "numerical variables (&$1$& &$2$& etc)"
12375 When a &%match%& expansion condition succeeds, these variables contain the
12376 captured substrings identified by the regular expression during subsequent
12377 processing of the success string of the containing &%if%& expansion item.
12378 In the expansion condition case
12379 they do not retain their values afterwards; in fact, their previous
12380 values are restored at the end of processing an &%if%& item. The numerical
12381 variables may also be set externally by some other matching process which
12382 precedes the expansion of the string. For example, the commands available in
12383 Exim filter files include an &%if%& command with its own regular expression
12384 matching condition.
12385 If the subject string was tainted then any captured substring will also be.
12386
12387 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12388 Within an acl condition, expansion condition or expansion item
12389 any arguments are copied to these variables,
12390 any unused variables being made empty.
12391
12392 .vitem "&$acl_c...$&"
12393 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12394 can be given any name that starts with &$acl_c$& and is at least six characters
12395 long, but the sixth character must be either a digit or an underscore. For
12396 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12397 variables persist throughout the lifetime of an SMTP connection. They can be
12398 used to pass information between ACLs and between different invocations of the
12399 same ACL. When a message is received, the values of these variables are saved
12400 with the message, and can be accessed by filters, routers, and transports
12401 during subsequent delivery.
12402
12403 .vitem "&$acl_m...$&"
12404 These variables are like the &$acl_c...$& variables, except that their values
12405 are reset after a message has been received. Thus, if several messages are
12406 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12407 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12408 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12409 message is received, the values of these variables are saved with the message,
12410 and can be accessed by filters, routers, and transports during subsequent
12411 delivery.
12412
12413 .vitem &$acl_narg$&
12414 Within an acl condition, expansion condition or expansion item
12415 this variable has the number of arguments.
12416
12417 .vitem &$acl_verify_message$&
12418 .vindex "&$acl_verify_message$&"
12419 After an address verification has failed, this variable contains the failure
12420 message. It retains its value for use in subsequent modifiers of the verb.
12421 The message can be preserved by coding like this:
12422 .code
12423 warn !verify = sender
12424      set acl_m0 = $acl_verify_message
12425 .endd
12426 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12427 &%log_message%& modifiers, to include information about the verification
12428 failure.
12429 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12430
12431 .vitem &$address_data$&
12432 .vindex "&$address_data$&"
12433 This variable is set by means of the &%address_data%& option in routers. The
12434 value then remains with the address while it is processed by subsequent routers
12435 and eventually a transport. If the transport is handling multiple addresses,
12436 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12437 for more details. &*Note*&: The contents of &$address_data$& are visible in
12438 user filter files.
12439
12440 If &$address_data$& is set when the routers are called from an ACL to verify
12441 a recipient address, the final value is still in the variable for subsequent
12442 conditions and modifiers of the ACL statement. If routing the address caused it
12443 to be redirected to just one address, the child address is also routed as part
12444 of the verification, and in this case the final value of &$address_data$& is
12445 from the child's routing.
12446
12447 If &$address_data$& is set when the routers are called from an ACL to verify a
12448 sender address, the final value is also preserved, but this time in
12449 &$sender_address_data$&, to distinguish it from data from a recipient
12450 address.
12451
12452 In both cases (recipient and sender verification), the value does not persist
12453 after the end of the current ACL statement. If you want to preserve
12454 these values for longer, you can save them in ACL variables.
12455
12456 .vitem &$address_file$&
12457 .vindex "&$address_file$&"
12458 When, as a result of aliasing, forwarding, or filtering, a message is directed
12459 to a specific file, this variable holds the name of the file when the transport
12460 is running. At other times, the variable is empty. For example, using the
12461 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12462 .code
12463 /home/r2d2/savemail
12464 .endd
12465 then when the &(address_file)& transport is running, &$address_file$&
12466 contains the text string &`/home/r2d2/savemail`&.
12467 .cindex "Sieve filter" "value of &$address_file$&"
12468 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12469 then up to the transport configuration to generate an appropriate absolute path
12470 to the relevant file.
12471
12472 .vitem &$address_pipe$&
12473 .vindex "&$address_pipe$&"
12474 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12475 this variable holds the pipe command when the transport is running.
12476
12477 .vitem "&$auth1$& &-- &$auth4$&"
12478 .vindex "&$auth1$&, &$auth2$&, etc"
12479 These variables are used in SMTP authenticators (see chapters
12480 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12481
12482 .vitem &$authenticated_id$&
12483 .cindex "authentication" "id"
12484 .vindex "&$authenticated_id$&"
12485 When a server successfully authenticates a client it may be configured to
12486 preserve some of the authentication information in the variable
12487 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12488 user/password authenticator configuration might preserve the user name for use
12489 in the routers. Note that this is not the same information that is saved in
12490 &$sender_host_authenticated$&.
12491
12492 When a message is submitted locally (that is, not over a TCP connection)
12493 the value of &$authenticated_id$& is normally the login name of the calling
12494 process. However, a trusted user can override this by means of the &%-oMai%&
12495 command line option.
12496 This second case also sets up information used by the
12497 &$authresults$& expansion item.
12498
12499 .vitem &$authenticated_fail_id$&
12500 .cindex "authentication" "fail" "id"
12501 .vindex "&$authenticated_fail_id$&"
12502 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12503 will contain the failed authentication id. If more than one authentication
12504 id is attempted, it will contain only the last one. The variable is
12505 available for processing in the ACL's, generally the quit or notquit ACL.
12506 A message to a local recipient could still be accepted without requiring
12507 authentication, which means this variable could also be visible in all of
12508 the ACL's as well.
12509
12510
12511 .tvar &$authenticated_sender$&
12512 .cindex "sender" "authenticated"
12513 .cindex "authentication" "sender"
12514 .cindex "AUTH" "on MAIL command"
12515 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12516 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12517 described in section &<<SECTauthparamail>>&. Unless the data is the string
12518 &"<>"&, it is set as the authenticated sender of the message, and the value is
12519 available during delivery in the &$authenticated_sender$& variable. If the
12520 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12521
12522 .vindex "&$qualify_domain$&"
12523 When a message is submitted locally (that is, not over a TCP connection), the
12524 value of &$authenticated_sender$& is an address constructed from the login
12525 name of the calling process and &$qualify_domain$&, except that a trusted user
12526 can override this by means of the &%-oMas%& command line option.
12527
12528
12529 .vitem &$authentication_failed$&
12530 .cindex "authentication" "failure"
12531 .vindex "&$authentication_failed$&"
12532 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12533 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12534 possible to distinguish between &"did not try to authenticate"&
12535 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12536 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12537 is empty and &$authentication_failed$& is set to &"1"&).
12538 Failure includes cancellation of a authentication attempt,
12539 and any negative response to an AUTH command,
12540 (including, for example, an attempt to use an undefined mechanism).
12541
12542 .vitem &$av_failed$&
12543 .cindex "content scanning" "AV scanner failure"
12544 This variable is available when Exim is compiled with the content-scanning
12545 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12546 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12547 the ACL malware condition.
12548
12549 .vitem &$body_linecount$&
12550 .cindex "message body" "line count"
12551 .cindex "body of message" "line count"
12552 .vindex "&$body_linecount$&"
12553 When a message is being received or delivered, this variable contains the
12554 number of lines in the message's body. See also &$message_linecount$&.
12555
12556 .vitem &$body_zerocount$&
12557 .cindex "message body" "binary zero count"
12558 .cindex "body of message" "binary zero count"
12559 .cindex "binary zero" "in message body"
12560 .vindex "&$body_zerocount$&"
12561 When a message is being received or delivered, this variable contains the
12562 number of binary zero bytes (ASCII NULs) in the message's body.
12563
12564 .vitem &$bounce_recipient$&
12565 .vindex "&$bounce_recipient$&"
12566 This is set to the recipient address of a bounce message while Exim is creating
12567 it. It is useful if a customized bounce message text file is in use (see
12568 chapter &<<CHAPemsgcust>>&).
12569
12570 .vitem &$bounce_return_size_limit$&
12571 .vindex "&$bounce_return_size_limit$&"
12572 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12573 up to a multiple of 1000. It is useful when a customized error message text
12574 file is in use (see chapter &<<CHAPemsgcust>>&).
12575
12576 .vitem &$caller_gid$&
12577 .cindex "gid (group id)" "caller"
12578 .vindex "&$caller_gid$&"
12579 The real group id under which the process that called Exim was running. This is
12580 not the same as the group id of the originator of a message (see
12581 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12582 incarnation normally contains the Exim gid.
12583
12584 .vitem &$caller_uid$&
12585 .cindex "uid (user id)" "caller"
12586 .vindex "&$caller_uid$&"
12587 The real user id under which the process that called Exim was running. This is
12588 not the same as the user id of the originator of a message (see
12589 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12590 incarnation normally contains the Exim uid.
12591
12592 .vitem &$callout_address$&
12593 .vindex "&$callout_address$&"
12594 After a callout for verification, spamd or malware daemon service, the
12595 address that was connected to.
12596
12597 .vitem &$compile_number$&
12598 .vindex "&$compile_number$&"
12599 The building process for Exim keeps a count of the number
12600 of times it has been compiled. This serves to distinguish different
12601 compilations of the same version of Exim.
12602
12603 .vitem &$config_dir$&
12604 .vindex "&$config_dir$&"
12605 The directory name of the main configuration file. That is, the content of
12606 &$config_file$& with the last component stripped. The value does not
12607 contain the trailing slash. If &$config_file$& does not contain a slash,
12608 &$config_dir$& is ".".
12609
12610 .vitem &$config_file$&
12611 .vindex "&$config_file$&"
12612 The name of the main configuration file Exim is using.
12613
12614 .vitem &$dkim_verify_status$&
12615 Results of DKIM verification.
12616 For details see section &<<SECDKIMVFY>>&.
12617
12618 .vitem &$dkim_cur_signer$& &&&
12619        &$dkim_verify_reason$& &&&
12620        &$dkim_domain$& &&&
12621        &$dkim_identity$& &&&
12622        &$dkim_selector$& &&&
12623        &$dkim_algo$& &&&
12624        &$dkim_canon_body$& &&&
12625        &$dkim_canon_headers$& &&&
12626        &$dkim_copiedheaders$& &&&
12627        &$dkim_bodylength$& &&&
12628        &$dkim_created$& &&&
12629        &$dkim_expires$& &&&
12630        &$dkim_headernames$& &&&
12631        &$dkim_key_testing$& &&&
12632        &$dkim_key_nosubdomains$& &&&
12633        &$dkim_key_srvtype$& &&&
12634        &$dkim_key_granularity$& &&&
12635        &$dkim_key_notes$& &&&
12636        &$dkim_key_length$&
12637 These variables are only available within the DKIM ACL.
12638 For details see section &<<SECDKIMVFY>>&.
12639
12640 .vitem &$dkim_signers$&
12641 .vindex &$dkim_signers$&
12642 When a message has been received this variable contains
12643 a colon-separated list of signer domains and identities for the message.
12644 For details see section &<<SECDKIMVFY>>&.
12645
12646 .vitem &$dmarc_domain_policy$& &&&
12647        &$dmarc_status$& &&&
12648        &$dmarc_status_text$& &&&
12649        &$dmarc_used_domains$&
12650 Results of DMARC verification.
12651 For details see section &<<SECDMARC>>&.
12652
12653 .vitem &$dnslist_domain$& &&&
12654        &$dnslist_matched$& &&&
12655        &$dnslist_text$& &&&
12656        &$dnslist_value$&
12657 .vindex "&$dnslist_domain$&"
12658 .vindex "&$dnslist_matched$&"
12659 .vindex "&$dnslist_text$&"
12660 .vindex "&$dnslist_value$&"
12661 .cindex "black list (DNS)"
12662 When a DNS (black) list lookup succeeds, these variables are set to contain
12663 the following data from the lookup: the list's domain name, the key that was
12664 looked up, the contents of any associated TXT record, and the value from the
12665 main A record. See section &<<SECID204>>& for more details.
12666
12667 .tvar &$domain$&
12668 When an address is being routed, or delivered on its own, this variable
12669 contains the domain. Uppercase letters in the domain are converted into lower
12670 case for &$domain$&.
12671
12672 Global address rewriting happens when a message is received, so the value of
12673 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12674 is set during user filtering, but not during system filtering, because a
12675 message may have many recipients and the system filter is called just once.
12676
12677 When more than one address is being delivered at once (for example, several
12678 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12679 have the same domain. Transports can be restricted to handling only one domain
12680 at a time if the value of &$domain$& is required at transport time &-- this is
12681 the default for local transports. For further details of the environment in
12682 which local transports are run, see chapter &<<CHAPenvironment>>&.
12683
12684 .oindex "&%delay_warning_condition%&"
12685 At the end of a delivery, if all deferred addresses have the same domain, it is
12686 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12687
12688 The &$domain$& variable is also used in some other circumstances:
12689
12690 .ilist
12691 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12692 the recipient address. The domain of the &'sender'& address is in
12693 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12694 normally set during the running of the MAIL ACL. However, if the sender address
12695 is verified with a callout during the MAIL ACL, the sender domain is placed in
12696 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12697 the &(smtp)& transport.
12698
12699 .next
12700 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12701 &$domain$& contains the domain portion of the address that is being rewritten;
12702 it can be used in the expansion of the replacement address, for example, to
12703 rewrite domains by file lookup.
12704
12705 .next
12706 With one important exception, whenever a domain list is being scanned,
12707 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12708 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12709 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12710 that, in a RCPT ACL, the sender domain list can be dependent on the
12711 recipient domain (which is what is in &$domain$& at this time).
12712
12713 .next
12714 .cindex "ETRN" "value of &$domain$&"
12715 .oindex "&%smtp_etrn_command%&"
12716 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12717 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12718 .endlist
12719
12720 .cindex "tainted data"
12721 If the origin of the data is an incoming message,
12722 the result of expanding this variable is tainted and may not
12723 be further expanded or used as a filename.
12724 When an untainted version is needed, one should be obtained from
12725 looking up the value in a local (therefore trusted) database.
12726 Often &$domain_data$& is usable in this role.
12727
12728
12729 .vitem &$domain_data$&
12730 .vindex "&$domain_data$&"
12731 When the &%domains%& condition on a router
12732 or an ACL
12733 matches a domain
12734 against a list, the match value is copied to &$domain_data$&.
12735 This is an enhancement over previous versions of Exim, when it only
12736 applied to the data read by a lookup.
12737 For details on match values see section &<<SECTlistresults>>& et. al.
12738
12739 If the router routes the
12740 address to a transport, the value is available in that transport. If the
12741 transport is handling multiple addresses, the value from the first address is
12742 used.
12743
12744 &$domain_data$& set in an ACL is available during
12745 the rest of the ACL statement.
12746
12747 .vitem &$exim_gid$&
12748 .vindex "&$exim_gid$&"
12749 This variable contains the numerical value of the Exim group id.
12750
12751 .vitem &$exim_path$&
12752 .vindex "&$exim_path$&"
12753 This variable contains the path to the Exim binary.
12754
12755 .vitem &$exim_uid$&
12756 .vindex "&$exim_uid$&"
12757 This variable contains the numerical value of the Exim user id.
12758
12759 .vitem &$exim_version$&
12760 .vindex "&$exim_version$&"
12761 This variable contains the version string of the Exim build.
12762 The first character is a major version number, currently 4.
12763 Then after a dot, the next group of digits is a minor version number.
12764 There may be other characters following the minor version.
12765 This value may be overridden by the &%exim_version%& main config option.
12766
12767 .vitem &$header_$&<&'name'&>
12768 .tmark
12769 This is not strictly an expansion variable. It is expansion syntax for
12770 inserting the message header line with the given name. Note that the name must
12771 be terminated by colon or white space, because it may contain a wide variety of
12772 characters. Note also that braces must &'not'& be used.
12773 See the full description in section &<<SECTexpansionitems>>& above.
12774
12775 .vitem &$headers_added$&
12776 .vindex "&$headers_added$&"
12777 Within an ACL this variable contains the headers added so far by
12778 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12779 The headers are a newline-separated list.
12780
12781 .vitem &$home$&
12782 .vindex "&$home$&"
12783 When the &%check_local_user%& option is set for a router, the user's home
12784 directory is placed in &$home$& when the check succeeds. In particular, this
12785 means it is set during the running of users' filter files. A router may also
12786 explicitly set a home directory for use by a transport; this can be overridden
12787 by a setting on the transport itself.
12788
12789 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12790 of the environment variable HOME, which is subject to the
12791 &%keep_environment%& and &%add_environment%& main config options.
12792
12793 .vitem &$host$&
12794 .vindex "&$host$&"
12795 If a router assigns an address to a transport (any transport), and passes a
12796 list of hosts with the address, the value of &$host$& when the transport starts
12797 to run is the name of the first host on the list. Note that this applies both
12798 to local and remote transports.
12799
12800 .cindex "transport" "filter"
12801 .cindex "filter" "transport filter"
12802 For the &(smtp)& transport, if there is more than one host, the value of
12803 &$host$& changes as the transport works its way through the list. In
12804 particular, when the &(smtp)& transport is expanding its options for encryption
12805 using TLS, or for specifying a transport filter (see chapter
12806 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12807 is connected.
12808
12809 When used in the client part of an authenticator configuration (see chapter
12810 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12811 client is connected.
12812
12813
12814 .vitem &$host_address$&
12815 .vindex "&$host_address$&"
12816 This variable is set to the remote host's IP address whenever &$host$& is set
12817 for a remote connection. It is also set to the IP address that is being checked
12818 when the &%ignore_target_hosts%& option is being processed.
12819
12820 .vitem &$host_data$&
12821 .vindex "&$host_data$&"
12822 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12823 result of the lookup is made available in the &$host_data$& variable. This
12824 allows you, for example, to do things like this:
12825 .code
12826 deny  hosts = net-lsearch;/some/file
12827       message = $host_data
12828 .endd
12829
12830 .vitem &$host_lookup_deferred$&
12831 .cindex "host name" "lookup, failure of"
12832 .vindex "&$host_lookup_deferred$&"
12833 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12834 message comes from a remote host and there is an attempt to look up the host's
12835 name from its IP address, and the attempt is not successful, one of these
12836 variables is set to &"1"&.
12837
12838 .ilist
12839 If the lookup receives a definite negative response (for example, a DNS lookup
12840 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12841
12842 .next
12843 If there is any kind of problem during the lookup, such that Exim cannot
12844 tell whether or not the host name is defined (for example, a timeout for a DNS
12845 lookup), &$host_lookup_deferred$& is set to &"1"&.
12846 .endlist ilist
12847
12848 Looking up a host's name from its IP address consists of more than just a
12849 single reverse lookup. Exim checks that a forward lookup of at least one of the
12850 names it receives from a reverse lookup yields the original IP address. If this
12851 is not the case, Exim does not accept the looked up name(s), and
12852 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12853 IP address (for example, the existence of a PTR record in the DNS) is not
12854 sufficient on its own for the success of a host name lookup. If the reverse
12855 lookup succeeds, but there is a lookup problem such as a timeout when checking
12856 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12857 &"1"&. See also &$sender_host_name$&.
12858
12859 .cindex authentication "expansion item"
12860 Performing these checks sets up information used by the
12861 &%authresults%& expansion item.
12862
12863
12864 .vitem &$host_lookup_failed$&
12865 .vindex "&$host_lookup_failed$&"
12866 See &$host_lookup_deferred$&.
12867
12868 .vitem &$host_port$&
12869 .vindex "&$host_port$&"
12870 This variable is set to the remote host's TCP port whenever &$host$& is set
12871 for an outbound connection.
12872
12873 .vitem &$initial_cwd$&
12874 .vindex "&$initial_cwd$&
12875 This variable contains the full path name of the initial working
12876 directory of the current Exim process. This may differ from the current
12877 working directory, as Exim changes this to "/" during early startup, and
12878 to &$spool_directory$& later.
12879
12880 .vitem &$inode$&
12881 .vindex "&$inode$&"
12882 The only time this variable is set is while expanding the &%directory_file%&
12883 option in the &(appendfile)& transport. The variable contains the inode number
12884 of the temporary file which is about to be renamed. It can be used to construct
12885 a unique name for the file.
12886
12887 .vitem &$interface_address$& &&&
12888        &$interface_port$&
12889 .vindex "&$interface_address$&"
12890 .vindex "&$interface_port$&"
12891 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12892
12893 .vitem &$item$&
12894 .vindex "&$item$&"
12895 This variable is used during the expansion of &*forall*& and &*forany*&
12896 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12897 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12898 empty.
12899
12900 .vitem &$ldap_dn$&
12901 .vindex "&$ldap_dn$&"
12902 This variable, which is available only when Exim is compiled with LDAP support,
12903 contains the DN from the last entry in the most recently successful LDAP
12904 lookup.
12905
12906 .vitem &$load_average$&
12907 .vindex "&$load_average$&"
12908 This variable contains the system load average, multiplied by 1000 so that it
12909 is an integer. For example, if the load average is 0.21, the value of the
12910 variable is 210. The value is recomputed every time the variable is referenced.
12911
12912 .tvar &$local_part$&
12913 When an address is being routed, or delivered on its own, this
12914 variable contains the local part. When a number of addresses are being
12915 delivered together (for example, multiple RCPT commands in an SMTP
12916 session), &$local_part$& is not set.
12917
12918 Global address rewriting happens when a message is received, so the value of
12919 &$local_part$& during routing and delivery is the value after rewriting.
12920 &$local_part$& is set during user filtering, but not during system filtering,
12921 because a message may have many recipients and the system filter is called just
12922 once.
12923
12924 .cindex "tainted data"
12925 If the origin of the data is an incoming message,
12926 the result of expanding this variable is tainted and
12927 may not be further expanded or used as a filename.
12928
12929 &*Warning*&: the content of this variable is usually provided by a potential
12930 attacker.
12931 Consider carefully the implications of using it unvalidated as a name
12932 for file access.
12933 This presents issues for users' &_.forward_& and filter files.
12934 For traditional full user accounts, use &%check_local_users%& and the
12935 &$local_part_data$& variable rather than this one.
12936 For virtual users, store a suitable pathname component in the database
12937 which is used for account name validation, and use that retrieved value
12938 rather than this variable.
12939 Often &$local_part_data$& is usable in this role.
12940 If needed, use a router &%address_data%& or &%set%& option for
12941 the retrieved data.
12942
12943 When a message is being delivered to a file, pipe, or autoreply transport as a
12944 result of aliasing or forwarding, &$local_part$& is set to the local part of
12945 the parent address, not to the filename or command (see &$address_file$& and
12946 &$address_pipe$&).
12947
12948 When an ACL is running for a RCPT command, &$local_part$& contains the
12949 local part of the recipient address.
12950
12951 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12952 &$local_part$& contains the local part of the address that is being rewritten;
12953 it can be used in the expansion of the replacement address, for example.
12954
12955 In all cases, all quoting is removed from the local part. For example, for both
12956 the addresses
12957 .code
12958 "abc:xyz"@test.example
12959 abc\:xyz@test.example
12960 .endd
12961 the value of &$local_part$& is
12962 .code
12963 abc:xyz
12964 .endd
12965 If you use &$local_part$& to create another address, you should always wrap it
12966 inside a quoting operator. For example, in a &(redirect)& router you could
12967 have:
12968 .code
12969 data = ${quote_local_part:$local_part}@new.domain.example
12970 .endd
12971 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12972 to process local parts in a case-dependent manner in a router, you can set the
12973 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12974
12975 .vitem &$local_part_data$&
12976 .vindex "&$local_part_data$&"
12977 When the &%local_parts%& condition on a router or ACL
12978 matches a local part list
12979 the match value is copied to &$local_part_data$&.
12980 This is an enhancement over previous versions of Exim, when it only
12981 applied to the data read by a lookup.
12982 For details on match values see section &<<SECTlistresults>>& et. al.
12983
12984 The &%check_local_user%& router option also sets this variable.
12985
12986 .vindex &$local_part_prefix$& &&&
12987         &$local_part_prefix_v$& &&&
12988         &$local_part_suffix$& &&&
12989         &$local_part_suffix_v$&
12990 .cindex affix variables
12991 If a local part prefix or suffix has been recognized, it is not included in the
12992 value of &$local_part$& during routing and subsequent delivery. The values of
12993 any prefix or suffix are in &$local_part_prefix$& and
12994 &$local_part_suffix$&, respectively.
12995 .cindex "tainted data"
12996 If the specification did not include a wildcard then
12997 the affix variable value is not tainted.
12998
12999 If the affix specification included a wildcard then the portion of
13000 the affix matched by the wildcard is in
13001 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
13002 and both the whole and varying values are tainted.
13003
13004 .vitem &$local_scan_data$&
13005 .vindex "&$local_scan_data$&"
13006 This variable contains the text returned by the &[local_scan()]& function when
13007 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
13008
13009 .vitem &$local_user_gid$&
13010 .vindex "&$local_user_gid$&"
13011 See &$local_user_uid$&.
13012
13013 .vitem &$local_user_uid$&
13014 .vindex "&$local_user_uid$&"
13015 This variable and &$local_user_gid$& are set to the uid and gid after the
13016 &%check_local_user%& router precondition succeeds. This means that their values
13017 are available for the remaining preconditions (&%senders%&, &%require_files%&,
13018 and &%condition%&), for the &%address_data%& expansion, and for any
13019 router-specific expansions. At all other times, the values in these variables
13020 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
13021
13022 .vitem &$localhost_number$&
13023 .vindex "&$localhost_number$&"
13024 This contains the expanded value of the
13025 &%localhost_number%& option. The expansion happens after the main options have
13026 been read.
13027
13028 .vitem &$log_inodes$&
13029 .vindex "&$log_inodes$&"
13030 The number of free inodes in the disk partition where Exim's
13031 log files are being written. The value is recalculated whenever the variable is
13032 referenced. If the relevant file system does not have the concept of inodes,
13033 the value of is -1. See also the &%check_log_inodes%& option.
13034
13035 .vitem &$log_space$&
13036 .vindex "&$log_space$&"
13037 The amount of free space (as a number of kilobytes) in the disk
13038 partition where Exim's log files are being written. The value is recalculated
13039 whenever the variable is referenced. If the operating system does not have the
13040 ability to find the amount of free space (only true for experimental systems),
13041 the space value is -1. See also the &%check_log_space%& option.
13042
13043
13044 .vitem &$lookup_dnssec_authenticated$&
13045 .vindex "&$lookup_dnssec_authenticated$&"
13046 This variable is set after a DNS lookup done by
13047 a dnsdb lookup expansion, dnslookup router or smtp transport.
13048 .cindex "DNS" "DNSSEC"
13049 It will be empty if &(DNSSEC)& was not requested,
13050 &"no"& if the result was not labelled as authenticated data
13051 and &"yes"& if it was.
13052 Results that are labelled as authoritative answer that match
13053 the &%dns_trust_aa%& configuration variable count also
13054 as authenticated data.
13055
13056 .vitem &$mailstore_basename$&
13057 .vindex "&$mailstore_basename$&"
13058 This variable is set only when doing deliveries in &"mailstore"& format in the
13059 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
13060 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
13061 contains the basename of the files that are being written, that is, the name
13062 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
13063 variable is empty.
13064
13065 .vitem &$malware_name$&
13066 .vindex "&$malware_name$&"
13067 This variable is available when Exim is compiled with the
13068 content-scanning extension. It is set to the name of the virus that was found
13069 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
13070
13071 .vitem &$max_received_linelength$&
13072 .vindex "&$max_received_linelength$&"
13073 .cindex "maximum" "line length"
13074 .cindex "line length" "maximum"
13075 This variable contains the number of bytes in the longest line that was
13076 received as part of the message, not counting the line termination
13077 character(s).
13078 It is not valid if the &%spool_wireformat%& option is used.
13079
13080 .vitem &$message_age$&
13081 .cindex "message" "age of"
13082 .vindex "&$message_age$&"
13083 This variable is set at the start of a delivery attempt to contain the number
13084 of seconds since the message was received. It does not change during a single
13085 delivery attempt.
13086
13087 .tvar &$message_body$&
13088 .cindex "body of message" "expansion variable"
13089 .cindex "message body" "in expansion"
13090 .cindex "binary zero" "in message body"
13091 .oindex "&%message_body_visible%&"
13092 This variable contains the initial portion of a message's body while it is
13093 being delivered, and is intended mainly for use in filter files. The maximum
13094 number of characters of the body that are put into the variable is set by the
13095 &%message_body_visible%& configuration option; the default is 500.
13096
13097 .oindex "&%message_body_newlines%&"
13098 By default, newlines are converted into spaces in &$message_body$&, to make it
13099 easier to search for phrases that might be split over a line break. However,
13100 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13101 zeros are always converted into spaces.
13102
13103 .tvar &$message_body_end$&
13104 .cindex "body of message" "expansion variable"
13105 .cindex "message body" "in expansion"
13106 This variable contains the final portion of a message's
13107 body while it is being delivered. The format and maximum size are as for
13108 &$message_body$&.
13109
13110 .vitem &$message_body_size$&
13111 .cindex "body of message" "size"
13112 .cindex "message body" "size"
13113 .vindex "&$message_body_size$&"
13114 When a message is being delivered, this variable contains the size of the body
13115 in bytes. The count starts from the character after the blank line that
13116 separates the body from the header. Newlines are included in the count. See
13117 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13118
13119 If the spool file is wireformat
13120 (see the &%spool_wireformat%& main option)
13121 the CRLF line-terminators are included in the count.
13122
13123 .vitem &$message_exim_id$&
13124 .vindex "&$message_exim_id$&"
13125 When a message is being received or delivered, this variable contains the
13126 unique message id that is generated and used by Exim to identify the message.
13127 An id is not created for a message until after its header has been successfully
13128 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13129 line; it is the local id that Exim assigns to the message, for example:
13130 &`1BXTIK-0001yO-VA`&.
13131
13132 .tvar &$message_headers$&
13133 This variable contains a concatenation of all the header lines when a message
13134 is being processed, except for lines added by routers or transports. The header
13135 lines are separated by newline characters. Their contents are decoded in the
13136 same way as a header line that is inserted by &%bheader%&.
13137
13138 .tvar &$message_headers_raw$&
13139 This variable is like &$message_headers$& except that no processing of the
13140 contents of header lines is done.
13141
13142 .vitem &$message_id$&
13143 This is an old name for &$message_exim_id$&. It is now deprecated.
13144
13145 .vitem &$message_linecount$&
13146 .vindex "&$message_linecount$&"
13147 This variable contains the total number of lines in the header and body of the
13148 message. Compare &$body_linecount$&, which is the count for the body only.
13149 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13150 number of lines received. Before delivery happens (that is, before filters,
13151 routers, and transports run) the count is increased to include the
13152 &'Received:'& header line that Exim standardly adds, and also any other header
13153 lines that are added by ACLs. The blank line that separates the message header
13154 from the body is not counted.
13155
13156 As with the special case of &$message_size$&, during the expansion of the
13157 appendfile transport's maildir_tag option in maildir format, the value of
13158 &$message_linecount$& is the precise size of the number of newlines in the
13159 file that has been written (minus one for the blank line between the
13160 header and the body).
13161
13162 Here is an example of the use of this variable in a DATA ACL:
13163 .code
13164 deny condition = \
13165       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13166      message   = Too many lines in message header
13167 .endd
13168 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13169 message has not yet been received.
13170
13171 This variable is not valid if the &%spool_wireformat%& option is used.
13172
13173 .vitem &$message_size$&
13174 .cindex "size" "of message"
13175 .cindex "message" "size"
13176 .vindex "&$message_size$&"
13177 When a message is being processed, this variable contains its size in bytes. In
13178 most cases, the size includes those headers that were received with the
13179 message, but not those (such as &'Envelope-to:'&) that are added to individual
13180 deliveries as they are written. However, there is one special case: during the
13181 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13182 doing a delivery in maildir format, the value of &$message_size$& is the
13183 precise size of the file that has been written. See also
13184 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13185
13186 .cindex "RCPT" "value of &$message_size$&"
13187 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13188 contains the size supplied on the MAIL command, or -1 if no size was given. The
13189 value may not, of course, be truthful.
13190
13191 .vitem &$mime_anomaly_level$& &&&
13192        &$mime_anomaly_text$& &&&
13193        &$mime_boundary$& &&&
13194        &$mime_charset$& &&&
13195        &$mime_content_description$& &&&
13196        &$mime_content_disposition$& &&&
13197        &$mime_content_id$& &&&
13198        &$mime_content_size$& &&&
13199        &$mime_content_transfer_encoding$& &&&
13200        &$mime_content_type$& &&&
13201        &$mime_decoded_filename$& &&&
13202        &$mime_filename$& &&&
13203        &$mime_is_coverletter$& &&&
13204        &$mime_is_multipart$& &&&
13205        &$mime_is_rfc822$& &&&
13206        &$mime_part_count$&
13207 A number of variables whose names start with &$mime$& are
13208 available when Exim is compiled with the content-scanning extension. For
13209 details, see section &<<SECTscanmimepart>>&.
13210
13211 .vitem "&$n0$& &-- &$n9$&"
13212 These variables are counters that can be incremented by means
13213 of the &%add%& command in filter files.
13214
13215 .tvar &$original_domain$&
13216 .vindex "&$domain$&"
13217 When a top-level address is being processed for delivery, this contains the
13218 same value as &$domain$&. However, if a &"child"& address (for example,
13219 generated by an alias, forward, or filter file) is being processed, this
13220 variable contains the domain of the original address (lower cased). This
13221 differs from &$parent_domain$& only when there is more than one level of
13222 aliasing or forwarding. When more than one address is being delivered in a
13223 single transport run, &$original_domain$& is not set.
13224
13225 If a new address is created by means of a &%deliver%& command in a system
13226 filter, it is set up with an artificial &"parent"& address. This has the local
13227 part &'system-filter'& and the default qualify domain.
13228
13229 .tvar &$original_local_part$&
13230 .vindex "&$local_part$&"
13231 When a top-level address is being processed for delivery, this contains the
13232 same value as &$local_part$&, unless a prefix or suffix was removed from the
13233 local part, because &$original_local_part$& always contains the full local
13234 part. When a &"child"& address (for example, generated by an alias, forward, or
13235 filter file) is being processed, this variable contains the full local part of
13236 the original address.
13237
13238 If the router that did the redirection processed the local part
13239 case-insensitively, the value in &$original_local_part$& is in lower case.
13240 This variable differs from &$parent_local_part$& only when there is more than
13241 one level of aliasing or forwarding. When more than one address is being
13242 delivered in a single transport run, &$original_local_part$& is not set.
13243
13244 If a new address is created by means of a &%deliver%& command in a system
13245 filter, it is set up with an artificial &"parent"& address. This has the local
13246 part &'system-filter'& and the default qualify domain.
13247
13248 .vitem &$originator_gid$&
13249 .cindex "gid (group id)" "of originating user"
13250 .cindex "sender" "gid"
13251 .vindex "&$caller_gid$&"
13252 .vindex "&$originator_gid$&"
13253 This variable contains the value of &$caller_gid$& that was set when the
13254 message was received. For messages received via the command line, this is the
13255 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13256 normally the gid of the Exim user.
13257
13258 .vitem &$originator_uid$&
13259 .cindex "uid (user id)" "of originating user"
13260 .cindex "sender" "uid"
13261 .vindex "&$caller_uid$&"
13262 .vindex "&$originator_uid$&"
13263 The value of &$caller_uid$& that was set when the message was received. For
13264 messages received via the command line, this is the uid of the sending user.
13265 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13266 user.
13267
13268 .tvar &$parent_domain$&
13269 This variable is similar to &$original_domain$& (see
13270 above), except that it refers to the immediately preceding parent address.
13271
13272 .tvar &$parent_local_part$&
13273 This variable is similar to &$original_local_part$&
13274 (see above), except that it refers to the immediately preceding parent address.
13275
13276 .vitem &$pid$&
13277 .cindex "pid (process id)" "of current process"
13278 .vindex "&$pid$&"
13279 This variable contains the current process id.
13280
13281 .vitem &$pipe_addresses$&
13282 .cindex "filter" "transport filter"
13283 .cindex "transport" "filter"
13284 .vindex "&$pipe_addresses$&"
13285 This is not an expansion variable, but is mentioned here because the string
13286 &`$pipe_addresses`& is handled specially in the command specification for the
13287 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13288 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13289 It cannot be used in general expansion strings, and provokes an &"unknown
13290 variable"& error if encountered.
13291 &*Note*&: This value permits data supplied by a potential attacker to
13292 be used in the command for a &(pipe)& transport.
13293 Such configurations should be carefully assessed for security vulnerbilities.
13294
13295 .vitem &$primary_hostname$&
13296 .vindex "&$primary_hostname$&"
13297 This variable contains the value set by &%primary_hostname%& in the
13298 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13299 a single-component name, Exim calls &[gethostbyname()]& (or
13300 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13301 qualified host name. See also &$smtp_active_hostname$&.
13302
13303
13304 .vitem &$proxy_external_address$& &&&
13305        &$proxy_external_port$& &&&
13306        &$proxy_local_address$& &&&
13307        &$proxy_local_port$& &&&
13308        &$proxy_session$&
13309 These variables are only available when built with Proxy Protocol
13310 or SOCKS5 support.
13311 For details see chapter &<<SECTproxyInbound>>&.
13312
13313 .vitem &$prdr_requested$&
13314 .cindex "PRDR" "variable for"
13315 This variable is set to &"yes"& if PRDR was requested by the client for the
13316 current message, otherwise &"no"&.
13317
13318 .vitem &$prvscheck_address$& &&&
13319        &$prvscheck_keynum$& &&&
13320        &$prvscheck_result$&
13321 These variables are used in conjunction with the &%prvscheck%& expansion item,
13322 which is described in sections &<<SECTexpansionitems>>& and
13323 &<<SECTverifyPRVS>>&.
13324
13325 .vitem &$qualify_domain$&
13326 .vindex "&$qualify_domain$&"
13327 The value set for the &%qualify_domain%& option in the configuration file.
13328
13329 .vitem &$qualify_recipient$&
13330 .vindex "&$qualify_recipient$&"
13331 The value set for the &%qualify_recipient%& option in the configuration file,
13332 or if not set, the value of &$qualify_domain$&.
13333
13334 .vitem &$queue_name$&
13335 .vindex &$queue_name$&
13336 .cindex "named queues" variable
13337 .cindex queues named
13338 The name of the spool queue in use; empty for the default queue.
13339
13340 .vitem &$queue_size$&
13341 .vindex "&$queue_size$&"
13342 .cindex "queue" "size of"
13343 .cindex "spool" "number of messages"
13344 This variable contains the number of messages queued.
13345 It is evaluated on demand, but no more often than once every minute.
13346 If there is no daemon notifier socket open, the value will be
13347 an empty string.
13348
13349 .vitem &$r_...$&
13350 .vindex &$r_...$&
13351 .cindex router variables
13352 Values can be placed in these variables by the &%set%& option of a router.
13353 They can be given any name that starts with &$r_$&.
13354 The values persist for the address being handled through subsequent routers
13355 and the eventual transport.
13356
13357 .vitem &$rcpt_count$&
13358 .vindex "&$rcpt_count$&"
13359 When a message is being received by SMTP, this variable contains the number of
13360 RCPT commands received for the current message. If this variable is used in a
13361 RCPT ACL, its value includes the current command.
13362
13363 .vitem &$rcpt_defer_count$&
13364 .vindex "&$rcpt_defer_count$&"
13365 .cindex "4&'xx'& responses" "count of"
13366 When a message is being received by SMTP, this variable contains the number of
13367 RCPT commands in the current message that have previously been rejected with a
13368 temporary (4&'xx'&) response.
13369
13370 .vitem &$rcpt_fail_count$&
13371 .vindex "&$rcpt_fail_count$&"
13372 When a message is being received by SMTP, this variable contains the number of
13373 RCPT commands in the current message that have previously been rejected with a
13374 permanent (5&'xx'&) response.
13375
13376 .vitem &$received_count$&
13377 .vindex "&$received_count$&"
13378 This variable contains the number of &'Received:'& header lines in the message,
13379 including the one added by Exim (so its value is always greater than zero). It
13380 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13381 delivering.
13382
13383 .tvar &$received_for$&
13384 If there is only a single recipient address in an incoming message, this
13385 variable contains that address when the &'Received:'& header line is being
13386 built. The value is copied after recipient rewriting has happened, but before
13387 the &[local_scan()]& function is run.
13388
13389 .vitem &$received_ip_address$& &&&
13390        &$received_port$&
13391 .vindex "&$received_ip_address$&"
13392 .vindex "&$received_port$&"
13393 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13394 variables are set to the address and port on the local IP interface.
13395 (The remote IP address and port are in
13396 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13397 the port value is -1 unless it has been set using the &%-oMi%& command line
13398 option.
13399
13400 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13401 could be used, for example, to make the filename for a TLS certificate depend
13402 on which interface and/or port is being used for the incoming connection. The
13403 values of &$received_ip_address$& and &$received_port$& are saved with any
13404 messages that are received, thus making these variables available at delivery
13405 time.
13406 For outbound connections see &$sending_ip_address$&.
13407
13408 .vitem &$received_protocol$&
13409 .vindex "&$received_protocol$&"
13410 When a message is being processed, this variable contains the name of the
13411 protocol by which it was received. Most of the names used by Exim are defined
13412 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13413 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13414 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13415 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13416 connection and the client was successfully authenticated.
13417
13418 Exim uses the protocol name &"smtps"& for the case when encryption is
13419 automatically set up on connection without the use of STARTTLS (see
13420 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13421 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13422 where the client initially uses EHLO, sets up an encrypted connection using
13423 STARTTLS, and then uses HELO afterwards.
13424
13425 The &%-oMr%& option provides a way of specifying a custom protocol name for
13426 messages that are injected locally by trusted callers. This is commonly used to
13427 identify messages that are being re-injected after some kind of scanning.
13428
13429 .vitem &$received_time$&
13430 .vindex "&$received_time$&"
13431 This variable contains the date and time when the current message was received,
13432 as a number of seconds since the start of the Unix epoch.
13433
13434 .vitem &$recipient_data$&
13435 .vindex "&$recipient_data$&"
13436 This variable is set after an indexing lookup success in an ACL &%recipients%&
13437 condition. It contains the data from the lookup, and the value remains set
13438 until the next &%recipients%& test. Thus, you can do things like this:
13439 .display
13440 &`require recipients  = cdb*@;/some/file`&
13441 &`deny    `&&'some further test involving'& &`$recipient_data`&
13442 .endd
13443 &*Warning*&: This variable is set only when a lookup is used as an indexing
13444 method in the address list, using the semicolon syntax as in the example above.
13445 The variable is not set for a lookup that is used as part of the string
13446 expansion that all such lists undergo before being interpreted.
13447
13448 .vitem &$recipient_verify_failure$&
13449 .vindex "&$recipient_verify_failure$&"
13450 In an ACL, when a recipient verification fails, this variable contains
13451 information about the failure. It is set to one of the following words:
13452
13453 .ilist
13454 &"qualify"&: The address was unqualified (no domain), and the message
13455 was neither local nor came from an exempted host.
13456
13457 .next
13458 &"route"&: Routing failed.
13459
13460 .next
13461 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13462 or before the MAIL command (that is, on initial connection, HELO, or
13463 MAIL).
13464
13465 .next
13466 &"recipient"&: The RCPT command in a callout was rejected.
13467 .next
13468
13469 &"postmaster"&: The postmaster check in a callout was rejected.
13470 .endlist
13471
13472 The main use of this variable is expected to be to distinguish between
13473 rejections of MAIL and rejections of RCPT.
13474
13475 .tvar &$recipients$&
13476 .tvar &$recipients_list$&
13477 These variables both contain the envelope recipients for a message.
13478
13479 The first uses a comma and a space separate the addresses in the replacement text.
13480 &*Note*&: an address can legitimately contain a comma;
13481 this variable is not intended for further processing.
13482
13483 The second is a proper Exim list; colon-separated.
13484
13485 However, the variables
13486 are not generally available, to prevent exposure of Bcc recipients in
13487 unprivileged users' filter files. You can use either of them  only in these
13488 cases:
13489
13490 .olist
13491 In a system filter file.
13492 .next
13493 In the ACLs associated with the DATA command and with non-SMTP messages, that
13494 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13495 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13496 &%acl_not_smtp_mime%&.
13497 .next
13498 From within a &[local_scan()]& function.
13499 .endlist
13500
13501
13502 .vitem &$recipients_count$&
13503 .vindex "&$recipients_count$&"
13504 When a message is being processed, this variable contains the number of
13505 envelope recipients that came with the message. Duplicates are not excluded
13506 from the count. While a message is being received over SMTP, the number
13507 increases for each accepted recipient. It can be referenced in an ACL.
13508
13509
13510 .vitem &$regex_match_string$&
13511 .vindex "&$regex_match_string$&"
13512 This variable is set to contain the matching regular expression after a
13513 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13514
13515 .vitem "&$regex1$&, &$regex2$&, etc"
13516 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13517 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13518 these variables contain the
13519 captured substrings identified by the regular expression.
13520 If the subject string was tainted then so will any captured substring.
13521
13522
13523 .tvar &$reply_address$&
13524 When a message is being processed, this variable contains the contents of the
13525 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13526 contents of the &'From:'& header line. Apart from the removal of leading
13527 white space, the value is not processed in any way. In particular, no RFC 2047
13528 decoding or character code translation takes place.
13529
13530 .vitem &$return_path$&
13531 .vindex "&$return_path$&"
13532 When a message is being delivered, this variable contains the return path &--
13533 the sender field that will be sent as part of the envelope. It is not enclosed
13534 in <> characters. At the start of routing an address, &$return_path$& has the
13535 same value as &$sender_address$&, but if, for example, an incoming message to a
13536 mailing list has been expanded by a router which specifies a different address
13537 for bounce messages, &$return_path$& subsequently contains the new bounce
13538 address, whereas &$sender_address$& always contains the original sender address
13539 that was received with the message. In other words, &$sender_address$& contains
13540 the incoming envelope sender, and &$return_path$& contains the outgoing
13541 envelope sender.
13542
13543 .vitem &$return_size_limit$&
13544 .vindex "&$return_size_limit$&"
13545 This is an obsolete name for &$bounce_return_size_limit$&.
13546
13547 .vitem &$router_name$&
13548 .cindex "router" "name"
13549 .cindex "name" "of router"
13550 .vindex "&$router_name$&"
13551 During the running of a router, or a transport called,
13552 this variable contains the router name.
13553
13554 .vitem &$runrc$&
13555 .cindex "return code" "from &%run%& expansion"
13556 .vindex "&$runrc$&"
13557 This variable contains the return code from a command that is run by the
13558 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13559 assume the order in which option values are expanded, except for those
13560 preconditions whose order of testing is documented. Therefore, you cannot
13561 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13562 another.
13563
13564 .vitem &$self_hostname$&
13565 .oindex "&%self%&" "value of host name"
13566 .vindex "&$self_hostname$&"
13567 When an address is routed to a supposedly remote host that turns out to be the
13568 local host, what happens is controlled by the &%self%& generic router option.
13569 One of its values causes the address to be passed to another router. When this
13570 happens, &$self_hostname$& is set to the name of the local host that the
13571 original router encountered. In other circumstances its contents are null.
13572
13573 .tvar &$sender_address$&
13574 When a message is being processed, this variable contains the sender's address
13575 that was received in the message's envelope. The case of letters in the address
13576 is retained, in both the local part and the domain. For bounce messages, the
13577 value of this variable is the empty string. See also &$return_path$&.
13578
13579 .vitem &$sender_address_data$&
13580 .vindex "&$address_data$&"
13581 .vindex "&$sender_address_data$&"
13582 If &$address_data$& is set when the routers are called from an ACL to verify a
13583 sender address, the final value is preserved in &$sender_address_data$&, to
13584 distinguish it from data from a recipient address. The value does not persist
13585 after the end of the current ACL statement. If you want to preserve it for
13586 longer, you can save it in an ACL variable.
13587
13588 .tvar &$sender_address_domain$&
13589 The domain portion of &$sender_address$&.
13590
13591 .tvar &$sender_address_local_part$&
13592 The local part portion of &$sender_address$&.
13593
13594 .vitem &$sender_data$&
13595 .vindex "&$sender_data$&"
13596 This variable is set after a lookup success in an ACL &%senders%& condition or
13597 in a router &%senders%& option. It contains the data from the lookup, and the
13598 value remains set until the next &%senders%& test. Thus, you can do things like
13599 this:
13600 .display
13601 &`require senders      = cdb*@;/some/file`&
13602 &`deny    `&&'some further test involving'& &`$sender_data`&
13603 .endd
13604 &*Warning*&: This variable is set only when a lookup is used as an indexing
13605 method in the address list, using the semicolon syntax as in the example above.
13606 The variable is not set for a lookup that is used as part of the string
13607 expansion that all such lists undergo before being interpreted.
13608
13609 .vitem &$sender_fullhost$&
13610 .vindex "&$sender_fullhost$&"
13611 When a message is received from a remote host, this variable contains the host
13612 name and IP address in a single string. It ends with the IP address in square
13613 brackets, followed by a colon and a port number if the logging of ports is
13614 enabled. The format of the rest of the string depends on whether the host
13615 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13616 looking up its IP address. (Looking up the IP address can be forced by the
13617 &%host_lookup%& option, independent of verification.) A plain host name at the
13618 start of the string is a verified host name; if this is not present,
13619 verification either failed or was not requested. A host name in parentheses is
13620 the argument of a HELO or EHLO command. This is omitted if it is identical to
13621 the verified host name or to the host's IP address in square brackets.
13622
13623 .vitem &$sender_helo_dnssec$&
13624 .vindex "&$sender_helo_dnssec$&"
13625 This boolean variable is true if a successful HELO verification was
13626 .cindex "DNS" "DNSSEC"
13627 done using DNS information the resolver library stated was authenticated data.
13628
13629 .tvar &$sender_helo_name$&
13630 When a message is received from a remote host that has issued a HELO or EHLO
13631 command, the argument of that command is placed in this variable. It is also
13632 set if HELO or EHLO is used when a message is received using SMTP locally via
13633 the &%-bs%& or &%-bS%& options.
13634
13635 .vitem &$sender_host_address$&
13636 .vindex "&$sender_host_address$&"
13637 When a message is received from a remote host using SMTP,
13638 this variable contains that
13639 host's IP address. For locally non-SMTP submitted messages, it is empty.
13640
13641 .vitem &$sender_host_authenticated$&
13642 .vindex "&$sender_host_authenticated$&"
13643 This variable contains the name (not the public name) of the authenticator
13644 driver that successfully authenticated the client from which the message was
13645 received. It is empty if there was no successful authentication. See also
13646 &$authenticated_id$&.
13647
13648 .vitem &$sender_host_dnssec$&
13649 .vindex "&$sender_host_dnssec$&"
13650 If an attempt to populate &$sender_host_name$& has been made
13651 (by reference, &%hosts_lookup%& or
13652 otherwise) then this boolean will have been set true if, and only if, the
13653 resolver library states that both
13654 the reverse and forward DNS were authenticated data.  At all
13655 other times, this variable is false.
13656
13657 .cindex "DNS" "DNSSEC"
13658 It is likely that you will need to coerce DNSSEC support on in the resolver
13659 library, by setting:
13660 .code
13661 dns_dnssec_ok = 1
13662 .endd
13663
13664 In addition, on Linux with glibc 2.31 or newer the resolver library will
13665 default to stripping out a successful validation status.
13666 This will break a previously working Exim installation.
13667 Provided that you do trust the resolver (ie, is on localhost) you can tell
13668 glibc to pass through any successful validation with a new option in
13669 &_/etc/resolv.conf_&:
13670 .code
13671 options trust-ad
13672 .endd
13673
13674 Exim does not perform DNSSEC validation itself, instead leaving that to a
13675 validating resolver (e.g. unbound, or bind with suitable configuration).
13676
13677 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13678 mechanism in the list, then this variable will be false.
13679
13680 This requires that your system resolver library support EDNS0 (and that
13681 DNSSEC flags exist in the system headers).  If the resolver silently drops
13682 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13683 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13684
13685
13686 .tvar &$sender_host_name$&
13687 When a message is received from a remote host, this variable contains the
13688 host's name as obtained by looking up its IP address. For messages received by
13689 other means, this variable is empty.
13690
13691 .vindex "&$host_lookup_failed$&"
13692 If the host name has not previously been looked up, a reference to
13693 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13694 A looked up name is accepted only if it leads back to the original IP address
13695 via a forward lookup. If either the reverse or the forward lookup fails to find
13696 any data, or if the forward lookup does not yield the original IP address,
13697 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13698
13699 .vindex "&$host_lookup_deferred$&"
13700 However, if either of the lookups cannot be completed (for example, there is a
13701 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13702 &$host_lookup_failed$& remains set to &"0"&.
13703
13704 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13705 host name again if there is a subsequent reference to &$sender_host_name$&
13706 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13707 is set to &"1"&.
13708
13709 Exim does not automatically look up every calling host's name. If you want
13710 maximum efficiency, you should arrange your configuration so that it avoids
13711 these lookups altogether. The lookup happens only if one or more of the
13712 following are true:
13713
13714 .ilist
13715 A string containing &$sender_host_name$& is expanded.
13716 .next
13717 The calling host matches the list in &%host_lookup%&. In the default
13718 configuration, this option is set to *, so it must be changed if lookups are
13719 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13720 .next
13721 Exim needs the host name in order to test an item in a host list. The items
13722 that require this are described in sections &<<SECThoslispatnam>>& and
13723 &<<SECThoslispatnamsk>>&.
13724 .next
13725 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13726 In this case, the host name is required to compare with the name quoted in any
13727 EHLO or HELO commands that the client issues.
13728 .next
13729 The remote host issues a EHLO or HELO command that quotes one of the
13730 domains in &%helo_lookup_domains%&. The default value of this option is
13731 . ==== As this is a nested list, any displays it contains must be indented
13732 . ==== as otherwise they are too far to the left.
13733 .code
13734   helo_lookup_domains = @ : @[]
13735 .endd
13736 which causes a lookup if a remote host (incorrectly) gives the server's name or
13737 IP address in an EHLO or HELO command.
13738 .endlist
13739
13740
13741 .vitem &$sender_host_port$&
13742 .vindex "&$sender_host_port$&"
13743 When a message is received from a remote host, this variable contains the port
13744 number that was used on the remote host.
13745
13746 .vitem &$sender_ident$&
13747 .vindex "&$sender_ident$&"
13748 When a message is received from a remote host, this variable contains the
13749 identification received in response to an RFC 1413 request. When a message has
13750 been received locally, this variable contains the login name of the user that
13751 called Exim.
13752
13753 .vitem &$sender_rate_$&&'xxx'&
13754 A number of variables whose names begin &$sender_rate_$& are set as part of the
13755 &%ratelimit%& ACL condition. Details are given in section
13756 &<<SECTratelimiting>>&.
13757
13758 .vitem &$sender_rcvhost$&
13759 .cindex "DNS" "reverse lookup"
13760 .cindex "reverse DNS lookup"
13761 .vindex "&$sender_rcvhost$&"
13762 This is provided specifically for use in &'Received:'& headers. It starts with
13763 either the verified host name (as obtained from a reverse DNS lookup) or, if
13764 there is no verified host name, the IP address in square brackets. After that
13765 there may be text in parentheses. When the first item is a verified host name,
13766 the first thing in the parentheses is the IP address in square brackets,
13767 followed by a colon and a port number if port logging is enabled. When the
13768 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13769 the parentheses.
13770
13771 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13772 was used and its argument was not identical to the real host name or IP
13773 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13774 all three items are present in the parentheses, a newline and tab are inserted
13775 into the string, to improve the formatting of the &'Received:'& header.
13776
13777 .vitem &$sender_verify_failure$&
13778 .vindex "&$sender_verify_failure$&"
13779 In an ACL, when a sender verification fails, this variable contains information
13780 about the failure. The details are the same as for
13781 &$recipient_verify_failure$&.
13782
13783 .vitem &$sending_ip_address$&
13784 .vindex "&$sending_ip_address$&"
13785 This variable is set whenever an outgoing SMTP connection to another host has
13786 been set up. It contains the IP address of the local interface that is being
13787 used. This is useful if a host that has more than one IP address wants to take
13788 on different personalities depending on which one is being used. For incoming
13789 connections, see &$received_ip_address$&.
13790
13791 .vitem &$sending_port$&
13792 .vindex "&$sending_port$&"
13793 This variable is set whenever an outgoing SMTP connection to another host has
13794 been set up. It contains the local port that is being used. For incoming
13795 connections, see &$received_port$&.
13796
13797 .vitem &$smtp_active_hostname$&
13798 .vindex "&$smtp_active_hostname$&"
13799 During an incoming SMTP session, this variable contains the value of the active
13800 host name, as specified by the &%smtp_active_hostname%& option. The value of
13801 &$smtp_active_hostname$& is saved with any message that is received, so its
13802 value can be consulted during routing and delivery.
13803
13804 .tvar &$smtp_command$&
13805 During the processing of an incoming SMTP command, this variable contains the
13806 entire command. This makes it possible to distinguish between HELO and EHLO in
13807 the HELO ACL, and also to distinguish between commands such as these:
13808 .code
13809 MAIL FROM:<>
13810 MAIL FROM: <>
13811 .endd
13812 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13813 command, the address in &$smtp_command$& is the original address before any
13814 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13815 the address after SMTP-time rewriting.
13816
13817 .tvar &$smtp_command_argument$&
13818 .cindex "SMTP" "command, argument for"
13819 While an ACL is running to check an SMTP command, this variable contains the
13820 argument, that is, the text that follows the command name, with leading white
13821 space removed. Following the introduction of &$smtp_command$&, this variable is
13822 somewhat redundant, but is retained for backwards compatibility.
13823
13824 .vitem &$smtp_command_history$&
13825 .cindex SMTP "command history"
13826 .vindex "&$smtp_command_history$&"
13827 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13828 received, in time-order left to right.  Only a limited number of commands
13829 are remembered.
13830
13831 .vitem &$smtp_count_at_connection_start$&
13832 .vindex "&$smtp_count_at_connection_start$&"
13833 This variable is set greater than zero only in processes spawned by the Exim
13834 daemon for handling incoming SMTP connections. The name is deliberately long,
13835 in order to emphasize what the contents are. When the daemon accepts a new
13836 connection, it increments this variable. A copy of the variable is passed to
13837 the child process that handles the connection, but its value is fixed, and
13838 never changes. It is only an approximation of how many incoming connections
13839 there actually are, because many other connections may come and go while a
13840 single connection is being processed. When a child process terminates, the
13841 daemon decrements its copy of the variable.
13842
13843 .vitem &$smtp_notquit_reason$&
13844 .vindex "&$smtp_notquit_reason$&"
13845 When the not-QUIT ACL is running, this variable is set to a string
13846 that indicates the reason for the termination of the SMTP connection.
13847
13848 .vitem "&$sn0$& &-- &$sn9$&"
13849 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13850 that were current at the end of the system filter file. This allows a system
13851 filter file to set values that can be tested in users' filter files. For
13852 example, a system filter could set a value indicating how likely it is that a
13853 message is junk mail.
13854
13855 .vitem &$spam_score$& &&&
13856        &$spam_score_int$& &&&
13857        &$spam_bar$& &&&
13858        &$spam_report$& &&&
13859        &$spam_action$&
13860 A number of variables whose names start with &$spam$& are available when Exim
13861 is compiled with the content-scanning extension. For details, see section
13862 &<<SECTscanspamass>>&.
13863
13864 .vitem &$spf_header_comment$& &&&
13865        &$spf_received$& &&&
13866        &$spf_result$& &&&
13867        &$spf_result_guessed$& &&&
13868        &$spf_smtp_comment$&
13869 These variables are only available if Exim is built with SPF support.
13870 For details see section &<<SECSPF>>&.
13871
13872 .vitem &$spool_directory$&
13873 .vindex "&$spool_directory$&"
13874 The name of Exim's spool directory.
13875
13876 .vitem &$spool_inodes$&
13877 .vindex "&$spool_inodes$&"
13878 The number of free inodes in the disk partition where Exim's spool files are
13879 being written. The value is recalculated whenever the variable is referenced.
13880 If the relevant file system does not have the concept of inodes, the value of
13881 is -1. See also the &%check_spool_inodes%& option.
13882
13883 .vitem &$spool_space$&
13884 .vindex "&$spool_space$&"
13885 The amount of free space (as a number of kilobytes) in the disk partition where
13886 Exim's spool files are being written. The value is recalculated whenever the
13887 variable is referenced. If the operating system does not have the ability to
13888 find the amount of free space (only true for experimental systems), the space
13889 value is -1. For example, to check in an ACL that there is at least 50
13890 megabytes free on the spool, you could write:
13891 .code
13892 condition = ${if > {$spool_space}{50000}}
13893 .endd
13894 See also the &%check_spool_space%& option.
13895
13896
13897 .vitem &$thisaddress$&
13898 .vindex "&$thisaddress$&"
13899 This variable is set only during the processing of the &%foranyaddress%&
13900 command in a filter file. Its use is explained in the description of that
13901 command, which can be found in the separate document entitled &'Exim's
13902 interfaces to mail filtering'&.
13903
13904 .vitem &$tls_in_bits$&
13905 .vindex "&$tls_in_bits$&"
13906 Contains an approximation of the TLS cipher's bit-strength
13907 on the inbound connection; the meaning of
13908 this depends upon the TLS implementation used.
13909 If TLS has not been negotiated, the value will be 0.
13910 The value of this is automatically fed into the Cyrus SASL authenticator
13911 when acting as a server, to specify the "external SSF" (a SASL term).
13912
13913 The deprecated &$tls_bits$& variable refers to the inbound side
13914 except when used in the context of an outbound SMTP delivery, when it refers to
13915 the outbound.
13916
13917 .vitem &$tls_out_bits$&
13918 .vindex "&$tls_out_bits$&"
13919 Contains an approximation of the TLS cipher's bit-strength
13920 on an outbound SMTP connection; the meaning of
13921 this depends upon the TLS implementation used.
13922 If TLS has not been negotiated, the value will be 0.
13923
13924 .vitem &$tls_in_ourcert$&
13925 .vindex "&$tls_in_ourcert$&"
13926 .cindex certificate variables
13927 This variable refers to the certificate presented to the peer of an
13928 inbound connection when the message was received.
13929 It is only useful as the argument of a
13930 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13931 or a &%def%& condition.
13932
13933 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13934 when a list of more than one
13935 file is used for &%tls_certificate%&, this variable is not reliable.
13936 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13937
13938 .vitem &$tls_in_peercert$&
13939 .vindex "&$tls_in_peercert$&"
13940 This variable refers to the certificate presented by the peer of an
13941 inbound connection when the message was received.
13942 It is only useful as the argument of a
13943 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13944 or a &%def%& condition.
13945 If certificate verification fails it may refer to a failing chain element
13946 which is not the leaf.
13947
13948 .vitem &$tls_out_ourcert$&
13949 .vindex "&$tls_out_ourcert$&"
13950 This variable refers to the certificate presented to the peer of an
13951 outbound connection.  It is only useful as the argument of a
13952 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13953 or a &%def%& condition.
13954
13955 .vitem &$tls_out_peercert$&
13956 .vindex "&$tls_out_peercert$&"
13957 This variable refers to the certificate presented by the peer of an
13958 outbound connection.  It is only useful as the argument of a
13959 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13960 or a &%def%& condition.
13961 If certificate verification fails it may refer to a failing chain element
13962 which is not the leaf.
13963
13964 .vitem &$tls_in_certificate_verified$&
13965 .vindex "&$tls_in_certificate_verified$&"
13966 This variable is set to &"1"& if a TLS certificate was verified when the
13967 message was received, and &"0"& otherwise.
13968
13969 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13970 except when used in the context of an outbound SMTP delivery, when it refers to
13971 the outbound.
13972
13973 .vitem &$tls_out_certificate_verified$&
13974 .vindex "&$tls_out_certificate_verified$&"
13975 This variable is set to &"1"& if a TLS certificate was verified when an
13976 outbound SMTP connection was made,
13977 and &"0"& otherwise.
13978
13979 .vitem &$tls_in_cipher$&
13980 .vindex "&$tls_in_cipher$&"
13981 .vindex "&$tls_cipher$&"
13982 When a message is received from a remote host over an encrypted SMTP
13983 connection, this variable is set to the cipher suite that was negotiated, for
13984 example DES-CBC3-SHA. In other circumstances, in particular, for message
13985 received over unencrypted connections, the variable is empty. Testing
13986 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13987 non-encrypted connections during ACL processing.
13988
13989 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13990 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13991 becomes the same as &$tls_out_cipher$&.
13992
13993 .vitem &$tls_in_cipher_std$&
13994 .vindex "&$tls_in_cipher_std$&"
13995 As above, but returning the RFC standard name for the cipher suite.
13996
13997 .vitem &$tls_out_cipher$&
13998 .vindex "&$tls_out_cipher$&"
13999 This variable is
14000 cleared before any outgoing SMTP connection is made,
14001 and then set to the outgoing cipher suite if one is negotiated. See chapter
14002 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
14003 details of the &(smtp)& transport.
14004
14005 .vitem &$tls_out_cipher_std$&
14006 .vindex "&$tls_out_cipher_std$&"
14007 As above, but returning the RFC standard name for the cipher suite.
14008
14009 .vitem &$tls_out_dane$&
14010 .vindex &$tls_out_dane$&
14011 DANE active status.  See section &<<SECDANE>>&.
14012
14013 .vitem &$tls_in_ocsp$&
14014 .vindex "&$tls_in_ocsp$&"
14015 When a message is received from a remote client connection
14016 the result of any OCSP request from the client is encoded in this variable:
14017 .code
14018 0 OCSP proof was not requested (default value)
14019 1 No response to request
14020 2 Response not verified
14021 3 Verification failed
14022 4 Verification succeeded
14023 .endd
14024
14025 .vitem &$tls_out_ocsp$&
14026 .vindex "&$tls_out_ocsp$&"
14027 When a message is sent to a remote host connection
14028 the result of any OCSP request made is encoded in this variable.
14029 See &$tls_in_ocsp$& for values.
14030
14031 .vitem &$tls_in_peerdn$&
14032 .vindex "&$tls_in_peerdn$&"
14033 .vindex "&$tls_peerdn$&"
14034 .cindex certificate "extracting fields"
14035 When a message is received from a remote host over an encrypted SMTP
14036 connection, and Exim is configured to request a certificate from the client,
14037 the value of the Distinguished Name of the certificate is made available in the
14038 &$tls_in_peerdn$& during subsequent processing.
14039 If certificate verification fails it may refer to a failing chain element
14040 which is not the leaf.
14041
14042 The deprecated &$tls_peerdn$& variable refers to the inbound side
14043 except when used in the context of an outbound SMTP delivery, when it refers to
14044 the outbound.
14045
14046 .vitem &$tls_out_peerdn$&
14047 .vindex "&$tls_out_peerdn$&"
14048 When a message is being delivered to a remote host over an encrypted SMTP
14049 connection, and Exim is configured to request a certificate from the server,
14050 the value of the Distinguished Name of the certificate is made available in the
14051 &$tls_out_peerdn$& during subsequent processing.
14052 If certificate verification fails it may refer to a failing chain element
14053 which is not the leaf.
14054
14055
14056 .vitem &$tls_in_resumption$& &&&
14057        &$tls_out_resumption$&
14058 .vindex &$tls_in_resumption$&
14059 .vindex &$tls_out_resumption$&
14060 .cindex TLS resumption
14061 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
14062
14063
14064 .tvar &$tls_in_sni$&
14065 .vindex "&$tls_sni$&"
14066 .cindex "TLS" "Server Name Indication"
14067 .cindex "TLS" SNI
14068 .cindex SNI "observability on server"
14069 When a TLS session is being established, if the client sends the Server
14070 Name Indication extension, the value will be placed in this variable.
14071 If the variable appears in &%tls_certificate%& then this option and
14072 some others, described in &<<SECTtlssni>>&,
14073 will be re-expanded early in the TLS session, to permit
14074 a different certificate to be presented (and optionally a different key to be
14075 used) to the client, based upon the value of the SNI extension.
14076
14077 The deprecated &$tls_sni$& variable refers to the inbound side
14078 except when used in the context of an outbound SMTP delivery, when it refers to
14079 the outbound.
14080
14081 .vitem &$tls_out_sni$&
14082 .vindex "&$tls_out_sni$&"
14083 .cindex "TLS" "Server Name Indication"
14084 .cindex "TLS" SNI
14085 .cindex SNI "observability in client"
14086 During outbound
14087 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14088 the transport.
14089
14090 .vitem &$tls_out_tlsa_usage$&
14091 .vindex &$tls_out_tlsa_usage$&
14092 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14093
14094 .vitem &$tls_in_ver$&
14095 .vindex "&$tls_in_ver$&"
14096 When a message is received from a remote host over an encrypted SMTP connection
14097 this variable is set to the protocol version, eg &'TLS1.2'&.
14098
14099 .vitem &$tls_out_ver$&
14100 .vindex "&$tls_out_ver$&"
14101 When a message is being delivered to a remote host over an encrypted SMTP connection
14102 this variable is set to the protocol version.
14103
14104
14105 .vitem &$tod_bsdinbox$&
14106 .vindex "&$tod_bsdinbox$&"
14107 The time of day and the date, in the format required for BSD-style mailbox
14108 files, for example: Thu Oct 17 17:14:09 1995.
14109
14110 .vitem &$tod_epoch$&
14111 .vindex "&$tod_epoch$&"
14112 The time and date as a number of seconds since the start of the Unix epoch.
14113
14114 .vitem &$tod_epoch_l$&
14115 .vindex "&$tod_epoch_l$&"
14116 The time and date as a number of microseconds since the start of the Unix epoch.
14117
14118 .vitem &$tod_full$&
14119 .vindex "&$tod_full$&"
14120 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14121 +0100. The timezone is always given as a numerical offset from UTC, with
14122 positive values used for timezones that are ahead (east) of UTC, and negative
14123 values for those that are behind (west).
14124
14125 .vitem &$tod_log$&
14126 .vindex "&$tod_log$&"
14127 The time and date in the format used for writing Exim's log files, for example:
14128 1995-10-12 15:32:29, but without a timezone.
14129
14130 .vitem &$tod_logfile$&
14131 .vindex "&$tod_logfile$&"
14132 This variable contains the date in the format yyyymmdd. This is the format that
14133 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14134 flag.
14135
14136 .vitem &$tod_zone$&
14137 .vindex "&$tod_zone$&"
14138 This variable contains the numerical value of the local timezone, for example:
14139 -0500.
14140
14141 .vitem &$tod_zulu$&
14142 .vindex "&$tod_zulu$&"
14143 This variable contains the UTC date and time in &"Zulu"& format, as specified
14144 by ISO 8601, for example: 20030221154023Z.
14145
14146 .vitem &$transport_name$&
14147 .cindex "transport" "name"
14148 .cindex "name" "of transport"
14149 .vindex "&$transport_name$&"
14150 During the running of a transport, this variable contains its name.
14151
14152 .vitem &$value$&
14153 .vindex "&$value$&"
14154 This variable contains the result of an expansion lookup, extraction operation,
14155 or external command, as described above. It is also used during a
14156 &*reduce*& expansion.
14157
14158 .vitem &$verify_mode$&
14159 .vindex "&$verify_mode$&"
14160 While a router or transport is being run in verify mode or for cutthrough delivery,
14161 contains "S" for sender-verification or "R" for recipient-verification.
14162 Otherwise, empty.
14163
14164 .vitem &$version_number$&
14165 .vindex "&$version_number$&"
14166 The version number of Exim. Same as &$exim_version$&, may be overridden
14167 by the &%exim_version%& main config option.
14168
14169 .vitem &$warn_message_delay$&
14170 .vindex "&$warn_message_delay$&"
14171 This variable is set only during the creation of a message warning about a
14172 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14173
14174 .vitem &$warn_message_recipients$&
14175 .vindex "&$warn_message_recipients$&"
14176 This variable is set only during the creation of a message warning about a
14177 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14178 .endlist
14179 .ecindex IIDstrexp
14180
14181
14182
14183 . ////////////////////////////////////////////////////////////////////////////
14184 . ////////////////////////////////////////////////////////////////////////////
14185
14186 .chapter "Embedded Perl" "CHAPperl"
14187 .scindex IIDperl "Perl" "calling from Exim"
14188 Exim can be built to include an embedded Perl interpreter. When this is done,
14189 Perl subroutines can be called as part of the string expansion process. To make
14190 use of the Perl support, you need version 5.004 or later of Perl installed on
14191 your system. To include the embedded interpreter in the Exim binary, include
14192 the line
14193 .code
14194 EXIM_PERL = perl.o
14195 .endd
14196 in your &_Local/Makefile_& and then build Exim in the normal way.
14197
14198
14199 .section "Setting up so Perl can be used" "SECID85"
14200 .oindex "&%perl_startup%&"
14201 Access to Perl subroutines is via a global configuration option called
14202 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14203 no &%perl_startup%& option in the Exim configuration file then no Perl
14204 interpreter is started and there is almost no overhead for Exim (since none of
14205 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14206 option then the associated value is taken to be Perl code which is executed in
14207 a newly created Perl interpreter.
14208
14209 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14210 need backslashes before any characters to escape special meanings. The option
14211 should usually be something like
14212 .code
14213 perl_startup = do '/etc/exim.pl'
14214 .endd
14215 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14216 use from Exim. Exim can be configured either to start up a Perl interpreter as
14217 soon as it is entered, or to wait until the first time it is needed. Starting
14218 the interpreter at the beginning ensures that it is done while Exim still has
14219 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14220 fact used in a particular run. Also, note that this does not mean that Exim is
14221 necessarily running as root when Perl is called at a later time. By default,
14222 the interpreter is started only when it is needed, but this can be changed in
14223 two ways:
14224
14225 .ilist
14226 .oindex "&%perl_at_start%&"
14227 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14228 a startup when Exim is entered.
14229 .next
14230 The command line option &%-ps%& also requests a startup when Exim is entered,
14231 overriding the setting of &%perl_at_start%&.
14232 .endlist
14233
14234 There is also a command line option &%-pd%& (for delay) which suppresses the
14235 initial startup, even if &%perl_at_start%& is set.
14236
14237 .ilist
14238 .oindex "&%perl_taintmode%&"
14239 .cindex "Perl" "taintmode"
14240 To provide more security executing Perl code via the embedded Perl
14241 interpreter, the &%perl_taintmode%& option can be set. This enables the
14242 taint mode of the Perl interpreter. You are encouraged to set this
14243 option to a true value. To avoid breaking existing installations, it
14244 defaults to false.
14245
14246 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14247
14248
14249 .section "Calling Perl subroutines" "SECID86"
14250 When the configuration file includes a &%perl_startup%& option you can make use
14251 of the string expansion item to call the Perl subroutines that are defined
14252 by the &%perl_startup%& code. The operator is used in any of the following
14253 forms:
14254 .code
14255 ${perl{foo}}
14256 ${perl{foo}{argument}}
14257 ${perl{foo}{argument1}{argument2} ... }
14258 .endd
14259 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14260 arguments may be passed. Passing more than this results in an expansion failure
14261 with an error message of the form
14262 .code
14263 Too many arguments passed to Perl subroutine "foo" (max is 8)
14264 .endd
14265 The return value of the Perl subroutine is evaluated in a scalar context before
14266 it is passed back to Exim to be inserted into the expanded string. If the
14267 return value is &'undef'&, the expansion is forced to fail in the same way as
14268 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14269 by obeying Perl's &%die%& function, the expansion fails with the error message
14270 that was passed to &%die%&.
14271
14272
14273 .section "Calling Exim functions from Perl" "SECID87"
14274 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14275 is available to call back into Exim's string expansion function. For example,
14276 the Perl code
14277 .code
14278 my $lp = Exim::expand_string('$local_part');
14279 .endd
14280 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14281 Note those are single quotes and not double quotes to protect against
14282 &$local_part$& being interpolated as a Perl variable.
14283
14284 If the string expansion is forced to fail by a &"fail"& item, the result of
14285 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14286 expansion string, the Perl call from the original expansion string fails with
14287 an appropriate error message, in the same way as if &%die%& were used.
14288
14289 .cindex "debugging" "from embedded Perl"
14290 .cindex "log" "writing from embedded Perl"
14291 Two other Exim functions are available for use from within Perl code.
14292 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14293 debugging is enabled. If you want a newline at the end, you must supply it.
14294 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14295 timestamp. In this case, you should not supply a terminating newline.
14296
14297
14298 .section "Use of standard output and error by Perl" "SECID88"
14299 .cindex "Perl" "standard output and error"
14300 You should not write to the standard error or output streams from within your
14301 Perl code, as it is not defined how these are set up. In versions of Exim
14302 before 4.50, it is possible for the standard output or error to refer to the
14303 SMTP connection during message reception via the daemon. Writing to this stream
14304 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14305 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14306 avoided, but the output is lost.
14307
14308 .cindex "Perl" "use of &%warn%&"
14309 The Perl &%warn%& statement writes to the standard error stream by default.
14310 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14311 you have no control. When Exim starts up the Perl interpreter, it arranges for
14312 output from the &%warn%& statement to be written to the Exim main log. You can
14313 change this by including appropriate Perl magic somewhere in your Perl code.
14314 For example, to discard &%warn%& output completely, you need this:
14315 .code
14316 $SIG{__WARN__} = sub { };
14317 .endd
14318 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14319 example, the code for the subroutine is empty, so it does nothing, but you can
14320 include any Perl code that you like. The text of the &%warn%& message is passed
14321 as the first subroutine argument.
14322 .ecindex IIDperl
14323
14324
14325 . ////////////////////////////////////////////////////////////////////////////
14326 . ////////////////////////////////////////////////////////////////////////////
14327
14328 .chapter "Starting the daemon and the use of network interfaces" &&&
14329          "CHAPinterfaces" &&&
14330          "Starting the daemon"
14331 .cindex "daemon" "starting"
14332 .cindex "interface" "listening"
14333 .cindex "network interface"
14334 .cindex "interface" "network"
14335 .cindex "IP address" "for listening"
14336 .cindex "daemon" "listening IP addresses"
14337 .cindex "TCP/IP" "setting listening interfaces"
14338 .cindex "TCP/IP" "setting listening ports"
14339 A host that is connected to a TCP/IP network may have one or more physical
14340 hardware network interfaces. Each of these interfaces may be configured as one
14341 or more &"logical"& interfaces, which are the entities that a program actually
14342 works with. Each of these logical interfaces is associated with an IP address.
14343 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14344 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14345 knowledge about the host's interfaces for use in three different circumstances:
14346
14347 .olist
14348 When a listening daemon is started, Exim needs to know which interfaces
14349 and ports to listen on.
14350 .next
14351 When Exim is routing an address, it needs to know which IP addresses
14352 are associated with local interfaces. This is required for the correct
14353 processing of MX lists by removing the local host and others with the
14354 same or higher priority values. Also, Exim needs to detect cases
14355 when an address is routed to an IP address that in fact belongs to the
14356 local host. Unless the &%self%& router option or the &%allow_localhost%&
14357 option of the smtp transport is set (as appropriate), this is treated
14358 as an error situation.
14359 .next
14360 When Exim connects to a remote host, it may need to know which interface to use
14361 for the outgoing connection.
14362 .endlist
14363
14364
14365 Exim's default behaviour is likely to be appropriate in the vast majority
14366 of cases. If your host has only one interface, and you want all its IP
14367 addresses to be treated in the same way, and you are using only the
14368 standard SMTP port, you should not need to take any special action. The
14369 rest of this chapter does not apply to you.
14370
14371 In a more complicated situation you may want to listen only on certain
14372 interfaces, or on different ports, and for this reason there are a number of
14373 options that can be used to influence Exim's behaviour. The rest of this
14374 chapter describes how they operate.
14375
14376 When a message is received over TCP/IP, the interface and port that were
14377 actually used are set in &$received_ip_address$& and &$received_port$&.
14378
14379
14380
14381 .section "Starting a listening daemon" "SECID89"
14382 When a listening daemon is started (by means of the &%-bd%& command line
14383 option), the interfaces and ports on which it listens are controlled by the
14384 following options:
14385
14386 .ilist
14387 &%daemon_smtp_ports%& contains a list of default ports
14388 or service names.
14389 (For backward compatibility, this option can also be specified in the singular.)
14390 .next
14391 &%local_interfaces%& contains list of interface IP addresses on which to
14392 listen. Each item may optionally also specify a port.
14393 .endlist
14394
14395 The default list separator in both cases is a colon, but this can be changed as
14396 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14397 it is usually best to change the separator to avoid having to double all the
14398 colons. For example:
14399 .code
14400 local_interfaces = <; 127.0.0.1 ; \
14401                       192.168.23.65 ; \
14402                       ::1 ; \
14403                       3ffe:ffff:836f::fe86:a061
14404 .endd
14405 There are two different formats for specifying a port along with an IP address
14406 in &%local_interfaces%&:
14407
14408 .olist
14409 The port is added onto the address with a dot separator. For example, to listen
14410 on port 1234 on two different IP addresses:
14411 .code
14412 local_interfaces = <; 192.168.23.65.1234 ; \
14413                       3ffe:ffff:836f::fe86:a061.1234
14414 .endd
14415 .next
14416 The IP address is enclosed in square brackets, and the port is added
14417 with a colon separator, for example:
14418 .code
14419 local_interfaces = <; [192.168.23.65]:1234 ; \
14420                       [3ffe:ffff:836f::fe86:a061]:1234
14421 .endd
14422 .endlist
14423
14424 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14425 default setting contains just one port:
14426 .code
14427 daemon_smtp_ports = smtp
14428 .endd
14429 If more than one port is listed, each interface that does not have its own port
14430 specified listens on all of them. Ports that are listed in
14431 &%daemon_smtp_ports%& can be identified either by name (defined in
14432 &_/etc/services_&) or by number. However, when ports are given with individual
14433 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14434
14435
14436
14437 .section "Special IP listening addresses" "SECID90"
14438 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14439 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14440 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14441 instead of setting up separate listening sockets for each interface. The
14442 default value of &%local_interfaces%& is
14443 .code
14444 local_interfaces = 0.0.0.0
14445 .endd
14446 when Exim is built without IPv6 support; otherwise it is:
14447 .code
14448 local_interfaces = <; ::0 ; 0.0.0.0
14449 .endd
14450 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14451
14452
14453
14454 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14455 The &%-oX%& command line option can be used to override the values of
14456 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14457 instance. Another way of doing this would be to use macros and the &%-D%&
14458 option. However, &%-oX%& can be used by any admin user, whereas modification of
14459 the runtime configuration by &%-D%& is allowed only when the caller is root or
14460 exim.
14461
14462 The value of &%-oX%& is a list of items. The default colon separator can be
14463 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14464 If there are any items that do not
14465 contain dots or colons (that is, are not IP addresses), the value of
14466 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14467 items that do contain dots or colons, the value of &%local_interfaces%& is
14468 replaced by those items. Thus, for example,
14469 .code
14470 -oX 1225
14471 .endd
14472 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14473 whereas
14474 .code
14475 -oX 192.168.34.5.1125
14476 .endd
14477 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14478 (However, since &%local_interfaces%& now contains no items without ports, the
14479 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14480
14481
14482
14483 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14484 .cindex "submissions protocol"
14485 .cindex "ssmtp protocol"
14486 .cindex "smtps protocol"
14487 .cindex "SMTP" "ssmtp protocol"
14488 .cindex "SMTP" "smtps protocol"
14489 Exim supports the use of TLS-on-connect, used by mail clients in the
14490 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14491 For some years, IETF Standards Track documents only blessed the
14492 STARTTLS-based Submission service (port 587) while common practice was to support
14493 the same feature set on port 465, but using TLS-on-connect.
14494 If your installation needs to provide service to mail clients
14495 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14496 the 465 TCP ports.
14497
14498 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14499 service names, connections to those ports must first establish TLS, before
14500 proceeding to the application layer use of the SMTP protocol.
14501
14502 The common use of this option is expected to be
14503 .code
14504 tls_on_connect_ports = 465
14505 .endd
14506 per RFC 8314.
14507 There is also a command line option &%-tls-on-connect%&, which forces all ports
14508 to behave in this way when a daemon is started.
14509
14510 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14511 daemon to listen on those ports. You must still specify them in
14512 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14513 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14514 connections via the daemon.)
14515
14516
14517
14518
14519 .section "IPv6 address scopes" "SECID92"
14520 .cindex "IPv6" "address scopes"
14521 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14522 can, in principle, have the same link-local IPv6 address on different
14523 interfaces. Thus, additional information is needed, over and above the IP
14524 address, to distinguish individual interfaces. A convention of using a
14525 percent sign followed by something (often the interface name) has been
14526 adopted in some cases, leading to addresses like this:
14527 .code
14528 fe80::202:b3ff:fe03:45c1%eth0
14529 .endd
14530 To accommodate this usage, a percent sign followed by an arbitrary string is
14531 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14532 to convert a textual IPv6 address for actual use. This function recognizes the
14533 percent convention in operating systems that support it, and it processes the
14534 address appropriately. Unfortunately, some older libraries have problems with
14535 &[getaddrinfo()]&. If
14536 .code
14537 IPV6_USE_INET_PTON=yes
14538 .endd
14539 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14540 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14541 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14542 function.) Of course, this means that the additional functionality of
14543 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14544
14545 .section "Disabling IPv6" "SECID93"
14546 .cindex "IPv6" "disabling"
14547 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14548 run on a host whose kernel does not support IPv6. The binary will fall back to
14549 using IPv4, but it may waste resources looking up AAAA records, and trying to
14550 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14551 .oindex "&%disable_ipv6%&"
14552 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14553 activities take place. AAAA records are never looked up, and any IPv6 addresses
14554 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14555 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14556 to handle IPv6 literal addresses.
14557
14558 On the other hand, when IPv6 is in use, there may be times when you want to
14559 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14560 option to globally suppress the lookup of AAAA records for specified domains,
14561 and you can use the &%ignore_target_hosts%& generic router option to ignore
14562 IPv6 addresses in an individual router.
14563
14564
14565
14566 .section "Examples of starting a listening daemon" "SECID94"
14567 The default case in an IPv6 environment is
14568 .code
14569 daemon_smtp_ports = smtp
14570 local_interfaces = <; ::0 ; 0.0.0.0
14571 .endd
14572 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14573 Either one or two sockets may be used, depending on the characteristics of
14574 the TCP/IP stack. (This is complicated and messy; for more information,
14575 read the comments in the &_daemon.c_& source file.)
14576
14577 To specify listening on ports 25 and 26 on all interfaces:
14578 .code
14579 daemon_smtp_ports = 25 : 26
14580 .endd
14581 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14582 .code
14583 local_interfaces = <; ::0.25     ; ::0.26 \
14584                       0.0.0.0.25 ; 0.0.0.0.26
14585 .endd
14586 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14587 IPv4 loopback address only:
14588 .code
14589 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14590 .endd
14591 To specify listening on the default port on specific interfaces only:
14592 .code
14593 local_interfaces = 10.0.0.67 : 192.168.34.67
14594 .endd
14595 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14596
14597
14598
14599 .section "Recognizing the local host" "SECTreclocipadd"
14600 The &%local_interfaces%& option is also used when Exim needs to determine
14601 whether or not an IP address refers to the local host. That is, the IP
14602 addresses of all the interfaces on which a daemon is listening are always
14603 treated as local.
14604
14605 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14606 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14607 available interfaces from the operating system, and extracts the relevant
14608 (that is, IPv4 or IPv6) addresses to use for checking.
14609
14610 Some systems set up large numbers of virtual interfaces in order to provide
14611 many virtual web servers. In this situation, you may want to listen for
14612 email on only a few of the available interfaces, but nevertheless treat all
14613 interfaces as local when routing. You can do this by setting
14614 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14615 &"all"& wildcard values. These addresses are recognized as local, but are not
14616 used for listening. Consider this example:
14617 .code
14618 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14619                       192.168.53.235 ; \
14620                       3ffe:2101:12:1:a00:20ff:fe86:a061
14621
14622 extra_local_interfaces = <; ::0 ; 0.0.0.0
14623 .endd
14624 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14625 address, but all available interface addresses are treated as local when
14626 Exim is routing.
14627
14628 In some environments the local host name may be in an MX list, but with an IP
14629 address that is not assigned to any local interface. In other cases it may be
14630 desirable to treat other host names as if they referred to the local host. Both
14631 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14632 This contains host names rather than IP addresses. When a host is referenced
14633 during routing, either via an MX record or directly, it is treated as the local
14634 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14635 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14636
14637
14638
14639 .section "Delivering to a remote host" "SECID95"
14640 Delivery to a remote host is handled by the smtp transport. By default, it
14641 allows the system's TCP/IP functions to choose which interface to use (if
14642 there is more than one) when connecting to a remote host. However, the
14643 &%interface%& option can be set to specify which interface is used. See the
14644 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14645 details.
14646
14647
14648
14649
14650 . ////////////////////////////////////////////////////////////////////////////
14651 . ////////////////////////////////////////////////////////////////////////////
14652
14653 .chapter "Main configuration" "CHAPmainconfig"
14654 .scindex IIDconfima "configuration file" "main section"
14655 .scindex IIDmaiconf "main configuration"
14656 The first part of the runtime configuration file contains three types of item:
14657
14658 .ilist
14659 Macro definitions: These lines start with an upper case letter. See section
14660 &<<SECTmacrodefs>>& for details of macro processing.
14661 .next
14662 Named list definitions: These lines start with one of the words &"domainlist"&,
14663 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14664 section &<<SECTnamedlists>>&.
14665 .next
14666 Main configuration settings: Each setting occupies one line of the file
14667 (with possible continuations). If any setting is preceded by the word
14668 &"hide"&, the &%-bP%& command line option displays its value to admin users
14669 only. See section &<<SECTcos>>& for a description of the syntax of these option
14670 settings.
14671 .endlist
14672
14673 This chapter specifies all the main configuration options, along with their
14674 types and default values. For ease of finding a particular option, they appear
14675 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14676 are now so many options, they are first listed briefly in functional groups, as
14677 an aid to finding the name of the option you are looking for. Some options are
14678 listed in more than one group.
14679
14680 .section "Miscellaneous" "SECID96"
14681 .table2
14682 .row &%add_environment%&             "environment variables"
14683 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14684 .row &%debug_store%&                 "do extra internal checks"
14685 .row &%disable_ipv6%&                "do no IPv6 processing"
14686 .row &%keep_environment%&            "environment variables"
14687 .row &%keep_malformed%&              "for broken files &-- should not happen"
14688 .row &%localhost_number%&            "for unique message ids in clusters"
14689 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14690 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14691 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14692 .row &%print_topbitchars%&           "top-bit characters are printing"
14693 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14694 .row &%timezone%&                    "force time zone"
14695 .endtable
14696
14697
14698 .section "Exim parameters" "SECID97"
14699 .table2
14700 .row &%exim_group%&                  "override compiled-in value"
14701 .row &%exim_path%&                   "override compiled-in value"
14702 .row &%exim_user%&                   "override compiled-in value"
14703 .row &%primary_hostname%&            "default from &[uname()]&"
14704 .row &%split_spool_directory%&       "use multiple directories"
14705 .row &%spool_directory%&             "override compiled-in value"
14706 .endtable
14707
14708
14709
14710 .section "Privilege controls" "SECID98"
14711 .table2
14712 .row &%admin_groups%&                "groups that are Exim admin users"
14713 .row &%commandline_checks_require_admin%& "require admin for various checks"
14714 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14715 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14716 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14717 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14718 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14719 .row &%never_users%&                 "do not run deliveries as these"
14720 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14721 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14722 .row &%trusted_groups%&              "groups that are trusted"
14723 .row &%trusted_users%&               "users that are trusted"
14724 .endtable
14725
14726
14727
14728 .section "Logging" "SECID99"
14729 .table2
14730 .row &%event_action%&                "custom logging"
14731 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14732 .row &%log_file_path%&               "override compiled-in value"
14733 .row &%log_selector%&                "set/unset optional logging"
14734 .row &%log_timezone%&                "add timezone to log lines"
14735 .row &%message_logs%&                "create per-message logs"
14736 .row &%preserve_message_logs%&       "after message completion"
14737 .row &%panic_coredump%&              "request coredump on fatal errors"
14738 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14739 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14740 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14741 .row &%syslog_facility%&             "set syslog &""facility""& field"
14742 .row &%syslog_pid%&                  "pid in syslog lines"
14743 .row &%syslog_processname%&          "set syslog &""ident""& field"
14744 .row &%syslog_timestamp%&            "timestamp syslog lines"
14745 .row &%write_rejectlog%&             "control use of message log"
14746 .endtable
14747
14748
14749
14750 .section "Frozen messages" "SECID100"
14751 .table2
14752 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14753 .row &%freeze_tell%&                 "send message when freezing"
14754 .row &%move_frozen_messages%&        "to another directory"
14755 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14756 .endtable
14757
14758
14759
14760 .section "Data lookups" "SECID101"
14761 .table2
14762 .row &%ibase_servers%&               "InterBase servers"
14763 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14764 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14765 .row &%ldap_cert_file%&              "client cert file for LDAP"
14766 .row &%ldap_cert_key%&               "client key file for LDAP"
14767 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14768 .row &%ldap_default_servers%&        "used if no server in query"
14769 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14770 .row &%ldap_start_tls%&              "require TLS within LDAP"
14771 .row &%ldap_version%&                "set protocol version"
14772 .row &%lookup_open_max%&             "lookup files held open"
14773 .row &%mysql_servers%&               "default MySQL servers"
14774 .row &%oracle_servers%&              "Oracle servers"
14775 .row &%pgsql_servers%&               "default PostgreSQL servers"
14776 .row &%sqlite_lock_timeout%&         "as it says"
14777 .endtable
14778
14779
14780
14781 .section "Message ids" "SECID102"
14782 .table2
14783 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14784 .row &%message_id_header_text%&      "ditto"
14785 .endtable
14786
14787
14788
14789 .section "Embedded Perl Startup" "SECID103"
14790 .table2
14791 .row &%perl_at_start%&               "always start the interpreter"
14792 .row &%perl_startup%&                "code to obey when starting Perl"
14793 .row &%perl_taintmode%&              "enable taint mode in Perl"
14794 .endtable
14795
14796
14797
14798 .section "Daemon" "SECID104"
14799 .table2
14800 .row &%daemon_smtp_ports%&           "default ports"
14801 .row &%daemon_startup_retries%&      "number of times to retry"
14802 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14803 .row &%extra_local_interfaces%&      "not necessarily listened on"
14804 .row &%local_interfaces%&            "on which to listen, with optional ports"
14805 .row &%notifier_socket%&             "override compiled-in value"
14806 .row &%pid_file_path%&               "override compiled-in value"
14807 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14808 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14809 .endtable
14810
14811
14812
14813 .section "Resource control" "SECID105"
14814 .table2
14815 .row &%check_log_inodes%&            "before accepting a message"
14816 .row &%check_log_space%&             "before accepting a message"
14817 .row &%check_spool_inodes%&          "before accepting a message"
14818 .row &%check_spool_space%&           "before accepting a message"
14819 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14820 .row &%queue_only_load%&             "queue incoming if load high"
14821 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14822 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14823 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14824 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14825 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14826 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14827 .row &%smtp_accept_max_per_connection%& "messages per connection"
14828 .row &%smtp_accept_max_per_host%&    "connections from one host"
14829 .row &%smtp_accept_queue%&           "queue mail if more connections"
14830 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14831                                            connection"
14832 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14833 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14834 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14835 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14836 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14837 .endtable
14838
14839
14840
14841 .section "Policy controls" "SECID106"
14842 .table2
14843 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14844 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14845 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14846 .row &%acl_smtp_auth%&               "ACL for AUTH"
14847 .row &%acl_smtp_connect%&            "ACL for connection"
14848 .row &%acl_smtp_data%&               "ACL for DATA"
14849 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14850 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14851 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14852 .row &%acl_smtp_expn%&               "ACL for EXPN"
14853 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14854 .row &%acl_smtp_mail%&               "ACL for MAIL"
14855 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14856 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14857 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14858 .row &%acl_smtp_predata%&            "ACL for start of data"
14859 .row &%acl_smtp_quit%&               "ACL for QUIT"
14860 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14861 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14862 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14863 .row &%acl_smtp_wellknown%&          "ACL for WELLKNOWN"
14864 .row &%av_scanner%&                  "specify virus scanner"
14865 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14866                                       words""&"
14867 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14868 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14869 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14870 .row &%header_maxsize%&              "total size of message header"
14871 .row &%header_line_maxsize%&         "individual header line limit"
14872 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14873 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14874 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14875 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14876 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14877 .row &%host_lookup%&                 "host name looked up for these hosts"
14878 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14879 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14880 .row &%host_reject_connection%&      "reject connection from these hosts"
14881 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14882 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14883 .row &%message_size_limit%&          "for all messages"
14884 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14885 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14886 .row &%spamd_address%&               "set interface to SpamAssassin"
14887 .row &%strict_acl_vars%&             "object to unset ACL variables"
14888 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14889 .endtable
14890
14891
14892
14893 .section "Callout cache" "SECID107"
14894 .table2
14895 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14896                                          item"
14897 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14898                                          item"
14899 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14900 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14901 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14902 .endtable
14903
14904
14905
14906 .section "TLS" "SECID108"
14907 .table2
14908 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14909 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14910 .row &%hosts_require_alpn%&          "mandatory ALPN"
14911 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14912 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14913 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14914 .row &%tls_alpn%&                    "acceptable protocol names"
14915 .row &%tls_certificate%&             "location of server certificate"
14916 .row &%tls_crl%&                     "certificate revocation list"
14917 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14918 .row &%tls_dhparam%&                 "DH parameters for server"
14919 .row &%tls_eccurve%&                 "EC curve selection for server"
14920 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14921 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14922 .row &%tls_privatekey%&              "location of server private key"
14923 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14924 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14925 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14926 .row &%tls_verify_certificates%&     "expected client certificates"
14927 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14928 .endtable
14929
14930
14931
14932 .section "Local user handling" "SECID109"
14933 .table2
14934 .row &%finduser_retries%&            "useful in NIS environments"
14935 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14936 .row &%gecos_pattern%&               "ditto"
14937 .row &%max_username_length%&         "for systems that truncate"
14938 .row &%unknown_login%&               "used when no login name found"
14939 .row &%unknown_username%&            "ditto"
14940 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14941 .row &%uucp_from_sender%&            "ditto"
14942 .endtable
14943
14944
14945
14946 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14947 .table2
14948 .row &%header_maxsize%&              "total size of message header"
14949 .row &%header_line_maxsize%&         "individual header line limit"
14950 .row &%message_size_limit%&          "applies to all messages"
14951 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14952 .row &%received_header_text%&        "expanded to make &'Received:'&"
14953 .row &%received_headers_max%&        "for mail loop detection"
14954 .row &%recipients_max%&              "limit per message"
14955 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14956 .endtable
14957
14958
14959
14960
14961 .section "Non-SMTP incoming messages" "SECID111"
14962 .table2
14963 .row &%receive_timeout%&             "for non-SMTP messages"
14964 .endtable
14965
14966
14967
14968
14969
14970 .section "Incoming SMTP messages" "SECID112"
14971 See also the &'Policy controls'& section above.
14972
14973 .table2
14974 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14975 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14976 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14977 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14978 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14979 .row &%dmarc_history_file%&          "DMARC results log"
14980 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14981 .row &%host_lookup%&                 "host name looked up for these hosts"
14982 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14983 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14984 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14985 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14986 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14987 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14988 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14989 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14990 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14991 .row &%smtp_accept_max_per_connection%& "messages per connection"
14992 .row &%smtp_accept_max_per_host%&    "connections from one host"
14993 .row &%smtp_accept_queue%&           "queue mail if more connections"
14994 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14995                                            connection"
14996 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14997 .row &%smtp_active_hostname%&        "host name to use in messages"
14998 .row &%smtp_banner%&                 "text for welcome banner"
14999 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
15000 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
15001 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
15002 .row &%smtp_etrn_command%&           "what to run for ETRN"
15003 .row &%smtp_etrn_serialize%&         "only one at once"
15004 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
15005 .row &%smtp_max_unknown_commands%&   "before dropping connection"
15006 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
15007 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
15008 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
15009 .row &%smtp_receive_timeout%&        "per command or data line"
15010 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
15011 .row &%smtp_return_error_details%&   "give detail on rejections"
15012 .endtable
15013
15014
15015
15016 .section "SMTP extensions" "SECID113"
15017 .table2
15018 .row &%accept_8bitmime%&             "advertise 8BITMIME"
15019 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
15020 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
15021 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
15022 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
15023 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
15024 .row &%limits_advertise_hosts%&      "advertise LIMITS to these hosts"
15025 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
15026 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
15027 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
15028 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
15029 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
15030 .row &%wellknown_advertise_hosts%&   "advertise WELLKNOWN to these hosts"
15031 .endtable
15032
15033
15034
15035 .section "Processing messages" "SECID114"
15036 .table2
15037 .row &%allow_domain_literals%&       "recognize domain literal syntax"
15038 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
15039 .row &%allow_utf8_domains%&          "in addresses"
15040 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
15041                                       words""&"
15042 .row &%delivery_date_remove%&        "from incoming messages"
15043 .row &%envelope_to_remove%&          "from incoming messages"
15044 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
15045 .row &%headers_charset%&             "default for translations"
15046 .row &%qualify_domain%&              "default for senders"
15047 .row &%qualify_recipient%&           "default for recipients"
15048 .row &%return_path_remove%&          "from incoming messages"
15049 .row &%strip_excess_angle_brackets%& "in addresses"
15050 .row &%strip_trailing_dot%&          "at end of addresses"
15051 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
15052 .endtable
15053
15054
15055
15056 .section "System filter" "SECID115"
15057 .table2
15058 .row &%system_filter%&               "locate system filter"
15059 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
15060                                             directory"
15061 .row &%system_filter_file_transport%& "transport for delivery to a file"
15062 .row &%system_filter_group%&         "group for filter running"
15063 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
15064 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
15065 .row &%system_filter_user%&          "user for filter running"
15066 .endtable
15067
15068
15069
15070 .section "Routing and delivery" "SECID116"
15071 .table2
15072 .row &%disable_ipv6%&                "do no IPv6 processing"
15073 .row &%dns_again_means_nonexist%&    "for broken domains"
15074 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
15075 .row &%dns_dnssec_ok%&               "parameter for resolver"
15076 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
15077 .row &%dns_retrans%&                 "parameter for resolver"
15078 .row &%dns_retry%&                   "parameter for resolver"
15079 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
15080 .row &%dns_use_edns0%&               "parameter for resolver"
15081 .row &%hold_domains%&                "hold delivery for these domains"
15082 .row &%local_interfaces%&            "for routing checks"
15083 .row &%queue_domains%&               "no immediate delivery for these"
15084 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15085 .row &%queue_only%&                  "no immediate delivery at all"
15086 .row &%queue_only_file%&             "no immediate delivery if file exists"
15087 .row &%queue_only_load%&             "no immediate delivery if load is high"
15088 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15089 .row &%queue_only_override%&         "allow command line to override"
15090 .row &%queue_run_in_order%&          "order of arrival"
15091 .row &%queue_run_max%&               "of simultaneous queue runners"
15092 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15093 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15094 .row &%remote_sort_domains%&         "order of remote deliveries"
15095 .row &%retry_data_expire%&           "timeout for retry data"
15096 .row &%retry_interval_max%&          "safety net for retry rules"
15097 .endtable
15098
15099
15100
15101 .section "Bounce and warning messages" "SECID117"
15102 .table2
15103 .row &%bounce_message_file%&         "content of bounce"
15104 .row &%bounce_message_text%&         "content of bounce"
15105 .row &%bounce_return_body%&          "include body if returning message"
15106 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15107 .row &%bounce_return_message%&       "include original message in bounce"
15108 .row &%bounce_return_size_limit%&    "limit on returned message"
15109 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15110 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15111 .row &%errors_copy%&                 "copy bounce messages"
15112 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15113 .row &%delay_warning%&               "time schedule"
15114 .row &%delay_warning_condition%&     "condition for warning messages"
15115 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15116 .row &%smtp_return_error_details%&   "give detail on rejections"
15117 .row &%warn_message_file%&           "content of warning message"
15118 .endtable
15119
15120
15121
15122 .section "Alphabetical list of main options" "SECTalomo"
15123 Those options that undergo string expansion before use are marked with
15124 &dagger;.
15125
15126 .option accept_8bitmime main boolean true
15127 .cindex "8BITMIME"
15128 .cindex "8-bit characters"
15129 .cindex "log" "selectors"
15130 .cindex "log" "8BITMIME"
15131 .cindex "ESMTP extensions" 8BITMIME
15132 This option causes Exim to send 8BITMIME in its response to an SMTP
15133 EHLO command, and to accept the BODY= parameter on MAIL commands.
15134 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15135 takes no steps to do anything special with messages received by this route.
15136
15137 Historically Exim kept this option off by default, but the maintainers
15138 feel that in today's Internet, this causes more problems than it solves.
15139 It now defaults to true.
15140 A more detailed analysis of the issues is provided by Dan Bernstein:
15141 .display
15142 &url(https://cr.yp.to/smtp/8bitmime.html)
15143 .endd
15144
15145 To log received 8BITMIME status use
15146 .code
15147 log_selector = +8bitmime
15148 .endd
15149
15150 .option acl_not_smtp main string&!! unset
15151 .cindex "&ACL;" "for non-SMTP messages"
15152 .cindex "non-SMTP messages" "ACLs for"
15153 This option defines the ACL that is run when a non-SMTP message has been
15154 read and is on the point of being accepted. See section &<<SECnonSMTP>>& for
15155 further details.
15156
15157 .option acl_not_smtp_mime main string&!! unset
15158 This option defines the ACL that is run for individual MIME parts of non-SMTP
15159 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15160 SMTP messages.
15161
15162 .option acl_not_smtp_start main string&!! unset
15163 .cindex "&ACL;" "at start of non-SMTP message"
15164 .cindex "non-SMTP messages" "ACLs for"
15165 This option defines the ACL that is run before Exim starts reading a
15166 non-SMTP message. See section &<<SECnonSMTP>>& for further details.
15167
15168 .option acl_smtp_auth main string&!! unset
15169 .cindex "&ACL;" "setting up for SMTP commands"
15170 .cindex "AUTH" "ACL for"
15171 This option defines the ACL that is run when an SMTP AUTH command is
15172 received.
15173 See chapter &<<CHAPACL>>& for general information on ACLs, and chapter
15174 &<<CHAPSMTPAUTH>>& for details of authentication.
15175
15176 .option acl_smtp_connect main string&!! unset
15177 .cindex "&ACL;" "on SMTP connection"
15178 This option defines the ACL that is run when an SMTP connection is received.
15179 See section &<<SECconnectACL>>& for further details.
15180
15181 .option acl_smtp_data main string&!! unset
15182 .cindex "DATA" "ACL for"
15183 This option defines the ACL that is run after an SMTP DATA command has been
15184 processed and the message itself has been received, but before the final
15185 acknowledgment is sent. See section &<<SECdataACLS>>& for further details.
15186
15187 .option acl_smtp_data_prdr main string&!! accept
15188 .cindex "PRDR" "ACL for"
15189 .cindex "DATA" "PRDR ACL for"
15190 .cindex "&ACL;" "PRDR-related"
15191 .cindex "&ACL;" "per-user data processing"
15192 This option defines the ACL that,
15193 if the PRDR feature has been negotiated,
15194 is run for each recipient after an SMTP DATA command has been
15195 processed and the message itself has been received, but before the
15196 acknowledgment is sent. See section &<<SECTPRDRACL>>& for further details.
15197
15198 .option acl_smtp_dkim main string&!! unset
15199 .cindex DKIM "ACL for"
15200 This option defines the ACL that is run for each DKIM signature
15201 (by default, or as specified in the dkim_verify_signers option)
15202 of a received message.
15203 See section &<<SECDKIMVFY>>& for further details.
15204
15205 .option acl_smtp_etrn main string&!! unset
15206 .cindex "ETRN" "ACL for"
15207 .cindex "ETRN" advertisement
15208 This option defines the ACL that is run when an SMTP ETRN command is
15209 received.
15210 If no value is set then the ETRN facility is not advertised.
15211 See chapter &<<CHAPACL>>& for further details.
15212
15213 .option acl_smtp_expn main string&!! unset
15214 .cindex "EXPN" "ACL for"
15215 This option defines the ACL that is run when an SMTP EXPN command is
15216 received. See chapter &<<CHAPACL>>& for further details.
15217
15218 .option acl_smtp_helo main string&!! unset
15219 .cindex "EHLO" "ACL for"
15220 .cindex "HELO" "ACL for"
15221 This option defines the ACL that is run when an SMTP EHLO or HELO
15222 command is received. See section &<<SECheloACL>>& for further details.
15223
15224
15225 .option acl_smtp_mail main string&!! unset
15226 .cindex "MAIL" "ACL for"
15227 This option defines the ACL that is run when an SMTP MAIL command is
15228 received. See chapter &<<CHAPACL>>& for further details.
15229
15230 .option acl_smtp_mailauth main string&!! unset
15231 .cindex "AUTH" "on MAIL command"
15232 This option defines the ACL that is run when there is an AUTH parameter on
15233 a MAIL command.
15234 See chapter &<<CHAPACL>>& for general information on ACLs, and chapter
15235 &<<CHAPSMTPAUTH>>& for details of authentication.
15236
15237 .option acl_smtp_mime main string&!! unset
15238 .cindex "MIME content scanning" "ACL for"
15239 This option is available when Exim is built with the content-scanning
15240 extension. It defines the ACL that is run for each MIME part in a message. See
15241 section &<<SECTscanmimepart>>& for details.
15242
15243 .option acl_smtp_notquit main string&!! unset
15244 .cindex "not-QUIT, ACL for"
15245 This option defines the ACL that is run when an SMTP session
15246 ends without a QUIT command being received.
15247 See section &<<SECTNOTQUITACL>>& for further details.
15248
15249 .option acl_smtp_predata main string&!! unset
15250 This option defines the ACL that is run when an SMTP DATA command is
15251 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15252 further details.
15253
15254 .option acl_smtp_quit main string&!! unset
15255 .cindex "QUIT, ACL for"
15256 This option defines the ACL that is run when an SMTP QUIT command is
15257 received. See chapter &<<CHAPACL>>& for further details.
15258
15259 .option acl_smtp_rcpt main string&!! unset
15260 .cindex "RCPT" "ACL for"
15261 This option defines the ACL that is run when an SMTP RCPT command is
15262 received. See section &<<SECTQUITACL>>& for further details.
15263
15264 .option acl_smtp_starttls main string&!! unset
15265 .cindex "STARTTLS, ACL for"
15266 This option defines the ACL that is run when an SMTP STARTTLS command is
15267 received. See chapter &<<CHAPACL>>& for further details.
15268
15269 .option acl_smtp_vrfy main string&!! unset
15270 .cindex "VRFY" "ACL for"
15271 This option defines the ACL that is run when an SMTP VRFY command is
15272 received. See chapter &<<CHAPACL>>& for further details.
15273
15274 .option acl_smtp_wellknown main string&!! unset
15275 .cindex "WELLKNOWN, ACL for"
15276 This option defines the ACL that is run when an SMTP WELLKNOWN command is
15277 received. See section &<<SECTWELLKNOWNACL>>& for further details.
15278
15279 .option add_environment main "string list" empty
15280 .cindex "environment" "set values"
15281 This option adds individual environment variables that the
15282 currently linked libraries and programs in child processes may use.
15283 Each list element should be of the form &"name=value"&.
15284
15285 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15286
15287 .option admin_groups main "string list&!!" unset
15288 .cindex "admin user"
15289 This option is expanded just once, at the start of Exim's processing. If the
15290 current group or any of the supplementary groups of an Exim caller is in this
15291 colon-separated list, the caller has admin privileges. If all your system
15292 programmers are in a specific group, for example, you can give them all Exim
15293 admin privileges by putting that group in &%admin_groups%&. However, this does
15294 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15295 To permit this, you have to add individuals to the Exim group.
15296
15297 .option allow_domain_literals main boolean false
15298 .cindex "domain literal"
15299 If this option is set, the RFC 2822 domain literal format is permitted in
15300 email addresses. The option is not set by default, because the domain literal
15301 format is not normally required these days, and few people know about it. It
15302 has, however, been exploited by mail abusers.
15303
15304 Unfortunately, it seems that some DNS black list maintainers are using this
15305 format to report black listing to postmasters. If you want to accept messages
15306 addressed to your hosts by IP address, you need to set
15307 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15308 domains (defined in the named domain list &%local_domains%& in the default
15309 configuration). This &"magic string"& matches the domain literal form of all
15310 the local host's IP addresses.
15311
15312 .option allow_mx_to_ip main boolean false
15313 .cindex "MX record" "pointing to IP address"
15314 It appears that more and more DNS zone administrators are breaking the rules
15315 and putting domain names that look like IP addresses on the right hand side of
15316 MX records. Exim follows the rules and rejects this, giving an error message
15317 that explains the misconfiguration. However, some other MTAs support this
15318 practice, so to avoid &"Why can't Exim do this?"& complaints,
15319 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15320 recommended, except when you have no other choice.
15321
15322 .option allow_utf8_domains main boolean false
15323 .cindex "domain" "UTF-8 characters in"
15324 .cindex "UTF-8" "in domain name"
15325 Lots of discussion is going on about internationalized domain names. One
15326 camp is strongly in favour of just using UTF-8 characters, and it seems
15327 that at least two other MTAs permit this.
15328 This option allows Exim users to experiment if they wish.
15329
15330 If it is set true, Exim's domain parsing function allows valid
15331 UTF-8 multicharacters to appear in domain name components, in addition to
15332 letters, digits, and hyphens.
15333
15334 If Exim is built with internationalization support
15335 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15336 this option can be left as default.
15337 Without that,
15338 if you want to look up such domain names in the DNS, you must also
15339 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15340 suitable setting is:
15341 .code
15342 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15343   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15344 .endd
15345 Alternatively, you can just disable this feature by setting
15346 .code
15347 dns_check_names_pattern =
15348 .endd
15349 That is, set the option to an empty string so that no check is done.
15350
15351
15352 .option auth_advertise_hosts main "host list&!!" *
15353 .cindex "authentication" "advertising"
15354 .cindex "AUTH" "advertising"
15355 .cindex "ESMTP extensions" AUTH
15356 If any server authentication mechanisms are configured, Exim advertises them in
15357 response to an EHLO command only if the calling host matches this list.
15358 Otherwise, Exim does not advertise AUTH.
15359 Exim does not accept AUTH commands from clients to which it has not
15360 advertised the availability of AUTH. The advertising of individual
15361 authentication mechanisms can be controlled by the use of the
15362 &%server_advertise_condition%& generic authenticator option on the individual
15363 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15364
15365 Certain mail clients (for example, Netscape) require the user to provide a name
15366 and password for authentication if AUTH is advertised, even though it may
15367 not be needed (the host may accept messages from hosts on its local LAN without
15368 authentication, for example). The &%auth_advertise_hosts%& option can be used
15369 to make these clients more friendly by excluding them from the set of hosts to
15370 which Exim advertises AUTH.
15371
15372 .cindex "AUTH" "advertising when encrypted"
15373 If you want to advertise the availability of AUTH only when the connection
15374 is encrypted using TLS, you can make use of the fact that the value of this
15375 option is expanded, with a setting like this:
15376 .code
15377 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15378 .endd
15379 .vindex "&$tls_in_cipher$&"
15380 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15381 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15382 expansion is *, which matches all hosts.
15383
15384
15385 .option auto_thaw main time 0s
15386 .cindex "thawing messages"
15387 .cindex "unfreezing messages"
15388 If this option is set to a time greater than zero, a queue runner will try a
15389 new delivery attempt on any frozen message, other than a bounce message, if
15390 this much time has passed since it was frozen. This may result in the message
15391 being re-frozen if nothing has changed since the last attempt. It is a way of
15392 saying &"keep on trying, even though there are big problems"&.
15393
15394 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15395 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15396 thought to be very useful any more, and its use should probably be avoided.
15397
15398
15399 .option av_scanner main string "see below"
15400 This option is available if Exim is built with the content-scanning extension.
15401 It specifies which anti-virus scanner to use. The default value is:
15402 .code
15403 sophie:/var/run/sophie
15404 .endd
15405 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15406 before use. See section &<<SECTscanvirus>>& for further details.
15407
15408
15409 .option bi_command main string unset
15410 .oindex "&%-bi%&"
15411 This option supplies the name of a command that is run when Exim is called with
15412 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15413 just the command name, it is not a complete command line. If an argument is
15414 required, it must come from the &%-oA%& command line option.
15415
15416
15417 .option bounce_message_file main string&!! unset
15418 .cindex "bounce message" "customizing"
15419 .cindex "customizing" "bounce message"
15420 This option defines a template file containing paragraphs of text to be used
15421 for constructing bounce messages.  Details of the file's contents are given in
15422 chapter &<<CHAPemsgcust>>&.
15423 .cindex bounce_message_file "tainted data"
15424 The option is expanded to give the file path, which must be
15425 absolute and untainted.
15426 See also &%warn_message_file%&.
15427
15428
15429 .option bounce_message_text main string unset
15430 When this option is set, its contents are included in the default bounce
15431 message immediately after &"This message was created automatically by mail
15432 delivery software."& It is not used if &%bounce_message_file%& is set.
15433
15434 .option bounce_return_body main boolean true
15435 .cindex "bounce message" "including body"
15436 This option controls whether the body of an incoming message is included in a
15437 bounce message when &%bounce_return_message%& is true. The default setting
15438 causes the entire message, both header and body, to be returned (subject to the
15439 value of &%bounce_return_size_limit%&). If this option is false, only the
15440 message header is included. In the case of a non-SMTP message containing an
15441 error that is detected during reception, only those header lines preceding the
15442 point at which the error was detected are returned.
15443 .cindex "bounce message" "including original"
15444
15445 .option bounce_return_linesize_limit main integer 998
15446 .cindex "size" "of bounce lines, limit"
15447 .cindex "bounce message" "line length limit"
15448 .cindex "limit" "bounce message line length"
15449 This option sets a limit in bytes on the line length of messages
15450 that are returned to senders due to delivery problems,
15451 when &%bounce_return_message%& is true.
15452 The default value corresponds to RFC limits.
15453 If the message being returned has lines longer than this value it is
15454 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15455
15456 The option also applies to bounces returned when an error is detected
15457 during reception of a message.
15458 In this case lines from the original are truncated.
15459
15460 The option does not apply to messages generated by an &(autoreply)& transport.
15461
15462
15463 .option bounce_return_message main boolean true
15464 If this option is set false, none of the original message is included in
15465 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15466 &%bounce_return_body%&.
15467
15468
15469 .option bounce_return_size_limit main integer 100K
15470 .cindex "size" "of bounce, limit"
15471 .cindex "bounce message" "size limit"
15472 .cindex "limit" "bounce message size"
15473 This option sets a limit in bytes on the size of messages that are returned to
15474 senders as part of bounce messages when &%bounce_return_message%& is true. The
15475 limit should be less than the value of the global &%message_size_limit%& and of
15476 any &%message_size_limit%& settings on transports, to allow for the bounce text
15477 that Exim generates. If this option is set to zero there is no limit.
15478
15479 When the body of any message that is to be included in a bounce message is
15480 greater than the limit, it is truncated, and a comment pointing this out is
15481 added at the top. The actual cutoff may be greater than the value given, owing
15482 to the use of buffering for transferring the message in chunks (typically 8K in
15483 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15484 messages.
15485
15486 .option bounce_sender_authentication main string unset
15487 .cindex "bounce message" "sender authentication"
15488 .cindex "authentication" "bounce message"
15489 .cindex "AUTH" "on bounce message"
15490 This option provides an authenticated sender address that is sent with any
15491 bounce messages generated by Exim that are sent over an authenticated SMTP
15492 connection. A typical setting might be:
15493 .code
15494 bounce_sender_authentication = mailer-daemon@my.domain.example
15495 .endd
15496 which would cause bounce messages to be sent using the SMTP command:
15497 .code
15498 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15499 .endd
15500 The value of &%bounce_sender_authentication%& must always be a complete email
15501 address.
15502
15503 .option callout_domain_negative_expire main time 3h
15504 .cindex "caching" "callout timeouts"
15505 .cindex "callout" "caching timeouts"
15506 This option specifies the expiry time for negative callout cache data for a
15507 domain. See section &<<SECTcallver>>& for details of callout verification, and
15508 section &<<SECTcallvercache>>& for details of the caching.
15509
15510
15511 .option callout_domain_positive_expire main time 7d
15512 This option specifies the expiry time for positive callout cache data for a
15513 domain. See section &<<SECTcallver>>& for details of callout verification, and
15514 section &<<SECTcallvercache>>& for details of the caching.
15515
15516
15517 .option callout_negative_expire main time 2h
15518 This option specifies the expiry time for negative callout cache data for an
15519 address. See section &<<SECTcallver>>& for details of callout verification, and
15520 section &<<SECTcallvercache>>& for details of the caching.
15521
15522
15523 .option callout_positive_expire main time 24h
15524 This option specifies the expiry time for positive callout cache data for an
15525 address. See section &<<SECTcallver>>& for details of callout verification, and
15526 section &<<SECTcallvercache>>& for details of the caching.
15527
15528
15529 .option callout_random_local_part main string&!! "see below"
15530 This option defines the &"random"& local part that can be used as part of
15531 callout verification. The default value is
15532 .code
15533 $primary_hostname-$tod_epoch-testing
15534 .endd
15535 See section &<<CALLaddparcall>>& for details of how this value is used.
15536
15537
15538 .options check_log_inodes main integer 100 &&&
15539          check_log_space main integer 10M
15540 See &%check_spool_space%& below.
15541
15542 .oindex "&%check_rfc2047_length%&"
15543 .cindex "RFC 2047" "disabling length check"
15544 .option check_rfc2047_length main boolean true
15545 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15546 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15547 word; strings to be encoded that exceed this length are supposed to use
15548 multiple encoded words. By default, Exim does not recognize encoded words that
15549 exceed the maximum length. However, it seems that some software, in violation
15550 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15551 set false, Exim recognizes encoded words of any length.
15552
15553
15554 .options check_spool_inodes main integer 100 &&&
15555          check_spool_space main integer 10M
15556 .cindex "checking disk space"
15557 .cindex "disk space, checking"
15558 .cindex "spool directory" "checking space"
15559 The four &%check_...%& options allow for checking of disk resources before a
15560 message is accepted.
15561
15562 .vindex "&$log_inodes$&"
15563 .vindex "&$log_space$&"
15564 .vindex "&$spool_inodes$&"
15565 .vindex "&$spool_space$&"
15566 When any of these options are nonzero, they apply to all incoming messages. If you
15567 want to apply different checks to different kinds of message, you can do so by
15568 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15569 &$spool_space$& in an ACL with appropriate additional conditions.
15570
15571
15572 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15573 either value is greater than zero, for example:
15574 .code
15575 check_spool_space = 100M
15576 check_spool_inodes = 100
15577 .endd
15578 The spool partition is the one that contains the directory defined by
15579 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15580 transit.
15581
15582 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15583 files are written if either is greater than zero. These should be set only if
15584 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15585
15586 If there is less space or fewer inodes than requested, Exim refuses to accept
15587 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15588 error response to the MAIL command. If ESMTP is in use and there was a
15589 SIZE parameter on the MAIL command, its value is added to the
15590 &%check_spool_space%& value, and the check is performed even if
15591 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15592
15593 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15594 number of kilobytes (though specified in bytes).
15595 If a non-multiple of 1024 is specified, it is rounded up.
15596
15597 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15598 failure a message is written to stderr and Exim exits with a non-zero code, as
15599 it obviously cannot send an error message of any kind.
15600
15601 There is a slight performance penalty for these checks.
15602 Versions of Exim preceding 4.88 had these disabled by default;
15603 high-rate installations confident they will never run out of resources
15604 may wish to deliberately disable them.
15605
15606 .option chunking_advertise_hosts main "host list&!!" *
15607 .cindex CHUNKING advertisement
15608 .cindex "RFC 3030" "CHUNKING"
15609 .cindex "ESMTP extensions" CHUNKING
15610 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15611 these hosts.
15612 Hosts may use the BDAT command as an alternate to DATA.
15613
15614 .option commandline_checks_require_admin main boolean &`false`&
15615 .cindex "restricting access to features"
15616 This option restricts various basic checking features to require an
15617 administrative user.
15618 This affects most of the &%-b*%& options, such as &%-be%&.
15619
15620 .option debug_store main boolean &`false`&
15621 .cindex debugging "memory corruption"
15622 .cindex memory debugging
15623 This option, when true, enables extra checking in Exim's internal memory
15624 management.  For use when a memory corruption issue is being investigated,
15625 it should normally be left as default.
15626
15627 .option daemon_smtp_ports main string &`smtp`&
15628 .cindex "port" "for daemon"
15629 .cindex "TCP/IP" "setting listening ports"
15630 This option specifies one or more default SMTP ports on which the Exim daemon
15631 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15632 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15633
15634 .options daemon_startup_retries main integer 9 &&&
15635          daemon_startup_sleep main time 30s
15636 .cindex "daemon startup, retrying"
15637 These options control the retrying done by
15638 the daemon at startup when it cannot immediately bind a listening socket
15639 (typically because the socket is already in use): &%daemon_startup_retries%&
15640 defines the number of retries after the first failure, and
15641 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15642
15643 .option delay_warning main "time list" 24h
15644 .cindex "warning of delay"
15645 .cindex "delay warning, specifying"
15646 .cindex "queue" "delay warning"
15647 When a message is delayed, Exim sends a warning message to the sender at
15648 intervals specified by this option. The data is a colon-separated list of times
15649 after which to send warning messages. If the value of the option is an empty
15650 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15651 message has been in the queue for longer than the last time, the last interval
15652 between the times is used to compute subsequent warning times. For example,
15653 with
15654 .code
15655 delay_warning = 4h:8h:24h
15656 .endd
15657 the first message is sent after 4 hours, the second after 8 hours, and
15658 the third one after 24 hours. After that, messages are sent every 16 hours,
15659 because that is the interval between the last two times on the list. If you set
15660 just one time, it specifies the repeat interval. For example, with:
15661 .code
15662 delay_warning = 6h
15663 .endd
15664 messages are repeated every six hours. To stop warnings after a given time, set
15665 a very large time at the end of the list. For example:
15666 .code
15667 delay_warning = 2h:12h:99d
15668 .endd
15669 Note that the option is only evaluated at the time a delivery attempt fails,
15670 which depends on retry and queue-runner configuration.
15671 Typically retries will be configured more frequently than warning messages.
15672
15673 .option delay_warning_condition main string&!! "see below"
15674 .vindex "&$domain$&"
15675 The string is expanded at the time a warning message might be sent. If all the
15676 deferred addresses have the same domain, it is set in &$domain$& during the
15677 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15678 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15679 &"false"& (the comparison being done caselessly) then the warning message is
15680 not sent. The default is:
15681 .code
15682 delay_warning_condition = ${if or {\
15683   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15684   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15685   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15686   } {no}{yes}}
15687 .endd
15688 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15689 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15690 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15691 &"auto-replied"& in an &'Auto-Submitted:'& header.
15692
15693 .option deliver_drop_privilege main boolean false
15694 .cindex "unprivileged delivery"
15695 .cindex "delivery" "unprivileged"
15696 If this option is set true, Exim drops its root privilege at the start of a
15697 delivery process, and runs as the Exim user throughout. This severely restricts
15698 the kinds of local delivery that are possible, but is viable in certain types
15699 of configuration. There is a discussion about the use of root privilege in
15700 chapter &<<CHAPsecurity>>&.
15701
15702 .option deliver_queue_load_max main fixed-point unset
15703 .cindex "load average"
15704 .cindex "queue runner" "abandoning"
15705 When this option is set, a queue run is abandoned if the system load average
15706 becomes greater than the value of the option. The option has no effect on
15707 ancient operating systems on which Exim cannot determine the load average.
15708 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15709
15710
15711 .option delivery_date_remove main boolean true
15712 .cindex "&'Delivery-date:'& header line"
15713 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15714 message when it is delivered, in exactly the same way as &'Return-path:'& is
15715 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15716 should not be present in incoming messages, and this option causes them to be
15717 removed at the time the message is received, to avoid any problems that might
15718 occur when a delivered message is subsequently sent on to some other recipient.
15719
15720 .option disable_fsync main boolean false
15721 .cindex "&[fsync()]&, disabling"
15722 This option is available only if Exim was built with the compile-time option
15723 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15724 a runtime configuration generates an &"unknown option"& error. You should not
15725 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15726 really, really, really understand what you are doing. &'No pre-compiled
15727 distributions of Exim should ever make this option available.'&
15728
15729 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15730 updated files' data to be written to disc before continuing. Unexpected events
15731 such as crashes and power outages may cause data to be lost or scrambled.
15732 Here be Dragons. &*Beware.*&
15733
15734
15735 .option disable_ipv6 main boolean false
15736 .cindex "IPv6" "disabling"
15737 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15738 activities take place. AAAA records are never looked up, and any IPv6 addresses
15739 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15740 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15741 to handle IPv6 literal addresses.
15742
15743
15744 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15745 .cindex DKIM "selecting signature algorithms"
15746 This option gives a list of hash types which are acceptable in signatures,
15747 and an order of processing.
15748 Signatures with algorithms not in the list will be ignored.
15749
15750 Acceptable values include:
15751 .code
15752 sha1
15753 sha256
15754 sha512
15755 .endd
15756
15757 Note that the acceptance of sha1 violates RFC 8301.
15758
15759 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15760 This option gives a list of key types which are acceptable in signatures,
15761 and an order of processing.
15762 Signatures with algorithms not in the list will be ignored.
15763
15764
15765 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15766 This option gives a list of key sizes which are acceptable in signatures.
15767 The list is keyed by the algorithm type for the key; the values are in bits.
15768 Signatures with keys smaller than given by this option will fail verification.
15769
15770 The default enforces the RFC 8301 minimum key size for RSA signatures.
15771
15772 .option dkim_verify_minimal main boolean false
15773 If set to true, verification of signatures will terminate after the
15774 first success.
15775
15776 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15777 .cindex DKIM "controlling calls to the ACL"
15778 This option gives a list of DKIM domains for which the DKIM ACL is run.
15779 It is expanded after the message is received; by default it runs
15780 the ACL once for each signature in the message.
15781 See section &<<SECDKIMVFY>>&.
15782
15783
15784 .option dmarc_forensic_sender main string&!! unset &&&
15785         dmarc_history_file main string unset &&&
15786         dmarc_tld_file main string unset
15787 .cindex DMARC "main section options"
15788 These options control DMARC processing.
15789 See section &<<SECDMARC>>& for details.
15790
15791
15792 .option dns_again_means_nonexist main "domain list&!!" unset
15793 .cindex "DNS" "&""try again""& response; overriding"
15794 DNS lookups give a &"try again"& response for the DNS errors
15795 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15796 keep trying to deliver a message, or to give repeated temporary errors to
15797 incoming mail. Sometimes the effect is caused by a badly set up name server and
15798 may persist for a long time. If a domain which exhibits this problem matches
15799 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15800 This option should be used with care. You can make it apply to reverse lookups
15801 by a setting such as this:
15802 .code
15803 dns_again_means_nonexist = *.in-addr.arpa
15804 .endd
15805 This option applies to all DNS lookups that Exim does,
15806 except for TLSA lookups (where knowing about such failures
15807 is security-relevant).
15808 It also applies when the
15809 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15810 since these are most likely to be caused by DNS lookup problems. The
15811 &(dnslookup)& router has some options of its own for controlling what happens
15812 when lookups for MX or SRV records give temporary errors. These more specific
15813 options are applied after this global option.
15814
15815 .option dns_check_names_pattern main string "see below"
15816 .cindex "DNS" "pre-check of name syntax"
15817 When this option is set to a non-empty string, it causes Exim to check domain
15818 names for characters that are not allowed in host names before handing them to
15819 the DNS resolver, because some resolvers give temporary errors for names that
15820 contain unusual characters. If a domain name contains any unwanted characters,
15821 a &"not found"& result is forced, and the resolver is not called. The check is
15822 done by matching the domain name against a regular expression, which is the
15823 value of this option. The default pattern is
15824 .code
15825 dns_check_names_pattern = \
15826   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15827 .endd
15828 which permits only letters, digits, slashes, and hyphens in components, but
15829 they must start and end with a letter or digit. Slashes are not, in fact,
15830 permitted in host names, but they are found in certain NS records (which can be
15831 accessed in Exim by using a &%dnsdb%& lookup). If you set
15832 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15833 empty string.
15834
15835 .option dns_csa_search_limit main integer 5
15836 This option controls the depth of parental searching for CSA SRV records in the
15837 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15838
15839 .option dns_csa_use_reverse main boolean true
15840 This option controls whether or not an IP address, given as a CSA domain, is
15841 reversed and looked up in the reverse DNS, as described in more detail in
15842 section &<<SECTverifyCSA>>&.
15843
15844 .option dns_cname_loops main integer 1
15845 .cindex DNS "CNAME following"
15846 This option controls the following of CNAME chains, needed if the resolver does
15847 not do it internally.
15848 As of 2018 most should, and the default can be left.
15849 If you have an ancient one, a value of 10 is likely needed.
15850
15851 The default value of one CNAME-follow is needed
15852 thanks to the observed return for an MX request,
15853 given no MX presence but a CNAME to an A, of the CNAME.
15854
15855
15856 .option dns_dnssec_ok main integer -1
15857 .cindex "DNS" "resolver options"
15858 .cindex "DNS" "DNSSEC"
15859 If this option is set to a non-negative number then Exim will initialise the
15860 DNS resolver library to either use or not use DNSSEC, overriding the system
15861 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15862
15863 If the resolver library does not support DNSSEC then this option has no effect.
15864
15865 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15866 will default to stripping out a successful validation status.
15867 This will break a previously working Exim installation.
15868 Provided that you do trust the resolver (ie, is on localhost) you can tell
15869 glibc to pass through any successful validation with a new option in
15870 &_/etc/resolv.conf_&:
15871 .code
15872 options trust-ad
15873 .endd
15874
15875
15876 .option dns_ipv4_lookup main "domain list&!!" unset
15877 .cindex "IPv6" "DNS lookup for AAAA records"
15878 .cindex "DNS" "IPv6 lookup for AAAA records"
15879 .cindex DNS "IPv6 disabling"
15880 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15881 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15882 (A records) when trying to find IP addresses for hosts, unless the host's
15883 domain matches this list.
15884
15885 This is a fudge to help with name servers that give big delays or otherwise do
15886 not work for the AAAA record type. In due course, when the world's name
15887 servers have all been upgraded, there should be no need for this option.
15888 Note that all lookups, including those done for verification, are affected;
15889 this will result in verify failure for IPv6 connections or ones using names
15890 only valid for IPv6 addresses.
15891
15892
15893 .option dns_retrans main time 0s
15894 .cindex "DNS" "resolver options"
15895 .cindex timeout "dns lookup"
15896 .cindex "DNS" timeout
15897 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15898 retransmission and retry parameters for DNS lookups. Values of zero (the
15899 defaults) leave the system default settings unchanged. The first value is the
15900 time between retries, and the second is the number of retries. It isn't
15901 totally clear exactly how these settings affect the total time a DNS lookup may
15902 take. I haven't found any documentation about timeouts on DNS lookups; these
15903 parameter values are available in the external resolver interface structure,
15904 but nowhere does it seem to describe how they are used or what you might want
15905 to set in them.
15906 See also the &%slow_lookup_log%& option.
15907
15908
15909 .option dns_retry main integer 0
15910 See &%dns_retrans%& above.
15911
15912
15913 .option dns_trust_aa main "domain list&!!" unset
15914 .cindex "DNS" "resolver options"
15915 .cindex "DNS" "DNSSEC"
15916 If this option is set then lookup results marked with the AA bit
15917 (Authoritative Answer) are trusted the same way as if they were
15918 DNSSEC-verified. The authority section's name of the answer must
15919 match with this expanded domain list.
15920
15921 Use this option only if you talk directly to a resolver that is
15922 authoritative for some zones and does not set the AD (Authentic Data)
15923 bit in the answer. Some DNS servers may have an configuration option to
15924 mark the answers from their own zones as verified (they set the AD bit).
15925 Others do not have this option. It is considered as poor practice using
15926 a resolver that is an authoritative server for some zones.
15927
15928 Use this option only if you really have to (e.g. if you want
15929 to use DANE for remote delivery to a server that is listed in the DNS
15930 zones that your resolver is authoritative for).
15931
15932 If the DNS answer packet has the AA bit set and contains resource record
15933 in the answer section, the name of the first NS record appearing in the
15934 authority section is compared against the list. If the answer packet is
15935 authoritative but the answer section is empty, the name of the first SOA
15936 record in the authoritative section is used instead.
15937
15938 .cindex "DNS" "resolver options"
15939 .option dns_use_edns0 main integer -1
15940 .cindex "DNS" "resolver options"
15941 .cindex "DNS" "EDNS0"
15942 .cindex "DNS" "OpenBSD
15943 If this option is set to a non-negative number then Exim will initialise the
15944 DNS resolver library to either use or not use EDNS0 extensions, overriding
15945 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15946 on.
15947
15948 If the resolver library does not support EDNS0 then this option has no effect.
15949
15950 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15951 means that DNSSEC will not work with Exim on that platform either, unless Exim
15952 is linked against an alternative DNS client library.
15953
15954
15955 .option drop_cr main boolean false
15956 This is an obsolete option that is now a no-op. It used to affect the way Exim
15957 handled CR and LF characters in incoming messages. What happens now is
15958 described in section &<<SECTlineendings>>&.
15959
15960 .option dsn_advertise_hosts main "host list&!!" unset
15961 .cindex "bounce messages" "success"
15962 .cindex "DSN" "success"
15963 .cindex "Delivery Status Notification" "success"
15964 .cindex "ESMTP extensions" DSN
15965 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15966 and accepted from, these hosts.
15967 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15968 and RET and ENVID options on MAIL FROM commands.
15969 A NOTIFY=SUCCESS option requests success-DSN messages.
15970 A NOTIFY= option with no argument requests that no delay or failure DSNs
15971 are sent.
15972 &*Note*&: Supplying success-DSN messages has been criticised
15973 on privacy grounds; it can leak details of internal forwarding.
15974
15975 .option dsn_from main "string&!!" "see below"
15976 .cindex "&'From:'& header line" "in bounces"
15977 .cindex "bounce messages" "&'From:'& line, specifying"
15978 This option can be used to vary the contents of &'From:'& header lines in
15979 bounces and other automatically generated messages (&"Delivery Status
15980 Notifications"& &-- hence the name of the option). The default setting is:
15981 .code
15982 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15983 .endd
15984 The value is expanded every time it is needed. If the expansion fails, a
15985 panic is logged, and the default value is used.
15986
15987 .option envelope_to_remove main boolean true
15988 .cindex "&'Envelope-to:'& header line"
15989 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15990 message when it is delivered, in exactly the same way as &'Return-path:'& is
15991 handled. &'Envelope-to:'& records the original recipient address from the
15992 message's envelope that caused the delivery to happen. Such headers should not
15993 be present in incoming messages, and this option causes them to be removed at
15994 the time the message is received, to avoid any problems that might occur when a
15995 delivered message is subsequently sent on to some other recipient.
15996
15997
15998 .option errors_copy main "string list&!!" unset
15999 .cindex "bounce message" "copy to other address"
16000 .cindex "copy of bounce message"
16001 Setting this option causes Exim to send bcc copies of bounce messages that it
16002 generates to other addresses. &*Note*&: This does not apply to bounce messages
16003 coming from elsewhere. The value of the option is a colon-separated list of
16004 items. Each item consists of a pattern, terminated by white space, followed by
16005 a comma-separated list of email addresses. If a pattern contains spaces, it
16006 must be enclosed in double quotes.
16007
16008 Each pattern is processed in the same way as a single item in an address list
16009 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
16010 the bounce message, the message is copied to the addresses on the list. The
16011 items are scanned in order, and once a matching one is found, no further items
16012 are examined. For example:
16013 .code
16014 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
16015               rqps@mydomain   hostmaster@mydomain.example,\
16016                               postmaster@mydomain.example
16017 .endd
16018 .vindex "&$domain$&"
16019 .vindex "&$local_part$&"
16020 The address list is expanded before use. The expansion variables &$local_part$&
16021 and &$domain$& are set from the original recipient of the error message, and if
16022 there was any wildcard matching in the pattern, the expansion
16023 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
16024 variables &$0$&, &$1$&, etc. are set in the normal way.
16025
16026
16027 .option errors_reply_to main string unset
16028 .cindex "bounce message" "&'Reply-to:'& in"
16029 By default, Exim's bounce and delivery warning messages contain the header line
16030 .display
16031 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
16032 .endd
16033 .oindex &%quota_warn_message%&
16034 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
16035 A warning message that is generated by the &%quota_warn_message%& option in an
16036 &(appendfile)& transport may contain its own &'From:'& header line that
16037 overrides the default.
16038
16039 Experience shows that people reply to bounce messages. If the
16040 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
16041 and warning messages. For example:
16042 .code
16043 errors_reply_to = postmaster@my.domain.example
16044 .endd
16045 The value of the option is not expanded. It must specify a valid RFC 2822
16046 address. However, if a warning message that is generated by the
16047 &%quota_warn_message%& option in an &(appendfile)& transport contain its
16048 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
16049 not used.
16050
16051
16052 .option event_action main string&!! unset
16053 .cindex events
16054 This option declares a string to be expanded for Exim's events mechanism.
16055 For details see chapter &<<CHAPevents>>&.
16056
16057
16058 .option exim_group main string "compile-time configured"
16059 .cindex "gid (group id)" "Exim's own"
16060 .cindex "Exim group"
16061 This option changes the gid under which Exim runs when it gives up root
16062 privilege. The default value is compiled into the binary. The value of this
16063 option is used only when &%exim_user%& is also set. Unless it consists entirely
16064 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
16065 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
16066 security issues.
16067
16068
16069 .option exim_path main string "see below"
16070 .cindex "Exim binary, path name"
16071 This option specifies the path name of the Exim binary, which is used when Exim
16072 needs to re-exec itself. The default is set up to point to the file &'exim'& in
16073 the directory configured at compile time by the BIN_DIRECTORY setting. It
16074 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
16075 other place.
16076 &*Warning*&: Do not use a macro to define the value of this option, because
16077 you will break those Exim utilities that scan the configuration file to find
16078 where the binary is. (They then use the &%-bP%& option to extract option
16079 settings such as the value of &%spool_directory%&.)
16080
16081
16082 .option exim_user main string "compile-time configured"
16083 .cindex "uid (user id)" "Exim's own"
16084 .cindex "Exim user"
16085 This option changes the uid under which Exim runs when it gives up root
16086 privilege. The default value is compiled into the binary. Ownership of the run
16087 time configuration file and the use of the &%-C%& and &%-D%& command line
16088 options is checked against the values in the binary, not what is set here.
16089
16090 Unless it consists entirely of digits, the string is looked up using
16091 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16092 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16093 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16094
16095
16096 .option exim_version main string "current version"
16097 .cindex "Exim version"
16098 .cindex customizing "version number"
16099 .cindex "version number of Exim" override
16100 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16101 various places.  Use with care; this may fool stupid security scanners.
16102
16103
16104 .option extra_local_interfaces main "string list" unset
16105 This option defines network interfaces that are to be considered local when
16106 routing, but which are not used for listening by the daemon. See section
16107 &<<SECTreclocipadd>>& for details.
16108
16109
16110 . Allow this long option name to split; give it unsplit as a fifth argument
16111 . for the automatic .oindex that is generated by .option.
16112
16113 .option "extract_addresses_remove_arguments" main boolean true &&&
16114          extract_addresses_remove_arguments
16115 .oindex "&%-t%&"
16116 .cindex "command line" "addresses with &%-t%&"
16117 .cindex "Sendmail compatibility" "&%-t%& option"
16118 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16119 are present on the command line when the &%-t%& option is used to build an
16120 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16121 line addresses are removed from the recipients list. This is also how Smail
16122 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16123 command line addresses are added to those obtained from the header lines. When
16124 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16125 argument headers. If it is set false, Exim adds rather than removes argument
16126 addresses.
16127
16128
16129 .option finduser_retries main integer 0
16130 .cindex "NIS, retrying user lookups"
16131 On systems running NIS or other schemes in which user and group information is
16132 distributed from a remote system, there can be times when &[getpwnam()]& and
16133 related functions fail, even when given valid data, because things time out.
16134 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16135 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16136 many extra times to find a user or a group, waiting for one second between
16137 retries.
16138
16139 .cindex "&_/etc/passwd_&" "multiple reading of"
16140 You should not set this option greater than zero if your user information is in
16141 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16142 search the file multiple times for non-existent users, and also cause delay.
16143
16144
16145
16146 .option freeze_tell main "string list, comma separated" unset
16147 .cindex "freezing messages" "sending a message when freezing"
16148 .cindex "frozen messages" "sending a message when freezing"
16149 On encountering certain errors, or when configured to do so in a system filter,
16150 ACL, or special router, Exim freezes a message. This means that no further
16151 delivery attempts take place until an administrator thaws the message, or the
16152 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16153 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16154 warning message whenever it freezes something, unless the message it is
16155 freezing is a locally-generated bounce message. (Without this exception there
16156 is the possibility of looping.) The warning message is sent to the addresses
16157 supplied as the comma-separated value of this option. If several of the
16158 message's addresses cause freezing, only a single message is sent. If the
16159 freezing was automatic, the reason(s) for freezing can be found in the message
16160 log. If you configure freezing in a filter or ACL, you must arrange for any
16161 logging that you require.
16162
16163
16164 .options gecos_name main string&!! unset &&&
16165          gecos_pattern main string unset
16166 .cindex "HP-UX"
16167 .cindex "&""gecos""& field, parsing"
16168 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16169 password file to hold other information in addition to users' real names. Exim
16170 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16171 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16172 of the field are used unchanged, except that, if an ampersand is encountered,
16173 it is replaced by the user's login name with the first character forced to
16174 upper case, since this is a convention that is observed on many systems.
16175
16176 When these options are set, &%gecos_pattern%& is treated as a regular
16177 expression that is to be applied to the field (again with && replaced by the
16178 login name), and if it matches, &%gecos_name%& is expanded and used as the
16179 user's name.
16180
16181 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16182 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16183 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16184 name terminates at the first comma, the following can be used:
16185 .code
16186 gecos_pattern = ([^,]*)
16187 gecos_name = $1
16188 .endd
16189
16190
16191 .option gnutls_compat_mode main boolean unset
16192 This option controls whether GnuTLS is used in compatibility mode in an Exim
16193 server. This reduces security slightly, but improves interworking with older
16194 implementations of TLS.
16195
16196
16197 .option gnutls_allow_auto_pkcs11 main boolean unset
16198 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16199 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16200
16201 See
16202 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16203 for documentation.
16204
16205
16206
16207 .option headers_charset main string "see below"
16208 This option sets a default character set for translating from encoded MIME
16209 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16210 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16211 ultimate default is ISO-8859-1. For more details see the description of header
16212 insertions in section &<<SECTexpansionitems>>&.
16213
16214
16215
16216 .option header_maxsize main integer "see below"
16217 .cindex "header section" "maximum size of"
16218 .cindex "limit" "size of message header section"
16219 This option controls the overall maximum size of a message's header
16220 section. The default is the value of HEADER_MAXSIZE in
16221 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16222 sections are rejected.
16223
16224
16225 .option header_line_maxsize main integer 0
16226 .cindex "header lines" "maximum size of"
16227 .cindex "limit" "size of one header line"
16228 This option limits the length of any individual header line in a message, after
16229 all the continuations have been joined together. Messages with individual
16230 header lines that are longer than the limit are rejected. The default value of
16231 zero means &"no limit"&.
16232
16233
16234
16235
16236 .option helo_accept_junk_hosts main "host list&!!" unset
16237 .cindex "HELO" "accepting junk data"
16238 .cindex "EHLO" "accepting junk data"
16239 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16240 mail, and gives an error response for invalid data. Unfortunately, there are
16241 some SMTP clients that send syntactic junk. They can be accommodated by setting
16242 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16243 if you want to do semantic checking.
16244 See also &%helo_allow_chars%& for a way of extending the permitted character
16245 set.
16246
16247
16248 .option helo_allow_chars main string unset
16249 .cindex "HELO" "underscores in"
16250 .cindex "EHLO" "underscores in"
16251 .cindex "underscore in EHLO/HELO"
16252 This option can be set to a string of rogue characters that are permitted in
16253 non-ip-literal EHLO and HELO names in addition to the standard letters, digits,
16254 hyphens, and dots. For examplem if you really must allow underscores,
16255 you can set
16256 .code
16257 helo_allow_chars = _
16258 .endd
16259 This option does not apply to names that look like ip-literals.
16260 Note that the value is one string, not a list.
16261
16262
16263 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16264 .cindex "HELO" "forcing reverse lookup"
16265 .cindex "EHLO" "forcing reverse lookup"
16266 If the domain given by a client in a HELO or EHLO command matches this
16267 list, a reverse lookup is done in order to establish the host's true name. The
16268 default forces a lookup if the client host gives the server's name or any of
16269 its IP addresses (in brackets), something that broken clients have been seen to
16270 do.
16271
16272
16273 .option helo_try_verify_hosts main "host list&!!" unset
16274 .cindex "HELO verifying" "optional"
16275 .cindex "EHLO" "verifying, optional"
16276 By default, Exim just checks the syntax of HELO and EHLO commands (see
16277 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16278 to do more extensive checking of the data supplied by these commands. The ACL
16279 condition &`verify = helo`& is provided to make this possible.
16280 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16281 to force the check to occur. From release 4.53 onwards, this is no longer
16282 necessary. If the check has not been done before &`verify = helo`& is
16283 encountered, it is done at that time. Consequently, this option is obsolete.
16284 Its specification is retained here for backwards compatibility.
16285
16286 When an EHLO or HELO command is received, if the calling host matches
16287 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16288 EHLO command either:
16289
16290 .ilist
16291 is an IP literal matching the calling address of the host, or
16292 .next
16293 .cindex "DNS" "reverse lookup"
16294 .cindex "reverse DNS lookup"
16295 matches the host name that Exim obtains by doing a reverse lookup of the
16296 calling host address, or
16297 .next
16298 when looked up in DNS yields the calling host address.
16299 .endlist
16300
16301 However, the EHLO or HELO command is not rejected if any of the checks
16302 fail. Processing continues, but the result of the check is remembered, and can
16303 be detected later in an ACL by the &`verify = helo`& condition.
16304
16305 If DNS was used for successful verification, the variable
16306 .cindex "DNS" "DNSSEC"
16307 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16308
16309 .option helo_verify_hosts main "host list&!!" unset
16310 .cindex "HELO verifying" "mandatory"
16311 .cindex "EHLO" "verifying, mandatory"
16312 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16313 backwards compatibility. For hosts that match this option, Exim checks the host
16314 name given in the HELO or EHLO in the same way as for
16315 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16316 rejected with a 550 error, and entries are written to the main and reject logs.
16317 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16318 error.
16319
16320 .option hold_domains main "domain list&!!" unset
16321 .cindex "domain" "delaying delivery"
16322 .cindex "delivery" "delaying certain domains"
16323 This option allows mail for particular domains to be held in the queue
16324 manually. The option is overridden if a message delivery is forced with the
16325 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16326 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16327 item in &%hold_domains%&, no routing or delivery for that address is done, and
16328 it is deferred every time the message is looked at.
16329
16330 This option is intended as a temporary operational measure for delaying the
16331 delivery of mail while some problem is being sorted out, or some new
16332 configuration tested. If you just want to delay the processing of some
16333 domains until a queue run occurs, you should use &%queue_domains%& or
16334 &%queue_smtp_domains%&, not &%hold_domains%&.
16335
16336 A setting of &%hold_domains%& does not override Exim's code for removing
16337 messages from the queue if they have been there longer than the longest retry
16338 time in any retry rule. If you want to hold messages for longer than the normal
16339 retry times, insert a dummy retry rule with a long retry time.
16340
16341
16342 .option host_lookup main "host list&!!" unset
16343 .cindex "host name" "lookup, forcing"
16344 Exim does not look up the name of a calling host from its IP address unless it
16345 is required to compare against some host list, or the host matches
16346 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16347 option (which normally contains IP addresses rather than host names). The
16348 default configuration file contains
16349 .code
16350 host_lookup = *
16351 .endd
16352 which causes a lookup to happen for all hosts. If the expense of these lookups
16353 is felt to be too great, the setting can be changed or removed.
16354
16355 After a successful reverse lookup, Exim does a forward lookup on the name it
16356 has obtained, to verify that it yields the IP address that it started with. If
16357 this check fails, Exim behaves as if the name lookup failed.
16358
16359 .vindex "&$host_lookup_failed$&"
16360 .vindex "&$sender_host_name$&"
16361 After any kind of failure, the host name (in &$sender_host_name$&) remains
16362 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16363 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16364 &`verify = reverse_host_lookup`& in ACLs.
16365
16366
16367 .option host_lookup_order main "string list" &`bydns:byaddr`&
16368 This option specifies the order of different lookup methods when Exim is trying
16369 to find a host name from an IP address. The default is to do a DNS lookup
16370 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16371 if that fails. You can change the order of these lookups, or omit one entirely,
16372 if you want.
16373
16374 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16375 multiple PTR records in the DNS and the IP address is not listed in
16376 &_/etc/hosts_&. Different operating systems give different results in this
16377 case. That is why the default tries a DNS lookup first.
16378
16379
16380
16381 .option host_reject_connection main "host list&!!" unset
16382 .cindex "host" "rejecting connections from"
16383 If this option is set, incoming SMTP calls from the hosts listed are rejected
16384 as soon as the connection is made.
16385 This option is obsolete, and retained only for backward compatibility, because
16386 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16387 connections immediately.
16388
16389 If the connection is on a TLS-on-connect port then the TCP connection is
16390 just dropped.  Otherwise, an SMTP error is sent first.
16391
16392 The ability to give an immediate rejection (either by this option or using an
16393 ACL) is provided for use in unusual cases. Many hosts will just try again,
16394 sometimes without much delay. Normally, it is better to use an ACL to reject
16395 incoming messages at a later stage, such as after RCPT commands. See
16396 chapter &<<CHAPACL>>&.
16397
16398
16399 .option hosts_connection_nolog main "host list&!!" unset
16400 .cindex "host" "not logging connections from"
16401 This option defines a list of hosts for which connection logging does not
16402 happen, even though the &%smtp_connection%& log selector is set. For example,
16403 you might want not to log SMTP connections from local processes, or from
16404 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16405 the daemon; you should therefore strive to restrict its value to a short inline
16406 list of IP addresses and networks. To disable logging SMTP connections from
16407 local processes, you must create a host list with an empty item. For example:
16408 .code
16409 hosts_connection_nolog = :
16410 .endd
16411 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16412 lines, as may commonly be produced by a monitoring system.
16413
16414
16415 .option hosts_require_alpn main "host list&!!" unset
16416 .cindex ALPN "require negotiation in server"
16417 .cindex TLS ALPN
16418 .cindex TLS "Application Layer Protocol Names"
16419 If the TLS library supports ALPN
16420 then a successful negotiation of ALPN will be required for any client
16421 matching the list, for TLS to be used.
16422 See also the &%tls_alpn%& option.
16423
16424 &*Note*&: prevention of fallback to in-clear connection is not
16425 managed by this option, and should be done separately.
16426
16427
16428 .option hosts_require_helo main "host list&!!" *
16429 .cindex "HELO/EHLO" requiring
16430 Exim will require an accepted HELO or EHLO command from a host matching
16431 this list, before accepting a MAIL command.
16432
16433
16434 .option hosts_proxy main "host list&!!" unset
16435 .cindex proxy "proxy protocol"
16436 This option enables use of Proxy Protocol proxies for incoming
16437 connections.  For details see section &<<SECTproxyInbound>>&.
16438
16439
16440 .option hosts_treat_as_local main "domain list&!!" unset
16441 .cindex "local host" "domains treated as"
16442 .cindex "host" "treated as local"
16443 If this option is set, any host names that match the domain list are treated as
16444 if they were the local host when Exim is scanning host lists obtained from MX
16445 records
16446 or other sources. Note that the value of this option is a domain list, not a
16447 host list, because it is always used to check host names, not IP addresses.
16448
16449 This option also applies when Exim is matching the special items
16450 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16451 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16452 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16453 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16454 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16455 interfaces and recognizing the local host.
16456
16457
16458 .option ibase_servers main "string list" unset
16459 .cindex "InterBase" "server list"
16460 This option provides a list of InterBase servers and associated connection data,
16461 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16462 The option is available only if Exim has been built with InterBase support.
16463
16464
16465
16466 .option ignore_bounce_errors_after main time 10w
16467 .cindex "bounce message" "discarding"
16468 .cindex "discarding bounce message"
16469 This option affects the processing of bounce messages that cannot be delivered,
16470 that is, those that suffer a permanent delivery failure. (Bounce messages that
16471 suffer temporary delivery failures are of course retried in the usual way.)
16472
16473 After a permanent delivery failure, bounce messages are frozen,
16474 because there is no sender to whom they can be returned. When a frozen bounce
16475 message has been in the queue for more than the given time, it is unfrozen at
16476 the next queue run, and a further delivery is attempted. If delivery fails
16477 again, the bounce message is discarded. This makes it possible to keep failed
16478 bounce messages around for a shorter time than the normal maximum retry time
16479 for frozen messages. For example,
16480 .code
16481 ignore_bounce_errors_after = 12h
16482 .endd
16483 retries failed bounce message deliveries after 12 hours, discarding any further
16484 failures. If the value of this option is set to a zero time period, bounce
16485 failures are discarded immediately. Setting a very long time (as in the default
16486 value) has the effect of disabling this option. For ways of automatically
16487 dealing with other kinds of frozen message, see &%auto_thaw%& and
16488 &%timeout_frozen_after%&.
16489
16490
16491 .options ignore_fromline_hosts main "host list&!!" unset &&&
16492          ignore_fromline_local main boolean false
16493 .cindex "&""From""& line"
16494 .cindex "UUCP" "&""From""& line"
16495 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16496 the headers of a message. By default this is treated as the start of the
16497 message's body, which means that any following headers are not recognized as
16498 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16499 match those hosts that insist on sending it. If the sender is actually a local
16500 process rather than a remote host, and is using &%-bs%& to inject the messages,
16501 &%ignore_fromline_local%& must be set to achieve this effect.
16502
16503
16504
16505 .option keep_environment main "string list" unset
16506 .cindex "environment" "values from"
16507 This option contains a string list of environment variables to keep.
16508 You have to trust these variables or you have to be sure that
16509 these variables do not impose any security risk. Keep in mind that
16510 during the startup phase Exim is running with an effective UID 0 in most
16511 installations. As the default value is an empty list, the default
16512 environment for using libraries, running embedded Perl code, or running
16513 external binaries is empty, and does not not even contain PATH or HOME.
16514
16515 Actually the list is interpreted as a list of patterns
16516 (&<<SECTlistexpand>>&), except that it is not expanded first.
16517
16518 WARNING: Macro substitution is still done first, so having a macro
16519 FOO and having FOO_HOME in your &%keep_environment%& option may have
16520 unexpected results. You may work around this using a regular expression
16521 that does not match the macro name: ^[F]OO_HOME$.
16522
16523 Current versions of Exim issue a warning during startup if you do not mention
16524 &%keep_environment%& in your runtime configuration file and if your
16525 current environment is not empty. Future versions may not issue that warning
16526 anymore.
16527
16528 See the &%add_environment%& main config option for a way to set
16529 environment variables to a fixed value.  The environment for &(pipe)&
16530 transports is handled separately, see section &<<SECTpipeenv>>& for
16531 details.
16532
16533
16534 .option keep_malformed main time 4d
16535 This option specifies the length of time to keep messages whose spool files
16536 have been corrupted in some way. This should, of course, never happen. At the
16537 next attempt to deliver such a message, it gets removed. The incident is
16538 logged.
16539
16540
16541 .option ldap_ca_cert_dir main string unset
16542 .cindex "LDAP", "TLS CA certificate directory"
16543 .cindex certificate "directory for LDAP"
16544 This option indicates which directory contains CA certificates for verifying
16545 a TLS certificate presented by an LDAP server.
16546 While Exim does not provide a default value, your SSL library may.
16547 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16548 and constrained to be a directory.
16549
16550
16551 .option ldap_ca_cert_file main string unset
16552 .cindex "LDAP", "TLS CA certificate file"
16553 .cindex certificate "file for LDAP"
16554 This option indicates which file contains CA certificates for verifying
16555 a TLS certificate presented by an LDAP server.
16556 While Exim does not provide a default value, your SSL library may.
16557 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16558 and constrained to be a file.
16559
16560
16561 .option ldap_cert_file main string unset
16562 .cindex "LDAP" "TLS client certificate file"
16563 .cindex certificate "file for LDAP"
16564 This option indicates which file contains an TLS client certificate which
16565 Exim should present to the LDAP server during TLS negotiation.
16566 Should be used together with &%ldap_cert_key%&.
16567
16568
16569 .option ldap_cert_key main string unset
16570 .cindex "LDAP" "TLS client key file"
16571 .cindex certificate "key for LDAP"
16572 This option indicates which file contains the secret/private key to use
16573 to prove identity to the LDAP server during TLS negotiation.
16574 Should be used together with &%ldap_cert_file%&, which contains the
16575 identity to be proven.
16576
16577
16578 .option ldap_cipher_suite main string unset
16579 .cindex "LDAP" "TLS cipher suite"
16580 This controls the TLS cipher-suite negotiation during TLS negotiation with
16581 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16582 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16583
16584
16585 .option ldap_default_servers main "string list" unset
16586 .cindex "LDAP" "default servers"
16587 This option provides a list of LDAP servers which are tried in turn when an
16588 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16589 details of LDAP queries. This option is available only when Exim has been built
16590 with LDAP support.
16591
16592
16593 .option ldap_require_cert main string unset.
16594 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16595 This should be one of the values "hard", "demand", "allow", "try" or "never".
16596 A value other than one of these is interpreted as "never".
16597 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16598 Although Exim does not set a default, the LDAP library probably defaults
16599 to hard/demand.
16600
16601
16602 .option ldap_start_tls main boolean false
16603 .cindex "LDAP" "whether or not to negotiate TLS"
16604 If set, Exim will attempt to negotiate TLS with the LDAP server when
16605 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16606 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16607 of SSL-on-connect.
16608 In the event of failure to negotiate TLS, the action taken is controlled
16609 by &%ldap_require_cert%&.
16610 This option is ignored for &`ldapi`& connections.
16611
16612
16613 .option ldap_version main integer unset
16614 .cindex "LDAP" "protocol version, forcing"
16615 This option can be used to force Exim to set a specific protocol version for
16616 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16617 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16618 the LDAP headers; otherwise it is 2. This option is available only when Exim
16619 has been built with LDAP support.
16620
16621
16622
16623 .option limits_advertise_hosts main "host list&!!" *
16624 .cindex LIMITS "suppressing advertising"
16625 .cindex "ESMTP extensions" LIMITS
16626 This option can be used to suppress the advertisement of the SMTP
16627 LIMITS extension (RFC 9422) to specific hosts.
16628 If permitted, Exim as a servier will advertise in the EHLO response
16629 the limit for RCPT commands set by the &%recipients_max%& option (if it is set)
16630 and the limit for MAIL commands set by the &%smtp_accept_max_per_connection%&
16631 option.
16632
16633 .option local_from_check main boolean true
16634 .cindex "&'Sender:'& header line" "disabling addition of"
16635 .cindex "&'From:'& header line" "disabling checking of"
16636 When a message is submitted locally (that is, not over a TCP/IP connection) by
16637 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16638 checks that the &'From:'& header line matches the login of the calling user and
16639 the domain specified by &%qualify_domain%&.
16640
16641 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16642 locally submitted message is automatically qualified by Exim, unless the
16643 &%-bnq%& command line option is used.
16644
16645 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16646 on the local part. If the &'From:'& header line does not match, Exim adds a
16647 &'Sender:'& header with an address constructed from the calling user's login
16648 and the default qualify domain.
16649
16650 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16651 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16652 &'Sender:'& header lines supplied by untrusted users, you must also set
16653 &%local_sender_retain%& to be true.
16654
16655 .cindex "envelope from"
16656 .cindex "envelope sender"
16657 These options affect only the header lines in the message. The envelope sender
16658 is still forced to be the login id at the qualify domain unless
16659 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16660
16661 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16662 request similar header line checking. See section &<<SECTthesenhea>>&, which
16663 has more details about &'Sender:'& processing.
16664
16665
16666
16667
16668 .options local_from_prefix main string unset &&&
16669          local_from_suffix main string unset
16670 When Exim checks the &'From:'& header line of locally submitted messages for
16671 matching the login id (see &%local_from_check%& above), it can be configured to
16672 ignore certain prefixes and suffixes in the local part of the address. This is
16673 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16674 appropriate lists, in the same form as the &%local_part_prefix%& and
16675 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16676 example, if
16677 .code
16678 local_from_prefix = *-
16679 .endd
16680 is set, a &'From:'& line containing
16681 .code
16682 From: anything-user@your.domain.example
16683 .endd
16684 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16685 matches the actual sender address that is constructed from the login name and
16686 qualify domain.
16687
16688
16689 .option local_interfaces main "string list" "see below"
16690 This option controls which network interfaces are used by the daemon for
16691 listening; they are also used to identify the local host when routing. Chapter
16692 &<<CHAPinterfaces>>& contains a full description of this option and the related
16693 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16694 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16695 &%local_interfaces%& is
16696 .code
16697 local_interfaces = 0.0.0.0
16698 .endd
16699 when Exim is built without IPv6 support; otherwise it is
16700 .code
16701 local_interfaces = <; ::0 ; 0.0.0.0
16702 .endd
16703
16704 .option local_scan_timeout main time 5m
16705 .cindex "timeout" "for &[local_scan()]& function"
16706 .cindex "&[local_scan()]& function" "timeout"
16707 This timeout applies to the &[local_scan()]& function (see chapter
16708 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16709 the incoming message is rejected with a temporary error if it is an SMTP
16710 message. For a non-SMTP message, the message is dropped and Exim ends with a
16711 non-zero code. The incident is logged on the main and reject logs.
16712
16713
16714
16715 .option local_sender_retain main boolean false
16716 .cindex "&'Sender:'& header line" "retaining from local submission"
16717 When a message is submitted locally (that is, not over a TCP/IP connection) by
16718 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16719 do not want this to happen, you must set &%local_sender_retain%&, and you must
16720 also set &%local_from_check%& to be false (Exim will complain if you do not).
16721 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16722 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16723
16724
16725
16726
16727 .option localhost_number main string&!! unset
16728 .cindex "host" "locally unique number for"
16729 .cindex "message ids" "with multiple hosts"
16730 .cindex multiple "systems sharing a spool"
16731 .cindex "multiple hosts" "sharing a spool"
16732 .cindex "shared spool directory"
16733 .cindex "spool directory" sharing
16734 .vindex "&$localhost_number$&"
16735 Exim's message ids are normally unique only within the local host. If
16736 uniqueness among a set of hosts is required
16737 (eg. because they share a spool directory),
16738 each host must set a different
16739 value for the &%localhost_number%& option. The string is expanded immediately
16740 after reading the configuration file (so that a number can be computed from the
16741 host name, for example) and the result of the expansion must be a number in the
16742 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16743 systems). This is available in subsequent string expansions via the variable
16744 &$localhost_number$&. When &%localhost_number%& is set, the final four
16745 characters of the message id, instead of just being a fractional part of the
16746 time, are computed from the time and the local host number as described in
16747 section &<<SECTmessiden>>&.
16748
16749
16750
16751 .option log_file_path main "string list&!!" "set at compile time"
16752 .cindex "log" "file path for"
16753 This option sets the path which is used to determine the names of Exim's log
16754 files, or indicates that logging is to be to syslog, or both. It is expanded
16755 when Exim is entered, so it can, for example, contain a reference to the host
16756 name. If no specific path is set for the log files at compile or runtime,
16757 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16758 they are written in a sub-directory called &_log_& in Exim's spool directory.
16759 A path must start with a slash.
16760 To send to syslog, use the word &"syslog"&.
16761 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16762 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16763 used. If this string is fixed at your installation (contains no expansion
16764 variables) it is recommended that you do not set this option in the
16765 configuration file, but instead supply the path using LOG_FILE_PATH in
16766 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16767 early on &-- in particular, failure to read the configuration file.
16768
16769
16770 .option log_selector main string unset
16771 .cindex "log" "selectors"
16772 This option can be used to reduce or increase the number of things that Exim
16773 writes to its log files. Its argument is made up of names preceded by plus or
16774 minus characters. For example:
16775 .code
16776 log_selector = +arguments -retry_defer
16777 .endd
16778 A list of possible names and what they control is given in the chapter on
16779 logging, in section &<<SECTlogselector>>&.
16780
16781
16782 .option log_timezone main boolean false
16783 .cindex "log" "timezone for entries"
16784 .vindex "&$tod_log$&"
16785 .vindex "&$tod_zone$&"
16786 By default, the timestamps on log lines are in local time without the
16787 timezone. This means that if your timezone changes twice a year, the timestamps
16788 in log lines are ambiguous for an hour when the clocks go back. One way of
16789 avoiding this problem is to set the timezone to UTC. An alternative is to set
16790 &%log_timezone%& true. This turns on the addition of the timezone offset to
16791 timestamps in log lines. Turning on this option can add quite a lot to the size
16792 of log files because each line is extended by 6 characters. Note that the
16793 &$tod_log$& variable contains the log timestamp without the zone, but there is
16794 another variable called &$tod_zone$& that contains just the timezone offset.
16795
16796
16797 .option lookup_open_max main integer 25
16798 .cindex "too many open files"
16799 .cindex "open files, too many"
16800 .cindex "file" "too many open"
16801 .cindex "lookup" "maximum open files"
16802 .cindex "limit" "open files for lookups"
16803 This option limits the number of simultaneously open files for single-key
16804 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16805 Exim normally keeps these files open during routing, because often the same
16806 file is required several times. If the limit is reached, Exim closes the least
16807 recently used file. Note that if you are using the &'ndbm'& library, it
16808 actually opens two files for each logical DBM database, though it still counts
16809 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16810 open files"& errors with NDBM, you need to reduce the value of
16811 &%lookup_open_max%&.
16812
16813
16814 .option max_username_length main integer 0
16815 .cindex "length of login name"
16816 .cindex "user name" "maximum length"
16817 .cindex "limit" "user name length"
16818 Some operating systems are broken in that they truncate long arguments to
16819 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16820 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16821 an argument that is longer behaves as if &[getpwnam()]& failed.
16822
16823
16824 .option message_body_newlines main bool false
16825 .cindex "message body" "newlines in variables"
16826 .cindex "newline" "in message body variables"
16827 .vindex "&$message_body$&"
16828 .vindex "&$message_body_end$&"
16829 By default, newlines in the message body are replaced by spaces when setting
16830 the &$message_body$& and &$message_body_end$& expansion variables. If this
16831 option is set true, this no longer happens.
16832
16833
16834 .option message_body_visible main integer 500
16835 .cindex "body of message" "visible size"
16836 .cindex "message body" "visible size"
16837 .vindex "&$message_body$&"
16838 .vindex "&$message_body_end$&"
16839 This option specifies how much of a message's body is to be included in the
16840 &$message_body$& and &$message_body_end$& expansion variables.
16841
16842
16843 .option message_id_header_domain main string&!! unset
16844 .cindex "&'Message-ID:'& header line"
16845 If this option is set, the string is expanded and used as the right hand side
16846 (domain) of the &'Message-ID:'& header that Exim creates if a
16847 locally-originated incoming message does not have one. &"Locally-originated"&
16848 means &"not received over TCP/IP."&
16849 Otherwise, the primary host name is used.
16850 Only letters, digits, dot and hyphen are accepted; any other characters are
16851 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16852 empty string, the option is ignored.
16853
16854
16855 .option message_id_header_text main string&!! unset
16856 If this variable is set, the string is expanded and used to augment the text of
16857 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16858 message does not have one. The text of this header is required by RFC 2822 to
16859 take the form of an address. By default, Exim uses its internal message id as
16860 the local part, and the primary host name as the domain. If this option is set,
16861 it is expanded, and provided the expansion is not forced to fail, and does not
16862 yield an empty string, the result is inserted into the header immediately
16863 before the @, separated from the internal message id by a dot. Any characters
16864 that are illegal in an address are automatically converted into hyphens. This
16865 means that variables such as &$tod_log$& can be used, because the spaces and
16866 colons will become hyphens.
16867
16868
16869 .option message_logs main boolean true
16870 .cindex "message logs" "disabling"
16871 .cindex "log" "message log; disabling"
16872 If this option is turned off, per-message log files are not created in the
16873 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16874 Exim, by reducing the number of files involved in handling a message from a
16875 minimum of four (header spool file, body spool file, delivery journal, and
16876 per-message log) to three. The other major I/O activity is Exim's main log,
16877 which is not affected by this option.
16878
16879
16880 .option message_size_limit main string&!! 50M
16881 .cindex "message" "size limit"
16882 .cindex "limit" "message size"
16883 .cindex "size" "of message, limit"
16884 This option limits the maximum size of message that Exim will process. The
16885 value is expanded for each incoming connection so, for example, it can be made
16886 to depend on the IP address of the remote host for messages arriving via
16887 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16888 optionally followed by K or M.
16889
16890 .cindex "SIZE" "ESMTP extension, advertising"
16891 .cindex "ESMTP extensions" SIZE
16892 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16893 service extension keyword.
16894
16895 &*Note*&: This limit cannot be made to depend on a message's sender or any
16896 other properties of an individual message, because it has to be advertised in
16897 the server's response to EHLO. String expansion failure causes a temporary
16898 error. A value of zero means no limit, but its use is not recommended. See also
16899 &%bounce_return_size_limit%&.
16900
16901 Incoming SMTP messages are failed with a 552 error if the limit is
16902 exceeded; locally-generated messages either get a stderr message or a delivery
16903 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16904 an oversized message is logged in both the main and the reject logs. See also
16905 the generic transport option &%message_size_limit%&, which limits the size of
16906 message that an individual transport can process.
16907
16908 If you use a virus-scanner and set this option to to a value larger than the
16909 maximum size that your virus-scanner is configured to support, you may get
16910 failures triggered by large mails.  The right size to configure for the
16911 virus-scanner depends upon what data is passed and the options in use but it's
16912 probably safest to just set it to a little larger than this value.  E.g., with a
16913 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16914 some problems may result.
16915
16916 A value of 0 will disable size limit checking; Exim will still advertise the
16917 SIZE extension in an EHLO response, but without a limit, so as to permit
16918 SMTP clients to still indicate the message size along with the MAIL verb.
16919
16920
16921 .option move_frozen_messages main boolean false
16922 .cindex "frozen messages" "moving"
16923 This option, which is available only if Exim has been built with the setting
16924 .code
16925 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16926 .endd
16927 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16928 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16929 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16930 standard utilities for handling such moved messages, and they do not show up in
16931 lists generated by &%-bp%& or by the Exim monitor.
16932
16933
16934 .option mua_wrapper main boolean false
16935 Setting this option true causes Exim to run in a very restrictive mode in which
16936 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16937 contains a full description of this facility.
16938
16939
16940
16941 .option mysql_servers main "string list" unset
16942 .cindex "MySQL" "server list"
16943 This option provides a list of MySQL servers and associated connection data, to
16944 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16945 option is available only if Exim has been built with MySQL support.
16946
16947
16948 .option never_users main "string list&!!" unset
16949 This option is expanded just once, at the start of Exim's processing. Local
16950 message deliveries are normally run in processes that are setuid to the
16951 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16952 It is usually desirable to prevent any deliveries from running as root, as a
16953 safety precaution.
16954
16955 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16956 list of users that must not be used for local deliveries. This list is fixed in
16957 the binary and cannot be overridden by the configuration file. By default, it
16958 contains just the single user name &"root"&. The &%never_users%& runtime option
16959 can be used to add more users to the fixed list.
16960
16961 If a message is to be delivered as one of the users on the fixed list or the
16962 &%never_users%& list, an error occurs, and delivery is deferred. A common
16963 example is
16964 .code
16965 never_users = root:daemon:bin
16966 .endd
16967 Including root is redundant if it is also on the fixed list, but it does no
16968 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16969 transport driver.
16970
16971
16972 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16973 This option gives the name for a unix-domain socket on which the daemon
16974 listens for work and information-requests.
16975 Only installations running multiple daemons sharing a spool directory
16976 should need to modify the default.
16977
16978 The option is expanded before use.
16979 If the platform supports Linux-style abstract socket names, the result
16980 is used with a nul byte prefixed.
16981 Otherwise,
16982 it should be a full path name and use a directory accessible
16983 to Exim.
16984
16985 If this option is set as empty,
16986 or the command line &%-oY%& option is used, or
16987 the command line uses a &%-oX%& option and does not use &%-oP%&,
16988 then a notifier socket is not created.
16989
16990
16991 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16992 .cindex "OpenSSL "compatibility options"
16993 This option allows an administrator to adjust the SSL options applied
16994 by OpenSSL to connections.  It is given as a space-separated list of items,
16995 each one to be +added or -subtracted from the current value.
16996
16997 This option is only available if Exim is built against OpenSSL.  The values
16998 available for this option vary according to the age of your OpenSSL install.
16999 The &"all"& value controls a subset of flags which are available, typically
17000 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
17001 list the values known on your system and Exim should support all the
17002 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
17003 names lose the leading &"SSL_OP_"& and are lower-cased.
17004
17005 Note that adjusting the options can have severe impact upon the security of
17006 SSL as used by Exim.  It is possible to disable safety checks and shoot
17007 yourself in the foot in various unpleasant ways.  This option should not be
17008 adjusted lightly.  An unrecognised item will be detected at startup, by
17009 invoking Exim with the &%-bV%& flag.
17010
17011 The option affects Exim operating both as a server and as a client.
17012
17013 Historical note: prior to release 4.80, Exim defaulted this value to
17014 "+dont_insert_empty_fragments", which may still be needed for compatibility
17015 with some clients, but which lowers security by increasing exposure to
17016 some now infamous attacks.
17017
17018 Examples:
17019 .code
17020 # Make both old MS and old Eudora happy:
17021 openssl_options = -all +microsoft_big_sslv3_buffer \
17022                        +dont_insert_empty_fragments
17023
17024 # Disable older protocol versions:
17025 openssl_options = +no_sslv2 +no_sslv3
17026 .endd
17027
17028 Possible options may include:
17029 .ilist
17030 &`all`&
17031 .next
17032 &`allow_unsafe_legacy_renegotiation`&
17033 .next
17034 &`cipher_server_preference`&
17035 .next
17036 &`dont_insert_empty_fragments`&
17037 .next
17038 &`ephemeral_rsa`&
17039 .next
17040 &`legacy_server_connect`&
17041 .next
17042 &`microsoft_big_sslv3_buffer`&
17043 .next
17044 &`microsoft_sess_id_bug`&
17045 .next
17046 &`msie_sslv2_rsa_padding`&
17047 .next
17048 &`netscape_challenge_bug`&
17049 .next
17050 &`netscape_reuse_cipher_change_bug`&
17051 .next
17052 &`no_compression`&
17053 .next
17054 &`no_session_resumption_on_renegotiation`&
17055 .next
17056 &`no_sslv2`&
17057 .next
17058 &`no_sslv3`&
17059 .next
17060 &`no_ticket`&
17061 .next
17062 &`no_tlsv1`&
17063 .next
17064 &`no_tlsv1_1`&
17065 .next
17066 &`no_tlsv1_2`&
17067 .next
17068 &`safari_ecdhe_ecdsa_bug`&
17069 .next
17070 &`single_dh_use`&
17071 .next
17072 &`single_ecdh_use`&
17073 .next
17074 &`ssleay_080_client_dh_bug`&
17075 .next
17076 &`sslref2_reuse_cert_type_bug`&
17077 .next
17078 &`tls_block_padding_bug`&
17079 .next
17080 &`tls_d5_bug`&
17081 .next
17082 &`tls_rollback_bug`&
17083 .endlist
17084
17085 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
17086 all clients connecting using the MacOS SecureTransport TLS facility prior
17087 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
17088 to negotiate TLS then this option value might help, provided that your OpenSSL
17089 release is new enough to contain this work-around.  This may be a situation
17090 where you have to upgrade OpenSSL to get buggy clients working.
17091
17092
17093 .option oracle_servers main "string list" unset
17094 .cindex "Oracle" "server list"
17095 This option provides a list of Oracle servers and associated connection data,
17096 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17097 The option is available only if Exim has been built with Oracle support.
17098
17099
17100 .option panic_coredump main boolean false
17101 This option is rarely needed but can help for some debugging investigations.
17102 If set, when an internal error is detected by Exim which is sufficient
17103 to terminate the process
17104 (all such are logged in the paniclog)
17105 then a coredump is requested.
17106
17107 Note that most systems require additional administrative configuration
17108 to permit write a core file for a setuid program, which is Exim's
17109 common installed configuration.
17110
17111 .option percent_hack_domains main "domain list&!!" unset
17112 .cindex "&""percent hack""&"
17113 .cindex "source routing" "in email address"
17114 .cindex "address" "source-routed"
17115 The &"percent hack"& is the convention whereby a local part containing a
17116 percent sign is re-interpreted as a new email address, with the percent
17117 replaced by @. This is sometimes called &"source routing"&, though that term is
17118 also applied to RFC 2822 addresses that begin with an @ character. If this
17119 option is set, Exim implements the percent facility for those domains listed,
17120 but no others. This happens before an incoming SMTP address is tested against
17121 an ACL.
17122
17123 &*Warning*&: The &"percent hack"& has often been abused by people who are
17124 trying to get round relaying restrictions. For this reason, it is best avoided
17125 if at all possible. Unfortunately, a number of less security-conscious MTAs
17126 implement it unconditionally. If you are running Exim on a gateway host, and
17127 routing mail through to internal MTAs without processing the local parts, it is
17128 a good idea to reject recipient addresses with percent characters in their
17129 local parts. Exim's default configuration does this.
17130
17131
17132 .options perl_at_start main boolean false &&&
17133          perl_startup main string unset
17134 .cindex "Perl"
17135 These options are available only when Exim is built with an embedded Perl
17136 interpreter. See chapter &<<CHAPperl>>& for details of their use.
17137
17138 .option perl_taintmode main boolean false
17139 .cindex "Perl"
17140 This option enables the taint mode of the embedded Perl interpreter.
17141
17142
17143 .option pgsql_servers main "string list" unset
17144 .cindex "PostgreSQL lookup type" "server list"
17145 This option provides a list of PostgreSQL servers and associated connection
17146 data, to be used in conjunction with &(pgsql)& lookups (see section
17147 &<<SECID72>>&). The option is available only if Exim has been built with
17148 PostgreSQL support.
17149
17150
17151 .option pid_file_path main string&!! "set at compile time"
17152 .cindex "daemon" "pid file path"
17153 .cindex "pid file, path for"
17154 This option sets the name of the file to which the Exim daemon writes its
17155 process id. The string is expanded, so it can contain, for example, references
17156 to the host name:
17157 .code
17158 pid_file_path = /var/log/$primary_hostname/exim.pid
17159 .endd
17160 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17161 spool directory.
17162 The value set by the option can be overridden by the &%-oP%& command line
17163 option. A pid file is not written if a &"non-standard"& daemon is run by means
17164 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17165
17166
17167 .option pipelining_advertise_hosts main "host list&!!" *
17168 .cindex "PIPELINING" "suppressing advertising"
17169 .cindex "ESMTP extensions" PIPELINING
17170 This option can be used to suppress the advertisement of the SMTP
17171 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17172 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17173 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17174 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17175 that clients will use it; &"out of order"& commands that are &"expected"& do
17176 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17177
17178 .option pipelining_connect_advertise_hosts main "host list&!!" *
17179 .cindex "pipelining" "early connection"
17180 .cindex "pipelining" PIPECONNECT
17181 .cindex "ESMTP extensions" PIPECONNECT
17182 If Exim is built without the DISABLE_PIPE_CONNECT build option
17183 this option controls which hosts the facility is advertised to
17184 and from which pipeline early-connection (before MAIL) SMTP
17185 commands are acceptable.
17186 When used, the pipelining saves on roundtrip times.
17187
17188 See also the &%hosts_pipe_connect%& smtp transport option.
17189
17190 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17191 it permits the client to pipeline
17192 TCP connection and hello command (inclear phase),
17193 or TLS-establishment and hello command (encrypted phase),
17194 on later connections to the same host.
17195
17196
17197 .option prdr_enable main boolean false
17198 .cindex "PRDR" "enabling on server"
17199 .cindex "ESMTP extensions" PRDR
17200 This option can be used to enable the Per-Recipient Data Response extension
17201 to SMTP, defined by Eric Hall.
17202 If the option is set, PRDR is advertised by Exim when operating as a server.
17203 If the client requests PRDR, and more than one recipient, for a message
17204 an additional ACL is called for each recipient after the message content
17205 is received.  See section &<<SECTPRDRACL>>&.
17206
17207 .option preserve_message_logs main boolean false
17208 .cindex "message logs" "preserving"
17209 If this option is set, message log files are not deleted when messages are
17210 completed. Instead, they are moved to a sub-directory of the spool directory
17211 called &_msglog.OLD_&, where they remain available for statistical or debugging
17212 purposes. This is a dangerous option to set on systems with any appreciable
17213 volume of mail. Use with care!
17214
17215
17216 .option primary_hostname main string "see below"
17217 .cindex "name" "of local host"
17218 .cindex "host" "name of local"
17219 .cindex "local host" "name of"
17220 .vindex "&$primary_hostname$&"
17221 This specifies the name of the current host. It is used in the default EHLO or
17222 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17223 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17224 The value is also used by default in some SMTP response messages from an Exim
17225 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17226
17227 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17228 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17229 contains only one component, Exim passes it to &[gethostbyname()]& (or
17230 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17231 version. The variable &$primary_hostname$& contains the host name, whether set
17232 explicitly by this option, or defaulted.
17233
17234
17235 .option print_topbitchars main boolean false
17236 .cindex "printing characters"
17237 .cindex "8-bit characters"
17238 By default, Exim considers only those characters whose codes lie in the range
17239 32&--126 to be printing characters. In a number of circumstances (for example,
17240 when writing log entries) non-printing characters are converted into escape
17241 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17242 is set, code values of 128 and above are also considered to be printing
17243 characters.
17244
17245 This option also affects the header syntax checks performed by the
17246 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17247 the user's full name when constructing From: and Sender: addresses (as
17248 described in section &<<SECTconstr>>&). Setting this option can cause
17249 Exim to generate eight bit message headers that do not conform to the
17250 standards.
17251
17252
17253 .option process_log_path main string unset
17254 .cindex "process log path"
17255 .cindex "log" "process log"
17256 .cindex "&'exiwhat'&"
17257 This option sets the name of the file to which an Exim process writes its
17258 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17259 utility script. If this option is unset, the file called &_exim-process.info_&
17260 in Exim's spool directory is used. The ability to specify the name explicitly
17261 can be useful in environments where two different Exims are running, using
17262 different spool directories.
17263
17264
17265 .option prod_requires_admin main boolean true
17266 .cindex "restricting access to features"
17267 .oindex "&%-M%&"
17268 .oindex "&%-R%&"
17269 .oindex "&%-q%&"
17270 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17271 admin user unless &%prod_requires_admin%& is set false. See also
17272 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17273
17274
17275 .option proxy_protocol_timeout main time 3s
17276 .cindex proxy "proxy protocol"
17277 This option sets the timeout for proxy protocol negotiation.
17278 For details see section &<<SECTproxyInbound>>&.
17279
17280
17281 .option qualify_domain main string "see below"
17282 .cindex "domain" "for qualifying addresses"
17283 .cindex "address" "qualification"
17284 This option specifies the domain name that is added to any envelope sender
17285 addresses that do not have a domain qualification. It also applies to
17286 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17287 are accepted by default only for locally-generated messages. Qualification is
17288 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17289 locally-generated messages, unless the &%-bnq%& command line option is used.
17290
17291 Messages from external sources must always contain fully qualified addresses,
17292 unless the sending host matches &%sender_unqualified_hosts%& or
17293 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17294 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17295 necessary. Internally, Exim always works with fully qualified envelope
17296 addresses. If &%qualify_domain%& is not set, it defaults to the
17297 &%primary_hostname%& value.
17298
17299
17300 .option qualify_recipient main string "see below"
17301 This option allows you to specify a different domain for qualifying recipient
17302 addresses to the one that is used for senders. See &%qualify_domain%& above.
17303
17304
17305
17306 .option queue_domains main "domain list&!!" unset
17307 .cindex "domain" "specifying non-immediate delivery"
17308 .cindex "queueing incoming messages"
17309 .cindex "message" "queueing certain domains"
17310 This option lists domains for which immediate delivery is not required.
17311 A delivery process is started whenever a message is received, but only those
17312 domains that do not match are processed. All other deliveries wait until the
17313 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17314
17315
17316 .option queue_fast_ramp main boolean true
17317 .cindex "queue runner" "two phase"
17318 .cindex "queue" "double scanning"
17319 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17320 command line, may start parallel delivery processes during their first
17321 phase.  This will be done when a threshold number of messages have been
17322 routed for a single host.
17323
17324
17325 .option queue_list_requires_admin main boolean true
17326 .cindex "restricting access to features"
17327 .oindex "&%-bp%&"
17328 The &%-bp%& command-line option, which lists the messages that are on the
17329 queue, requires the caller to be an admin user unless
17330 &%queue_list_requires_admin%& is set false.
17331 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17332
17333
17334 .option queue_only main boolean false
17335 .cindex "queueing incoming messages"
17336 .cindex "message" "queueing unconditionally"
17337 If &%queue_only%& is set, a delivery process is not automatically started
17338 whenever a message is received. Instead, the message waits in the queue for the
17339 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17340 delivered immediately when certain conditions (such as heavy load) occur.
17341
17342 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17343 and &%-odi%& command line options override &%queue_only%& unless
17344 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17345 &%queue_only_load%&, and &%smtp_accept_queue%&.
17346
17347
17348 .option queue_only_file main "string list" unset
17349 .cindex "queueing incoming messages"
17350 .cindex "message" "queueing by file existence"
17351 This option can be set to a colon-separated list of absolute path names, each
17352 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17353 it tests for the existence of each listed path using a call to &[stat()]&. For
17354 each path that exists, the corresponding queueing option is set.
17355 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17356 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17357 .code
17358 queue_only_file = smtp/some/file
17359 .endd
17360 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17361 &_/some/file_& exists.
17362
17363
17364 .option queue_only_load main fixed-point unset
17365 .cindex "load average"
17366 .cindex "queueing incoming messages"
17367 .cindex "message" "queueing by load"
17368 If the system load average is higher than this value, incoming messages from
17369 all sources are queued, and no automatic deliveries are started. If this
17370 happens during local or remote SMTP input, all subsequent messages received on
17371 the same SMTP connection are queued by default, whatever happens to the load in
17372 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17373 false.
17374
17375 Deliveries will subsequently be performed by queue runner processes. This
17376 option has no effect on ancient operating systems on which Exim cannot
17377 determine the load average. See also &%deliver_queue_load_max%& and
17378 &%smtp_load_reserve%&.
17379
17380
17381 .option queue_only_load_latch main boolean true
17382 .cindex "load average" "re-evaluating per message"
17383 When this option is true (the default), once one message has been queued
17384 because the load average is higher than the value set by &%queue_only_load%&,
17385 all subsequent messages received on the same SMTP connection are also queued.
17386 This is a deliberate choice; even though the load average may fall below the
17387 threshold, it doesn't seem right to deliver later messages on the same
17388 connection when not delivering earlier ones. However, there are special
17389 circumstances such as very long-lived connections from scanning appliances
17390 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17391 should be set false. This causes the value of the load average to be
17392 re-evaluated for each message.
17393
17394
17395 .option queue_only_override main boolean true
17396 .cindex "queueing incoming messages"
17397 When this option is true, the &%-od%&&'x'& command line options override the
17398 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17399 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17400 to override; they are accepted, but ignored.
17401
17402
17403 .option queue_run_in_order main boolean false
17404 .cindex "queue runner" "processing messages in order"
17405 If this option is set, queue runs happen in order of message arrival instead of
17406 in an arbitrary order. For this to happen, a complete list of the entire queue
17407 must be set up before the deliveries start. When the queue is all held in a
17408 single directory (the default), a single list is created for both the ordered
17409 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17410 single list is not created when &%queue_run_in_order%& is false. In this case,
17411 the sub-directories are processed one at a time (in a random order), and this
17412 avoids setting up one huge list for the whole queue. Thus, setting
17413 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17414 when the queue is large, because of the extra work in setting up the single,
17415 large list. In most situations, &%queue_run_in_order%& should not be set.
17416
17417
17418
17419 .option queue_run_max main integer&!! 5
17420 .cindex "queue runner" "maximum number of"
17421 This controls the maximum number of queue runner processes that an Exim daemon
17422 can run simultaneously. This does not mean that it starts them all at once,
17423 but rather that if the maximum number are still running when the time comes to
17424 start another one, it refrains from starting another one. This can happen with
17425 very large queues and/or very sluggish deliveries. This option does not,
17426 however, interlock with other processes, so additional queue runners can be
17427 started by other means, or by killing and restarting the daemon.
17428
17429 Setting this option to zero does not suppress queue runs; rather, it disables
17430 the limit, allowing any number of simultaneous queue runner processes to be
17431 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17432 the daemon's command line.
17433
17434 .cindex queues named
17435 .cindex "named queues" "resource limit"
17436 To set limits for different named queues use
17437 an expansion depending on the &$queue_name$& variable.
17438
17439 .option queue_smtp_domains main "domain list&!!" unset
17440 .cindex "queueing incoming messages"
17441 .cindex "message" "queueing remote deliveries"
17442 .cindex "first pass routing"
17443 When this option is set, a delivery process is started whenever a message is
17444 received, routing is performed, and local deliveries take place.
17445 However, if any SMTP deliveries are required for domains that match
17446 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17447 message waits in the queue for the next queue run. Since routing of the message
17448 has taken place, Exim knows to which remote hosts it must be delivered, and so
17449 when the queue run happens, multiple messages for the same host are delivered
17450 over a single SMTP connection. The &%-odqs%& command line option causes all
17451 SMTP deliveries to be queued in this way, and is equivalent to setting
17452 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17453 &%queue_domains%&.
17454
17455
17456 .option receive_timeout main time 0s
17457 .cindex "timeout" "for non-SMTP input"
17458 This option sets the timeout for accepting a non-SMTP message, that is, the
17459 maximum time that Exim waits when reading a message on the standard input. If
17460 the value is zero, it will wait forever. This setting is overridden by the
17461 &%-or%& command line option. The timeout for incoming SMTP messages is
17462 controlled by &%smtp_receive_timeout%&.
17463
17464 .option received_header_text main string&!! "see below"
17465 .cindex "customizing" "&'Received:'& header"
17466 .cindex "&'Received:'& header line" "customizing"
17467 This string defines the contents of the &'Received:'& message header that is
17468 added to each message, except for the timestamp, which is automatically added
17469 on at the end (preceded by a semicolon). The string is expanded each time it is
17470 used. If the expansion yields an empty string, no &'Received:'& header line is
17471 added to the message. Otherwise, the string should start with the text
17472 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17473 header lines.
17474 The default setting is:
17475
17476 .code
17477 received_header_text = Received: \
17478   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17479     {${if def:sender_ident \
17480       {from ${quote_local_part:$sender_ident} }}\
17481         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17482   by $primary_hostname \
17483   ${if def:received_protocol {with $received_protocol }}\
17484   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17485   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17486   (Exim $version_number)\n\t\
17487   ${if def:sender_address \
17488   {(envelope-from <$sender_address>)\n\t}}\
17489   id $message_exim_id\
17490   ${if def:received_for {\n\tfor $received_for}}
17491 .endd
17492
17493 The references to the TLS version and cipher are
17494 omitted when Exim is built without TLS
17495 support. The use of conditional expansions ensures that this works for both
17496 locally generated messages and messages received from remote hosts, giving
17497 header lines such as the following:
17498 .code
17499 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17500 by marley.carol.example with esmtp (Exim 4.00)
17501 (envelope-from <bob@carol.example>)
17502 id 16IOWa-00019l-00
17503 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17504 Received: by scrooge.carol.example with local (Exim 4.00)
17505 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17506 .endd
17507 Until the body of the message has been received, the timestamp is the time when
17508 the message started to be received. Once the body has arrived, and all policy
17509 checks have taken place, the timestamp is updated to the time at which the
17510 message was accepted.
17511
17512
17513 .option received_headers_max main integer 30
17514 .cindex "loop" "prevention"
17515 .cindex "mail loop prevention"
17516 .cindex "&'Received:'& header line" "counting"
17517 When a message is to be delivered, the number of &'Received:'& headers is
17518 counted, and if it is greater than this parameter, a mail loop is assumed to
17519 have occurred, the delivery is abandoned, and an error message is generated.
17520 This applies to both local and remote deliveries.
17521
17522
17523 .option recipient_unqualified_hosts main "host list&!!" unset
17524 .cindex "unqualified addresses"
17525 .cindex "host" "unqualified addresses from"
17526 This option lists those hosts from which Exim is prepared to accept unqualified
17527 recipient addresses in message envelopes. The addresses are made fully
17528 qualified by the addition of the &%qualify_recipient%& value. This option also
17529 affects message header lines. Exim does not reject unqualified recipient
17530 addresses in headers, but it qualifies them only if the message came from a
17531 host that matches &%recipient_unqualified_hosts%&,
17532 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17533 option was not set.
17534
17535
17536 .option recipients_max main integer&!! 50000
17537 .cindex "limit" "number of recipients"
17538 .cindex "recipient" "maximum number"
17539 If the value resulting from expanding this option
17540 is set greater than zero, it specifies the maximum number of
17541 original recipients for any message. Additional recipients that are generated
17542 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17543 all recipients over the limit; earlier recipients are delivered as normal.
17544 Non-SMTP messages with too many recipients are failed, and no deliveries are
17545 done.
17546
17547 For SMTP message the expansion is done after the connection is
17548 accepted (but before any SMTP conversation) and may depend on
17549 the IP addresses and port numbers of the connection.
17550 &*Note*&: If an expansion is used for the option,
17551 care should be taken that a resonable value results for
17552 non-SMTP messages.
17553
17554 .cindex "RCPT" "maximum number of incoming"
17555 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17556 RCPT commands in a single message.
17557
17558
17559 .option recipients_max_reject main boolean false
17560 If this option is set true, Exim rejects SMTP messages containing too many
17561 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17562 error to the eventual DATA command. Otherwise (the default) it gives a 452
17563 error to the surplus RCPT commands and accepts the message on behalf of the
17564 initial set of recipients. The remote server should then re-send the message
17565 for the remaining recipients at a later time.
17566
17567
17568 .option remote_max_parallel main integer 4
17569 .cindex "delivery" "parallelism for remote"
17570 This option controls parallel delivery of one message to a number of remote
17571 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17572 does all the remote deliveries for a message one by one. Otherwise, if a single
17573 message has to be delivered to more than one remote host, or if several copies
17574 have to be sent to the same remote host, up to &%remote_max_parallel%&
17575 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17576 deliveries are required, the maximum number of processes are started, and as
17577 each one finishes, another is begun. The order of starting processes is the
17578 same as if sequential delivery were being done, and can be controlled by the
17579 &%remote_sort_domains%& option. If parallel delivery takes place while running
17580 with debugging turned on, the debugging output from each delivery process is
17581 tagged with its process id.
17582
17583 This option controls only the maximum number of parallel deliveries for one
17584 message in one Exim delivery process. Because Exim has no central queue
17585 manager, there is no way of controlling the total number of simultaneous
17586 deliveries if the configuration allows a delivery attempt as soon as a message
17587 is received.
17588
17589 See also the &%max_parallel%& generic transport option,
17590 and the &%serialize_hosts%& smtp transport option.
17591
17592 .cindex "number of deliveries"
17593 .cindex "delivery" "maximum number of"
17594 If you want to control the total number of deliveries on the system, you
17595 need to set the &%queue_only%& option. This ensures that all incoming messages
17596 are added to the queue without starting a delivery process. Then set up an Exim
17597 daemon to start queue runner processes at appropriate intervals (probably
17598 fairly often, for example, every minute), and limit the total number of queue
17599 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17600 delivers only one message at a time, the maximum number of deliveries that can
17601 then take place at once is &%queue_run_max%& multiplied by
17602 &%remote_max_parallel%&.
17603
17604 If it is purely remote deliveries you want to control, use
17605 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17606 doing the SMTP routing before queueing, so that several messages for the same
17607 host will eventually get delivered down the same connection.
17608
17609
17610 .option remote_sort_domains main "domain list&!!" unset
17611 .cindex "sorting remote deliveries"
17612 .cindex "delivery" "sorting remote"
17613 When there are a number of remote deliveries for a message, they are sorted by
17614 domain into the order given by this list. For example,
17615 .code
17616 remote_sort_domains = *.cam.ac.uk:*.uk
17617 .endd
17618 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17619 then to those in the &%uk%& domain, then to any others.
17620
17621
17622 .option retry_data_expire main time 7d
17623 .cindex "hints database" "data expiry"
17624 This option sets a &"use before"& time on retry information in Exim's hints
17625 database. Any older retry data is ignored. This means that, for example, once a
17626 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17627 past failures.
17628
17629
17630 .option retry_interval_max main time 24h
17631 .cindex "retry" "limit on interval"
17632 .cindex "limit" "on retry interval"
17633 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17634 intervals between delivery attempts for messages that cannot be delivered
17635 straight away. This option sets an overall limit to the length of time between
17636 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17637 the default value.
17638
17639
17640 .option return_path_remove main boolean true
17641 .cindex "&'Return-path:'& header line" "removing"
17642 RFC 2821, section 4.4, states that an SMTP server must insert a
17643 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17644 The &'Return-path:'& header preserves the sender address as received in the
17645 MAIL command. This description implies that this header should not be present
17646 in an incoming message. If &%return_path_remove%& is true, any existing
17647 &'Return-path:'& headers are removed from messages at the time they are
17648 received. Exim's transports have options for adding &'Return-path:'& headers at
17649 the time of delivery. They are normally used only for final local deliveries.
17650
17651
17652 .option return_size_limit main integer 100K
17653 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17654
17655
17656 .option rfc1413_hosts main "host list&!!" @[]
17657 .cindex "RFC 1413"
17658 .cindex "host" "for RFC 1413 calls"
17659 RFC 1413 identification calls are made to any client host which matches
17660 an item in the list.
17661 The default value specifies just this host, being any local interface
17662 for the system.
17663
17664 .option rfc1413_query_timeout main time 0s
17665 .cindex "RFC 1413" "query timeout"
17666 .cindex "timeout" "for RFC 1413 call"
17667 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17668 no RFC 1413 calls are ever made.
17669
17670
17671 .option sender_unqualified_hosts main "host list&!!" unset
17672 .cindex "unqualified addresses"
17673 .cindex "host" "unqualified addresses from"
17674 This option lists those hosts from which Exim is prepared to accept unqualified
17675 sender addresses. The addresses are made fully qualified by the addition of
17676 &%qualify_domain%&. This option also affects message header lines. Exim does
17677 not reject unqualified addresses in headers that contain sender addresses, but
17678 it qualifies them only if the message came from a host that matches
17679 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17680 using TCP/IP), and the &%-bnq%& option was not set.
17681
17682
17683 .option slow_lookup_log main integer 0
17684 .cindex "logging" "slow lookups"
17685 .cindex "dns" "logging slow lookups"
17686 This option controls logging of slow lookups.
17687 If the value is nonzero it is taken as a number of milliseconds
17688 and lookups taking longer than this are logged.
17689 Currently this applies only to DNS lookups.
17690
17691
17692
17693 .option smtp_accept_keepalive main boolean true
17694 .cindex "keepalive" "on incoming connection"
17695 This option controls the setting of the SO_KEEPALIVE option on incoming
17696 TCP/IP socket connections. When set, it causes the kernel to probe idle
17697 connections periodically, by sending packets with &"old"& sequence numbers. The
17698 other end of the connection should send an acknowledgment if the connection is
17699 still okay or a reset if the connection has been aborted. The reason for doing
17700 this is that it has the beneficial effect of freeing up certain types of
17701 connection that can get stuck when the remote host is disconnected without
17702 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17703 hours to detect unreachable hosts.
17704
17705
17706
17707 .option smtp_accept_max main integer 20
17708 .cindex "limit" "incoming SMTP connections"
17709 .cindex "SMTP" "incoming connection count"
17710 .cindex "inetd"
17711 This option specifies the maximum number of simultaneous incoming SMTP calls
17712 that Exim will accept. It applies only to the listening daemon; there is no
17713 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17714 value is set to zero, no limit is applied. However, it is required to be
17715 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17716 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17717
17718 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17719 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17720 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17721 and &%smtp_load_reserve%& are then checked before accepting the connection.
17722
17723
17724 .option smtp_accept_max_nonmail main integer 10
17725 .cindex "limit" "non-mail SMTP commands"
17726 .cindex "SMTP" "limiting non-mail commands"
17727 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17728 the connection if there are too many. This option defines &"too many"&. The
17729 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17730 client looping sending EHLO, for example. The check is applied only if the
17731 client host matches &%smtp_accept_max_nonmail_hosts%&.
17732
17733 When a new message is expected, one occurrence of RSET is not counted. This
17734 allows a client to send one RSET between messages (this is not necessary,
17735 but some clients do it). Exim also allows one uncounted occurrence of HELO
17736 or EHLO, and one occurrence of STARTTLS between messages. After
17737 starting up a TLS session, another EHLO is expected, and so it too is not
17738 counted. The first occurrence of AUTH in a connection, or immediately
17739 following STARTTLS is not counted. Otherwise, all commands other than
17740 MAIL, RCPT, DATA, and QUIT are counted.
17741
17742
17743 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17744 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17745 check by setting this option. The default value makes it apply to all hosts. By
17746 changing the value, you can exclude any badly-behaved hosts that you have to
17747 live with.
17748
17749
17750 . Allow this long option name to split; give it unsplit as a fifth argument
17751 . for the automatic .oindex that is generated by .option.
17752 . We insert " &~&~" which is both pretty nasty visually and results in
17753 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17754 . zero-width-space, which would be nicer visually and results in (at least)
17755 . html that Firefox will split on when it's forced to reflow (rather than
17756 . inserting a horizontal scrollbar).  However, the text is still not
17757 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17758 . the option name to split.
17759
17760 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17761          smtp_accept_max_per_connection
17762 .cindex "SMTP" "limiting incoming message count"
17763 .cindex "limit" "messages per SMTP connection"
17764 The value of this option limits the number of MAIL commands that Exim is
17765 prepared to accept over a single SMTP connection, whether or not each command
17766 results in the transfer of a message. After the limit is reached, a 421
17767 response is given to subsequent MAIL commands. This limit is a safety
17768 precaution against a client that goes mad (incidents of this type have been
17769 seen).
17770 The option is expanded after the HELO or EHLO is received
17771 and may depend on values available at that time.
17772 An empty or zero value after expansion removes the limit.
17773
17774
17775 .option smtp_accept_max_per_host main string&!! unset
17776 .cindex "limit" "SMTP connections from one host"
17777 .cindex "host" "limiting SMTP connections from"
17778 This option restricts the number of simultaneous IP connections from a single
17779 host (strictly, from a single IP address) to the Exim daemon. The option is
17780 expanded, to enable different limits to be applied to different hosts by
17781 reference to &$sender_host_address$&. Once the limit is reached, additional
17782 connection attempts from the same host are rejected with error code 421. This
17783 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17784 of zero imposes no limit. If this option is set greater than zero, it is
17785 required that &%smtp_accept_max%& be non-zero.
17786
17787 &*Warning*&: When setting this option you should not use any expansion
17788 constructions that take an appreciable amount of time. The expansion and test
17789 happen in the main daemon loop, in order to reject additional connections
17790 without forking additional processes (otherwise a denial-of-service attack
17791 could cause a vast number or processes to be created). While the daemon is
17792 doing this processing, it cannot accept any other incoming connections.
17793
17794
17795
17796 .option smtp_accept_queue main integer 0
17797 .cindex "SMTP" "incoming connection count"
17798 .cindex "queueing incoming messages"
17799 .cindex "message" "queueing by SMTP connection count"
17800 If the number of simultaneous incoming SMTP connections being handled via the
17801 listening daemon exceeds this value, messages received by SMTP are just placed
17802 in the queue; no delivery processes are started automatically. The count is
17803 fixed at the start of an SMTP connection. It cannot be updated in the
17804 subprocess that receives messages, and so the queueing or not queueing applies
17805 to all messages received in the same connection.
17806
17807 A value of zero implies no limit, and clearly any non-zero value is useful only
17808 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17809 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17810 various &%-od%&&'x'& command line options.
17811
17812
17813 . See the comment on smtp_accept_max_per_connection
17814
17815 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17816          smtp_accept_queue_per_connection
17817 .cindex "queueing incoming messages"
17818 .cindex "message" "queueing by message count"
17819 This option limits the number of delivery processes that Exim starts
17820 automatically when receiving messages via SMTP, whether via the daemon or by
17821 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17822 and the number of messages received in a single SMTP session exceeds this
17823 number, subsequent messages are placed in the queue, but no delivery processes
17824 are started. This helps to limit the number of Exim processes when a server
17825 restarts after downtime and there is a lot of mail waiting for it on other
17826 systems. On large systems, the default should probably be increased, and on
17827 dial-in client systems it should probably be set to zero (that is, disabled).
17828
17829
17830 .option smtp_accept_reserve main integer 0
17831 .cindex "SMTP" "incoming call count"
17832 .cindex "host" "reserved"
17833 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17834 number of SMTP connections that are reserved for connections from the hosts
17835 that are specified in &%smtp_reserve_hosts%&. The value set in
17836 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17837 restricted to this number of connections; the option specifies a minimum number
17838 of connection slots for them, not a maximum. It is a guarantee that this group
17839 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17840 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17841 individual host.
17842
17843 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17844 set to 5, once there are 45 active connections (from any hosts), new
17845 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17846 provided the other criteria for acceptance are met.
17847
17848
17849 .option smtp_active_hostname main string&!! unset
17850 .cindex "host" "name in SMTP responses"
17851 .cindex "SMTP" "host name in responses"
17852 .vindex "&$primary_hostname$&"
17853 This option is provided for multi-homed servers that want to masquerade as
17854 several different hosts. At the start of an incoming SMTP connection, its value
17855 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17856 responses. For example, it is used as domain name in the response to an
17857 incoming HELO or EHLO command.
17858
17859 .vindex "&$smtp_active_hostname$&"
17860 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17861 is saved with any messages that are received. It is therefore available for use
17862 in routers and transports when the message is later delivered.
17863
17864 If this option is unset, or if its expansion is forced to fail, or if the
17865 expansion results in an empty string, the value of &$primary_hostname$& is
17866 used. Other expansion failures cause a message to be written to the main and
17867 panic logs, and the SMTP command receives a temporary error. Typically, the
17868 value of &%smtp_active_hostname%& depends on the incoming interface address.
17869 For example:
17870 .code
17871 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17872   {cox.mydomain}{box.mydomain}}
17873 .endd
17874
17875 Although &$smtp_active_hostname$& is primarily concerned with incoming
17876 messages, it is also used as the default for HELO commands in callout
17877 verification if there is no remote transport from which to obtain a
17878 &%helo_data%& value.
17879
17880 .option smtp_backlog_monitor main integer 0
17881 .cindex "connection backlog" monitoring
17882 If this option is set to greater than zero, and the backlog of available
17883 TCP connections on a socket listening for SMTP is larger than it, a line
17884 is logged giving the value and the socket address and port.
17885 The value is retrived jsut before an accept call.
17886 This facility is only available on Linux.
17887
17888 .option smtp_banner main string&!! "see below"
17889 .cindex "SMTP" "welcome banner"
17890 .cindex "banner for SMTP"
17891 .cindex "welcome banner for SMTP"
17892 .cindex "customizing" "SMTP banner"
17893 If a connect ACL does not supply a message,
17894 this string (which is expanded every time it is used) is output as the initial
17895 positive response to an SMTP connection. The default setting is:
17896 .code
17897 smtp_banner = $smtp_active_hostname ESMTP Exim \
17898   $version_number $tod_full
17899 .endd
17900 Failure to expand the string causes a panic error;
17901 a forced fail just closes the connection.
17902 If you want to create a
17903 multiline response to the initial SMTP connection, use &"\n"& in the string at
17904 appropriate points, but not at the end. Note that the 220 code is not included
17905 in this string. Exim adds it automatically (several times in the case of a
17906 multiline response).
17907
17908
17909 .option smtp_check_spool_space main boolean true
17910 .cindex "checking disk space"
17911 .cindex "disk space, checking"
17912 .cindex "spool directory" "checking space"
17913 When this option is set, if an incoming SMTP session encounters the SIZE
17914 option on a MAIL command, it checks that there is enough space in the
17915 spool directory's partition to accept a message of that size, while still
17916 leaving free the amount specified by &%check_spool_space%& (even if that value
17917 is zero). If there isn't enough space, a temporary error code is returned.
17918
17919
17920 .option smtp_connect_backlog main integer 20
17921 .cindex "connection backlog" "set maximum"
17922 .cindex "SMTP" "connection backlog"
17923 .cindex "backlog of connections"
17924 This option specifies a maximum number of waiting SMTP connections. Exim passes
17925 this value to the TCP/IP system when it sets up its listener. Once this number
17926 of connections are waiting for the daemon's attention, subsequent connection
17927 attempts are refused at the TCP/IP level. At least, that is what the manuals
17928 say; in some circumstances such connection attempts have been observed to time
17929 out instead. For large systems it is probably a good idea to increase the
17930 value (to 50, say). It also gives some protection against denial-of-service
17931 attacks by SYN flooding.
17932
17933
17934 .option smtp_enforce_sync main boolean true
17935 .cindex "SMTP" "synchronization checking"
17936 .cindex "synchronization checking in SMTP"
17937 The SMTP protocol specification requires the client to wait for a response from
17938 the server at certain points in the dialogue. Without PIPELINING these
17939 synchronization points are after every command; with PIPELINING they are
17940 fewer, but they still exist.
17941
17942 Some spamming sites send out a complete set of SMTP commands without waiting
17943 for any response. Exim protects against this by rejecting a message if the
17944 client has sent further input when it should not have. The error response &"554
17945 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17946 for this error cannot be perfect because of transmission delays (unexpected
17947 input may be on its way but not yet received when Exim checks). However, it
17948 does detect many instances.
17949
17950 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17951 If you want to disable the check selectively (for example, only for certain
17952 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17953 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17954
17955
17956
17957 .option smtp_etrn_command main string&!! unset
17958 .cindex "ETRN" "command to be run"
17959 .cindex "ESMTP extensions" ETRN
17960 .vindex "&$domain$&"
17961 If this option is set, the given command is run whenever an SMTP ETRN
17962 command is received from a host that is permitted to issue such commands (see
17963 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17964 are independently expanded. The expansion variable &$domain$& is set to the
17965 argument of the ETRN command, and no syntax checking is done on it. For
17966 example:
17967 .code
17968 smtp_etrn_command = /etc/etrn_command $domain \
17969                     $sender_host_address
17970 .endd
17971 If the option is not set, the argument for the ETRN command must
17972 be a &'#'& followed by an address string.
17973 In this case an &'exim -R <string>'& command is used;
17974 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17975
17976 A new process is created to run the command, but Exim does not wait for it to
17977 complete. Consequently, its status cannot be checked. If the command cannot be
17978 run, a line is written to the panic log, but the ETRN caller still receives
17979 a 250 success response. Exim is normally running under its own uid when
17980 receiving SMTP, so it is not possible for it to change the uid before running
17981 the command.
17982
17983
17984 .option smtp_etrn_serialize main boolean true
17985 .cindex "ETRN" "serializing"
17986 When this option is set, it prevents the simultaneous execution of more than
17987 one identical command as a result of ETRN in an SMTP connection. See
17988 section &<<SECTETRN>>& for details.
17989
17990
17991 .option smtp_load_reserve main fixed-point unset
17992 .cindex "load average"
17993 If the system load average ever gets higher than this, incoming SMTP calls are
17994 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17995 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17996 the load is over the limit. The option has no effect on ancient operating
17997 systems on which Exim cannot determine the load average. See also
17998 &%deliver_queue_load_max%& and &%queue_only_load%&.
17999
18000
18001
18002 .option smtp_max_synprot_errors main integer 3
18003 .cindex "SMTP" "limiting syntax and protocol errors"
18004 .cindex "limit" "SMTP syntax and protocol errors"
18005 Exim rejects SMTP commands that contain syntax or protocol errors. In
18006 particular, a syntactically invalid email address, as in this command:
18007 .code
18008 RCPT TO:<abc xyz@a.b.c>
18009 .endd
18010 causes immediate rejection of the command, before any other tests are done.
18011 (The ACL cannot be run if there is no valid address to set up for it.) An
18012 example of a protocol error is receiving RCPT before MAIL. If there are
18013 too many syntax or protocol errors in one SMTP session, the connection is
18014 dropped. The limit is set by this option.
18015
18016 .cindex "PIPELINING" "expected errors"
18017 When the PIPELINING extension to SMTP is in use, some protocol errors are
18018 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
18019 Exim assumes that PIPELINING will be used if it advertises it (see
18020 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
18021 not count towards the limit.
18022
18023
18024
18025 .option smtp_max_unknown_commands main integer 3
18026 .cindex "SMTP" "limiting unknown commands"
18027 .cindex "limit" "unknown SMTP commands"
18028 If there are too many unrecognized commands in an incoming SMTP session, an
18029 Exim server drops the connection. This is a defence against some kinds of abuse
18030 that subvert web
18031 clients
18032 into making connections to SMTP ports; in these circumstances, a number of
18033 non-SMTP command lines are sent first.
18034
18035
18036
18037 .options smtp_ratelimit_hosts main "host list&!!" unset &&&
18038          smtp_ratelimit_mail main string unset &&&
18039          smtp_ratelimit_rcpt main string unset
18040 .cindex "SMTP" "rate limiting"
18041 .cindex "limit" "rate of message arrival"
18042 .cindex "RCPT" "rate limiting"
18043 Some sites find it helpful to be able to limit the rate at which certain hosts
18044 can send them messages, and the rate at which an individual message can specify
18045 recipients.
18046
18047 Exim has two rate-limiting facilities. This section describes the older
18048 facility, which can limit rates within a single connection. The newer
18049 &%ratelimit%& ACL condition can limit rates across all connections. See section
18050 &<<SECTratelimiting>>& for details of the newer facility.
18051
18052 When a host matches &%smtp_ratelimit_hosts%&, the values of
18053 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
18054 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
18055 respectively. Each option, if set, must contain a set of four comma-separated
18056 values:
18057
18058 .ilist
18059 A threshold, before which there is no rate limiting.
18060 .next
18061 An initial time delay. Unlike other times in Exim, numbers with decimal
18062 fractional parts are allowed here.
18063 .next
18064 A factor by which to increase the delay each time.
18065 .next
18066 A maximum value for the delay. This should normally be less than 5 minutes,
18067 because after that time, the client is liable to timeout the SMTP command.
18068 .endlist
18069
18070 For example, these settings have been used successfully at the site which
18071 first suggested this feature, for controlling mail from their customers:
18072 .code
18073 smtp_ratelimit_mail = 2,0.5s,1.05,4m
18074 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
18075 .endd
18076 The first setting specifies delays that are applied to MAIL commands after
18077 two have been received over a single connection. The initial delay is 0.5
18078 seconds, increasing by a factor of 1.05 each time. The second setting applies
18079 delays to RCPT commands when more than four occur in a single message.
18080
18081
18082
18083 .option smtp_receive_timeout main time&!! 5m
18084 .cindex "timeout" "for SMTP input"
18085 .cindex "SMTP" "input timeout"
18086 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
18087 input, including batch SMTP. If a line of input (either an SMTP command or a
18088 data line) is not received within this time, the SMTP connection is dropped and
18089 the message is abandoned.
18090 A line is written to the log containing one of the following messages:
18091 .code
18092 SMTP command timeout on connection from...
18093 SMTP data timeout on connection from...
18094 .endd
18095 The former means that Exim was expecting to read an SMTP command; the latter
18096 means that it was in the DATA phase, reading the contents of a message.
18097
18098 If the first character of the option is a &"$"& the option is
18099 expanded before use and may depend on
18100 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18101
18102
18103 .oindex "&%-os%&"
18104 The value set by this option can be overridden by the
18105 &%-os%& command-line option. A setting of zero time disables the timeout, but
18106 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18107 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18108 timeout is controlled by &%receive_timeout%& and &%-or%&.
18109
18110
18111 .option smtp_reserve_hosts main "host list&!!" unset
18112 This option defines hosts for which SMTP connections are reserved; see
18113 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18114
18115
18116 .option smtp_return_error_details main boolean false
18117 .cindex "SMTP" "details policy failures"
18118 .cindex "policy control" "rejection, returning details"
18119 In the default state, Exim uses bland messages such as
18120 &"Administrative prohibition"& when it rejects SMTP commands for policy
18121 reasons. Many sysadmins like this because it gives away little information
18122 to spammers. However, some other sysadmins who are applying strict checking
18123 policies want to give out much fuller information about failures. Setting
18124 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18125 example, instead of &"Administrative prohibition"&, it might give:
18126 .code
18127 550-Rejected after DATA: '>' missing at end of address:
18128 550 failing address in "From" header is: <user@dom.ain
18129 .endd
18130
18131
18132 .option smtputf8_advertise_hosts main "host list&!!" *
18133 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18134 .cindex "ESMTP extensions" SMTPUTF8
18135 When Exim is built with support for internationalised mail names,
18136 the availability thereof is advertised in
18137 response to EHLO only to those client hosts that match this option. See
18138 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18139
18140
18141 .option spamd_address main string "127.0.0.1 783"
18142 This option is available when Exim is compiled with the content-scanning
18143 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18144 See section &<<SECTscanspamass>>& for more details.
18145
18146
18147
18148 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18149 This option is available when Exim is compiled with SPF support.
18150 See section &<<SECSPF>>& for more details.
18151
18152 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18153 This option is available when Exim is compiled with SPF support.  It
18154 allows the customisation of the SMTP comment that the SPF library
18155 generates.  You are strongly encouraged to link to your own explanative
18156 site. The template must not contain spaces. If you need spaces in the
18157 output, use the proper placeholder. If libspf2 can not parse the
18158 template, it uses a built-in default broken link. The following placeholders
18159 (along with Exim variables (but see below)) are allowed in the template:
18160 .ilist
18161 &*%_*&: A space.
18162 .next
18163 &*%{L}*&: Envelope sender's local part.
18164 .next
18165 &*%{S}*&: Envelope sender.
18166 .next
18167 &*%{O}*&: Envelope sender's domain.
18168 .next
18169 &*%{D}*&: Current(?) domain.
18170 .next
18171 &*%{I}*&: SMTP client Ip.
18172 .next
18173 &*%{C}*&: SMTP client pretty IP.
18174 .next
18175 &*%{T}*&: Epoch time (UTC).
18176 .next
18177 &*%{P}*&: SMTP client domain name.
18178 .next
18179 &*%{V}*&: IP version.
18180 .next
18181 &*%{H}*&: EHLO/HELO domain.
18182 .next
18183 &*%{R}*&: Receiving domain.
18184 .endlist
18185 The capitalized placeholders do proper URL encoding, if you use them
18186 lowercased, no encoding takes place.  This list was compiled from the
18187 libspf2 sources.
18188
18189 A note on using Exim variables: As
18190 currently the SPF library is initialized before the SMTP EHLO phase,
18191 the variables useful for expansion are quite limited.
18192
18193
18194 .option split_spool_directory main boolean false
18195 .cindex "multiple spool directories"
18196 .cindex "spool directory" "split"
18197 .cindex "directories, multiple"
18198 If this option is set, it causes Exim to split its input directory into 62
18199 subdirectories, each with a single alphanumeric character as its name. The
18200 sixth character of the message id is used to allocate messages to
18201 subdirectories; this is the least significant base-62 digit of the time of
18202 arrival of the message.
18203
18204 Splitting up the spool in this way may provide better performance on systems
18205 where there are long mail queues, by reducing the number of files in any one
18206 directory. The msglog directory is also split up in a similar way to the input
18207 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18208 are still placed in the single directory &_msglog.OLD_&.
18209
18210 It is not necessary to take any special action for existing messages when
18211 changing &%split_spool_directory%&. Exim notices messages that are in the
18212 &"wrong"& place, and continues to process them. If the option is turned off
18213 after a period of being on, the subdirectories will eventually empty and be
18214 automatically deleted.
18215
18216 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18217 changes. Instead of creating a list of all messages in the queue, and then
18218 trying to deliver each one, in turn, it constructs a list of those in one
18219 sub-directory and tries to deliver them, before moving on to the next
18220 sub-directory. The sub-directories are processed in a random order. This
18221 spreads out the scanning of the input directories, and uses less memory. It is
18222 particularly beneficial when there are lots of messages in the queue. However,
18223 if &%queue_run_in_order%& is set, none of this new processing happens. The
18224 entire queue has to be scanned and sorted before any deliveries can start.
18225
18226
18227 .option spool_directory main string&!! "set at compile time"
18228 .cindex "spool directory" "path to"
18229 This defines the directory in which Exim keeps its spool, that is, the messages
18230 it is waiting to deliver. The default value is taken from the compile-time
18231 configuration setting, if there is one. If not, this option must be set. The
18232 string is expanded, so it can contain, for example, a reference to
18233 &$primary_hostname$&.
18234
18235 If the spool directory name is fixed on your installation, it is recommended
18236 that you set it at build time rather than from this option, particularly if the
18237 log files are being written to the spool directory (see &%log_file_path%&).
18238 Otherwise log files cannot be used for errors that are detected early on, such
18239 as failures in the configuration file.
18240
18241 By using this option to override the compiled-in path, it is possible to run
18242 tests of Exim without using the standard spool.
18243
18244 .option spool_wireformat main boolean false
18245 .cindex "spool directory" "file formats"
18246 If this option is set, Exim may for some messages use an alternative format
18247 for data-files in the spool which matches the wire format.
18248 Doing this permits more efficient message reception and transmission.
18249 Currently it is only done for messages received using the ESMTP CHUNKING
18250 option.
18251
18252 The following variables will not have useful values:
18253 .code
18254 $max_received_linelength
18255 $body_linecount
18256 $body_zerocount
18257 .endd
18258
18259 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18260 and any external programs which are passed a reference to a message data file
18261 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18262 will need to be aware of the different formats potentially available.
18263
18264 Using any of the ACL conditions noted will negate the reception benefit
18265 (as a Unix-mbox-format file is constructed for them).
18266 The transmission benefit is maintained.
18267
18268 .option sqlite_lock_timeout main time 5s
18269 .cindex "sqlite lookup type" "lock timeout"
18270 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18271 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18272
18273 .option strict_acl_vars main boolean false
18274 .cindex "&ACL;" "variables, handling unset"
18275 This option controls what happens if a syntactically valid but undefined ACL
18276 variable is referenced. If it is false (the default), an empty string
18277 is substituted; if it is true, an error is generated. See section
18278 &<<SECTaclvariables>>& for details of ACL variables.
18279
18280 .option strip_excess_angle_brackets main boolean false
18281 .cindex "angle brackets, excess"
18282 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18283 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18284 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18285 passed on to another MTA, the excess angle brackets are not passed on. If this
18286 option is not set, multiple pairs of angle brackets cause a syntax error.
18287
18288
18289 .option strip_trailing_dot main boolean false
18290 .cindex "trailing dot on domain"
18291 .cindex "dot" "trailing on domain"
18292 If this option is set, a trailing dot at the end of a domain in an address is
18293 ignored. If this is in the envelope and the message is passed on to another
18294 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18295 domain causes a syntax error.
18296 However, addresses in header lines are checked only when an ACL requests header
18297 syntax checking.
18298
18299
18300 .option syslog_duplication main boolean true
18301 .cindex "syslog" "duplicate log lines; suppressing"
18302 When Exim is logging to syslog, it writes the log lines for its three
18303 separate logs at different syslog priorities so that they can in principle
18304 be separated on the logging hosts. Some installations do not require this
18305 separation, and in those cases, the duplication of certain log lines is a
18306 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18307 particular log line is written to syslog. For lines that normally go to
18308 both the main log and the reject log, the reject log version (possibly
18309 containing message header lines) is written, at LOG_NOTICE priority.
18310 Lines that normally go to both the main and the panic log are written at
18311 the LOG_ALERT priority.
18312
18313
18314 .option syslog_facility main string unset
18315 .cindex "syslog" "facility; setting"
18316 This option sets the syslog &"facility"& name, used when Exim is logging to
18317 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18318 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18319 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18320 details of Exim's logging.
18321
18322
18323 .option syslog_pid main boolean true
18324 .cindex "syslog" "pid"
18325 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18326 omitted when these lines are sent to syslog. (Syslog normally prefixes
18327 the log lines with the PID of the logging process automatically.) You need
18328 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18329 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18330
18331
18332
18333 .option syslog_processname main string &`exim`&
18334 .cindex "syslog" "process name; setting"
18335 This option sets the syslog &"ident"& name, used when Exim is logging to
18336 syslog. The value must be no longer than 32 characters. See chapter
18337 &<<CHAPlog>>& for details of Exim's logging.
18338
18339
18340
18341 .option syslog_timestamp main boolean true
18342 .cindex "syslog" "timestamps"
18343 .cindex timestamps syslog
18344 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18345 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18346 details of Exim's logging.
18347
18348
18349 .option system_filter main string&!! unset
18350 .cindex "filter" "system filter"
18351 .cindex "system filter" "specifying"
18352 .cindex "Sieve filter" "not available for system filter"
18353 This option specifies an Exim filter file that is applied to all messages at
18354 the start of each delivery attempt, before any routing is done. System filters
18355 must be Exim filters; they cannot be Sieve filters. If the system filter
18356 generates any deliveries to files or pipes, or any new mail messages, the
18357 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18358 which transports are to be used. Details of this facility are given in chapter
18359 &<<CHAPsystemfilter>>&.
18360 A forced expansion failure results in no filter operation.
18361
18362
18363 .option system_filter_directory_transport main string&!! unset
18364 .vindex "&$address_file$&"
18365 This sets the name of the transport driver that is to be used when the
18366 &%save%& command in a system message filter specifies a path ending in &"/"&,
18367 implying delivery of each message into a separate file in some directory.
18368 During the delivery, the variable &$address_file$& contains the path name.
18369
18370
18371 .option system_filter_file_transport main string&!! unset
18372 .cindex "file" "transport for system filter"
18373 This sets the name of the transport driver that is to be used when the &%save%&
18374 command in a system message filter specifies a path not ending in &"/"&. During
18375 the delivery, the variable &$address_file$& contains the path name.
18376
18377 .option system_filter_group main string unset
18378 .cindex "gid (group id)" "system filter"
18379 This option is used only when &%system_filter_user%& is also set. It sets the
18380 gid under which the system filter is run, overriding any gid that is associated
18381 with the user. The value may be numerical or symbolic.
18382
18383 .option system_filter_pipe_transport main string&!! unset
18384 .cindex "&(pipe)& transport" "for system filter"
18385 .vindex "&$address_pipe$&"
18386 This specifies the transport driver that is to be used when a &%pipe%& command
18387 is used in a system filter. During the delivery, the variable &$address_pipe$&
18388 contains the pipe command.
18389
18390
18391 .option system_filter_reply_transport main string&!! unset
18392 .cindex "&(autoreply)& transport" "for system filter"
18393 This specifies the transport driver that is to be used when a &%mail%& command
18394 is used in a system filter.
18395
18396
18397 .option system_filter_user main string unset
18398 .cindex "uid (user id)" "system filter"
18399 If this option is set to root, the system filter is run in the main Exim
18400 delivery process, as root.  Otherwise, the system filter runs in a separate
18401 process, as the given user, defaulting to the Exim run-time user.
18402 Unless the string consists entirely of digits, it
18403 is looked up in the password data. Failure to find the named user causes a
18404 configuration error. The gid is either taken from the password data, or
18405 specified by &%system_filter_group%&. When the uid is specified numerically,
18406 &%system_filter_group%& is required to be set.
18407
18408 If the system filter generates any pipe, file, or reply deliveries, the uid
18409 under which the filter is run is used when transporting them, unless a
18410 transport option overrides.
18411
18412
18413 .option tcp_nodelay main boolean true
18414 .cindex "daemon" "TCP_NODELAY on sockets"
18415 .cindex "Nagle algorithm"
18416 .cindex "TCP_NODELAY on listening sockets"
18417 If this option is set false, it stops the Exim daemon setting the
18418 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18419 turns off the &"Nagle algorithm"&, which is a way of improving network
18420 performance in interactive (character-by-character) situations. Turning it off
18421 should improve Exim's performance a bit, so that is what happens by default.
18422 However, it appears that some broken clients cannot cope, and time out. Hence
18423 this option. It affects only those sockets that are set up for listening by the
18424 daemon. Sockets created by the smtp transport for delivering mail always set
18425 TCP_NODELAY.
18426
18427
18428 .option timeout_frozen_after main time 0s
18429 .cindex "frozen messages" "timing out"
18430 .cindex "timeout" "frozen messages"
18431 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18432 message of any kind that has been in the queue for longer than the given time
18433 is automatically cancelled at the next queue run. If the frozen message is a
18434 bounce message, it is just discarded; otherwise, a bounce is sent to the
18435 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18436 If you want to timeout frozen bounce messages earlier than other kinds of
18437 frozen message, see &%ignore_bounce_errors_after%&.
18438
18439 &*Note:*& the default value of zero means no timeouts; with this setting,
18440 frozen messages remain in the queue forever (except for any frozen bounce
18441 messages that are released by &%ignore_bounce_errors_after%&).
18442
18443
18444 .option timezone main string unset
18445 .cindex "timezone, setting"
18446 .cindex "environment" "values from"
18447 The value of &%timezone%& is used to set the environment variable TZ while
18448 running Exim (if it is different on entry). This ensures that all timestamps
18449 created by Exim are in the required timezone. If you want all your timestamps
18450 to be in UTC (aka GMT) you should set
18451 .code
18452 timezone = UTC
18453 .endd
18454 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18455 or, if that is not set, from the value of the TZ environment variable when Exim
18456 is built. If &%timezone%& is set to the empty string, either at build or run
18457 time, any existing TZ variable is removed from the environment when Exim
18458 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18459 unfortunately not all, operating systems.
18460
18461
18462 .option tls_advertise_hosts main "host list&!!" *
18463 .cindex "TLS" "advertising"
18464 .cindex "encryption" "on SMTP connection"
18465 .cindex "SMTP" "encrypted connection"
18466 .cindex "ESMTP extensions" STARTTLS
18467 When Exim is built with support for TLS encrypted connections, the availability
18468 of the STARTTLS command to set up an encrypted session is advertised in
18469 response to EHLO only to those client hosts that match this option. See
18470 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18471 Note that the default value requires that a certificate be supplied
18472 using the &%tls_certificate%& option.  If TLS support for incoming connections
18473 is not required the &%tls_advertise_hosts%& option should be set empty.
18474
18475
18476 .option tls_alpn main "string list&!!" "smtp : esmtp"
18477 .cindex TLS "Application Layer Protocol Names"
18478 .cindex TLS ALPN
18479 .cindex ALPN "set acceptable names for server"
18480 If this option is set,
18481 the TLS library supports ALPN,
18482 and the client offers either more than one
18483 ALPN name or a name which does not match the list,
18484 the TLS connection is declined.
18485
18486
18487 .option tls_certificate main "string list&!!" unset
18488 .cindex "TLS" "server certificate; location of"
18489 .cindex "certificate" "server, location of"
18490 The value of this option is expanded, and must then be a list of absolute paths to
18491 files which contain the server's certificates (in PEM format).
18492 Commonly only one file is needed.
18493 The server's private key is also
18494 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18495 &<<CHAPTLS>>& for further details.
18496
18497 &*Note*&: The certificates defined by this option are used only when Exim is
18498 receiving incoming messages as a server. If you want to supply certificates for
18499 use when sending messages as a client, you must set the &%tls_certificate%&
18500 option in the relevant &(smtp)& transport.
18501
18502 &*Note*&: If you use filenames based on IP addresses, change the list
18503 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18504
18505 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18506 when a list of more than one
18507 file is used, the &$tls_in_ourcert$& variable is unreliable.
18508 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18509
18510 .cindex SNI "selecting server certificate based on"
18511 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18512 if the OpenSSL build supports TLS extensions and the TLS client sends the
18513 Server Name Indication extension, then this option and others documented in
18514 &<<SECTtlssni>>& will be re-expanded.
18515
18516 If this option is unset or empty a self-signed certificate will be
18517 used.
18518 Under Linux this is generated at daemon startup; on other platforms it will be
18519 generated fresh for every connection.
18520
18521 .option tls_crl main string&!! unset
18522 .cindex "TLS" "server certificate revocation list"
18523 .cindex "certificate" "revocation list for server"
18524 This option specifies a certificate revocation list. The expanded value must
18525 be the name of a file that contains CRLs in PEM format.
18526
18527 Under OpenSSL the option can specify a directory with CRL files.
18528
18529 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18530 for each signing element of the certificate chain (i.e. all but the leaf).
18531 For the file variant this can be multiple PEM blocks in the one file.
18532
18533 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18534
18535
18536 .option tls_dh_max_bits main integer 2236
18537 .cindex "TLS" "D-H bit count"
18538 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18539 the chosen TLS library.  That value might prove to be too high for
18540 interoperability.  This option provides a maximum clamp on the value
18541 suggested, trading off security for interoperability.
18542
18543 The value must be at least 1024.
18544
18545 The value 2236 was chosen because, at time of adding the option, it was the
18546 hard-coded maximum value supported by the NSS cryptographic library, as used
18547 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18548
18549 If you prefer more security and are willing to break some clients, raise this
18550 number.
18551
18552 Note that the value passed to GnuTLS for *generating* a new prime may be a
18553 little less than this figure, because GnuTLS is inexact and may produce a
18554 larger prime than requested.
18555
18556
18557 .option tls_dhparam main string&!! unset
18558 .cindex "TLS" "D-H parameters for server"
18559 The value of this option is expanded and indicates the source of DH parameters
18560 to be used by Exim.
18561
18562 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18563 local DH parameters*&, which has been supported across all versions of Exim.  The
18564 other specific constants available are a fallback so that even when
18565 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18566
18567 If &%tls_dhparam%& is a filename starting with a &`/`&,
18568 then it names a file from which DH
18569 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18570 PKCS#3 representation of the DH prime.  If the file does not exist, for
18571 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18572 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18573 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18574 and treated as though the &%tls_dhparam%& were set to "none".
18575
18576 If this option expands to the string "none", then no DH parameters will be
18577 loaded by Exim.
18578
18579 If this option expands to the string "historic" and Exim is using GnuTLS, then
18580 Exim will attempt to load a file from inside the spool directory.  If the file
18581 does not exist, Exim will attempt to create it.
18582 See section &<<SECTgnutlsparam>>& for further details.
18583
18584 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18585 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18586
18587 In older versions of Exim the default was the 2048 bit prime described in section
18588 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18589 in IKE is assigned number 23.
18590
18591 Otherwise, the option must expand to the name used by Exim for any of a number
18592 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18593 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18594 the number used by IKE, or "default" which corresponds to
18595 &`exim.dev.20160529.3`&.
18596
18597 The available standard primes are:
18598 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18599 &`ike1`&, &`ike2`&, &`ike5`&,
18600 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18601 &`ike22`&, &`ike23`& and &`ike24`&.
18602
18603 The available additional primes are:
18604 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18605
18606 Some of these will be too small to be accepted by clients.
18607 Some may be too large to be accepted by clients.
18608 The open cryptographic community has suspicions about the integrity of some
18609 of the later IKE values, which led into RFC7919 providing new fixed constants
18610 (the "ffdhe" identifiers).
18611
18612 At this point, all of the "ike" values should be considered obsolete;
18613 they are still in Exim to avoid breaking unusual configurations, but are
18614 candidates for removal the next time we have backwards-incompatible changes.
18615 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18616 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18617 SHOULD NOT.
18618 Because of this, Exim regards them as deprecated; if either of the first pair
18619 are used, warnings will be logged in the paniclog, and if any are used then
18620 warnings will be logged in the mainlog.
18621 All four will be removed in a future Exim release.
18622
18623 The TLS protocol does not negotiate an acceptable size for this; clients tend
18624 to hard-drop connections if what is offered by the server is unacceptable,
18625 whether too large or too small, and there's no provision for the client to
18626 tell the server what these constraints are.  Thus, as a server operator, you
18627 need to make an educated guess as to what is most likely to work for your
18628 userbase.
18629
18630 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18631 is most likely to maximise interoperability.  The upper bound comes from
18632 applications using the Mozilla Network Security Services (NSS) library, which
18633 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18634 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18635 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18636 acceptable bound from 1024 to 2048.
18637
18638
18639 .option tls_eccurve main string list&!! &`auto`&
18640 .cindex TLS "EC cryptography"
18641 This option selects EC curves for use by Exim when used with OpenSSL.
18642 It has no effect when Exim is used with GnuTLS
18643 (the equivalent can be done using a priority string for the
18644 &%tls_require_ciphers%& option).
18645
18646 After expansion it must contain
18647 one or (only for OpenSSL versiona 1.1.1 onwards) more
18648 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18649 Consult your OpenSSL manual for valid curve names.
18650
18651 For OpenSSL versions before (and not including) 1.0.2, the string
18652 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18653 &`auto`& tells the library to choose.
18654
18655 If the option expands to an empty string, the effect is undefined.
18656
18657
18658 .option tls_ocsp_file main string&!! unset
18659 .cindex TLS "certificate status"
18660 .cindex TLS "OCSP proof file"
18661 This option
18662 must if set expand to the absolute path to a file which contains a current
18663 status proof for the server's certificate, as obtained from the
18664 Certificate Authority.
18665
18666 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18667 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18668
18669 For OpenSSL 1.1.0 or later, and
18670 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18671 of files, to match a list given for the &%tls_certificate%& option.
18672 The ordering of the two lists must match.
18673 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18674
18675 The file(s) should be in DER format,
18676 except for GnuTLS 3.6.3 or later
18677 or for OpenSSL,
18678 when an optional filetype prefix can be used.
18679 The prefix must be one of "DER" or "PEM", followed by
18680 a single space.  If one is used it sets the format for subsequent
18681 files in the list; the initial format is DER.
18682 If multiple proofs are wanted, for multiple chain elements
18683 (this only works under TLS1.3)
18684 they must be coded as a combined OCSP response.
18685
18686 Although GnuTLS will accept PEM files with multiple separate
18687 PEM blobs (ie. separate OCSP responses), it sends them in the
18688 TLS Certificate record interleaved with the certificates of the chain;
18689 although a GnuTLS client is happy with that, an OpenSSL client is not.
18690
18691 .option tls_on_connect_ports main "string list" unset
18692 .cindex SSMTP
18693 .cindex SMTPS
18694 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18695 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18696 set up without waiting for the client to issue a STARTTLS command. For
18697 further details, see section &<<SECTsupobssmt>>&.
18698
18699
18700
18701 .option tls_privatekey main "string list&!!" unset
18702 .cindex "TLS" "server private key; location of"
18703 The value of this option is expanded, and must then be a list of absolute paths to
18704 files which contains the server's private keys.
18705 If this option is unset, or if
18706 the expansion is forced to fail, or the result is an empty string, the private
18707 key is assumed to be in the same file as the server's certificates. See chapter
18708 &<<CHAPTLS>>& for further details.
18709
18710 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18711
18712
18713 .option tls_remember_esmtp main boolean false
18714 .cindex "TLS" "esmtp state; remembering"
18715 .cindex "TLS" "broken clients"
18716 If this option is set true, Exim violates the RFCs by remembering that it is in
18717 &"esmtp"& state after successfully negotiating a TLS session. This provides
18718 support for broken clients that fail to send a new EHLO after starting a
18719 TLS session.
18720
18721
18722 .option tls_require_ciphers main string&!! unset
18723 .cindex "TLS" "requiring specific ciphers"
18724 .cindex "cipher" "requiring specific"
18725 This option controls which ciphers can be used for incoming TLS connections.
18726 The &(smtp)& transport has an option of the same name for controlling outgoing
18727 connections. This option is expanded for each connection, so can be varied for
18728 different clients if required. The value of this option must be a list of
18729 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18730 in somewhat different ways. If GnuTLS is being used, the client controls the
18731 preference order of the available ciphers. Details are given in sections
18732 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18733
18734
18735 .option tls_resumption_hosts main "host list&!!" unset
18736 .cindex TLS resumption
18737 This option controls which connections to offer the TLS resumption feature.
18738 See &<<SECTresumption>>& for details.
18739
18740
18741 .option tls_try_verify_hosts main "host list&!!" unset
18742 .cindex "TLS" "client certificate verification"
18743 .cindex "certificate" "verification of client"
18744 See &%tls_verify_hosts%& below.
18745
18746
18747 .option tls_verify_certificates main string&!! system
18748 .cindex "TLS" "client certificate verification"
18749 .cindex "certificate" "verification of client"
18750 The value of this option is expanded, and must then be either the
18751 word "system"
18752 or the absolute path to
18753 a file or directory containing permitted certificates for clients that
18754 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18755
18756 The "system" value for the option will use a
18757 system default location compiled into the SSL library.
18758 This is not available for GnuTLS versions preceding 3.0.20,
18759 and will be taken as empty; an explicit location
18760 must be specified.
18761
18762 The use of a directory for the option value is not available for GnuTLS versions
18763 preceding 3.3.6 and a single file must be used.
18764
18765 With OpenSSL the certificates specified
18766 explicitly
18767 either by file or directory
18768 are added to those given by the system default location.
18769
18770 These certificates should be for the certificate authorities trusted, rather
18771 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18772 the value is a file then the certificates are sent by Exim as a server to
18773 connecting clients, defining the list of accepted certificate authorities.
18774 Thus the values defined should be considered public data.  To avoid this,
18775 use the explicit directory version. (If your peer is Exim up to 4.85,
18776 using GnuTLS, you may need to send the CAs (thus using the file
18777 variant). Otherwise the peer doesn't send its certificate.)
18778
18779 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18780
18781 A forced expansion failure or setting to an empty string is equivalent to
18782 being unset.
18783
18784
18785 .option tls_verify_hosts main "host list&!!" unset
18786 .cindex "TLS" "client certificate verification"
18787 .cindex "certificate" "verification of client"
18788 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18789 certificates from clients. The expected certificates are defined by
18790 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18791 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18792 &%tls_verify_certificates%& is not set.
18793
18794 Any client that matches &%tls_verify_hosts%& is constrained by
18795 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18796 present one of the listed certificates. If it does not, the connection is
18797 aborted.
18798 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18799 the host to use TLS. It can still send SMTP commands through unencrypted
18800 connections. Forcing a client to use TLS has to be done separately using an
18801 ACL to reject inappropriate commands when the connection is not encrypted.
18802
18803 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18804 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18805 certificate and checks it against &%tls_verify_certificates%&, but does not
18806 abort the connection if there is no certificate or if it does not match. This
18807 state can be detected in an ACL, which makes it possible to implement policies
18808 such as &"accept for relay only if a verified certificate has been received,
18809 but accept for local delivery if encrypted, even without a verified
18810 certificate"&.
18811
18812 Client hosts that match neither of these lists are not asked to present
18813 certificates.
18814
18815
18816 .option trusted_groups main "string list&!!" unset
18817 .cindex "trusted groups"
18818 .cindex "groups" "trusted"
18819 This option is expanded just once, at the start of Exim's processing. If this
18820 option is set, any process that is running in one of the listed groups, or
18821 which has one of them as a supplementary group, is trusted. The groups can be
18822 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18823 details of what trusted callers are permitted to do. If neither
18824 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18825 are trusted.
18826
18827 .option trusted_users main "string list&!!" unset
18828 .cindex "trusted users"
18829 .cindex "user" "trusted"
18830 This option is expanded just once, at the start of Exim's processing. If this
18831 option is set, any process that is running as one of the listed users is
18832 trusted. The users can be specified numerically or by name. See section
18833 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18834 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18835 Exim user are trusted.
18836
18837 .option unknown_login main string&!! unset
18838 .cindex "uid (user id)" "unknown caller"
18839 .vindex "&$caller_uid$&"
18840 This is a specialized feature for use in unusual configurations. By default, if
18841 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18842 gives up. The &%unknown_login%& option can be used to set a login name to be
18843 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18844 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18845 is used for the user's real name (gecos field), unless this has been set by the
18846 &%-F%& option.
18847
18848 .option unknown_username main string unset
18849 See &%unknown_login%&.
18850
18851 .option untrusted_set_sender main "address list&!!" unset
18852 .cindex "trusted users"
18853 .cindex "sender" "setting by untrusted user"
18854 .cindex "untrusted user setting sender"
18855 .cindex "user" "untrusted setting sender"
18856 .cindex "envelope from"
18857 .cindex "envelope sender"
18858 When an untrusted user submits a message to Exim using the standard input, Exim
18859 normally creates an envelope sender address from the user's login and the
18860 default qualification domain. Data from the &%-f%& option (for setting envelope
18861 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18862 is used) is ignored.
18863
18864 However, untrusted users are permitted to set an empty envelope sender address,
18865 to declare that a message should never generate any bounces. For example:
18866 .code
18867 exim -f '<>' user@domain.example
18868 .endd
18869 .vindex "&$sender_ident$&"
18870 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18871 other envelope sender addresses in a controlled way. When it is set, untrusted
18872 users are allowed to set envelope sender addresses that match any of the
18873 patterns in the list. Like all address lists, the string is expanded. The
18874 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18875 users to setting senders that start with their login ids
18876 followed by a hyphen
18877 by a setting like this:
18878 .code
18879 untrusted_set_sender = ^$sender_ident-
18880 .endd
18881 If you want to allow untrusted users to set envelope sender addresses without
18882 restriction, you can use
18883 .code
18884 untrusted_set_sender = *
18885 .endd
18886 The &%untrusted_set_sender%& option applies to all forms of local input, but
18887 only to the setting of the envelope sender. It does not permit untrusted users
18888 to use the other options which trusted user can use to override message
18889 parameters. Furthermore, it does not stop Exim from removing an existing
18890 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18891 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18892 overriding these actions. The handling of the &'Sender:'& header is also
18893 described in section &<<SECTthesenhea>>&.
18894
18895 The log line for a message's arrival shows the envelope sender following
18896 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18897 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18898 envelope sender address, the user's login is shown in parentheses after the
18899 sender address.
18900
18901
18902 .option uucp_from_pattern main string "see below"
18903 .cindex "&""From""& line"
18904 .cindex "UUCP" "&""From""& line"
18905 Some applications that pass messages to an MTA via a command line interface use
18906 an initial line starting with &"From&~"& to pass the envelope sender. In
18907 particular, this is used by UUCP software. Exim recognizes such a line by means
18908 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18909 matches, the sender address is constructed by expanding the contents of
18910 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18911 default pattern recognizes lines in the following two forms:
18912 .code
18913 From ph10 Fri Jan  5 12:35 GMT 1996
18914 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18915 .endd
18916 The pattern can be seen by running
18917 .code
18918 exim -bP uucp_from_pattern
18919 .endd
18920 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18921 year in the second case. The first word after &"From&~"& is matched in the
18922 regular expression by a parenthesized subpattern. The default value for
18923 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18924 (&"ph10"& in the example above) as the message's sender. See also
18925 &%ignore_fromline_hosts%&.
18926
18927
18928 .option uucp_from_sender main string&!! &`$1`&
18929 See &%uucp_from_pattern%& above.
18930
18931
18932 .option warn_message_file main string&!! unset
18933 .cindex "warning of delay" "customizing the message"
18934 .cindex "customizing" "warning message"
18935 This option defines a template file containing paragraphs of text to be used
18936 for constructing the warning message which is sent by Exim when a message has
18937 been in the queue for a specified amount of time, as specified by
18938 &%delay_warning%&. Details of the file's contents are given in chapter
18939 &<<CHAPemsgcust>>&.
18940 .cindex warn_message_file "tainted data"
18941 The option is expanded to give the file path, which must be
18942 absolute and untainted.
18943 See also &%bounce_message_file%&.
18944
18945
18946 .option wellknown_advertise_hosts main boolean unset
18947 .cindex WELLKNOWN advertisement
18948 .cindex "ESMTP extensions" WELLKNOWN
18949 This option enables the advertising of the SMTP WELLKNOWN extension.
18950 See also the &%acl_smtp_wellknown%& ACL (&<<SECTWELLKNOWNACL>>&).
18951
18952 .option write_rejectlog main boolean true
18953 .cindex "reject log" "disabling"
18954 If this option is set false, Exim no longer writes anything to the reject log.
18955 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18956 .ecindex IIDconfima
18957 .ecindex IIDmaiconf
18958
18959
18960
18961
18962 . ////////////////////////////////////////////////////////////////////////////
18963 . ////////////////////////////////////////////////////////////////////////////
18964
18965 .chapter "Generic options for routers" "CHAProutergeneric"
18966 .scindex IIDgenoprou1 "options" "generic; for routers"
18967 .scindex IIDgenoprou2 "generic options" "router"
18968 This chapter describes the generic options that apply to all routers.
18969 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18970
18971 For a general description of how a router operates, see sections
18972 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18973 which the preconditions are tested. The order of expansion of the options that
18974 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18975 &%headers_remove%&, &%transport%&.
18976
18977 The name of a router is limited to be &drivernamemax; ASCII characters long;
18978 prior to Exim 4.95 names would be silently truncated at this length, but now
18979 it is enforced.
18980
18981
18982 .option address_data routers string&!! unset
18983 .cindex "router" "data attached to address"
18984 The string is expanded just before the router is run, that is, after all the
18985 precondition tests have succeeded. If the expansion is forced to fail, the
18986 router declines, the value of &%address_data%& remains unchanged, and the
18987 &%more%& option controls what happens next. Other expansion failures cause
18988 delivery of the address to be deferred.
18989
18990 .vindex "&$address_data$&"
18991 When the expansion succeeds, the value is retained with the address, and can be
18992 accessed using the variable &$address_data$& in the current router, subsequent
18993 routers, and the eventual transport.
18994
18995 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18996 that runs a user's filter file, the contents of &$address_data$& are accessible
18997 in the filter. This is not normally a problem, because such data is usually
18998 either not confidential or it &"belongs"& to the current user, but if you do
18999 put confidential data into &$address_data$& you need to remember this point.
19000
19001 Even if the router declines or passes, the value of &$address_data$& remains
19002 with the address, though it can be changed by another &%address_data%& setting
19003 on a subsequent router. If a router generates child addresses, the value of
19004 &$address_data$& propagates to them. This also applies to the special kind of
19005 &"child"& that is generated by a router with the &%unseen%& option.
19006
19007 The idea of &%address_data%& is that you can use it to look up a lot of data
19008 for the address once, and then pick out parts of the data later. For example,
19009 you could use a single LDAP lookup to return a string of the form
19010 .code
19011 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
19012 .endd
19013 In the transport you could pick out the mailbox by a setting such as
19014 .code
19015 file = ${extract{mailbox}{$address_data}}
19016 .endd
19017 This makes the configuration file less messy, and also reduces the number of
19018 lookups (though Exim does cache lookups).
19019
19020 See also the &%set%& option below.
19021
19022 .vindex "&$sender_address_data$&"
19023 .vindex "&$address_data$&"
19024 The &%address_data%& facility is also useful as a means of passing information
19025 from one router to another, and from a router to a transport. In addition, if
19026 &$address_data$& is set by a router when verifying a recipient address from an
19027 ACL, it remains available for use in the rest of the ACL statement. After
19028 verifying a sender, the value is transferred to &$sender_address_data$&.
19029
19030
19031
19032 .option address_test routers&!? boolean true
19033 .oindex "&%-bt%&"
19034 .cindex "router" "skipping when address testing"
19035 If this option is set false, the router is skipped when routing is being tested
19036 by means of the &%-bt%& command line option. This can be a convenience when
19037 your first router sends messages to an external scanner, because it saves you
19038 having to set the &"already scanned"& indicator when testing real address
19039 routing.
19040
19041
19042
19043 .option cannot_route_message routers string&!! unset
19044 .cindex "router" "customizing &""cannot route""& message"
19045 .cindex "customizing" "&""cannot route""& message"
19046 This option specifies a text message that is used when an address cannot be
19047 routed because Exim has run out of routers. The default message is
19048 &"Unrouteable address"&. This option is useful only on routers that have
19049 &%more%& set false, or on the very last router in a configuration, because the
19050 value that is used is taken from the last router that is considered. This
19051 includes a router that is skipped because its preconditions are not met, as
19052 well as a router that declines. For example, using the default configuration,
19053 you could put:
19054 .code
19055 cannot_route_message = Remote domain not found in DNS
19056 .endd
19057 on the first router, which is a &(dnslookup)& router with &%more%& set false,
19058 and
19059 .code
19060 cannot_route_message = Unknown local user
19061 .endd
19062 on the final router that checks for local users. If string expansion fails for
19063 this option, the default message is used. Unless the expansion failure was
19064 explicitly forced, a message about the failure is written to the main and panic
19065 logs, in addition to the normal message about the routing failure.
19066
19067
19068 .option caseful_local_part routers boolean false
19069 .cindex "case of local parts"
19070 .cindex "router" "case of local parts"
19071 By default, routers handle the local parts of addresses in a case-insensitive
19072 manner, though the actual case is preserved for transmission with the message.
19073 If you want the case of letters to be significant in a router, you must set
19074 this option true. For individual router options that contain address or local
19075 part lists (for example, &%local_parts%&), case-sensitive matching can be
19076 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
19077 more details.
19078
19079 .vindex "&$local_part$&"
19080 .vindex "&$original_local_part$&"
19081 .vindex "&$parent_local_part$&"
19082 The value of the &$local_part$& variable is forced to lower case while a
19083 router is running unless &%caseful_local_part%& is set. When a router assigns
19084 an address to a transport, the value of &$local_part$& when the transport runs
19085 is the same as it was in the router. Similarly, when a router generates child
19086 addresses by aliasing or forwarding, the values of &$original_local_part$&
19087 and &$parent_local_part$& are those that were used by the redirecting router.
19088
19089 This option applies to the processing of an address by a router. When a
19090 recipient address is being processed in an ACL, there is a separate &%control%&
19091 modifier that can be used to specify case-sensitive processing within the ACL
19092 (see section &<<SECTcontrols>>&).
19093
19094
19095
19096 .option check_local_user routers&!? boolean false
19097 .cindex "local user, checking in router"
19098 .cindex "router" "checking for local user"
19099 .cindex "&_/etc/passwd_&"
19100 .vindex "&$home$&"
19101 When this option is true, Exim checks that the local part of the recipient
19102 address (with affixes removed if relevant) is the name of an account on the
19103 local system. The check is done by calling the &[getpwnam()]& function rather
19104 than trying to read &_/etc/passwd_& directly. This means that other methods of
19105 holding password data (such as NIS) are supported. If the local part is a local
19106 user,
19107 .cindex "tainted data" "de-tainting"
19108 .cindex "de-tainting" "using router check_local_user option"
19109 &$local_part_data$& is set to an untainted version of the local part and
19110 &$home$& is set from the password data. The latter can be tested in other
19111 preconditions that are evaluated after this one (the order of evaluation is
19112 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19113 overridden by &%router_home_directory%&. If the local part is not a local user,
19114 the router is skipped.
19115
19116 If you want to check that the local part is either the name of a local user
19117 or matches something else, you cannot combine &%check_local_user%& with a
19118 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19119 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19120 setting to achieve this. For example:
19121 .code
19122 local_parts = passwd;$local_part : lsearch;/etc/other/users
19123 .endd
19124 Note, however, that the side effects of &%check_local_user%& (such as setting
19125 up a home directory) do not occur when a &(passwd)& lookup is used in a
19126 &%local_parts%& (or any other) precondition.
19127
19128
19129
19130 .option condition routers&!? string&!! unset
19131 .cindex "router" "customized precondition"
19132 This option specifies a general precondition test that has to succeed for the
19133 router to be called. The &%condition%& option is the last precondition to be
19134 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19135 result is a forced failure, or an empty string, or one of the strings &"0"& or
19136 &"no"& or &"false"& (checked without regard to the case of the letters), the
19137 router is skipped, and the address is offered to the next one.
19138
19139 If the result is any other value, the router is run (as this is the last
19140 precondition to be evaluated, all the other preconditions must be true).
19141
19142 This option is unusual in that multiple &%condition%& options may be present.
19143 All &%condition%& options must succeed.
19144
19145 The &%condition%& option provides a means of applying custom conditions to the
19146 running of routers. Note that in the case of a simple conditional expansion,
19147 the default expansion values are exactly what is wanted. For example:
19148 .code
19149 condition = ${if >{$message_age}{600}}
19150 .endd
19151 Because of the default behaviour of the string expansion, this is equivalent to
19152 .code
19153 condition = ${if >{$message_age}{600}{true}{}}
19154 .endd
19155
19156 A multiple condition example, which succeeds:
19157 .code
19158 condition = ${if >{$message_age}{600}}
19159 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19160 condition = foobar
19161 .endd
19162
19163 If the expansion fails (other than forced failure) delivery is deferred. Some
19164 of the other precondition options are common special cases that could in fact
19165 be specified using &%condition%&.
19166
19167 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19168 are far older, and use one set of semantics.  ACLs are newer and when
19169 they were created, the ACL &%condition%& process was given far stricter
19170 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19171 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19172 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19173 Router rules processing behavior.
19174
19175 This is best illustrated in an example:
19176 .code
19177 # If used in an ACL condition will fail with a syntax error, but
19178 # in a router condition any extra characters are treated as a string
19179
19180 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19181 true {yes} {no}}
19182
19183 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19184  {yes} {no}}
19185 .endd
19186 In each example above, the &%if%& statement actually ends after
19187 &"{google.com}}"&.  Since no true or false braces were defined, the
19188 default &%if%& behavior is to return a boolean true or a null answer
19189 (which evaluates to false). The rest of the line is then treated as a
19190 string. So the first example resulted in the boolean answer &"true"&
19191 with the string &" {yes} {no}}"& appended to it. The second example
19192 resulted in the null output (indicating false) with the string
19193 &" {yes} {no}}"& appended to it.
19194
19195 In fact you can put excess forward braces in too.  In the router
19196 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19197 mean something, like after a &"$"& or when required as part of a
19198 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19199 string characters.
19200
19201 Thus, in a Router, the above expansion strings will both always evaluate
19202 true, as the result of expansion is a non-empty string which doesn't
19203 match an explicit false value.  This can be tricky to debug.  By
19204 contrast, in an ACL either of those strings will always result in an
19205 expansion error because the result doesn't look sufficiently boolean.
19206
19207
19208 .option debug_print routers string&!! unset
19209 .cindex "testing" "variables in drivers"
19210 If this option is set and debugging is enabled (see the &%-d%& command line
19211 option) or in address-testing mode (see the &%-bt%& command line option),
19212 the string is expanded and included in the debugging output.
19213 If expansion of the string fails, the error message is written to the debugging
19214 output, and Exim carries on processing.
19215 This option is provided to help with checking out the values of variables and
19216 so on when debugging router configurations. For example, if a &%condition%&
19217 option appears not to be working, &%debug_print%& can be used to output the
19218 variables it references. The output happens after checks for &%domains%&,
19219 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19220 are tested. A newline is added to the text if it does not end with one.
19221 The variable &$router_name$& contains the name of the router.
19222
19223
19224
19225 .option disable_logging routers boolean false
19226 If this option is set true, nothing is logged for any routing errors
19227 or for any deliveries caused by this router. You should not set this option
19228 unless you really, really know what you are doing. See also the generic
19229 transport option of the same name.
19230
19231 .option dnssec_request_domains routers "domain list&!!" *
19232 .cindex "MX record" "security"
19233 .cindex "DNSSEC" "MX lookup"
19234 .cindex "security" "MX lookup"
19235 .cindex "DNS" "DNSSEC"
19236 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19237 the DNSSEC request bit set.
19238 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19239
19240 .option dnssec_require_domains routers "domain list&!!" unset
19241 .cindex "MX record" "security"
19242 .cindex "DNSSEC" "MX lookup"
19243 .cindex "security" "MX lookup"
19244 .cindex "DNS" "DNSSEC"
19245 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19246 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19247 (AD bit) set will be ignored and logged as a host-lookup failure.
19248 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19249
19250
19251 .option domains routers&!? "domain list&!!" unset
19252 .cindex "router" "restricting to specific domains"
19253 .vindex "&$domain_data$&"
19254 If this option is set, the router is skipped unless the current domain matches
19255 the list.
19256 The data returned by the list check
19257 is placed in &$domain_data$& for use in string
19258 expansions of the driver's private options and in the transport.
19259 See section &<<SECTrouprecon>>& for
19260 a list of the order in which preconditions are evaluated.
19261
19262 A complex example, using a file like:
19263 .code
19264 alice@dom1
19265 bill@dom1
19266 maggie@dom1
19267 .endd
19268 and checking both domain and local_part
19269 .code
19270 domains =         ${domain:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19271 local_parts = ${local_part:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19272 .endd
19273
19274
19275
19276 .option driver routers string unset
19277 This option must always be set. It specifies which of the available routers is
19278 to be used.
19279
19280
19281 .option dsn_lasthop routers boolean false
19282 .cindex "DSN" "success"
19283 .cindex "Delivery Status Notification" "success"
19284 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19285 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19286 instead send a success DSN as if the next hop does not support DSN.
19287 Not effective on redirect routers.
19288
19289
19290
19291 .option errors_to routers string&!! unset
19292 .cindex "envelope from"
19293 .cindex "envelope sender"
19294 .cindex "router" "changing address for errors"
19295 If a router successfully handles an address, it may assign the address to a
19296 transport for delivery or it may generate child addresses. In both cases, if
19297 there is a delivery problem during later processing, the resulting bounce
19298 message is sent to the address that results from expanding this string,
19299 provided that the address verifies successfully. The &%errors_to%& option is
19300 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19301
19302 The &%errors_to%& setting associated with an address can be overridden if it
19303 subsequently passes through other routers that have their own &%errors_to%&
19304 settings, or if the message is delivered by a transport with a &%return_path%&
19305 setting.
19306
19307 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19308 the expansion fails to verify, the errors address associated with the incoming
19309 address is used. At top level, this is the envelope sender. A non-forced
19310 expansion failure causes delivery to be deferred.
19311
19312 If an address for which &%errors_to%& has been set ends up being delivered over
19313 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19314 any bounces that are generated by other MTAs on the delivery route are also
19315 sent there. You can set &%errors_to%& to the empty string by either of these
19316 settings:
19317 .code
19318 errors_to =
19319 errors_to = ""
19320 .endd
19321 An expansion item that yields an empty string has the same effect. If you do
19322 this, a locally detected delivery error for addresses processed by this router
19323 no longer gives rise to a bounce message; the error is discarded. If the
19324 address is delivered to a remote host, the return path is set to &`<>`&, unless
19325 overridden by the &%return_path%& option on the transport.
19326
19327 .vindex "&$address_data$&"
19328 If for some reason you want to discard local errors, but use a non-empty
19329 MAIL command for remote delivery, you can preserve the original return
19330 path in &$address_data$& in the router, and reinstate it in the transport by
19331 setting &%return_path%&.
19332
19333 The most common use of &%errors_to%& is to direct mailing list bounces to the
19334 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19335 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19336
19337
19338
19339 .option expn routers&!? boolean true
19340 .cindex "address" "testing"
19341 .cindex "testing" "addresses"
19342 .cindex "EXPN" "router skipping"
19343 .cindex "router" "skipping for EXPN"
19344 If this option is turned off, the router is skipped when testing an address
19345 as a result of processing an SMTP EXPN command. You might, for example,
19346 want to turn it off on a router for users' &_.forward_& files, while leaving it
19347 on for the system alias file.
19348 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19349 are evaluated.
19350
19351 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19352 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19353 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19354
19355
19356
19357 .option fail_verify routers boolean false
19358 .cindex "router" "forcing verification failure"
19359 Setting this option has the effect of setting both &%fail_verify_sender%& and
19360 &%fail_verify_recipient%& to the same value.
19361
19362
19363
19364 .option fail_verify_recipient routers boolean false
19365 If this option is true and an address is accepted by this router when
19366 verifying a recipient, verification fails.
19367
19368
19369
19370 .option fail_verify_sender routers boolean false
19371 If this option is true and an address is accepted by this router when
19372 verifying a sender, verification fails.
19373
19374
19375
19376 .option fallback_hosts routers "string list" unset
19377 .cindex "router" "fallback hosts"
19378 .cindex "fallback" "hosts specified on router"
19379 String expansion is not applied to this option. The argument must be a
19380 colon-separated list of host names or IP addresses. The list separator can be
19381 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19382 each name or address. In fact, the format of each item is exactly the same as
19383 defined for the list of hosts in a &(manualroute)& router (see section
19384 &<<SECTformatonehostitem>>&).
19385
19386 If a router queues an address for a remote transport, this host list is
19387 associated with the address, and used instead of the transport's fallback host
19388 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19389 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19390 transport for further details.
19391
19392
19393 .option group routers string&!! "see below"
19394 .cindex "gid (group id)" "local delivery"
19395 .cindex "local transports" "uid and gid"
19396 .cindex "transport" "local"
19397 .cindex "router" "setting group"
19398 When a router queues an address for a transport, and the transport does not
19399 specify a group, the group given here is used when running the delivery
19400 process.
19401 The group may be specified numerically or by name. If expansion fails, the
19402 error is logged and delivery is deferred.
19403 The default is unset, unless &%check_local_user%& is set, when the default
19404 is taken from the password information. See also &%initgroups%& and &%user%&
19405 and the discussion in chapter &<<CHAPenvironment>>&.
19406
19407
19408
19409 .option headers_add routers list&!! unset
19410 .cindex "header lines" "adding"
19411 .cindex "router" "adding header lines"
19412 This option specifies a list of text headers,
19413 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19414 that is associated with any addresses that are accepted by the router.
19415 Each item is separately expanded, at routing time.  However, this
19416 option has no effect when an address is just being verified. The way in which
19417 the text is used to add header lines at transport time is described in section
19418 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19419 message is in the process of being transported. This means that references to
19420 header lines in string expansions in the transport's configuration do not
19421 &"see"& the added header lines.
19422
19423 The &%headers_add%& option is expanded after &%errors_to%&, but before
19424 &%headers_remove%& and &%transport%&. If an item is empty, or if
19425 an item expansion is forced to fail, the item has no effect. Other expansion
19426 failures are treated as configuration errors.
19427
19428 Unlike most options, &%headers_add%& can be specified multiple times
19429 for a router; all listed headers are added.
19430
19431 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19432 router that has the &%one_time%& option set.
19433
19434 .cindex "duplicate addresses"
19435 .oindex "&%unseen%&"
19436 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19437 additions are deleted when the address is passed on to subsequent routers.
19438 For a &%redirect%& router, if a generated address is the same as the incoming
19439 address, this can lead to duplicate addresses with different header
19440 modifications. Exim does not do duplicate deliveries (except, in certain
19441 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19442 which of the duplicates is discarded, so this ambiguous situation should be
19443 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19444
19445
19446
19447 .option headers_remove routers list&!! unset
19448 .cindex "header lines" "removing"
19449 .cindex "router" "removing header lines"
19450 This option specifies a list of text headers,
19451 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19452 that is associated with any addresses that are accepted by the router.
19453 However, the option has no effect when an address is just being verified.
19454 Each list item is separately expanded, at transport time.
19455 If an item ends in *, it will match any header with the given prefix.
19456 The way in which
19457 the text is used to remove header lines at transport time is described in
19458 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19459 the message is in the process of being transported. This means that references
19460 to header lines in string expansions in the transport's configuration still
19461 &"see"& the original header lines.
19462
19463 The &%headers_remove%& option is handled after &%errors_to%& and
19464 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19465 the item has no effect. Other expansion failures are treated as configuration
19466 errors.
19467
19468 Unlike most options, &%headers_remove%& can be specified multiple times
19469 for a router; all listed headers are removed.
19470
19471 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19472 router that has the &%one_time%& option set.
19473
19474 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19475 removal requests are deleted when the address is passed on to subsequent
19476 routers, and this can lead to problems with duplicates -- see the similar
19477 warning for &%headers_add%& above.
19478
19479 &*Warning 3*&: Because of the separate expansion of the list items,
19480 items that contain a list separator must have it doubled.
19481 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19482
19483
19484
19485 .option ignore_target_hosts routers "host list&!!" unset
19486 .cindex "IP address" "discarding"
19487 .cindex "router" "discarding IP addresses"
19488 Although this option is a host list, it should normally contain IP address
19489 entries rather than names. If any host that is looked up by the router has an
19490 IP address that matches an item in this list, Exim behaves as if that IP
19491 address did not exist. This option allows you to cope with rogue DNS entries
19492 like
19493 .code
19494 remote.domain.example.  A  127.0.0.1
19495 .endd
19496 by setting
19497 .code
19498 ignore_target_hosts = 127.0.0.1
19499 .endd
19500 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19501 discarded in this way, the router declines. In a conventional configuration, an
19502 attempt to mail to such a domain would normally provoke the &"unrouteable
19503 domain"& error, and an attempt to verify an address in the domain would fail.
19504 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19505 router declines if presented with one of the listed addresses.
19506
19507 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19508 means of the first or the second of the following settings, respectively:
19509 .code
19510 ignore_target_hosts = 0.0.0.0/0
19511 ignore_target_hosts = <; 0::0/0
19512 .endd
19513 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19514 in the second line matches all IPv6 addresses.
19515
19516 This option may also be useful for ignoring link-local and site-local IPv6
19517 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19518 is expanded before use as a list, it is possible to make it dependent on the
19519 domain that is being routed.
19520
19521 .vindex "&$host_address$&"
19522 During its expansion, &$host_address$& is set to the IP address that is being
19523 checked.
19524
19525 .option initgroups routers boolean false
19526 .cindex "additional groups"
19527 .cindex "groups" "additional"
19528 .cindex "local transports" "uid and gid"
19529 .cindex "transport" "local"
19530 If the router queues an address for a transport, and this option is true, and
19531 the uid supplied by the router is not overridden by the transport, the
19532 &[initgroups()]& function is called when running the transport to ensure that
19533 any additional groups associated with the uid are set up. See also &%group%&
19534 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19535
19536
19537
19538 .option local_part_prefix routers&!? "string list" unset
19539 .cindex affix "router precondition"
19540 .cindex "router" "prefix for local part"
19541 .cindex "prefix" "for local part, used in router"
19542 If this option is set, the router is skipped unless the local part starts with
19543 one of the given strings, or &%local_part_prefix_optional%& is true. See
19544 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19545 evaluated.
19546
19547 The list is scanned from left to right, and the first prefix that matches is
19548 used. A limited form of wildcard is available; if the prefix begins with an
19549 asterisk, it matches the longest possible sequence of arbitrary characters at
19550 the start of the local part. An asterisk should therefore always be followed by
19551 some character that does not occur in normal local parts.
19552 .cindex "multiple mailboxes"
19553 .cindex "mailbox" "multiple"
19554 Wildcarding can be used to set up multiple user mailboxes, as described in
19555 section &<<SECTmulbox>>&.
19556
19557 .vindex "&$local_part$&"
19558 .vindex "&$local_part_prefix$&"
19559 During the testing of the &%local_parts%& option, and while the router is
19560 running, the prefix is removed from the local part, and is available in the
19561 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19562 the router accepts the address, this remains true during subsequent delivery by
19563 a transport. In particular, the local part that is transmitted in the RCPT
19564 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19565 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19566 the relevant transport.
19567
19568 .vindex &$local_part_prefix_v$&
19569 If wildcarding (above) was used then the part of the prefix matching the
19570 wildcard is available in &$local_part_prefix_v$&.
19571
19572 When an address is being verified, &%local_part_prefix%& affects only the
19573 behaviour of the router. If the callout feature of verification is in use, this
19574 means that the full address, including the prefix, will be used during the
19575 callout.
19576
19577 The prefix facility is commonly used to handle local parts of the form
19578 &%owner-something%&. Another common use is to support local parts of the form
19579 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19580 to tell a user their forwarding is broken &-- by placing a router like this one
19581 immediately before the router that handles &_.forward_& files:
19582 .code
19583 real_localuser:
19584   driver = accept
19585   local_part_prefix = real-
19586   check_local_user
19587   transport = local_delivery
19588 .endd
19589 For security, it would probably be a good idea to restrict the use of this
19590 router to locally-generated messages, using a condition such as this:
19591 .code
19592   condition = ${if match {$sender_host_address}\
19593                          {\N^(|127\.0\.0\.1)$\N}}
19594 .endd
19595
19596 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19597 both conditions must be met if not optional. Care must be taken if wildcards
19598 are used in both a prefix and a suffix on the same router. Different
19599 separator characters must be used to avoid ambiguity.
19600
19601
19602 .option local_part_prefix_optional routers boolean false
19603 See &%local_part_prefix%& above.
19604
19605
19606
19607 .option local_part_suffix routers&!? "string list" unset
19608 .cindex "router" "suffix for local part"
19609 .cindex "suffix for local part" "used in router"
19610 This option operates in the same way as &%local_part_prefix%&, except that the
19611 local part must end (rather than start) with the given string, the
19612 &%local_part_suffix_optional%& option determines whether the suffix is
19613 mandatory, and the wildcard * character, if present, must be the last
19614 character of the suffix. This option facility is commonly used to handle local
19615 parts of the form &%something-request%& and multiple user mailboxes of the form
19616 &%username-foo%&.
19617
19618
19619 .option local_part_suffix_optional routers boolean false
19620 See &%local_part_suffix%& above.
19621
19622
19623
19624 .option local_parts routers&!? "local part list&!!" unset
19625 .cindex "router" "restricting to specific local parts"
19626 .cindex "local part" "checking in router"
19627 The router is run only if the local part of the address matches the list.
19628 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19629 are evaluated, and
19630 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19631 string is expanded, it is possible to make it depend on the domain, for
19632 example:
19633 .code
19634 local_parts = dbm;/usr/local/specials/$domain_data
19635 .endd
19636 .vindex "&$local_part_data$&"
19637 the data returned by the list check
19638 for the local part is placed in the variable &$local_part_data$& for use in
19639 expansions of the router's private options or in the transport.
19640 You might use this option, for
19641 example, if you have a large number of local virtual domains, and you want to
19642 send all postmaster mail to the same place without having to set up an alias in
19643 each virtual domain:
19644 .code
19645 postmaster:
19646   driver = redirect
19647   local_parts = postmaster
19648   data = postmaster@real.domain.example
19649 .endd
19650
19651
19652 .option log_as_local routers boolean "see below"
19653 .cindex "log" "delivery line"
19654 .cindex "delivery" "log line format"
19655 Exim has two logging styles for delivery, the idea being to make local
19656 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19657 recipient address is given just as the local part, without a domain. The use of
19658 this style is controlled by this option. It defaults to true for the &(accept)&
19659 router, and false for all the others. This option applies only when a
19660 router assigns an address to a transport. It has no effect on routers that
19661 redirect addresses.
19662
19663
19664
19665 .option more routers boolean&!! true
19666 The result of string expansion for this option must be a valid boolean value,
19667 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19668 result causes an error, and delivery is deferred. If the expansion is forced to
19669 fail, the default value for the option (true) is used. Other failures cause
19670 delivery to be deferred.
19671
19672 If this option is set false, and the router declines to handle the address, no
19673 further routers are tried, routing fails, and the address is bounced.
19674 .oindex "&%self%&"
19675 However, if the router explicitly passes an address to the following router by
19676 means of the setting
19677 .code
19678 self = pass
19679 .endd
19680 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19681 does not affect the behaviour if one of the precondition tests fails. In that
19682 case, the address is always passed to the next router.
19683
19684 Note that &%address_data%& is not considered to be a precondition. If its
19685 expansion is forced to fail, the router declines, and the value of &%more%&
19686 controls what happens next.
19687
19688
19689 .option pass_on_timeout routers boolean false
19690 .cindex "timeout" "of router"
19691 .cindex "router" "timeout"
19692 If a router times out during a host lookup, it normally causes deferral of the
19693 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19694 router, overriding &%no_more%&. This may be helpful for systems that are
19695 intermittently connected to the Internet, or those that want to pass to a smart
19696 host any messages that cannot immediately be delivered.
19697
19698 There are occasional other temporary errors that can occur while doing DNS
19699 lookups. They are treated in the same way as a timeout, and this option
19700 applies to all of them.
19701
19702
19703
19704 .option pass_router routers string unset
19705 .cindex "router" "go to after &""pass""&"
19706 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19707 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19708 routing to continue, and overriding a false setting of &%more%&. When one of
19709 these routers returns &"pass"&, the address is normally handed on to the next
19710 router in sequence. This can be changed by setting &%pass_router%& to the name
19711 of another router. However (unlike &%redirect_router%&) the named router must
19712 be below the current router, to avoid loops. Note that this option applies only
19713 to the special case of &"pass"&. It does not apply when a router returns
19714 &"decline"& because it cannot handle an address.
19715
19716
19717
19718 .option redirect_router routers string unset
19719 .cindex "router" "start at after redirection"
19720 Sometimes an administrator knows that it is pointless to reprocess addresses
19721 generated from alias or forward files with the same router again. For
19722 example, if an alias file translates real names into login ids there is no
19723 point searching the alias file a second time, especially if it is a large file.
19724
19725 The &%redirect_router%& option can be set to the name of any router instance.
19726 It causes the routing of any generated addresses to start at the named router
19727 instead of at the first router. This option has no effect if the router in
19728 which it is set does not generate new addresses.
19729
19730
19731
19732 .option require_files routers&!? "string list&!!" unset
19733 .cindex "file" "requiring for router"
19734 .cindex "router" "requiring file existence"
19735 This option provides a general mechanism for predicating the running of a
19736 router on the existence or non-existence of certain files or directories.
19737 Before running a router, as one of its precondition tests, Exim works its way
19738 through the &%require_files%& list, expanding each item separately.
19739
19740 Because the list is split before expansion, any colons in expansion items must
19741 be doubled, or the facility for using a different list separator must be used
19742 (&<<SECTlistsepchange>>&).
19743 If any expansion is forced to fail, the item is ignored. Other expansion
19744 failures cause routing of the address to be deferred.
19745
19746 If any expanded string is empty, it is ignored. Otherwise, except as described
19747 below, each string must be a fully qualified file path, optionally preceded by
19748 &"!"&. The paths are passed to the &[stat()]& function to test for the
19749 existence of the files or directories. The router is skipped if any paths not
19750 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19751
19752 .cindex "NFS"
19753 If &[stat()]& cannot determine whether a file exists or not, delivery of
19754 the message is deferred. This can happen when NFS-mounted filesystems are
19755 unavailable.
19756
19757 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19758 options, so you cannot use it to check for the existence of a file in which to
19759 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19760 full list of the order in which preconditions are evaluated.) However, as
19761 these options are all expanded, you can use the &%exists%& expansion condition
19762 to make such tests. The &%require_files%& option is intended for checking files
19763 that the router may be going to use internally, or which are needed by a
19764 transport (e.g., &_.procmailrc_&).
19765
19766 During delivery, the &[stat()]& function is run as root, but there is a
19767 facility for some checking of the accessibility of a file by another user.
19768 This is not a proper permissions check, but just a &"rough"& check that
19769 operates as follows:
19770
19771 If an item in a &%require_files%& list does not contain any forward slash
19772 characters, it is taken to be the user (and optional group, separated by a
19773 comma) to be checked for subsequent files in the list. If no group is specified
19774 but the user is specified symbolically, the gid associated with the uid is
19775 used. For example:
19776 .code
19777 require_files = mail:/some/file
19778 require_files = $local_part_data:$home/.procmailrc
19779 .endd
19780 If a user or group name in a &%require_files%& list does not exist, the
19781 &%require_files%& condition fails.
19782
19783 Exim performs the check by scanning along the components of the file path, and
19784 checking the access for the given uid and gid. It checks for &"x"& access on
19785 directories, and &"r"& access on the final file. Note that this means that file
19786 access control lists, if the operating system has them, are ignored.
19787
19788 &*Warning 1*&: When the router is being run to verify addresses for an
19789 incoming SMTP message, Exim is not running as root, but under its own uid. This
19790 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19791 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19792 user is not permitted to read one of the directories on the file's path.
19793
19794 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19795 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19796 without root access. In this case, if a check for access by a particular user
19797 is requested, Exim creates a subprocess that runs as that user, and tries the
19798 check again in that process.
19799
19800 The default action for handling an unresolved EACCES is to consider it to
19801 be caused by a configuration error, and routing is deferred because the
19802 existence or non-existence of the file cannot be determined. However, in some
19803 circumstances it may be desirable to treat this condition as if the file did
19804 not exist. If the filename (or the exclamation mark that precedes the filename
19805 for non-existence) is preceded by a plus sign, the EACCES error is treated
19806 as if the file did not exist. For example:
19807 .code
19808 require_files = +/some/file
19809 .endd
19810 If the router is not an essential part of verification (for example, it
19811 handles users' &_.forward_& files), another solution is to set the &%verify%&
19812 option false so that the router is skipped when verifying.
19813
19814
19815
19816 .option retry_use_local_part routers boolean "see below"
19817 .cindex "hints database" "retry keys"
19818 .cindex "local part" "in retry keys"
19819 When a delivery suffers a temporary routing failure, a retry record is created
19820 in Exim's hints database. For addresses whose routing depends only on the
19821 domain, the key for the retry record should not involve the local part, but for
19822 other addresses, both the domain and the local part should be included.
19823 Usually, remote routing is of the former kind, and local routing is of the
19824 latter kind.
19825
19826 This option controls whether the local part is used to form the key for retry
19827 hints for addresses that suffer temporary errors while being handled by this
19828 router. The default value is true for any router that has any of
19829 &%check_local_user%&,
19830 &%local_parts%&,
19831 &%condition%&,
19832 &%local_part_prefix%&,
19833 &%local_part_suffix%&,
19834 &%senders%& or
19835 &%require_files%&
19836 set, and false otherwise. Note that this option does not apply to hints keys
19837 for transport delays; they are controlled by a generic transport option of the
19838 same name.
19839
19840 Failing to set this option when it is needed
19841 (because a remote router handles only some of the local-parts for a domain)
19842 can result in incorrect error messages being generated.
19843
19844 The setting of &%retry_use_local_part%& applies only to the router on which it
19845 appears. If the router generates child addresses, they are routed
19846 independently; this setting does not become attached to them.
19847
19848
19849
19850 .option router_home_directory routers string&!! unset
19851 .cindex "router" "home directory for"
19852 .cindex "home directory" "for router"
19853 .vindex "&$home$&"
19854 This option sets a home directory for use while the router is running. (Compare
19855 &%transport_home_directory%&, which sets a home directory for later
19856 transporting.) In particular, if used on a &(redirect)& router, this option
19857 sets a value for &$home$& while a filter is running. The value is expanded;
19858 forced expansion failure causes the option to be ignored &-- other failures
19859 cause the router to defer.
19860
19861 Expansion of &%router_home_directory%& happens immediately after the
19862 &%check_local_user%& test (if configured), before any further expansions take
19863 place.
19864 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19865 are evaluated.)
19866 While the router is running, &%router_home_directory%& overrides the value of
19867 &$home$& that came from &%check_local_user%&.
19868
19869 When a router accepts an address and assigns it to a local transport (including
19870 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19871 delivery), the home directory setting for the transport is taken from the first
19872 of these values that is set:
19873
19874 .ilist
19875 The &%home_directory%& option on the transport;
19876 .next
19877 The &%transport_home_directory%& option on the router;
19878 .next
19879 The password data if &%check_local_user%& is set on the router;
19880 .next
19881 The &%router_home_directory%& option on the router.
19882 .endlist
19883
19884 In other words, &%router_home_directory%& overrides the password data for the
19885 router, but not for the transport.
19886
19887
19888
19889 .option self routers string freeze
19890 .cindex "MX record" "pointing to local host"
19891 .cindex "local host" "MX pointing to"
19892 This option applies to those routers that use a recipient address to find a
19893 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19894 and &(manualroute)& routers.
19895 Certain configurations of the &(queryprogram)& router can also specify a list
19896 of remote hosts.
19897 Usually such routers are configured to send the message to a remote host via an
19898 &(smtp)& transport. The &%self%& option specifies what happens when the first
19899 host on the list turns out to be the local host.
19900 The way in which Exim checks for the local host is described in section
19901 &<<SECTreclocipadd>>&.
19902
19903 Normally this situation indicates either an error in Exim's configuration (for
19904 example, the router should be configured not to process this domain), or an
19905 error in the DNS (for example, the MX should not point to this host). For this
19906 reason, the default action is to log the incident, defer the address, and
19907 freeze the message. The following alternatives are provided for use in special
19908 cases:
19909
19910 .vlist
19911 .vitem &%defer%&
19912 Delivery of the message is tried again later, but the message is not frozen.
19913
19914 .vitem "&%reroute%&: <&'domain'&>"
19915 The domain is changed to the given domain, and the address is passed back to
19916 be reprocessed by the routers. No rewriting of headers takes place. This
19917 behaviour is essentially a redirection.
19918
19919 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19920 The domain is changed to the given domain, and the address is passed back to be
19921 reprocessed by the routers. Any headers that contain the original domain are
19922 rewritten.
19923
19924 .vitem &%pass%&
19925 .oindex "&%more%&"
19926 .vindex "&$self_hostname$&"
19927 The router passes the address to the next router, or to the router named in the
19928 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19929 subsequent routing and delivery, the variable &$self_hostname$& contains the
19930 name of the local host that the router encountered. This can be used to
19931 distinguish between different cases for hosts with multiple names. The
19932 combination
19933 .code
19934 self = pass
19935 no_more
19936 .endd
19937 ensures that only those addresses that routed to the local host are passed on.
19938 Without &%no_more%&, addresses that were declined for other reasons would also
19939 be passed to the next router.
19940
19941 .vitem &%fail%&
19942 Delivery fails and an error report is generated.
19943
19944 .vitem &%send%&
19945 .cindex "local host" "sending to"
19946 The anomaly is ignored and the address is queued for the transport. This
19947 setting should be used with extreme caution. For an &(smtp)& transport, it
19948 makes sense only in cases where the program that is listening on the SMTP port
19949 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19950 different configuration file that handles the domain in another way.
19951 .endlist
19952
19953
19954
19955 .option senders routers&!? "address list&!!" unset
19956 .cindex "router" "checking senders"
19957 If this option is set, the router is skipped unless the message's sender
19958 address matches something on the list.
19959 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19960 are evaluated.
19961
19962 There are issues concerning verification when the running of routers is
19963 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19964 setting, it sets the sender to the null string. When using the &%-bt%& option
19965 to check a configuration file, it is necessary also to use the &%-f%& option to
19966 set an appropriate sender. For incoming mail, the sender is unset when
19967 verifying the sender, but is available when verifying any recipients. If the
19968 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19969 matters.
19970
19971
19972 .option set routers "string list" unset
19973 .cindex router variables
19974 This option may be used multiple times on a router;
19975 because of this the list aspect is mostly irrelevant.
19976 The list separator is a semicolon but can be changed in the
19977 usual way.
19978
19979 Each list-element given must be of the form &"name = value"&
19980 and the names used must start with the string &"r_"&.
19981 Values containing a list-separator should have them doubled.
19982 When a router runs, the strings are evaluated in order,
19983 to create variables which are added to the set associated with
19984 the address.
19985 This is done immediately after all the preconditions, before the
19986 evaluation of the &%address_data%& option.
19987 The variable is set with the expansion of the value.
19988 The variables can be used by the router options
19989 (not including any preconditions)
19990 and by the transport.
19991 Later definitions of a given named variable will override former ones.
19992 Variable use is via the usual &$r_...$& syntax.
19993
19994 This is similar to the &%address_data%& option, except that
19995 many independent variables can be used, with choice of naming.
19996
19997
19998 .option translate_ip_address routers string&!! unset
19999 .cindex "IP address" "translating"
20000 .cindex "packet radio"
20001 .cindex "router" "IP address translation"
20002 There exist some rare networking situations (for example, packet radio) where
20003 it is helpful to be able to translate IP addresses generated by normal routing
20004 mechanisms into other IP addresses, thus performing a kind of manual IP
20005 routing. This should be done only if the normal IP routing of the TCP/IP stack
20006 is inadequate or broken. Because this is an extremely uncommon requirement, the
20007 code to support this option is not included in the Exim binary unless
20008 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
20009
20010 .vindex "&$host_address$&"
20011 The &%translate_ip_address%& string is expanded for every IP address generated
20012 by the router, with the generated address set in &$host_address$&. If the
20013 expansion is forced to fail, no action is taken.
20014 For any other expansion error, delivery of the message is deferred.
20015 If the result of the expansion is an IP address, that replaces the original
20016 address; otherwise the result is assumed to be a host name &-- this is looked
20017 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
20018 produce one or more replacement IP addresses. For example, to subvert all IP
20019 addresses in some specific networks, this could be added to a router:
20020 .code
20021 translate_ip_address = \
20022   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
20023     {$value}fail}}
20024 .endd
20025 The file would contain lines like
20026 .code
20027 10.2.3.128/26    some.host
20028 10.8.4.34/26     10.44.8.15
20029 .endd
20030 You should not make use of this facility unless you really understand what you
20031 are doing.
20032
20033
20034
20035 .option transport routers string&!! unset
20036 This option specifies the transport to be used when a router accepts an address
20037 and sets it up for delivery. A transport is never needed if a router is used
20038 only for verification. The value of the option is expanded at routing time,
20039 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
20040 and result must be the name of one of the configured transports. If it is not,
20041 delivery is deferred.
20042
20043 The &%transport%& option is not used by the &(redirect)& router, but it does
20044 have some private options that set up transports for pipe and file deliveries
20045 (see chapter &<<CHAPredirect>>&).
20046
20047
20048
20049 .option transport_current_directory routers string&!! unset
20050 .cindex "current directory for local transport"
20051 This option associates a current directory with any address that is routed
20052 to a local transport. This can happen either because a transport is
20053 explicitly configured for the router, or because it generates a delivery to a
20054 file or a pipe. During the delivery process (that is, at transport time), this
20055 option string is expanded and is set as the current directory, unless
20056 overridden by a setting on the transport.
20057 If the expansion fails for any reason, including forced failure, an error is
20058 logged, and delivery is deferred.
20059 See chapter &<<CHAPenvironment>>& for details of the local delivery
20060 environment.
20061
20062
20063
20064
20065 .option transport_home_directory routers string&!! "see below"
20066 .cindex "home directory" "for local transport"
20067 This option associates a home directory with any address that is routed to a
20068 local transport. This can happen either because a transport is explicitly
20069 configured for the router, or because it generates a delivery to a file or a
20070 pipe. During the delivery process (that is, at transport time), the option
20071 string is expanded and is set as the home directory, unless overridden by a
20072 setting of &%home_directory%& on the transport.
20073 If the expansion fails for any reason, including forced failure, an error is
20074 logged, and delivery is deferred.
20075
20076 If the transport does not specify a home directory, and
20077 &%transport_home_directory%& is not set for the router, the home directory for
20078 the transport is taken from the password data if &%check_local_user%& is set for
20079 the router. Otherwise it is taken from &%router_home_directory%& if that option
20080 is set; if not, no home directory is set for the transport.
20081
20082 See chapter &<<CHAPenvironment>>& for further details of the local delivery
20083 environment.
20084
20085
20086
20087
20088 .option unseen routers boolean&!! false
20089 .cindex "router" "carrying on after success"
20090 The result of string expansion for this option must be a valid boolean value,
20091 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
20092 result causes an error, and delivery is deferred. If the expansion is forced to
20093 fail, the default value for the option (false) is used. Other failures cause
20094 delivery to be deferred.
20095
20096 When this option is set true, routing does not cease if the router accepts the
20097 address. Instead, a copy of the incoming address is passed to the next router,
20098 overriding a false setting of &%more%&. There is little point in setting
20099 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
20100 the value of &%unseen%& contains expansion items (and therefore, presumably, is
20101 sometimes true and sometimes false).
20102
20103 .cindex "copy of message (&%unseen%& option)"
20104 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
20105 qualifier in filter files. It can be used to cause copies of messages to be
20106 delivered to some other destination, while also carrying out a normal delivery.
20107 In effect, the current address is made into a &"parent"& that has two children
20108 &-- one that is delivered as specified by this router, and a clone that goes on
20109 to be routed further. For this reason, &%unseen%& may not be combined with the
20110 &%one_time%& option in a &(redirect)& router.
20111
20112 &*Warning*&: Header lines added to the address (or specified for removal) by
20113 this router or by previous routers affect the &"unseen"& copy of the message
20114 only. The clone that continues to be processed by further routers starts with
20115 no added headers and none specified for removal. For a &%redirect%& router, if
20116 a generated address is the same as the incoming address, this can lead to
20117 duplicate addresses with different header modifications. Exim does not do
20118 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20119 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20120 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20121 &%redirect%& router may be of help.
20122
20123 Unlike the handling of header modifications, any data that was set by the
20124 &%address_data%& option in the current or previous routers &'is'& passed on to
20125 subsequent routers.
20126
20127
20128 .option user routers string&!! "see below"
20129 .cindex "uid (user id)" "local delivery"
20130 .cindex "local transports" "uid and gid"
20131 .cindex "transport" "local"
20132 .cindex "router" "user for filter processing"
20133 .cindex "filter" "user for processing"
20134 When a router queues an address for a transport, and the transport does not
20135 specify a user, the user given here is used when running the delivery process.
20136 The user may be specified numerically or by name. If expansion fails, the
20137 error is logged and delivery is deferred.
20138 This user is also used by the &(redirect)& router when running a filter file.
20139 The default is unset, except when &%check_local_user%& is set. In this case,
20140 the default is taken from the password information. If the user is specified as
20141 a name, and &%group%& is not set, the group associated with the user is used.
20142 See also &%initgroups%& and &%group%& and the discussion in chapter
20143 &<<CHAPenvironment>>&.
20144
20145
20146
20147 .option verify routers&!? boolean true
20148 Setting this option has the effect of setting &%verify_sender%& and
20149 &%verify_recipient%& to the same value.
20150
20151
20152 .option verify_only routers&!? boolean false
20153 .cindex "EXPN" "with &%verify_only%&"
20154 .oindex "&%-bv%&"
20155 .cindex "router" "used only when verifying"
20156 If this option is set, the router is used only when verifying an address,
20157 delivering in cutthrough mode or
20158 testing with the &%-bv%& option, not when actually doing a delivery, testing
20159 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20160 restricted to verifying only senders or recipients by means of
20161 &%verify_sender%& and &%verify_recipient%&.
20162
20163 &*Warning*&: When the router is being run to verify addresses for an incoming
20164 SMTP message, Exim is not running as root, but under its own uid. If the router
20165 accesses any files, you need to make sure that they are accessible to the Exim
20166 user or group.
20167
20168
20169 .option verify_recipient routers&!? boolean true
20170 If this option is false, the router is skipped when verifying recipient
20171 addresses,
20172 delivering in cutthrough mode
20173 or testing recipient verification using &%-bv%&.
20174 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20175 are evaluated.
20176 See also the &$verify_mode$& variable.
20177
20178
20179 .option verify_sender routers&!? boolean true
20180 If this option is false, the router is skipped when verifying sender addresses
20181 or testing sender verification using &%-bvs%&.
20182 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20183 are evaluated.
20184 See also the &$verify_mode$& variable.
20185 .ecindex IIDgenoprou1
20186 .ecindex IIDgenoprou2
20187
20188
20189
20190
20191
20192
20193 . ////////////////////////////////////////////////////////////////////////////
20194 . ////////////////////////////////////////////////////////////////////////////
20195
20196 .chapter "The accept router" "CHID4"
20197 .cindex "&(accept)& router"
20198 .cindex "routers" "&(accept)&"
20199 The &(accept)& router has no private options of its own. Unless it is being
20200 used purely for verification (see &%verify_only%&) a transport is required to
20201 be defined by the generic &%transport%& option. If the preconditions that are
20202 specified by generic options are met, the router accepts the address and queues
20203 it for the given transport. The most common use of this router is for setting
20204 up deliveries to local mailboxes. For example:
20205 .code
20206 localusers:
20207   driver = accept
20208   domains = mydomain.example
20209   check_local_user
20210   transport = local_delivery
20211 .endd
20212 The &%domains%& condition in this example checks the domain of the address, and
20213 &%check_local_user%& checks that the local part is the login of a local user.
20214 When both preconditions are met, the &(accept)& router runs, and queues the
20215 address for the &(local_delivery)& transport.
20216
20217
20218
20219
20220
20221
20222 . ////////////////////////////////////////////////////////////////////////////
20223 . ////////////////////////////////////////////////////////////////////////////
20224
20225 .chapter "The dnslookup router" "CHAPdnslookup"
20226 .scindex IIDdnsrou1 "&(dnslookup)& router"
20227 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20228 The &(dnslookup)& router looks up the hosts that handle mail for the
20229 recipient's domain in the DNS. A transport must always be set for this router,
20230 unless &%verify_only%& is set.
20231
20232 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20233 SRV records. If none are found, or if SRV support is not configured,
20234 MX records are looked up. If no MX records exist, address records are sought.
20235 However, &%mx_domains%& can be set to disable the direct use of address
20236 records.
20237
20238 MX records of equal priority are sorted by Exim into a random order. Exim then
20239 looks for address records for the host names obtained from MX or SRV records.
20240 When a host has more than one IP address, they are sorted into a random order,
20241 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20242 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20243 generic option, the router declines.
20244
20245 Unless they have the highest priority (lowest MX value), MX records that point
20246 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20247 are discarded, together with any other MX records of equal or lower priority.
20248
20249 .cindex "MX record" "pointing to local host"
20250 .cindex "local host" "MX pointing to"
20251 .oindex "&%self%&" "in &(dnslookup)& router"
20252 If the host pointed to by the highest priority MX record, or looked up as an
20253 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20254 happens is controlled by the generic &%self%& option.
20255
20256
20257 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20258 There have been problems with DNS servers when SRV records are looked up.
20259 Some misbehaving servers return a DNS error or timeout when a non-existent
20260 SRV record is sought. Similar problems have in the past been reported for
20261 MX records. The global &%dns_again_means_nonexist%& option can help with this
20262 problem, but it is heavy-handed because it is a global option.
20263
20264 For this reason, there are two options, &%srv_fail_domains%& and
20265 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20266 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20267 an attempt to look up an SRV or MX record causes one of these results, and the
20268 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20269 such record"&. In the case of an SRV lookup, this means that the router
20270 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20271 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20272 case routing fails.
20273
20274
20275 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20276 .cindex "&(dnslookup)& router" "declines"
20277 There are a few cases where a &(dnslookup)& router will decline to accept
20278 an address; if such a router is expected to handle "all remaining non-local
20279 domains", then it is important to set &%no_more%&.
20280
20281 The router will defer rather than decline if the domain
20282 is found in the &%fail_defer_domains%& router option.
20283
20284 Reasons for a &(dnslookup)& router to decline currently include:
20285 .ilist
20286 The domain does not exist in DNS
20287 .next
20288 The domain exists but the MX record's host part is just "."; this is a common
20289 convention (borrowed from SRV) used to indicate that there is no such service
20290 for this domain and to not fall back to trying A/AAAA records.
20291 .next
20292 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20293 .next
20294 MX record points to a non-existent host.
20295 .next
20296 MX record points to an IP address and the main section option
20297 &%allow_mx_to_ip%& is not set.
20298 .next
20299 MX records exist and point to valid hosts, but all hosts resolve only to
20300 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20301 .next
20302 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20303 &%dns_check_names_pattern%& for handling one variant of this)
20304 .next
20305 &%check_secondary_mx%& is set on this router but the local host can
20306 not be found in the MX records (see below)
20307 .endlist
20308
20309
20310
20311
20312 .section "Private options for dnslookup" "SECID118"
20313 .cindex "options" "&(dnslookup)& router"
20314 The private options for the &(dnslookup)& router are as follows:
20315
20316 .option check_secondary_mx dnslookup boolean false
20317 .cindex "MX record" "checking for secondary"
20318 If this option is set, the router declines unless the local host is found in
20319 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20320 process domains for which the local host is a secondary mail exchanger
20321 differently to other domains. The way in which Exim decides whether a host is
20322 the local host is described in section &<<SECTreclocipadd>>&.
20323
20324
20325 .option check_srv dnslookup string&!! unset
20326 .cindex "SRV record" "enabling use of"
20327 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20328 addition to MX and address records. The support is disabled by default. To
20329 enable SRV support, set the &%check_srv%& option to the name of the service
20330 required. For example,
20331 .code
20332 check_srv = smtp
20333 .endd
20334 looks for SRV records that refer to the normal smtp service. The option is
20335 expanded, so the service name can vary from message to message or address
20336 to address. This might be helpful if SRV records are being used for a
20337 submission service. If the expansion is forced to fail, the &%check_srv%&
20338 option is ignored, and the router proceeds to look for MX records in the
20339 normal way.
20340
20341 When the expansion succeeds, the router searches first for SRV records for
20342 the given service (it assumes TCP protocol). A single SRV record with a
20343 host name that consists of just a single dot indicates &"no such service for
20344 this domain"&; if this is encountered, the router declines. If other kinds of
20345 SRV record are found, they are used to construct a host list for delivery
20346 according to the rules of RFC 2782. MX records are not sought in this case.
20347
20348 When no SRV records are found, MX records (and address records) are sought in
20349 the traditional way. In other words, SRV records take precedence over MX
20350 records, just as MX records take precedence over address records. Note that
20351 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20352 defined it. It is apparently believed that MX records are sufficient for email
20353 and that SRV records should not be used for this purpose. However, SRV records
20354 have an additional &"weight"& feature which some people might find useful when
20355 trying to split an SMTP load between hosts of different power.
20356
20357 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20358 when there is a DNS lookup error.
20359
20360
20361
20362
20363 .option fail_defer_domains dnslookup "domain list&!!" unset
20364 .cindex "MX record" "not found"
20365 DNS lookups for domains matching &%fail_defer_domains%&
20366 which find no matching record will cause the router to defer
20367 rather than the default behaviour of decline.
20368 This maybe be useful for queueing messages for a newly created
20369 domain while the DNS configuration is not ready.
20370 However, it will result in any message with mistyped domains
20371 also being queued.
20372
20373
20374 .option ipv4_only "string&!!" unset
20375 .cindex IPv6 disabling
20376 .cindex DNS "IPv6 disabling"
20377 The string is expanded, and if the result is anything but a forced failure,
20378 or an empty string, or one of the strings “0” or “no” or “false”
20379 (checked without regard to the case of the letters),
20380 only A records are used.
20381
20382 .option ipv4_prefer "string&!!" unset
20383 .cindex IPv4 preference
20384 .cindex DNS "IPv4 preference"
20385 The string is expanded, and if the result is anything but a forced failure,
20386 or an empty string, or one of the strings “0” or “no” or “false”
20387 (checked without regard to the case of the letters),
20388 A records are sorted before AAAA records (inverting the default).
20389
20390 .option mx_domains dnslookup "domain list&!!" unset
20391 .cindex "MX record" "required to exist"
20392 .cindex "SRV record" "required to exist"
20393 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20394 record in order to be recognized. (The name of this option could be improved.)
20395 For example, if all the mail hosts in &'fict.example'& are known to have MX
20396 records, except for those in &'discworld.fict.example'&, you could use this
20397 setting:
20398 .code
20399 mx_domains = ! *.discworld.fict.example : *.fict.example
20400 .endd
20401 This specifies that messages addressed to a domain that matches the list but
20402 has no MX record should be bounced immediately instead of being routed using
20403 the address record.
20404
20405
20406 .option mx_fail_domains dnslookup "domain list&!!" unset
20407 If the DNS lookup for MX records for one of the domains in this list causes a
20408 DNS lookup error, Exim behaves as if no MX records were found. See section
20409 &<<SECTprowitdnsloo>>& for more discussion.
20410
20411
20412
20413
20414 .option qualify_single dnslookup boolean true
20415 .cindex "DNS" "resolver options"
20416 .cindex "DNS" "qualifying single-component names"
20417 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20418 lookups. Typically, but not standardly, this causes the resolver to qualify
20419 single-component names with the default domain. For example, on a machine
20420 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20421 &'thesaurus.ref.example'& inside the resolver. For details of what your
20422 resolver actually does, consult your man pages for &'resolver'& and
20423 &'resolv.conf'&.
20424
20425
20426
20427 .option rewrite_headers dnslookup boolean true
20428 .cindex "rewriting" "header lines"
20429 .cindex "header lines" "rewriting"
20430 If the domain name in the address that is being processed is not fully
20431 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20432 an address is specified as &'dormouse@teaparty'&, the domain might be
20433 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20434 occur as a result of setting the &%widen_domains%& option. If
20435 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20436 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20437 header lines of the message are rewritten with the full domain name.
20438
20439 This option should be turned off only when it is known that no message is
20440 ever going to be sent outside an environment where the abbreviation makes
20441 sense.
20442
20443 When an MX record is looked up in the DNS and matches a wildcard record, name
20444 servers normally return a record containing the name that has been looked up,
20445 making it impossible to detect whether a wildcard was present or not. However,
20446 some name servers have recently been seen to return the wildcard entry. If the
20447 name returned by a DNS lookup begins with an asterisk, it is not used for
20448 header rewriting.
20449
20450
20451 .option same_domain_copy_routing dnslookup boolean false
20452 .cindex "address" "copying routing"
20453 Addresses with the same domain are normally routed by the &(dnslookup)& router
20454 to the same list of hosts. However, this cannot be presumed, because the router
20455 options and preconditions may refer to the local part of the address. By
20456 default, therefore, Exim routes each address in a message independently. DNS
20457 servers run caches, so repeated DNS lookups are not normally expensive, and in
20458 any case, personal messages rarely have more than a few recipients.
20459
20460 If you are running mailing lists with large numbers of subscribers at the same
20461 domain, and you are using a &(dnslookup)& router which is independent of the
20462 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20463 lookups for identical domains in one message. In this case, when &(dnslookup)&
20464 routes an address to a remote transport, any other unrouted addresses in the
20465 message that have the same domain are automatically given the same routing
20466 without processing them independently,
20467 provided the following conditions are met:
20468
20469 .ilist
20470 No router that processed the address specified &%headers_add%& or
20471 &%headers_remove%&.
20472 .next
20473 The router did not change the address in any way, for example, by &"widening"&
20474 the domain.
20475 .endlist
20476
20477
20478
20479
20480 .option search_parents dnslookup boolean false
20481 .cindex "DNS" "resolver options"
20482 When this option is true, the resolver option RES_DNSRCH is set for DNS
20483 lookups. This is different from the &%qualify_single%& option in that it
20484 applies to domains containing dots. Typically, but not standardly, it causes
20485 the resolver to search for the name in the current domain and in parent
20486 domains. For example, on a machine in the &'fict.example'& domain, if looking
20487 up &'teaparty.wonderland'& failed, the resolver would try
20488 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20489 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20490
20491 Setting this option true can cause problems in domains that have a wildcard MX
20492 record, because any domain that does not have its own MX record matches the
20493 local wildcard.
20494
20495
20496
20497 .option srv_fail_domains dnslookup "domain list&!!" unset
20498 If the DNS lookup for SRV records for one of the domains in this list causes a
20499 DNS lookup error, Exim behaves as if no SRV records were found. See section
20500 &<<SECTprowitdnsloo>>& for more discussion.
20501
20502
20503
20504
20505 .option widen_domains dnslookup "string list" unset
20506 .cindex "domain" "partial; widening"
20507 If a DNS lookup fails and this option is set, each of its strings in turn is
20508 added onto the end of the domain, and the lookup is tried again. For example,
20509 if
20510 .code
20511 widen_domains = fict.example:ref.example
20512 .endd
20513 is set and a lookup of &'klingon.dictionary'& fails,
20514 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20515 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20516 and &%search_parents%& options can cause some widening to be undertaken inside
20517 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20518 when verifying, unless &%rewrite_headers%& is false (not the default).
20519
20520
20521 .section "Effect of qualify_single and search_parents" "SECID119"
20522 When a domain from an envelope recipient is changed by the resolver as a result
20523 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20524 corresponding address in the message's header lines unless &%rewrite_headers%&
20525 is set false. Exim then re-routes the address, using the full domain.
20526
20527 These two options affect only the DNS lookup that takes place inside the router
20528 for the domain of the address that is being routed. They do not affect lookups
20529 such as that implied by
20530 .code
20531 domains = @mx_any
20532 .endd
20533 that may happen while processing a router precondition before the router is
20534 entered. No widening ever takes place for these lookups.
20535 .ecindex IIDdnsrou1
20536 .ecindex IIDdnsrou2
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546 . ////////////////////////////////////////////////////////////////////////////
20547 . ////////////////////////////////////////////////////////////////////////////
20548
20549 .chapter "The ipliteral router" "CHID5"
20550 .cindex "&(ipliteral)& router"
20551 .cindex "domain literal" "routing"
20552 .cindex "routers" "&(ipliteral)&"
20553 This router has no private options. Unless it is being used purely for
20554 verification (see &%verify_only%&) a transport is required to be defined by the
20555 generic &%transport%& option. The router accepts the address if its domain part
20556 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20557 router handles the address
20558 .code
20559 root@[192.168.1.1]
20560 .endd
20561 by setting up delivery to the host with that IP address. IPv4 domain literals
20562 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20563 are similar, but the address is preceded by &`ipv6:`&. For example:
20564 .code
20565 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20566 .endd
20567 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20568 grounds that sooner or later somebody will try it.
20569
20570 .oindex "&%self%&" "in &(ipliteral)& router"
20571 If the IP address matches something in &%ignore_target_hosts%&, the router
20572 declines. If an IP literal turns out to refer to the local host, the generic
20573 &%self%& option determines what happens.
20574
20575 The RFCs require support for domain literals; however, their use is
20576 controversial in today's Internet. If you want to use this router, you must
20577 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20578 Exim will not recognize the domain literal syntax in addresses.
20579
20580
20581
20582 . ////////////////////////////////////////////////////////////////////////////
20583 . ////////////////////////////////////////////////////////////////////////////
20584
20585 .chapter "The iplookup router" "CHID6"
20586 .cindex "&(iplookup)& router"
20587 .cindex "routers" "&(iplookup)&"
20588 The &(iplookup)& router was written to fulfil a specific requirement in
20589 Cambridge University (which in fact no longer exists). For this reason, it is
20590 not included in the binary of Exim by default. If you want to include it, you
20591 must set
20592 .code
20593 ROUTER_IPLOOKUP=yes
20594 .endd
20595 in your &_Local/Makefile_& configuration file.
20596
20597 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20598 connection to one or more specific hosts. The host can then return the same or
20599 a different address &-- in effect rewriting the recipient address in the
20600 message's envelope. The new address is then passed on to subsequent routers. If
20601 this process fails, the address can be passed on to other routers, or delivery
20602 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20603 must not be specified for it.
20604
20605 .cindex "options" "&(iplookup)& router"
20606 .option hosts iplookup string unset
20607 This option must be supplied. Its value is a colon-separated list of host
20608 names. The hosts are looked up using &[gethostbyname()]&
20609 (or &[getipnodebyname()]& when available)
20610 and are tried in order until one responds to the query. If none respond, what
20611 happens is controlled by &%optional%&.
20612
20613
20614 .option optional iplookup boolean false
20615 If &%optional%& is true, if no response is obtained from any host, the address
20616 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20617 delivery to the address is deferred.
20618
20619
20620 .option port iplookup integer 0
20621 .cindex "port" "&(iplookup)& router"
20622 This option must be supplied. It specifies the port number for the TCP or UDP
20623 call.
20624
20625
20626 .option protocol iplookup string udp
20627 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20628 protocols is to be used.
20629
20630
20631 .option query iplookup string&!! "see below"
20632 This defines the content of the query that is sent to the remote hosts. The
20633 default value is:
20634 .code
20635 $local_part@$domain $local_part@$domain
20636 .endd
20637 The repetition serves as a way of checking that a response is to the correct
20638 query in the default case (see &%response_pattern%& below).
20639
20640
20641 .option reroute iplookup string&!! unset
20642 If this option is not set, the rerouted address is precisely the byte string
20643 returned by the remote host, up to the first white space, if any. If set, the
20644 string is expanded to form the rerouted address. It can include parts matched
20645 in the response by &%response_pattern%& by means of numeric variables such as
20646 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20647 whether or not a pattern is in use. In all cases, the rerouted address must end
20648 up in the form &'local_part@domain'&.
20649
20650
20651 .option response_pattern iplookup string unset
20652 This option can be set to a regular expression that is applied to the string
20653 returned from the remote host. If the pattern does not match the response, the
20654 router declines. If &%response_pattern%& is not set, no checking of the
20655 response is done, unless the query was defaulted, in which case there is a
20656 check that the text returned after the first white space is the original
20657 address. This checks that the answer that has been received is in response to
20658 the correct question. For example, if the response is just a new domain, the
20659 following could be used:
20660 .code
20661 response_pattern = ^([^@]+)$
20662 reroute = $local_part@$1
20663 .endd
20664
20665 .option timeout iplookup time 5s
20666 This specifies the amount of time to wait for a response from the remote
20667 machine. The same timeout is used for the &[connect()]& function for a TCP
20668 call. It does not apply to UDP.
20669
20670
20671
20672
20673 . ////////////////////////////////////////////////////////////////////////////
20674 . ////////////////////////////////////////////////////////////////////////////
20675
20676 .chapter "The manualroute router" "CHID7"
20677 .scindex IIDmanrou1 "&(manualroute)& router"
20678 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20679 .cindex "domain" "manually routing"
20680 The &(manualroute)& router is so-called because it provides a way of manually
20681 routing an address according to its domain. It is mainly used when you want to
20682 route addresses to remote hosts according to your own rules, bypassing the
20683 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20684 route to local transports, a facility that may be useful if you want to save
20685 messages for dial-in hosts in local files.
20686
20687 The &(manualroute)& router compares a list of domain patterns with the domain
20688 it is trying to route. If there is no match, the router declines. Each pattern
20689 has associated with it a list of hosts and some other optional data, which may
20690 include a transport. The combination of a pattern and its data is called a
20691 &"routing rule"&. For patterns that do not have an associated transport, the
20692 generic &%transport%& option must specify a transport, unless the router is
20693 being used purely for verification (see &%verify_only%&).
20694
20695 .vindex "&$host$&"
20696 In the case of verification, matching the domain pattern is sufficient for the
20697 router to accept the address. When actually routing an address for delivery,
20698 an address that matches a domain pattern is queued for the associated
20699 transport. If the transport is not a local one, a host list must be associated
20700 with the pattern; IP addresses are looked up for the hosts, and these are
20701 passed to the transport along with the mail address. For local transports, a
20702 host list is optional. If it is present, it is passed in &$host$& as a single
20703 text string.
20704
20705 The list of routing rules can be provided as an inline string in
20706 &%route_list%&, or the data can be obtained by looking up the domain in a file
20707 or database by setting &%route_data%&. Only one of these settings may appear in
20708 any one instance of &(manualroute)&. The format of routing rules is described
20709 below, following the list of private options.
20710
20711
20712 .section "Private options for manualroute" "SECTprioptman"
20713
20714 .cindex "options" "&(manualroute)& router"
20715 The private options for the &(manualroute)& router are as follows:
20716
20717 .option host_all_ignored manualroute string defer
20718 See &%host_find_failed%&.
20719
20720 .option host_find_failed manualroute string freeze
20721 This option controls what happens when &(manualroute)& tries to find an IP
20722 address for a host, and the host does not exist. The option can be set to one
20723 of the following values:
20724 .code
20725 decline
20726 defer
20727 fail
20728 freeze
20729 ignore
20730 pass
20731 .endd
20732 The default (&"freeze"&) assumes that this state is a serious configuration
20733 error. The difference between &"pass"& and &"decline"& is that the former
20734 forces the address to be passed to the next router (or the router defined by
20735 &%pass_router%&),
20736 .oindex "&%more%&"
20737 overriding &%no_more%&, whereas the latter passes the address to the next
20738 router only if &%more%& is true.
20739
20740 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20741 cannot be found. If all the hosts in the list are ignored, the behaviour is
20742 controlled by the &%host_all_ignored%& option. This takes the same values
20743 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20744
20745 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20746 state; if a host lookup gets a temporary error, delivery is deferred unless the
20747 generic &%pass_on_timeout%& option is set.
20748
20749
20750 .option hosts_randomize manualroute boolean false
20751 .cindex "randomized host list"
20752 .cindex "host" "list of; randomized"
20753 If this option is set, the order of the items in a host list in a routing rule
20754 is randomized each time the list is used, unless an option in the routing rule
20755 overrides (see below). Randomizing the order of a host list can be used to do
20756 crude load sharing. However, if more than one mail address is routed by the
20757 same router to the same host list, the host lists are considered to be the same
20758 (even though they may be randomized into different orders) for the purpose of
20759 deciding whether to batch the deliveries into a single SMTP transaction.
20760
20761 When &%hosts_randomize%& is true, a host list may be split
20762 into groups whose order is separately randomized. This makes it possible to
20763 set up MX-like behaviour. The boundaries between groups are indicated by an
20764 item that is just &`+`& in the host list. For example:
20765 .code
20766 route_list = * host1:host2:host3:+:host4:host5
20767 .endd
20768 The order of the first three hosts and the order of the last two hosts is
20769 randomized for each use, but the first three always end up before the last two.
20770 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20771 randomized host list is passed to an &(smtp)& transport that also has
20772 &%hosts_randomize set%&, the list is not re-randomized.
20773
20774
20775 .option route_data manualroute string&!! unset
20776 If this option is set, it must expand to yield the data part of a routing rule.
20777 Typically, the expansion string includes a lookup based on the domain. For
20778 example:
20779 .code
20780 route_data = ${lookup{$domain}dbm{/etc/routes}}
20781 .endd
20782 If the expansion is forced to fail, or the result is an empty string, the
20783 router declines. Other kinds of expansion failure cause delivery to be
20784 deferred.
20785
20786
20787 .option route_list manualroute "string list" unset
20788 This string is a list of routing rules, in the form defined below. Note that,
20789 unlike most string lists, the items are separated by semicolons. This is so
20790 that they may contain colon-separated host lists.
20791
20792
20793 .option same_domain_copy_routing manualroute boolean false
20794 .cindex "address" "copying routing"
20795 Addresses with the same domain are normally routed by the &(manualroute)&
20796 router to the same list of hosts. However, this cannot be presumed, because the
20797 router options and preconditions may refer to the local part of the address. By
20798 default, therefore, Exim routes each address in a message independently. DNS
20799 servers run caches, so repeated DNS lookups are not normally expensive, and in
20800 any case, personal messages rarely have more than a few recipients.
20801
20802 If you are running mailing lists with large numbers of subscribers at the same
20803 domain, and you are using a &(manualroute)& router which is independent of the
20804 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20805 lookups for identical domains in one message. In this case, when
20806 &(manualroute)& routes an address to a remote transport, any other unrouted
20807 addresses in the message that have the same domain are automatically given the
20808 same routing without processing them independently. However, this is only done
20809 if &%headers_add%& and &%headers_remove%& are unset.
20810
20811
20812
20813
20814 .section "Routing rules in route_list" "SECID120"
20815 The value of &%route_list%& is a string consisting of a sequence of routing
20816 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20817 entered as two semicolons. Alternatively, the list separator can be changed as
20818 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20819 Empty rules are ignored. The format of each rule is
20820 .display
20821 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20822 .endd
20823 The following example contains two rules, each with a simple domain pattern and
20824 no options:
20825 .code
20826 route_list = \
20827   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20828   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20829 .endd
20830 The three parts of a rule are separated by white space. The pattern and the
20831 list of hosts can be enclosed in quotes if necessary, and if they are, the
20832 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20833 single domain pattern, which is the only mandatory item in the rule. The
20834 pattern is in the same format as one item in a domain list (see section
20835 &<<SECTdomainlist>>&),
20836 except that it may not be the name of an interpolated file.
20837 That is, it may be wildcarded, or a regular expression, or a file or database
20838 lookup (with semicolons doubled, because of the use of semicolon as a separator
20839 in a &%route_list%&).
20840
20841 The rules in &%route_list%& are searched in order until one of the patterns
20842 matches the domain that is being routed. The list of hosts and then options are
20843 then used as described below. If there is no match, the router declines. When
20844 &%route_list%& is set, &%route_data%& must not be set.
20845
20846
20847
20848 .section "Routing rules in route_data" "SECID121"
20849 The use of &%route_list%& is convenient when there are only a small number of
20850 routing rules. For larger numbers, it is easier to use a file or database to
20851 hold the routing information, and use the &%route_data%& option instead.
20852 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20853 Most commonly, &%route_data%& is set as a string that contains an
20854 expansion lookup. For example, suppose we place two routing rules in a file
20855 like this:
20856 .code
20857 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20858 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20859 .endd
20860 This data can be accessed by setting
20861 .code
20862 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20863 .endd
20864 Failure of the lookup results in an empty string, causing the router to
20865 decline. However, you do not have to use a lookup in &%route_data%&. The only
20866 requirement is that the result of expanding the string is a list of hosts,
20867 possibly followed by options, separated by white space. The list of hosts must
20868 be enclosed in quotes if it contains white space.
20869
20870
20871
20872
20873 .section "Format of the list of hosts" "SECID122"
20874 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20875 always separately expanded before use. If the expansion fails, the router
20876 declines. The result of the expansion must be a colon-separated list of names
20877 and/or IP addresses, optionally also including ports.
20878 If the list is written with spaces, it must be protected with quotes.
20879 The format of each item
20880 in the list is described in the next section. The list separator can be changed
20881 as described in section &<<SECTlistsepchange>>&.
20882
20883 If the list of hosts was obtained from a &%route_list%& item, the following
20884 variables are set during its expansion:
20885
20886 .ilist
20887 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20888 If the domain was matched against a regular expression, the numeric variables
20889 &$1$&, &$2$&, etc. may be set. For example:
20890 .code
20891 route_list = ^domain(\d+)   host-$1.text.example
20892 .endd
20893 .next
20894 &$0$& is always set to the entire domain.
20895 .next
20896 &$1$& is also set when partial matching is done in a file lookup.
20897
20898 .next
20899 .vindex "&$value$&"
20900 If the pattern that matched the domain was a lookup item, the data that was
20901 looked up is available in the expansion variable &$value$&. For example:
20902 .code
20903 route_list = lsearch;;/some/file.routes  $value
20904 .endd
20905 .endlist
20906
20907 Note the doubling of the semicolon in the pattern that is necessary because
20908 semicolon is the default route list separator.
20909
20910
20911
20912 .section "Format of one host item" "SECTformatonehostitem"
20913 Each item in the list of hosts can be either a host name or an IP address,
20914 optionally with an attached port number, or it can be a single "+"
20915 (see &%hosts_randomize%&).
20916 When no port is given, an IP address
20917 is not enclosed in brackets. When a port is specified, it overrides the port
20918 specification on the transport. The port is separated from the name or address
20919 by a colon. This leads to some complications:
20920
20921 .ilist
20922 Because colon is the default separator for the list of hosts, either
20923 the colon that specifies a port must be doubled, or the list separator must
20924 be changed. The following two examples have the same effect:
20925 .code
20926 route_list = * "host1.tld::1225 : host2.tld::1226"
20927 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20928 .endd
20929 .next
20930 When IPv6 addresses are involved, it gets worse, because they contain
20931 colons of their own. To make this case easier, it is permitted to
20932 enclose an IP address (either v4 or v6) in square brackets if a port
20933 number follows. For example:
20934 .code
20935 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20936 .endd
20937 .endlist
20938
20939 .section "How the list of hosts is used" "SECThostshowused"
20940 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20941 the hosts is tried, in the order specified, when carrying out the SMTP
20942 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20943 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20944 transport.
20945
20946 Hosts may be listed by name or by IP address. An unadorned name in the list of
20947 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20948 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20949 records in the DNS. For example:
20950 .code
20951 route_list = *  x.y.z:p.q.r/MX:e.f.g
20952 .endd
20953 If this feature is used with a port specifier, the port must come last. For
20954 example:
20955 .code
20956 route_list = *  dom1.tld/mx::1225
20957 .endd
20958 If the &%hosts_randomize%& option is set, the order of the items in the list is
20959 randomized before any lookups are done. Exim then scans the list; for any name
20960 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20961 be an interface on the local host and the item is not the first in the list,
20962 Exim discards it and any subsequent items. If it is the first item, what
20963 happens is controlled by the
20964 .oindex "&%self%&" "in &(manualroute)& router"
20965 &%self%& option of the router.
20966
20967 A name on the list that is followed by &`/MX`& is replaced with the list of
20968 hosts obtained by looking up MX records for the name. This is always a DNS
20969 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20970 below) are not relevant here. The order of these hosts is determined by the
20971 preference values in the MX records, according to the usual rules. Because
20972 randomizing happens before the MX lookup, it does not affect the order that is
20973 defined by MX preferences.
20974
20975 If the local host is present in the sublist obtained from MX records, but is
20976 not the most preferred host in that list, it and any equally or less
20977 preferred hosts are removed before the sublist is inserted into the main list.
20978
20979 If the local host is the most preferred host in the MX list, what happens
20980 depends on where in the original list of hosts the &`/MX`& item appears. If it
20981 is not the first item (that is, there are previous hosts in the main list),
20982 Exim discards this name and any subsequent items in the main list.
20983
20984 If the MX item is first in the list of hosts, and the local host is the
20985 most preferred host, what happens is controlled by the &%self%& option of the
20986 router.
20987
20988 DNS failures when lookup up the MX records are treated in the same way as DNS
20989 failures when looking up IP addresses: &%pass_on_timeout%& and
20990 &%host_find_failed%& are used when relevant.
20991
20992 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20993 whether obtained from an MX lookup or not.
20994
20995
20996
20997 .section "How the options are used" "SECThowoptused"
20998 The options are a sequence of words, space-separated.
20999 One of the words can be the name of a transport; this overrides the
21000 &%transport%& option on the router for this particular routing rule only. The
21001 other words (if present) control randomization of the list of hosts on a
21002 per-rule basis, and how the IP addresses of the hosts are to be found when
21003 routing to a remote transport. These options are as follows:
21004
21005 .ilist
21006 &%randomize%&: randomize the order of the hosts in this list, overriding the
21007 setting of &%hosts_randomize%& for this routing rule only.
21008 .next
21009 &%no_randomize%&: do not randomize the order of the hosts in this list,
21010 overriding the setting of &%hosts_randomize%& for this routing rule only.
21011 .next
21012 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
21013 find IP addresses. This function may ultimately cause a DNS lookup, but it may
21014 also look in &_/etc/hosts_& or other sources of information.
21015 .next
21016 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
21017 no address records are found. If there is a temporary DNS error (such as a
21018 timeout), delivery is deferred.
21019 .next
21020 &%ipv4_only%&: in direct DNS lookups, look up only A records.
21021 .next
21022 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
21023 .endlist
21024
21025 For example:
21026 .code
21027 route_list = domain1  host1:host2:host3  randomize bydns;\
21028              domain2  host4:host5
21029 .endd
21030 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
21031 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
21032 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
21033 or &[gethostbyname()]&, and the result of the lookup is the result of that
21034 call.
21035
21036 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
21037 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
21038 instead of TRY_AGAIN. That is why the default action is to try a DNS
21039 lookup first. Only if that gives a definite &"no such host"& is the local
21040 function called.
21041
21042 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
21043 inadvertent constraint that a transport name as an option had to be the last
21044 option specified.
21045
21046
21047
21048 If no IP address for a host can be found, what happens is controlled by the
21049 &%host_find_failed%& option.
21050
21051 .vindex "&$host$&"
21052 When an address is routed to a local transport, IP addresses are not looked up.
21053 The host list is passed to the transport in the &$host$& variable.
21054
21055
21056
21057 .section "Manualroute examples" "SECID123"
21058 In some of the examples that follow, the presence of the &%remote_smtp%&
21059 transport, as defined in the default configuration file, is assumed:
21060
21061 .ilist
21062 .cindex "smart host" "example router"
21063 The &(manualroute)& router can be used to forward all external mail to a
21064 &'smart host'&. If you have set up, in the main part of the configuration, a
21065 named domain list that contains your local domains, for example:
21066 .code
21067 domainlist local_domains = my.domain.example
21068 .endd
21069 You can arrange for all other domains to be routed to a smart host by making
21070 your first router something like this:
21071 .code
21072 smart_route:
21073   driver = manualroute
21074   domains = !+local_domains
21075   transport = remote_smtp
21076   route_list = * smarthost.ref.example
21077 .endd
21078 This causes all non-local addresses to be sent to the single host
21079 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
21080 they are tried in order
21081 (but you can use &%hosts_randomize%& to vary the order each time).
21082 Another way of configuring the same thing is this:
21083 .code
21084 smart_route:
21085   driver = manualroute
21086   transport = remote_smtp
21087   route_list = !+local_domains  smarthost.ref.example
21088 .endd
21089 There is no difference in behaviour between these two routers as they stand.
21090 However, they behave differently if &%no_more%& is added to them. In the first
21091 example, the router is skipped if the domain does not match the &%domains%&
21092 precondition; the following router is always tried. If the router runs, it
21093 always matches the domain and so can never decline. Therefore, &%no_more%&
21094 would have no effect. In the second case, the router is never skipped; it
21095 always runs. However, if it doesn't match the domain, it declines. In this case
21096 &%no_more%& would prevent subsequent routers from running.
21097
21098 .next
21099 .cindex "mail hub example"
21100 A &'mail hub'& is a host which receives mail for a number of domains via MX
21101 records in the DNS and delivers it via its own private routing mechanism. Often
21102 the final destinations are behind a firewall, with the mail hub being the one
21103 machine that can connect to machines both inside and outside the firewall. The
21104 &(manualroute)& router is usually used on a mail hub to route incoming messages
21105 to the correct hosts. For a small number of domains, the routing can be inline,
21106 using the &%route_list%& option, but for a larger number a file or database
21107 lookup is easier to manage.
21108
21109 If the domain names are in fact the names of the machines to which the mail is
21110 to be sent by the mail hub, the configuration can be quite simple. For
21111 example:
21112 .code
21113 hub_route:
21114   driver = manualroute
21115   transport = remote_smtp
21116   route_list = *.rhodes.tvs.example  $domain
21117 .endd
21118 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21119 whose names are the same as the mail domains. A similar approach can be taken
21120 if the host name can be obtained from the domain name by a string manipulation
21121 that the expansion facilities can handle. Otherwise, a lookup based on the
21122 domain can be used to find the host:
21123 .code
21124 through_firewall:
21125   driver = manualroute
21126   transport = remote_smtp
21127   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21128 .endd
21129 The result of the lookup must be the name or IP address of the host (or
21130 hosts) to which the address is to be routed. If the lookup fails, the route
21131 data is empty, causing the router to decline. The address then passes to the
21132 next router.
21133
21134 .next
21135 .cindex "batched SMTP output example"
21136 .cindex "SMTP" "batched outgoing; example"
21137 You can use &(manualroute)& to deliver messages to pipes or files in batched
21138 SMTP format for onward transportation by some other means. This is one way of
21139 storing mail for a dial-up host when it is not connected. The route list entry
21140 can be as simple as a single domain name in a configuration like this:
21141 .code
21142 save_in_file:
21143   driver = manualroute
21144   transport = batchsmtp_appendfile
21145   route_list = saved.domain.example
21146 .endd
21147 though often a pattern is used to pick up more than one domain. If there are
21148 several domains or groups of domains with different transport requirements,
21149 different transports can be listed in the routing information:
21150 .code
21151 save_in_file:
21152   driver = manualroute
21153   route_list = \
21154     *.saved.domain1.example  $domain  batch_appendfile; \
21155     *.saved.domain2.example  \
21156       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21157       batch_pipe
21158 .endd
21159 .vindex "&$domain$&"
21160 .vindex "&$host$&"
21161 The first of these just passes the domain in the &$host$& variable, which
21162 doesn't achieve much (since it is also in &$domain$&), but the second does a
21163 file lookup to find a value to pass, causing the router to decline to handle
21164 the address if the lookup fails.
21165
21166 .next
21167 .cindex "UUCP" "example of router for"
21168 Routing mail directly to UUCP software is a specific case of the use of
21169 &(manualroute)& in a gateway to another mail environment. This is an example of
21170 one way it can be done:
21171 .code
21172 # Transport
21173 uucp:
21174   driver = pipe
21175   user = nobody
21176   command = /usr/local/bin/uux -r - \
21177     ${substr_-5:$host}!rmail ${local_part}
21178   return_fail_output = true
21179
21180 # Router
21181 uucphost:
21182   transport = uucp
21183   driver = manualroute
21184   route_data = \
21185     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21186 .endd
21187 The file &_/usr/local/exim/uucphosts_& contains entries like
21188 .code
21189 darksite.ethereal.example:           darksite.UUCP
21190 .endd
21191 It can be set up more simply without adding and removing &".UUCP"& but this way
21192 makes clear the distinction between the domain name
21193 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21194 .endlist
21195 .ecindex IIDmanrou1
21196 .ecindex IIDmanrou2
21197
21198
21199
21200
21201
21202
21203
21204
21205 . ////////////////////////////////////////////////////////////////////////////
21206 . ////////////////////////////////////////////////////////////////////////////
21207
21208 .chapter "The queryprogram router" "CHAPdriverlast"
21209 .scindex IIDquerou1 "&(queryprogram)& router"
21210 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21211 .cindex "routing" "by external program"
21212 The &(queryprogram)& router routes an address by running an external command
21213 and acting on its output. This is an expensive way to route, and is intended
21214 mainly for use in lightly-loaded systems, or for performing experiments.
21215 However, if it is possible to use the precondition options (&%domains%&,
21216 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21217 be used in special cases, even on a busy host. There are the following private
21218 options:
21219 .cindex "options" "&(queryprogram)& router"
21220
21221 .option command queryprogram string&!! unset
21222 This option must be set. It specifies the command that is to be run. The
21223 command is split up into a command name and arguments, and then each is
21224 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21225 &<<CHAPpipetransport>>&).
21226
21227
21228 .option command_group queryprogram string unset
21229 .cindex "gid (group id)" "in &(queryprogram)& router"
21230 This option specifies a gid to be set when running the command while routing an
21231 address for deliver. It must be set if &%command_user%& specifies a numerical
21232 uid. If it begins with a digit, it is interpreted as the numerical value of the
21233 gid. Otherwise it is looked up using &[getgrnam()]&.
21234
21235
21236 .option command_user queryprogram string unset
21237 .cindex "uid (user id)" "for &(queryprogram)&"
21238 This option must be set. It specifies the uid which is set when running the
21239 command while routing an address for delivery. If the value begins with a digit,
21240 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21241 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21242 not set, a value for the gid also.
21243
21244 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21245 root, which it does during a normal delivery in a conventional configuration.
21246 However, when an address is being verified during message reception, Exim is
21247 usually running as the Exim user, not as root. If the &(queryprogram)& router
21248 is called from a non-root process, Exim cannot change uid or gid before running
21249 the command. In this circumstance the command runs under the current uid and
21250 gid.
21251
21252
21253 .option current_directory queryprogram string /
21254 This option specifies an absolute path which is made the current directory
21255 before running the command.
21256
21257
21258 .option timeout queryprogram time 1h
21259 If the command does not complete within the timeout period, its process group
21260 is killed and the message is frozen. A value of zero time specifies no
21261 timeout.
21262
21263
21264 The standard output of the command is connected to a pipe, which is read when
21265 the command terminates. It should consist of a single line of output,
21266 containing up to five fields, separated by white space. The maximum length of
21267 the line is 1023 characters. Longer lines are silently truncated. The first
21268 field is one of the following words (case-insensitive):
21269
21270 .ilist
21271 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21272 below).
21273 .next
21274 &'Decline'&: the router declines; pass the address to the next router, unless
21275 &%no_more%& is set.
21276 .next
21277 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21278 subsequent text on the line is an error message. If the router is run as part
21279 of address verification during an incoming SMTP message, the message is
21280 included in the SMTP response.
21281 .next
21282 &'Defer'&: routing could not be completed at this time; try again later. Any
21283 subsequent text on the line is an error message which is logged. It is not
21284 included in any SMTP response.
21285 .next
21286 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21287 .next
21288 &'Pass'&: pass the address to the next router (or the router specified by
21289 &%pass_router%&), overriding &%no_more%&.
21290 .next
21291 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21292 new addresses, which are routed independently, starting with the first router,
21293 or the router specified by &%redirect_router%&, if set.
21294 .endlist
21295
21296 When the first word is &'accept'&, the remainder of the line consists of a
21297 number of keyed data values, as follows (split into two lines here, to fit on
21298 the page):
21299 .code
21300 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21301 LOOKUP=byname|bydns DATA=<text>
21302 .endd
21303 The data items can be given in any order, and all are optional. If no transport
21304 is included, the transport specified by the generic &%transport%& option is
21305 used. The list of hosts and the lookup type are needed only if the transport is
21306 an &(smtp)& transport that does not itself supply a list of hosts.
21307
21308 The format of the list of hosts is the same as for the &(manualroute)& router.
21309 As well as host names and IP addresses with optional port numbers, as described
21310 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21311 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21312 (see section &<<SECThostshowused>>&).
21313
21314 If the lookup type is not specified, Exim behaves as follows when trying to
21315 find an IP address for each host: First, a DNS lookup is done. If this yields
21316 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21317 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21318 result of the lookup is the result of that call.
21319
21320 .vindex "&$address_data$&"
21321 If the DATA field is set, its value is placed in the &$address_data$&
21322 variable. For example, this return line
21323 .code
21324 accept hosts=x1.y.example:x2.y.example data="rule1"
21325 .endd
21326 routes the address to the default transport, passing a list of two hosts. When
21327 the transport runs, the string &"rule1"& is in &$address_data$&.
21328 .ecindex IIDquerou1
21329 .ecindex IIDquerou2
21330
21331
21332
21333
21334 . ////////////////////////////////////////////////////////////////////////////
21335 . ////////////////////////////////////////////////////////////////////////////
21336
21337 .chapter "The redirect router" "CHAPredirect"
21338 .scindex IIDredrou1 "&(redirect)& router"
21339 .scindex IIDredrou2 "routers" "&(redirect)&"
21340 .cindex "alias file" "in a &(redirect)& router"
21341 .cindex "address redirection" "&(redirect)& router"
21342 The &(redirect)& router handles several kinds of address redirection. Its most
21343 common uses are for resolving local part aliases from a central alias file
21344 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21345 files, but it has many other potential uses. The incoming address can be
21346 redirected in several different ways:
21347
21348 .ilist
21349 It can be replaced by one or more new addresses which are themselves routed
21350 independently.
21351 .next
21352 It can be routed to be delivered to a given file or directory.
21353 .next
21354 It can be routed to be delivered to a specified pipe command.
21355 .next
21356 It can cause an automatic reply to be generated.
21357 .next
21358 It can be forced to fail, optionally with a custom error message.
21359 .next
21360 It can be temporarily deferred, optionally with a custom message.
21361 .next
21362 It can be discarded.
21363 .endlist
21364
21365 The generic &%transport%& option must not be set for &(redirect)& routers.
21366 However, there are some private options which define transports for delivery to
21367 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21368 &%pipe_transport%& and &%reply_transport%& descriptions below.
21369
21370 If success DSNs have been requested
21371 .cindex "DSN" "success"
21372 .cindex "Delivery Status Notification" "success"
21373 redirection triggers one and the DSN options are not passed any further.
21374
21375
21376
21377 .section "Redirection data" "SECID124"
21378 The router operates by interpreting a text string which it obtains either by
21379 expanding the contents of the &%data%& option, or by reading the entire
21380 contents of a file whose name is given in the &%file%& option. These two
21381 options are mutually exclusive. The first is commonly used for handling system
21382 aliases, in a configuration like this:
21383 .code
21384 system_aliases:
21385   driver = redirect
21386   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21387 .endd
21388 If the lookup fails, the expanded string in this example is empty. When the
21389 expansion of &%data%& results in an empty string, the router declines. A forced
21390 expansion failure also causes the router to decline; other expansion failures
21391 cause delivery to be deferred.
21392
21393 A configuration using &%file%& is commonly used for handling users'
21394 &_.forward_& files, like this:
21395 .code
21396 userforward:
21397   driver = redirect
21398   check_local_user
21399   file = $home/.forward
21400   no_verify
21401 .endd
21402 If the file does not exist, or causes no action to be taken (for example, it is
21403 empty or consists only of comments), the router declines. &*Warning*&: This
21404 is not the case when the file contains syntactically valid items that happen to
21405 yield empty addresses, for example, items containing only RFC 2822 address
21406 comments.
21407
21408 .cindex "tainted data" "in filenames"
21409 .cindex redirect "tainted data"
21410 Tainted data may not be used for a filename.
21411
21412 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21413 directly for redirection,
21414 as they are provided by a potential attacker.
21415 In the examples above, &$local_part$& is used for looking up data held locally
21416 on the system, and not used directly (the second example derives &$home$& via
21417 the passsword file or database, using &$local_part$&).
21418
21419
21420
21421 .section "Forward files and address verification" "SECID125"
21422 .cindex "address redirection" "while verifying"
21423 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21424 &_.forward_& files, as in the example above. There are two reasons for this:
21425
21426 .ilist
21427 When Exim is receiving an incoming SMTP message from a remote host, it is
21428 running under the Exim uid, not as root. Exim is unable to change uid to read
21429 the file as the user, and it may not be able to read it as the Exim user. So in
21430 practice the router may not be able to operate.
21431 .next
21432 However, even when the router can operate, the existence of a &_.forward_& file
21433 is unimportant when verifying an address. What should be checked is whether the
21434 local part is a valid user name or not. Cutting out the redirection processing
21435 saves some resources.
21436 .endlist
21437
21438
21439
21440
21441
21442
21443 .section "Interpreting redirection data" "SECID126"
21444 .cindex "Sieve filter" "specifying in redirection data"
21445 .cindex "filter" "specifying in redirection data"
21446 The contents of the data string, whether obtained from &%data%& or &%file%&,
21447 can be interpreted in two different ways:
21448
21449 .ilist
21450 If the &%allow_filter%& option is set true, and the data begins with the text
21451 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21452 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21453 respectively. Details of the syntax and semantics of filter files are described
21454 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21455 document is intended for use by end users.
21456 .next
21457 Otherwise, the data must be a comma-separated list of redirection items, as
21458 described in the next section.
21459 .endlist
21460
21461 When a message is redirected to a file (a &"mail folder"&), the filename given
21462 in a non-filter redirection list must always be an absolute path. A filter may
21463 generate a relative path &-- how this is handled depends on the transport's
21464 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21465 for the &(appendfile)& transport.
21466
21467
21468
21469 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21470 .cindex "address redirection" "non-filter list items"
21471 When the redirection data is not an Exim or Sieve filter, for example, if it
21472 comes from a conventional alias or forward file, it consists of a list of
21473 addresses, filenames, pipe commands, or certain special items (see section
21474 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21475 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21476 depending on their default values. The items in the list are separated by
21477 commas or newlines.
21478 If a comma is required in an item, the entire item must be enclosed in double
21479 quotes.
21480
21481 Lines starting with a # character are comments, and are ignored, and # may
21482 also appear following a comma, in which case everything between the # and the
21483 next newline character is ignored.
21484
21485 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21486 double quotes are retained because some forms of mail address require their use
21487 (but never to enclose the entire address). In the following description,
21488 &"item"& refers to what remains after any surrounding double quotes have been
21489 removed.
21490
21491 .vindex "&$local_part$&"
21492 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21493 and the expansion contains a reference to &$local_part$&, you should make use
21494 of the &%quote_local_part%& expansion operator, in case the local part contains
21495 special characters. For example, to redirect all mail for the domain
21496 &'obsolete.example'&, retaining the existing local part, you could use this
21497 setting:
21498 .code
21499 data = ${quote_local_part:$local_part}@newdomain.example
21500 .endd
21501
21502
21503 .section "Redirecting to a local mailbox" "SECTredlocmai"
21504 .cindex "routing" "loops in"
21505 .cindex "loop" "while routing, avoidance of"
21506 .cindex "address redirection" "to local mailbox"
21507 A redirection item may safely be the same as the address currently under
21508 consideration. This does not cause a routing loop, because a router is
21509 automatically skipped if any ancestor of the address that is being processed
21510 is the same as the current address and was processed by the current router.
21511 Such an address is therefore passed to the following routers, so it is handled
21512 as if there were no redirection. When making this loop-avoidance test, the
21513 complete local part, including any prefix or suffix, is used.
21514
21515 .cindex "address redirection" "local part without domain"
21516 Specifying the same local part without a domain is a common usage in personal
21517 filter files when the user wants to have messages delivered to the local
21518 mailbox and also forwarded elsewhere. For example, the user whose login is
21519 &'cleo'& might have a &_.forward_& file containing this:
21520 .code
21521 cleo, cleopatra@egypt.example
21522 .endd
21523 .cindex "backslash in alias file"
21524 .cindex "alias file" "backslash in"
21525 For compatibility with other MTAs, such unqualified local parts may be
21526 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21527 it does make a difference if more than one domain is being handled
21528 synonymously.
21529
21530 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21531 2822 address that does not include a domain, the item is qualified using the
21532 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21533 addresses are qualified using the value in &%qualify_recipient%&, but you can
21534 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21535
21536 Care must be taken if there are alias names for local users.
21537 Consider an MTA handling a single local domain where the system alias file
21538 contains:
21539 .code
21540 Sam.Reman: spqr
21541 .endd
21542 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21543 messages in the local mailbox, and also forward copies elsewhere. He creates
21544 this forward file:
21545 .code
21546 Sam.Reman, spqr@reme.elsewhere.example
21547 .endd
21548 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21549 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21550 second time round, because it has previously routed it,
21551 and the following routers presumably cannot handle the alias. The forward file
21552 should really contain
21553 .code
21554 spqr, spqr@reme.elsewhere.example
21555 .endd
21556 but because this is such a common error, the &%check_ancestor%& option (see
21557 below) exists to provide a way to get round it. This is normally set on a
21558 &(redirect)& router that is handling users' &_.forward_& files.
21559
21560
21561
21562 .section "Special items in redirection lists" "SECTspecitredli"
21563 In addition to addresses, the following types of item may appear in redirection
21564 lists (that is, in non-filter redirection data):
21565
21566 .ilist
21567 .cindex "pipe" "in redirection list"
21568 .cindex "address redirection" "to pipe"
21569 An item is treated as a pipe command if it begins with &"|"& and does not parse
21570 as a valid RFC 2822 address that includes a domain. A transport for running the
21571 command must be specified by the &%pipe_transport%& option.
21572 Normally, either the router or the transport specifies a user and a group under
21573 which to run the delivery. The default is to use the Exim user and group.
21574
21575 Single or double quotes can be used for enclosing the individual arguments of
21576 the pipe command; no interpretation of escapes is done for single quotes. If
21577 the command contains a comma character, it is necessary to put the whole item
21578 in double quotes, for example:
21579 .code
21580 "|/some/command ready,steady,go"
21581 .endd
21582 since items in redirection lists are terminated by commas. Do not, however,
21583 quote just the command. An item such as
21584 .code
21585 |"/some/command ready,steady,go"
21586 .endd
21587 is interpreted as a pipe with a rather strange command name, and no arguments.
21588
21589 Note that the above example assumes that the text comes from a lookup source
21590 of some sort, so that the quotes are part of the data.  If composing a
21591 redirect router with a &%data%& option directly specifying this command, the
21592 quotes will be used by the configuration parser to define the extent of one
21593 string, but will not be passed down into the redirect router itself.  There
21594 are two main approaches to get around this: escape quotes to be part of the
21595 data itself, or avoid using this mechanism and instead create a custom
21596 transport with the &%command%& option set and reference that transport from
21597 an &%accept%& router.
21598
21599 .next
21600 .cindex "file" "in redirection list"
21601 .cindex "address redirection" "to file"
21602 An item is interpreted as a path name if it begins with &"/"& and does not
21603 parse as a valid RFC 2822 address that includes a domain. For example,
21604 .code
21605 /home/world/minbari
21606 .endd
21607 is treated as a filename, but
21608 .code
21609 /s=molari/o=babylon/@x400gate.way
21610 .endd
21611 is treated as an address. For a filename, a transport must be specified using
21612 the &%file_transport%& option. However, if the generated path name ends with a
21613 forward slash character, it is interpreted as a directory name rather than a
21614 filename, and &%directory_transport%& is used instead.
21615
21616 Normally, either the router or the transport specifies a user and a group under
21617 which to run the delivery. The default is to use the Exim user and group.
21618
21619 .cindex "&_/dev/null_&"
21620 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21621 bypassed at a high level, and the log entry shows &"**bypassed**"&
21622 instead of a transport name. In this case the user and group are not used.
21623
21624 .next
21625 .cindex "included address list"
21626 .cindex "address redirection" "included external list"
21627 If an item is of the form
21628 .code
21629 :include:<path name>
21630 .endd
21631 a list of further items is taken from the given file and included at that
21632 point. &*Note*&: Such a file can not be a filter file; it is just an
21633 out-of-line addition to the list. The items in the included list are separated
21634 by commas or newlines and are not subject to expansion. If this is the first
21635 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21636 the alias name. This example is incorrect:
21637 .code
21638 list1    :include:/opt/lists/list1
21639 .endd
21640 It must be given as
21641 .code
21642 list1:   :include:/opt/lists/list1
21643 .endd
21644 .cindex "tainted data" "in filenames"
21645 .cindex redirect "tainted data"
21646 Tainted data may not be used for a filename.
21647 .next
21648 .cindex "address redirection" "to black hole"
21649 .cindex "delivery" "discard"
21650 .cindex "delivery" "blackhole"
21651 .cindex "black hole"
21652 .cindex "abandoning mail"
21653 Sometimes you want to throw away mail to a particular local part.  Making the
21654 &%data%& option expand to an empty string does not work, because that causes
21655 the router to decline. Instead, the alias item
21656 .code
21657 :blackhole:
21658 .endd
21659 can be used. It does what its name implies. No delivery is
21660 done, and no error message is generated. This has the same effect as specifying
21661 &_/dev/null_& as a destination, but it can be independently disabled.
21662
21663 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21664 delivery is done for the original local part, even if other redirection items
21665 are present. If you are generating a multi-item list (for example, by reading a
21666 database) and need the ability to provide a no-op item, you must use
21667 &_/dev/null_&.
21668
21669 .next
21670 .cindex "delivery" "forcing failure"
21671 .cindex "delivery" "forcing deferral"
21672 .cindex "failing delivery" "forcing"
21673 .cindex "deferred delivery, forcing"
21674 .cindex "customizing" "failure message"
21675 An attempt to deliver a particular address can be deferred or forced to fail by
21676 redirection items of the form
21677 .code
21678 :defer:
21679 :fail:
21680 .endd
21681 respectively. When a redirection list contains such an item, it applies
21682 to the entire redirection; any other items in the list are ignored. Any
21683 text following &':fail:'& or &':defer:'& is placed in the error text
21684 associated with the failure. For example, an alias file might contain:
21685 .code
21686 X.Employee:  :fail: Gone away, no forwarding address
21687 .endd
21688 In the case of an address that is being verified from an ACL or as the subject
21689 of a
21690 .cindex "VRFY" "error text, display of"
21691 VRFY command, the text is included in the SMTP error response by
21692 default.
21693 .cindex "EXPN" "error text, display of"
21694 The text is not included in the response to an EXPN command. In non-SMTP cases
21695 the text is included in the error message that Exim generates.
21696
21697 .cindex "SMTP" "error codes"
21698 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21699 &':fail:'&. However, if the message starts with three digits followed by a
21700 space, optionally followed by an extended code of the form &'n.n.n'&, also
21701 followed by a space, and the very first digit is the same as the default error
21702 code, the code from the message is used instead. If the very first digit is
21703 incorrect, a panic error is logged, and the default code is used. You can
21704 suppress the use of the supplied code in a redirect router by setting the
21705 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21706 ignored.
21707
21708 .vindex "&$acl_verify_message$&"
21709 In an ACL, an explicitly provided message overrides the default, but the
21710 default message is available in the variable &$acl_verify_message$& and can
21711 therefore be included in a custom message if this is desired.
21712
21713 Normally the error text is the rest of the redirection list &-- a comma does
21714 not terminate it &-- but a newline does act as a terminator. Newlines are not
21715 normally present in alias expansions. In &(lsearch)& lookups they are removed
21716 as part of the continuation process, but they may exist in other kinds of
21717 lookup and in &':include:'& files.
21718
21719 During routing for message delivery (as opposed to verification), a redirection
21720 containing &':fail:'& causes an immediate failure of the incoming address,
21721 whereas &':defer:'& causes the message to remain in the queue so that a
21722 subsequent delivery attempt can happen at a later time. If an address is
21723 deferred for too long, it will ultimately fail, because the normal retry
21724 rules still apply.
21725
21726 .next
21727 .cindex "alias file" "exception to default"
21728 Sometimes it is useful to use a single-key search type with a default (see
21729 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21730 for exceptions to the default. These can be handled by aliasing them to
21731 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21732 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21733 results in an empty redirection list has the same effect.
21734 .endlist
21735
21736
21737 .section "Duplicate addresses" "SECTdupaddr"
21738 .cindex "duplicate addresses"
21739 .cindex "address duplicate, discarding"
21740 .cindex "pipe" "duplicated"
21741 Exim removes duplicate addresses from the list to which it is delivering, so as
21742 to deliver just one copy to each address. This does not apply to deliveries
21743 routed to pipes by different immediate parent addresses, but an indirect
21744 aliasing scheme of the type
21745 .code
21746 pipe:       |/some/command $local_part
21747 localpart1: pipe
21748 localpart2: pipe
21749 .endd
21750 does not work with a message that is addressed to both local parts, because
21751 when the second is aliased to the intermediate local part &"pipe"& it gets
21752 discarded as being the same as a previously handled address. However, a scheme
21753 such as
21754 .code
21755 localpart1: |/some/command $local_part
21756 localpart2: |/some/command $local_part
21757 .endd
21758 does result in two different pipe deliveries, because the immediate parents of
21759 the pipes are distinct.
21760
21761
21762
21763 .section "Repeated redirection expansion" "SECID128"
21764 .cindex "repeated redirection expansion"
21765 .cindex "address redirection" "repeated for each delivery attempt"
21766 When a message cannot be delivered to all of its recipients immediately,
21767 leading to two or more delivery attempts, redirection expansion is carried out
21768 afresh each time for those addresses whose children were not all previously
21769 delivered. If redirection is being used as a mailing list, this can lead to new
21770 members of the list receiving copies of old messages. The &%one_time%& option
21771 can be used to avoid this.
21772
21773
21774 .section "Errors in redirection lists" "SECID129"
21775 .cindex "address redirection" "errors"
21776 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21777 error is skipped, and an entry is written to the main log. This may be useful
21778 for mailing lists that are automatically managed. Otherwise, if an error is
21779 detected while generating the list of new addresses, the original address is
21780 deferred. See also &%syntax_errors_to%&.
21781
21782
21783
21784 .section "Private options for the redirect router" "SECID130"
21785
21786 .cindex "options" "&(redirect)& router"
21787 The private options for the &(redirect)& router are as follows:
21788
21789
21790 .option allow_defer redirect boolean false
21791 Setting this option allows the use of &':defer:'& in non-filter redirection
21792 data, or the &%defer%& command in an Exim filter file.
21793
21794
21795 .option allow_fail redirect boolean false
21796 .cindex "failing delivery" "from filter"
21797 If this option is true, the &':fail:'& item can be used in a redirection list,
21798 and the &%fail%& command may be used in an Exim filter file.
21799
21800
21801 .option allow_filter redirect boolean false
21802 .cindex "filter" "enabling use of"
21803 .cindex "Sieve filter" "enabling use of"
21804 Setting this option allows Exim to interpret redirection data that starts with
21805 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21806 are some features of Exim filter files that some administrators may wish to
21807 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21808
21809 It is also possible to lock out Exim filters or Sieve filters while allowing
21810 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21811
21812
21813 The filter is run using the uid and gid set by the generic &%user%& and
21814 &%group%& options. These take their defaults from the password data if
21815 &%check_local_user%& is set, so in the normal case of users' personal filter
21816 files, the filter is run as the relevant user. When &%allow_filter%& is set
21817 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21818
21819
21820
21821 .option allow_freeze redirect boolean false
21822 .cindex "freezing messages" "allowing in filter"
21823 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21824 This command is more normally encountered in system filters, and is disabled by
21825 default for redirection filters because it isn't something you usually want to
21826 let ordinary users do.
21827
21828
21829
21830 .option check_ancestor redirect boolean false
21831 This option is concerned with handling generated addresses that are the same
21832 as some address in the list of redirection ancestors of the current address.
21833 Although it is turned off by default in the code, it is set in the default
21834 configuration file for handling users' &_.forward_& files. It is recommended
21835 for this use of the &(redirect)& router.
21836
21837 When &%check_ancestor%& is set, if a generated address (including the domain)
21838 is the same as any ancestor of the current address, it is replaced by a copy of
21839 the current address. This helps in the case where local part A is aliased to B,
21840 and B has a &_.forward_& file pointing back to A. For example, within a single
21841 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21842 &_&~jb/.forward_& contains:
21843 .code
21844 \Joe.Bloggs, <other item(s)>
21845 .endd
21846 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21847 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21848 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21849 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21850 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21851 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21852 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21853 original address. See also the &%repeat_use%& option below.
21854
21855
21856 .option check_group redirect boolean "see below"
21857 When the &%file%& option is used, the group owner of the file is checked only
21858 when this option is set. The permitted groups are those listed in the
21859 &%owngroups%& option, together with the user's default group if
21860 &%check_local_user%& is set. If the file has the wrong group, routing is
21861 deferred. The default setting for this option is true if &%check_local_user%&
21862 is set and the &%modemask%& option permits the group write bit, or if the
21863 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21864
21865
21866
21867 .option check_owner redirect boolean "see below"
21868 When the &%file%& option is used, the owner of the file is checked only when
21869 this option is set. If &%check_local_user%& is set, the local user is
21870 permitted; otherwise the owner must be one of those listed in the &%owners%&
21871 option. The default value for this option is true if &%check_local_user%& or
21872 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21873
21874
21875 .option data redirect string&!! unset
21876 This option is mutually exclusive with &%file%&. One or other of them must be
21877 set, but not both. The contents of &%data%& are expanded, and then used as the
21878 list of forwarding items, or as a set of filtering instructions. If the
21879 expansion is forced to fail, or the result is an empty string or a string that
21880 has no effect (consists entirely of comments), the router declines.
21881
21882 When filtering instructions are used, the string must begin with &"#Exim
21883 filter"&, and all comments in the string, including this initial one, must be
21884 terminated with newline characters. For example:
21885 .code
21886 data = #Exim filter\n\
21887        if $h_to: contains Exim then save $home/mail/exim endif
21888 .endd
21889 If you are reading the data from a database where newlines cannot be included,
21890 you can use the &${sg}$& expansion item to turn the escape string of your
21891 choice into a newline.
21892
21893
21894 .option directory_transport redirect string&!! unset
21895 A &(redirect)& router sets up a direct delivery to a directory when a path name
21896 ending with a slash is specified as a new &"address"&. The transport used is
21897 specified by this option, which, after expansion, must be the name of a
21898 configured transport. This should normally be an &(appendfile)& transport.
21899
21900
21901 .option file redirect string&!! unset
21902 This option specifies the name of a file that contains the redirection data. It
21903 is mutually exclusive with the &%data%& option. The string is expanded before
21904 use; if the expansion is forced to fail, the router declines. Other expansion
21905 failures cause delivery to be deferred. The result of a successful expansion
21906 must be an absolute path. The entire file is read and used as the redirection
21907 data. If the data is an empty string or a string that has no effect (consists
21908 entirely of comments), the router declines.
21909
21910 .cindex "NFS" "checking for file existence"
21911 If the attempt to open the file fails with a &"does not exist"& error, Exim
21912 runs a check on the containing directory,
21913 unless &%ignore_enotdir%& is true (see below).
21914 If the directory does not appear to exist, delivery is deferred. This can
21915 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21916 is a mount problem. If the containing directory does exist, but the file does
21917 not, the router declines.
21918
21919
21920 .option file_transport redirect string&!! unset
21921 .vindex "&$address_file$&"
21922 A &(redirect)& router sets up a direct delivery to a file when a path name not
21923 ending in a slash is specified as a new &"address"&. The transport used is
21924 specified by this option, which, after expansion, must be the name of a
21925 configured transport. This should normally be an &(appendfile)& transport. When
21926 it is running, the filename is in &$address_file$&.
21927
21928
21929 .option filter_prepend_home redirect boolean true
21930 When this option is true, if a &(save)& command in an Exim filter specifies a
21931 relative path, and &$home$& is defined, it is automatically prepended to the
21932 relative path. If this option is set false, this action does not happen. The
21933 relative path is then passed to the transport unmodified.
21934
21935
21936 .option forbid_blackhole redirect boolean false
21937 .cindex "restricting access to features"
21938 .cindex "filter" "locking out certain features"
21939 If this option is true, the &':blackhole:'& item may not appear in a
21940 redirection list.
21941
21942
21943 .option forbid_exim_filter redirect boolean false
21944 .cindex "restricting access to features"
21945 .cindex "filter" "locking out certain features"
21946 If this option is set true, only Sieve filters are permitted when
21947 &%allow_filter%& is true.
21948
21949
21950
21951
21952 .option forbid_file redirect boolean false
21953 .cindex "restricting access to features"
21954 .cindex "delivery" "to file; forbidding"
21955 .cindex "filter" "locking out certain features"
21956 .cindex "Sieve filter" "forbidding delivery to a file"
21957 .cindex "Sieve filter" "&""keep""& facility; disabling"
21958 If this option is true, this router may not generate a new address that
21959 specifies delivery to a local file or directory, either from a filter or from a
21960 conventional forward file. This option is forced to be true if &%one_time%& is
21961 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21962 locks out the Sieve's &"keep"& facility.
21963
21964
21965 .option forbid_filter_dlfunc redirect boolean false
21966 .cindex "restricting access to features"
21967 .cindex "filter" "locking out certain features"
21968 If this option is true, string expansions in Exim filters are not allowed to
21969 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21970 functions.
21971
21972 .option forbid_filter_existstest redirect boolean false
21973 .cindex "restricting access to features"
21974 .cindex "filter" "locking out certain features"
21975 .cindex "expansion" "statting a file"
21976 If this option is true, string expansions in Exim filters are not allowed to
21977 make use of the &%exists%& condition or the &%stat%& expansion item.
21978
21979 .option forbid_filter_logwrite redirect boolean false
21980 .cindex "restricting access to features"
21981 .cindex "filter" "locking out certain features"
21982 If this option is true, use of the logging facility in Exim filters is not
21983 permitted. Logging is in any case available only if the filter is being run
21984 under some unprivileged uid (which is normally the case for ordinary users'
21985 &_.forward_& files).
21986
21987
21988 .option forbid_filter_lookup redirect boolean false
21989 .cindex "restricting access to features"
21990 .cindex "filter" "locking out certain features"
21991 If this option is true, string expansions in Exim filter files are not allowed
21992 to make use of &%lookup%& items.
21993
21994
21995 .option forbid_filter_perl redirect boolean false
21996 .cindex "restricting access to features"
21997 .cindex "filter" "locking out certain features"
21998 This option has an effect only if Exim is built with embedded Perl support. If
21999 it is true, string expansions in Exim filter files are not allowed to make use
22000 of the embedded Perl support.
22001
22002
22003 .option forbid_filter_readfile redirect boolean false
22004 .cindex "restricting access to features"
22005 .cindex "filter" "locking out certain features"
22006 If this option is true, string expansions in Exim filter files are not allowed
22007 to make use of &%readfile%& items.
22008
22009
22010 .option forbid_filter_readsocket redirect boolean false
22011 .cindex "restricting access to features"
22012 .cindex "filter" "locking out certain features"
22013 If this option is true, string expansions in Exim filter files are not allowed
22014 to make use of &%readsocket%& items.
22015
22016
22017 .option forbid_filter_reply redirect boolean false
22018 .cindex "restricting access to features"
22019 .cindex "filter" "locking out certain features"
22020 If this option is true, this router may not generate an automatic reply
22021 message. Automatic replies can be generated only from Exim or Sieve filter
22022 files, not from traditional forward files. This option is forced to be true if
22023 &%one_time%& is set.
22024
22025
22026 .option forbid_filter_run redirect boolean false
22027 .cindex "restricting access to features"
22028 .cindex "filter" "locking out certain features"
22029 If this option is true, string expansions in Exim filter files are not allowed
22030 to make use of &%run%& items.
22031
22032
22033 .option forbid_include redirect boolean false
22034 .cindex "restricting access to features"
22035 .cindex "filter" "locking out certain features"
22036 If this option is true, items of the form
22037 .code
22038 :include:<path name>
22039 .endd
22040 are not permitted in non-filter redirection lists.
22041
22042
22043 .option forbid_pipe redirect boolean false
22044 .cindex "restricting access to features"
22045 .cindex "filter" "locking out certain features"
22046 .cindex "delivery" "to pipe; forbidding"
22047 If this option is true, this router may not generate a new address which
22048 specifies delivery to a pipe, either from an Exim filter or from a conventional
22049 forward file. This option is forced to be true if &%one_time%& is set.
22050
22051
22052 .option forbid_sieve_filter redirect boolean false
22053 .cindex "restricting access to features"
22054 .cindex "filter" "locking out certain features"
22055 If this option is set true, only Exim filters are permitted when
22056 &%allow_filter%& is true.
22057
22058
22059 .cindex "SMTP" "error codes"
22060 .option forbid_smtp_code redirect boolean false
22061 If this option is set true, any SMTP error codes that are present at the start
22062 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
22063 the default codes (451 and 550, respectively) are always used.
22064
22065
22066
22067
22068 .option hide_child_in_errmsg redirect boolean false
22069 .cindex "bounce message" "redirection details; suppressing"
22070 If this option is true, it prevents Exim from quoting a child address if it
22071 generates a bounce or delay message for it. Instead it says &"an address
22072 generated from <&'the top level address'&>"&. Of course, this applies only to
22073 bounces generated locally. If a message is forwarded to another host, &'its'&
22074 bounce may well quote the generated address.
22075
22076
22077 .option ignore_eacces redirect boolean false
22078 .cindex "EACCES"
22079 If this option is set and an attempt to open a redirection file yields the
22080 EACCES error (permission denied), the &(redirect)& router behaves as if the
22081 file did not exist.
22082
22083
22084 .option ignore_enotdir redirect boolean false
22085 .cindex "ENOTDIR"
22086 If this option is set and an attempt to open a redirection file yields the
22087 ENOTDIR error (something on the path is not a directory), the &(redirect)&
22088 router behaves as if the file did not exist.
22089
22090 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
22091 router that has the &%file%& option set discovers that the file does not exist
22092 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
22093 against unmounted NFS directories. If the parent can not be statted, delivery
22094 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
22095 is set, because that option tells Exim to ignore &"something on the path is not
22096 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
22097 that some operating systems give ENOENT where others give ENOTDIR.
22098
22099
22100
22101 .option include_directory redirect string unset
22102 If this option is set, the path names of any &':include:'& items in a
22103 redirection list must start with this directory.
22104
22105
22106 .option modemask redirect "octal integer" 022
22107 This specifies mode bits which must not be set for a file specified by the
22108 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22109
22110
22111 .option one_time redirect boolean false
22112 .cindex "one-time aliasing/forwarding expansion"
22113 .cindex "alias file" "one-time expansion"
22114 .cindex "forward file" "one-time expansion"
22115 .cindex "mailing lists" "one-time expansion"
22116 .cindex "address redirection" "one-time expansion"
22117 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22118 files each time it tries to deliver a message causes a problem when one or more
22119 of the generated addresses fails be delivered at the first attempt. The problem
22120 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22121 but of what happens when the redirection list changes during the time that the
22122 message is on Exim's queue. This is particularly true in the case of mailing
22123 lists, where new subscribers might receive copies of messages that were posted
22124 before they subscribed.
22125
22126 If &%one_time%& is set and any addresses generated by the router fail to
22127 deliver at the first attempt, the failing addresses are added to the message as
22128 &"top level"& addresses, and the parent address that generated them is marked
22129 &"delivered"&. Thus, redirection does not happen again at the next delivery
22130 attempt.
22131
22132 &*Warning 1*&: Any header line addition or removal that is specified by this
22133 router would be lost if delivery did not succeed at the first attempt. For this
22134 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22135 permitted when &%one_time%& is set.
22136
22137 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22138 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22139 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22140
22141 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22142 &%one_time%&.
22143
22144 The original top-level address is remembered with each of the generated
22145 addresses, and is output in any log messages. However, any intermediate parent
22146 addresses are not recorded. This makes a difference to the log only if
22147 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22148 typically be used for mailing lists, where there is normally just one level of
22149 expansion.
22150
22151
22152 .option owners redirect "string list" unset
22153 .cindex "ownership" "alias file"
22154 .cindex "ownership" "forward file"
22155 .cindex "alias file" "ownership"
22156 .cindex "forward file" "ownership"
22157 This specifies a list of permitted owners for the file specified by &%file%&.
22158 This list is in addition to the local user when &%check_local_user%& is set.
22159 See &%check_owner%& above.
22160
22161
22162 .option owngroups redirect "string list" unset
22163 This specifies a list of permitted groups for the file specified by &%file%&.
22164 The list is in addition to the local user's primary group when
22165 &%check_local_user%& is set. See &%check_group%& above.
22166
22167
22168 .option pipe_transport redirect string&!! unset
22169 .vindex "&$address_pipe$&"
22170 A &(redirect)& router sets up a direct delivery to a pipe when a string
22171 starting with a vertical bar character is specified as a new &"address"&. The
22172 transport used is specified by this option, which, after expansion, must be the
22173 name of a configured transport. This should normally be a &(pipe)& transport.
22174 When the transport is run, the pipe command is in &$address_pipe$&.
22175
22176
22177 .option qualify_domain redirect string&!! unset
22178 .vindex "&$qualify_recipient$&"
22179 If this option is set, and an unqualified address (one without a domain) is
22180 generated, and that address would normally be qualified by the global setting
22181 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22182 expanding this string. If the expansion fails, the router declines. If you want
22183 to revert to the default, you can have the expansion generate
22184 &$qualify_recipient$&.
22185
22186 This option applies to all unqualified addresses generated by Exim filters,
22187 but for traditional &_.forward_& files, it applies only to addresses that are
22188 not preceded by a backslash. Sieve filters cannot generate unqualified
22189 addresses.
22190
22191 .option qualify_preserve_domain redirect boolean false
22192 .cindex "domain" "in redirection; preserving"
22193 .cindex "preserving domain in redirection"
22194 .cindex "address redirection" "domain; preserving"
22195 If this option is set, the router's local &%qualify_domain%& option must not be
22196 set (a configuration error occurs if it is). If an unqualified address (one
22197 without a domain) is generated, it is qualified with the domain of the parent
22198 address (the immediately preceding ancestor) instead of the global
22199 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22200 this applies whether or not the address is preceded by a backslash.
22201
22202
22203 .option repeat_use redirect boolean true
22204 If this option is set false, the router is skipped for a child address that has
22205 any ancestor that was routed by this router. This test happens before any of
22206 the other preconditions are tested. Exim's default anti-looping rules skip
22207 only when the ancestor is the same as the current address. See also
22208 &%check_ancestor%& above and the generic &%redirect_router%& option.
22209
22210
22211 .option reply_transport redirect string&!! unset
22212 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22213 &%vacation%& command is used in a filter file. The transport used is specified
22214 by this option, which, after expansion, must be the name of a configured
22215 transport. This should normally be an &(autoreply)& transport. Other transports
22216 are unlikely to do anything sensible or useful.
22217
22218
22219 .option rewrite redirect boolean true
22220 .cindex "address redirection" "disabling rewriting"
22221 If this option is set false, addresses generated by the router are not
22222 subject to address rewriting. Otherwise, they are treated like new addresses
22223 and are rewritten according to the global rewriting rules.
22224
22225
22226 .option sieve_subaddress redirect string&!! unset
22227 The value of this option is passed to a Sieve filter to specify the
22228 :subaddress part of an address.
22229
22230 .option sieve_useraddress redirect string&!! unset
22231 The value of this option is passed to a Sieve filter to specify the :user part
22232 of an address. However, if it is unset, the entire original local part
22233 (including any prefix or suffix) is used for :user.
22234
22235
22236 .option sieve_vacation_directory redirect string&!! unset
22237 .cindex "Sieve filter" "vacation directory"
22238 To enable the &"vacation"& extension for Sieve filters, you must set
22239 &%sieve_vacation_directory%& to the directory where vacation databases are held
22240 (do not put anything else in that directory), and ensure that the
22241 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22242 needs their own directory; Exim will create it if necessary.
22243
22244
22245
22246 .option skip_syntax_errors redirect boolean false
22247 .cindex "forward file" "broken"
22248 .cindex "address redirection" "broken files"
22249 .cindex "alias file" "broken"
22250 .cindex "broken alias or forward files"
22251 .cindex "ignoring faulty addresses"
22252 .cindex "skipping faulty addresses"
22253 .cindex "error" "skipping bad syntax"
22254 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22255 non-filter redirection data are skipped, and each failing address is logged. If
22256 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22257 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22258 are expanded and placed at the head of the error message generated by
22259 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22260 be the same address as the generic &%errors_to%& option. The
22261 &%skip_syntax_errors%& option is often used when handling mailing lists.
22262
22263 If all the addresses in a redirection list are skipped because of syntax
22264 errors, the router declines to handle the original address, and it is passed to
22265 the following routers.
22266
22267 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22268 error in the filter causes filtering to be abandoned without any action being
22269 taken. The incident is logged, and the router declines to handle the address,
22270 so it is passed to the following routers.
22271
22272 .cindex "Sieve filter" "syntax errors in"
22273 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22274 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22275 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22276
22277 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22278 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22279 option, used with an address that does not get redirected, can be used to
22280 notify users of these errors, by means of a router like this:
22281 .code
22282 userforward:
22283   driver = redirect
22284   allow_filter
22285   check_local_user
22286   file = $home/.forward
22287   file_transport = address_file
22288   pipe_transport = address_pipe
22289   reply_transport = address_reply
22290   no_verify
22291   skip_syntax_errors
22292   syntax_errors_to = real-$local_part@$domain
22293   syntax_errors_text = \
22294    This is an automatically generated message. An error has\n\
22295    been found in your .forward file. Details of the error are\n\
22296    reported below. While this error persists, you will receive\n\
22297    a copy of this message for every message that is addressed\n\
22298    to you. If your .forward file is a filter file, or if it is\n\
22299    a non-filter file containing no valid forwarding addresses,\n\
22300    a copy of each incoming message will be put in your normal\n\
22301    mailbox. If a non-filter file contains at least one valid\n\
22302    forwarding address, forwarding to the valid addresses will\n\
22303    happen, and those will be the only deliveries that occur.
22304 .endd
22305 You also need a router to ensure that local addresses that are prefixed by
22306 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22307 put this immediately before the &(userforward)& router:
22308 .code
22309 real_localuser:
22310   driver = accept
22311   check_local_user
22312   local_part_prefix = real-
22313   transport = local_delivery
22314 .endd
22315 For security, it would probably be a good idea to restrict the use of this
22316 router to locally-generated messages, using a condition such as this:
22317 .code
22318   condition = ${if match {$sender_host_address}\
22319                          {\N^(|127\.0\.0\.1)$\N}}
22320 .endd
22321
22322
22323 .option syntax_errors_text redirect string&!! unset
22324 See &%skip_syntax_errors%& above.
22325
22326
22327 .option syntax_errors_to redirect string unset
22328 See &%skip_syntax_errors%& above.
22329 .ecindex IIDredrou1
22330 .ecindex IIDredrou2
22331
22332
22333
22334
22335
22336
22337 . ////////////////////////////////////////////////////////////////////////////
22338 . ////////////////////////////////////////////////////////////////////////////
22339
22340 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22341          "Environment for local transports"
22342 .scindex IIDenvlotra1 "local transports" "environment for"
22343 .scindex IIDenvlotra2 "environment" "local transports"
22344 .scindex IIDenvlotra3 "transport" "local; environment for"
22345 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22346 transport can be thought of as similar to a pipe.) Exim always runs transports
22347 in subprocesses, under specified uids and gids. Typical deliveries to local
22348 mailboxes run under the uid and gid of the local user.
22349
22350 Exim also sets a specific current directory while running the transport; for
22351 some transports a home directory setting is also relevant. The &(pipe)&
22352 transport is the only one that sets up environment variables; see section
22353 &<<SECTpipeenv>>& for details.
22354
22355 The values used for the uid, gid, and the directories may come from several
22356 different places. In many cases, the router that handles the address associates
22357 settings with that address as a result of its &%check_local_user%&, &%group%&,
22358 or &%user%& options. However, values may also be given in the transport's own
22359 configuration, and these override anything that comes from the router.
22360
22361
22362
22363 .section "Concurrent deliveries" "SECID131"
22364 .cindex "concurrent deliveries"
22365 .cindex "simultaneous deliveries"
22366 If two different messages for the same local recipient arrive more or less
22367 simultaneously, the two delivery processes are likely to run concurrently. When
22368 the &(appendfile)& transport is used to write to a file, Exim applies locking
22369 rules to stop concurrent processes from writing to the same file at the same
22370 time.
22371
22372 However, when you use a &(pipe)& transport, it is up to you to arrange any
22373 locking that is needed. Here is a silly example:
22374 .code
22375 my_transport:
22376   driver = pipe
22377   command = /bin/sh -c 'cat >>/some/file'
22378 .endd
22379 This is supposed to write the message at the end of the file. However, if two
22380 messages arrive at the same time, the file will be scrambled. You can use the
22381 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22382 file using the same algorithm that Exim itself uses.
22383
22384
22385
22386
22387 .section "Uids and gids" "SECTenvuidgid"
22388 .cindex "local transports" "uid and gid"
22389 .cindex "transport" "local; uid and gid"
22390 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22391 overrides any group that the router set in the address, even if &%user%& is not
22392 set for the transport. This makes it possible, for example, to run local mail
22393 delivery under the uid of the recipient (set by the router), but in a special
22394 group (set by the transport). For example:
22395 .code
22396 # Routers ...
22397 # User/group are set by check_local_user in this router
22398 local_users:
22399   driver = accept
22400   check_local_user
22401   transport = group_delivery
22402
22403 # Transports ...
22404 # This transport overrides the group
22405 group_delivery:
22406   driver = appendfile
22407   file = /var/spool/mail/$local_part_data
22408   group = mail
22409 .endd
22410 If &%user%& is set for a transport, its value overrides what is set in the
22411 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22412 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22413 set.
22414
22415 .oindex "&%initgroups%&"
22416 When the uid is taken from the transport's configuration, the &[initgroups()]&
22417 function is called for the groups associated with that uid if the
22418 &%initgroups%& option is set for the transport. When the uid is not specified
22419 by the transport, but is associated with the address by a router, the option
22420 for calling &[initgroups()]& is taken from the router configuration.
22421
22422 .cindex "&(pipe)& transport" "uid for"
22423 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22424 is set and &%user%& is not set, the uid of the process that called Exim to
22425 receive the message is used, and if &%group%& is not set, the corresponding
22426 original gid is also used.
22427
22428 This is the detailed preference order for obtaining a gid; the first of the
22429 following that is set is used:
22430
22431 .ilist
22432 A &%group%& setting of the transport;
22433 .next
22434 A &%group%& setting of the router;
22435 .next
22436 A gid associated with a user setting of the router, either as a result of
22437 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22438 .next
22439 The group associated with a non-numeric &%user%& setting of the transport;
22440 .next
22441 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22442 the uid is the creator's uid;
22443 .next
22444 The Exim gid if the Exim uid is being used as a default.
22445 .endlist
22446
22447 If, for example, the user is specified numerically on the router and there are
22448 no group settings, no gid is available. In this situation, an error occurs.
22449 This is different for the uid, for which there always is an ultimate default.
22450 The first of the following that is set is used:
22451
22452 .ilist
22453 A &%user%& setting of the transport;
22454 .next
22455 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22456 .next
22457 A &%user%& setting of the router;
22458 .next
22459 A &%check_local_user%& setting of the router;
22460 .next
22461 The Exim uid.
22462 .endlist
22463
22464 Of course, an error will still occur if the uid that is chosen is on the
22465 &%never_users%& list.
22466
22467
22468
22469
22470
22471 .section "Current and home directories" "SECID132"
22472 .cindex "current directory for local transport"
22473 .cindex "home directory" "for local transport"
22474 .cindex "transport" "local; home directory for"
22475 .cindex "transport" "local; current directory for"
22476 Routers may set current and home directories for local transports by means of
22477 the &%transport_current_directory%& and &%transport_home_directory%& options.
22478 However, if the transport's &%current_directory%& or &%home_directory%& options
22479 are set, they override the router's values. In detail, the home directory
22480 for a local transport is taken from the first of these values that is set:
22481
22482 .ilist
22483 The &%home_directory%& option on the transport;
22484 .next
22485 The &%transport_home_directory%& option on the router;
22486 .next
22487 The password data if &%check_local_user%& is set on the router;
22488 .next
22489 The &%router_home_directory%& option on the router.
22490 .endlist
22491
22492 The current directory is taken from the first of these values that is set:
22493
22494 .ilist
22495 The &%current_directory%& option on the transport;
22496 .next
22497 The &%transport_current_directory%& option on the router.
22498 .endlist
22499
22500
22501 If neither the router nor the transport sets a current directory, Exim uses the
22502 value of the home directory, if it is set. Otherwise it sets the current
22503 directory to &_/_& before running a local transport.
22504
22505
22506
22507 .section "Expansion variables derived from the address" "SECID133"
22508 .vindex "&$domain$&"
22509 .vindex "&$local_part$&"
22510 .vindex "&$original_domain$&"
22511 Normally a local delivery is handling a single address, and in that case the
22512 variables such as &$domain$& and &$local_part$& are set during local
22513 deliveries. However, in some circumstances more than one address may be handled
22514 at once (for example, while writing batch SMTP for onward transmission by some
22515 other means). In this case, the variables associated with the local part are
22516 never set, &$domain$& is set only if all the addresses have the same domain,
22517 and &$original_domain$& is never set.
22518 .ecindex IIDenvlotra1
22519 .ecindex IIDenvlotra2
22520 .ecindex IIDenvlotra3
22521
22522
22523
22524
22525
22526
22527
22528 . ////////////////////////////////////////////////////////////////////////////
22529 . ////////////////////////////////////////////////////////////////////////////
22530
22531 .chapter "Generic options for transports" "CHAPtransportgeneric"
22532 .scindex IIDgenoptra1 "generic options" "transport"
22533 .scindex IIDgenoptra2 "options" "generic; for transports"
22534 .scindex IIDgenoptra3 "transport" "generic options for"
22535 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22536 prior to Exim 4.95 names would be silently truncated at this length, but now
22537 it is enforced.
22538
22539 The following generic options apply to all transports:
22540
22541
22542 .option body_only transports boolean false
22543 .cindex "transport" "body only"
22544 .cindex "message" "transporting body only"
22545 .cindex "body of message" "transporting"
22546 If this option is set, the message's headers are not transported. It is
22547 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22548 or &(pipe)& transports, the settings of &%message_prefix%& and
22549 &%message_suffix%& should be checked, because this option does not
22550 automatically suppress them.
22551
22552
22553 .option current_directory transports string&!! unset
22554 .cindex "transport" "current directory for"
22555 This specifies the current directory that is to be set while running the
22556 transport, overriding any value that may have been set by the router.
22557 If the expansion fails for any reason, including forced failure, an error is
22558 logged, and delivery is deferred.
22559
22560
22561 .option disable_logging transports boolean false
22562 If this option is set true, nothing is logged for any
22563 deliveries by the transport or for any
22564 transport errors. You should not set this option unless you really, really know
22565 what you are doing.
22566
22567
22568 .option debug_print transports string&!! unset
22569 .cindex "testing" "variables in drivers"
22570 If this option is set and debugging is enabled (see the &%-d%& command line
22571 option), the string is expanded and included in the debugging output when the
22572 transport is run.
22573 If expansion of the string fails, the error message is written to the debugging
22574 output, and Exim carries on processing.
22575 This facility is provided to help with checking out the values of variables and
22576 so on when debugging driver configurations. For example, if a &%headers_add%&
22577 option is not working properly, &%debug_print%& could be used to output the
22578 variables it references. A newline is added to the text if it does not end with
22579 one.
22580 The variables &$transport_name$& and &$router_name$& contain the name of the
22581 transport and the router that called it.
22582
22583 .option delivery_date_add transports boolean false
22584 .cindex "&'Delivery-date:'& header line"
22585 If this option is true, a &'Delivery-date:'& header is added to the message.
22586 This gives the actual time the delivery was made. As this is not a standard
22587 header, Exim has a configuration option (&%delivery_date_remove%&) which
22588 requests its removal from incoming messages, so that delivered messages can
22589 safely be resent to other recipients.
22590
22591
22592 .option driver transports string unset
22593 This specifies which of the available transport drivers is to be used.
22594 There is no default, and this option must be set for every transport.
22595
22596
22597 .option envelope_to_add transports boolean false
22598 .cindex "&'Envelope-to:'& header line"
22599 If this option is true, an &'Envelope-to:'& header is added to the message.
22600 This gives the original address(es) in the incoming envelope that caused this
22601 delivery to happen. More than one address may be present if the transport is
22602 configured to handle several addresses at once, or if more than one original
22603 address was redirected to the same final address. As this is not a standard
22604 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22605 its removal from incoming messages, so that delivered messages can safely be
22606 resent to other recipients.
22607
22608 &*Note:*& If used on a transport handling multiple recipients
22609 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22610 transport if &%batch_max%& is greater than 1)
22611 then information about Bcc recipients will be leaked.
22612 Doing so is generally not advised.
22613
22614
22615 .option event_action transports string&!! unset
22616 .cindex events
22617 This option declares a string to be expanded for Exim's events mechanism.
22618 For details see chapter &<<CHAPevents>>&.
22619
22620
22621 .option group transports string&!! "Exim group"
22622 .cindex "transport" "group; specifying"
22623 This option specifies a gid for running the transport process, overriding any
22624 value that the router supplies, and also overriding any value associated with
22625 &%user%& (see below).
22626
22627
22628 .option headers_add transports list&!! unset
22629 .cindex "header lines" "adding in transport"
22630 .cindex "transport" "header lines; adding"
22631 This option specifies a list of text headers,
22632 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22633 which are (separately) expanded and added to the header
22634 portion of a message as it is transported, as described in section
22635 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22636 routers. If the result of the expansion is an empty string, or if the expansion
22637 is forced to fail, no action is taken. Other expansion failures are treated as
22638 errors and cause the delivery to be deferred.
22639
22640 Unlike most options, &%headers_add%& can be specified multiple times
22641 for a transport; all listed headers are added.
22642
22643
22644 .option headers_only transports boolean false
22645 .cindex "transport" "header lines only"
22646 .cindex "message" "transporting headers only"
22647 .cindex "header lines" "transporting"
22648 If this option is set, the message's body is not transported. It is mutually
22649 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22650 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22651 checked, since this option does not automatically suppress them.
22652
22653
22654 .option headers_remove transports list&!! unset
22655 .cindex "header lines" "removing"
22656 .cindex "transport" "header lines; removing"
22657 This option specifies a list of text headers,
22658 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22659 to be removed from the message.
22660 However, the option has no effect when an address is just being verified.
22661 Each list item is separately expanded.
22662 If the result of the expansion is an empty string, or if the expansion
22663 is forced to fail, no action is taken. Other expansion failures are treated as
22664 errors and cause the delivery to be deferred.
22665 If an item ends in *, it will match any header with the given prefix.
22666
22667 Matching headers are omitted from the message as it is transported, as described
22668 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22669 routers.
22670
22671 Unlike most options, &%headers_remove%& can be specified multiple times
22672 for a transport; all listed headers are removed.
22673
22674 &*Warning*&: Because of the separate expansion of the list items,
22675 items that contain a list separator must have it doubled.
22676 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22677
22678
22679
22680 .option headers_rewrite transports string unset
22681 .cindex "transport" "header lines; rewriting"
22682 .cindex "rewriting" "at transport time"
22683 This option allows addresses in header lines to be rewritten at transport time,
22684 that is, as the message is being copied to its destination. The contents of the
22685 option are a colon-separated list of rewriting rules. Each rule is in exactly
22686 the same form as one of the general rewriting rules that are applied when a
22687 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22688 example,
22689 .code
22690 headers_rewrite = a@b c@d f : \
22691                   x@y w@z
22692 .endd
22693 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22694 &'w@z'& in all address-bearing header lines. The rules are applied to the
22695 header lines just before they are written out at transport time, so they affect
22696 only those copies of the message that pass through the transport. However, only
22697 the message's original header lines, and any that were added by a system
22698 filter, are rewritten. If a router or transport adds header lines, they are not
22699 affected by this option. These rewriting rules are &'not'& applied to the
22700 envelope. You can change the return path using &%return_path%&, but you cannot
22701 change envelope recipients at this time.
22702
22703
22704 .option home_directory transports string&!! unset
22705 .cindex "transport" "home directory for"
22706 .vindex "&$home$&"
22707 This option specifies a home directory setting for a local transport,
22708 overriding any value that may be set by the router. The home directory is
22709 placed in &$home$& while expanding the transport's private options. It is also
22710 used as the current directory if no current directory is set by the
22711 &%current_directory%& option on the transport or the
22712 &%transport_current_directory%& option on the router. If the expansion fails
22713 for any reason, including forced failure, an error is logged, and delivery is
22714 deferred.
22715
22716
22717 .option initgroups transports boolean false
22718 .cindex "additional groups"
22719 .cindex "groups" "additional"
22720 .cindex "transport" "group; additional"
22721 If this option is true and the uid for the delivery process is provided by the
22722 transport, the &[initgroups()]& function is called when running the transport
22723 to ensure that any additional groups associated with the uid are set up.
22724
22725
22726 .option max_parallel transports integer&!! unset
22727 .cindex limit "transport parallelism"
22728 .cindex transport "parallel processes"
22729 .cindex transport "concurrency limit"
22730 .cindex "delivery" "parallelism for transport"
22731 If this option is set and expands to an integer greater than zero
22732 it limits the number of concurrent runs of the transport.
22733 The control does not apply to shadow transports.
22734
22735 .cindex "hints database" "transport concurrency control"
22736 Exim implements this control by means of a hints database in which a record is
22737 incremented whenever a transport process is being created. The record
22738 is decremented and possibly removed when the process terminates.
22739 Obviously there is scope for
22740 records to get left lying around if there is a system or program crash. To
22741 guard against this, Exim ignores any records that are more than six hours old.
22742
22743 If you use this option, you should also arrange to delete the
22744 relevant hints database whenever your system reboots. The names of the files
22745 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22746 may be one or two files, depending on the type of DBM in use. The same files
22747 are used for ETRN and smtp transport serialization.
22748
22749
22750 .option message_size_limit transports string&!! 0
22751 .cindex "limit" "message size per transport"
22752 .cindex "size" "of message, limit"
22753 .cindex "transport" "message size; limiting"
22754 This option controls the size of messages passed through the transport. It is
22755 expanded before use; the result of the expansion must be a sequence of decimal
22756 digits, optionally followed by K or M. If the expansion fails for any reason,
22757 including forced failure, or if the result is not of the required form,
22758 delivery is deferred. If the value is greater than zero and the size of a
22759 message exceeds this limit, the address is failed. If there is any chance that
22760 the resulting bounce message could be routed to the same transport, you should
22761 ensure that &%return_size_limit%& is less than the transport's
22762 &%message_size_limit%&, as otherwise the bounce message will fail to get
22763 delivered.
22764
22765
22766
22767 .option rcpt_include_affixes transports boolean false
22768 .cindex "prefix" "for local part, including in envelope"
22769 .cindex "suffix for local part" "including in envelope"
22770 .cindex "local part" "prefix"
22771 .cindex "local part" "suffix"
22772 When this option is false (the default), and an address that has had any
22773 affixes (prefixes or suffixes) removed from the local part is delivered by any
22774 form of SMTP or LMTP, the affixes are not included. For example, if a router
22775 that contains
22776 .code
22777 local_part_prefix = *-
22778 .endd
22779 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22780 is delivered with
22781 .code
22782 RCPT TO:<xyz@some.domain>
22783 .endd
22784 This is also the case when an ACL-time callout is being used to verify a
22785 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22786 whole local part is included in the RCPT command. This option applies to BSMTP
22787 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22788 &(lmtp)& and &(smtp)& transports.
22789
22790
22791 .option retry_use_local_part transports boolean "see below"
22792 .cindex "hints database" "retry keys"
22793 When a delivery suffers a temporary failure, a retry record is created
22794 in Exim's hints database. For remote deliveries, the key for the retry record
22795 is based on the name and/or IP address of the failing remote host. For local
22796 deliveries, the key is normally the entire address, including both the local
22797 part and the domain. This is suitable for most common cases of local delivery
22798 temporary failure &-- for example, exceeding a mailbox quota should delay only
22799 deliveries to that mailbox, not to the whole domain.
22800
22801 However, in some special cases you may want to treat a temporary local delivery
22802 as a failure associated with the domain, and not with a particular local part.
22803 (For example, if you are storing all mail for some domain in files.) You can do
22804 this by setting &%retry_use_local_part%& false.
22805
22806 For all the local transports, its default value is true. For remote transports,
22807 the default value is false for tidiness, but changing the value has no effect
22808 on a remote transport in the current implementation.
22809
22810
22811 .option return_path transports string&!! unset
22812 .cindex "envelope sender"
22813 .cindex "envelope from"
22814 .cindex "transport" "return path; changing"
22815 .cindex "return path" "changing in transport"
22816 If this option is set, the string is expanded at transport time and replaces
22817 the existing return path (envelope sender) value in the copy of the message
22818 that is being delivered. An empty return path is permitted. This feature is
22819 designed for remote deliveries, where the value of this option is used in the
22820 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22821 only effect is to change the address that is placed in the &'Return-path:'&
22822 header line, if one is added to the message (see the next option).
22823
22824 &*Note:*& A changed return path is not logged unless you add
22825 &%return_path_on_delivery%& to the log selector.
22826
22827 .vindex "&$return_path$&"
22828 The expansion can refer to the existing value via &$return_path$&. This is
22829 either the message's envelope sender, or an address set by the
22830 &%errors_to%& option on a router. If the expansion is forced to fail, no
22831 replacement occurs; if it fails for another reason, delivery is deferred. This
22832 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22833 section &<<SECTverp>>&.
22834
22835 &*Note*&: If a delivery error is detected locally, including the case when a
22836 remote server rejects a message at SMTP time, the bounce message is not sent to
22837 the value of this option. It is sent to the previously set errors address.
22838 This defaults to the incoming sender address, but can be changed by setting
22839 &%errors_to%& in a router.
22840
22841
22842
22843 .option return_path_add transports boolean false
22844 .chindex Return-path:
22845 If this option is true, a &'Return-path:'& header is added to the message.
22846 Although the return path is normally available in the prefix line of BSD
22847 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22848 have easy access to it.
22849
22850 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22851 the delivery SMTP server makes the final delivery"&. This implies that this
22852 header should not be present in incoming messages. Exim has a configuration
22853 option, &%return_path_remove%&, which requests removal of this header from
22854 incoming messages, so that delivered messages can safely be resent to other
22855 recipients.
22856
22857
22858 .option shadow_condition transports string&!! unset
22859 See &%shadow_transport%& below.
22860
22861
22862 .option shadow_transport transports string unset
22863 .cindex "shadow transport"
22864 .cindex "transport" "shadow"
22865 A local transport may set the &%shadow_transport%& option to the name of
22866 another local transport. Shadow remote transports are not supported.
22867
22868 Whenever a delivery to the main transport succeeds, and either
22869 &%shadow_condition%& is unset, or its expansion does not result in the empty
22870 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22871 passed to the shadow transport, with the same delivery address or addresses. If
22872 expansion fails, no action is taken except that non-forced expansion failures
22873 cause a log line to be written.
22874
22875 The result of the shadow transport is discarded and does not affect the
22876 subsequent processing of the message. Only a single level of shadowing is
22877 provided; the &%shadow_transport%& option is ignored on any transport when it
22878 is running as a shadow. Options concerned with output from pipes are also
22879 ignored. The log line for the successful delivery has an item added on the end,
22880 of the form
22881 .code
22882 ST=<shadow transport name>
22883 .endd
22884 If the shadow transport did not succeed, the error message is put in
22885 parentheses afterwards. Shadow transports can be used for a number of different
22886 purposes, including keeping more detailed log information than Exim normally
22887 provides, and implementing automatic acknowledgment policies based on message
22888 headers that some sites insist on.
22889
22890
22891 .option transport_filter transports string&!! unset
22892 .cindex "transport" "filter"
22893 .cindex "filter" "transport filter"
22894 This option sets up a filtering (in the Unix shell sense) process for messages
22895 at transport time. It should not be confused with mail filtering as set up by
22896 individual users or via a system filter.
22897 If unset, or expanding to an empty string, no filtering is done.
22898
22899 When the message is about to be written out, the command specified by
22900 &%transport_filter%& is started up in a separate, parallel process, and
22901 the entire message, including the header lines, is passed to it on its standard
22902 input (this in fact is done from a third process, to avoid deadlock).
22903 The command must be specified as an absolute path.
22904
22905 The process run by the command must use its standard input as the message
22906 data to be transformed, and write the results on its standard output.
22907
22908 The lines of the message that are written to the transport filter are
22909 terminated by newline (&"\n"&). The message is passed to the filter before any
22910 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22911 lines beginning with a dot, and also before any processing implied by the
22912 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22913 &(pipe)& transports.
22914
22915 The standard error for the filter process is set to the same destination as its
22916 standard output; this is read and written to the message's ultimate
22917 destination. The process that writes the message to the filter, the
22918 filter itself, and the original process that reads the result and delivers it
22919 are all run in parallel, like a shell pipeline.
22920
22921 The filter can perform any transformations it likes, but of course should take
22922 care not to break RFC 2822 syntax. Exim does not check the result, except to
22923 test for a final newline when SMTP is in use. All messages transmitted over
22924 SMTP must end with a newline, so Exim supplies one if it is missing.
22925
22926 .cindex "content scanning" "per user"
22927 A transport filter can be used to provide content-scanning on a per-user basis
22928 at delivery time if the only required effect of the scan is to modify the
22929 message. For example, a content scan could insert a new header line containing
22930 a spam score. This could be interpreted by a filter in the user's MUA. It is
22931 not possible to discard a message at this stage.
22932
22933 .cindex "SIZE" "ESMTP extension"
22934 A problem might arise if the filter increases the size of a message that is
22935 being sent down an SMTP connection. If the receiving SMTP server has indicated
22936 support for the SIZE parameter, Exim will have sent the size of the message
22937 at the start of the SMTP session. If what is actually sent is substantially
22938 more, the server might reject the message. This can be worked round by setting
22939 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22940 additions to the message, or to disable the use of SIZE altogether.
22941
22942 .vindex "&$pipe_addresses$&"
22943 The value of the &%transport_filter%& option is the command string for starting
22944 the filter, which is run directly from Exim, not under a shell. The string is
22945 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22946 Exim breaks it up into arguments and then expands each argument separately (see
22947 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22948 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22949 of arguments, one for each address that applies to this delivery. (This isn't
22950 an ideal name for this feature here, but as it was already implemented for the
22951 &(pipe)& transport, it seemed sensible not to change it.)
22952
22953 .vindex "&$host$&"
22954 .vindex "&$host_address$&"
22955 The expansion variables &$host$& and &$host_address$& are available when the
22956 transport is a remote one. They contain the name and IP address of the host to
22957 which the message is being sent. For example:
22958 . used to have $sender_address in this cmdline, but it's tainted
22959 .code
22960 transport_filter = /some/directory/transport-filter.pl \
22961   $host $host_address $pipe_addresses
22962 .endd
22963
22964 Two problems arise if you want to use more complicated expansion items to
22965 generate transport filter commands, both of which due to the fact that the
22966 command is split up &'before'& expansion.
22967 .ilist
22968 If an expansion item contains white space, you must quote it, so that it is all
22969 part of the same command item. If the entire option setting is one such
22970 expansion item, you have to take care what kind of quoting you use. For
22971 example:
22972 .code
22973 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22974 .endd
22975 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22976 &(/bin/cmd2)& otherwise.
22977
22978 Option strings in general have any fully-surrounding double quote wrapping
22979 removed early in parsing (see &<<SECTstrings>>&).
22980 Then, for this option, quotes protect against whitespace being
22981 regarded as a separator while splitting into the command argument vector.
22982 Either double or single quotes can be used here;
22983 the former interprets backlash-quoted charachters
22984 and the latter does not.
22985
22986 If double quotes had been used in this example, they would have been
22987 stripped by Exim when it read the option's value. When the value is used, if
22988 the single quotes were missing, the line would be split into two items,
22989 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22990 Exim tried to expand the first one.
22991 .next
22992 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22993 expansion cannot generate multiple arguments, or a command name followed by
22994 arguments. Consider this example:
22995 .code
22996 transport_filter = ${lookup{$host}lsearch{/a/file}\
22997                     {$value}{/bin/cat}}
22998 .endd
22999 The result of the lookup is interpreted as the name of the command, even
23000 if it contains white space. The simplest way round this is to use a shell:
23001 .code
23002 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
23003                                {$value}{/bin/cat}}
23004 .endd
23005 .endlist
23006
23007 The filter process is run under the same uid and gid as the normal delivery.
23008 For remote deliveries this is the Exim uid/gid by default. The command should
23009 normally yield a zero return code. Transport filters are not supposed to fail.
23010 A non-zero code is taken to mean that the transport filter encountered some
23011 serious problem. Delivery of the message is deferred; the message remains on
23012 the queue and is tried again later. It is not possible to cause a message to be
23013 bounced from a transport filter.
23014
23015 If a transport filter is set on an autoreply transport, the original message is
23016 passed through the filter as it is being copied into the newly generated
23017 message, which happens if the &%return_message%& option is set.
23018
23019
23020 .option transport_filter_timeout transports time 5m
23021 .cindex "transport" "filter, timeout"
23022 When Exim is reading the output of a transport filter, it applies a timeout
23023 that can be set by this option. Exceeding the timeout is normally treated as a
23024 temporary delivery failure. However, if a transport filter is used with a
23025 &(pipe)& transport, a timeout in the transport filter is treated in the same
23026 way as a timeout in the pipe command itself. By default, a timeout is a hard
23027 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
23028 becomes a temporary error.
23029
23030
23031 .option user transports string&!! "Exim user"
23032 .cindex "uid (user id)" "local delivery"
23033 .cindex "transport" "user, specifying"
23034 This option specifies the user under whose uid the delivery process is to be
23035 run, overriding any uid that may have been set by the router. If the user is
23036 given as a name, the uid is looked up from the password data, and the
23037 associated group is taken as the value of the gid to be used if the &%group%&
23038 option is not set.
23039
23040 For deliveries that use local transports, a user and group are normally
23041 specified explicitly or implicitly (for example, as a result of
23042 &%check_local_user%&) by the router or transport.
23043
23044 .cindex "hints database" "access by remote transport"
23045 For remote transports, you should leave this option unset unless you really are
23046 sure you know what you are doing. When a remote transport is running, it needs
23047 to be able to access Exim's hints databases, because each host may have its own
23048 retry data.
23049 .ecindex IIDgenoptra1
23050 .ecindex IIDgenoptra2
23051 .ecindex IIDgenoptra3
23052
23053
23054
23055
23056
23057
23058 . ////////////////////////////////////////////////////////////////////////////
23059 . ////////////////////////////////////////////////////////////////////////////
23060
23061 .chapter "Address batching in local transports" "CHAPbatching" &&&
23062          "Address batching"
23063 .cindex "transport" "local; address batching in"
23064 The only remote transport (&(smtp)&) is normally configured to handle more than
23065 one address at a time, so that when several addresses are routed to the same
23066 remote host, just one copy of the message is sent. Local transports, however,
23067 normally handle one address at a time. That is, a separate instance of the
23068 transport is run for each address that is routed to the transport. A separate
23069 copy of the message is delivered each time.
23070
23071 .cindex "batched local delivery"
23072 .oindex "&%batch_max%&"
23073 .oindex "&%batch_id%&"
23074 In special cases, it may be desirable to handle several addresses at once in a
23075 local transport, for example:
23076
23077 .ilist
23078 In an &(appendfile)& transport, when storing messages in files for later
23079 delivery by some other means, a single copy of the message with multiple
23080 recipients saves space.
23081 .next
23082 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
23083 a single copy saves time, and is the normal way LMTP is expected to work.
23084 .next
23085 In a &(pipe)& transport, when passing the message
23086 to a scanner program or
23087 to some other delivery mechanism such as UUCP, multiple recipients may be
23088 acceptable.
23089 .endlist
23090
23091 These three local transports all have the same options for controlling multiple
23092 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
23093 repeating the information for each transport, these options are described here.
23094
23095 The &%batch_max%& option specifies the maximum number of addresses that can be
23096 delivered together in a single run of the transport. Its default value is one
23097 (no batching). When more than one address is routed to a transport that has a
23098 &%batch_max%& value greater than one, the addresses are delivered in a batch
23099 (that is, in a single run of the transport with multiple recipients), subject
23100 to certain conditions:
23101
23102 .ilist
23103 .vindex "&$local_part$&"
23104 If any of the transport's options contain a reference to &$local_part$&, no
23105 batching is possible.
23106 .next
23107 .vindex "&$domain$&"
23108 If any of the transport's options contain a reference to &$domain$&, only
23109 addresses with the same domain are batched.
23110 .next
23111 .cindex "customizing" "batching condition"
23112 If &%batch_id%& is set, it is expanded for each address, and only those
23113 addresses with the same expanded value are batched. This allows you to specify
23114 customized batching conditions. Failure of the expansion for any reason,
23115 including forced failure, disables batching, but it does not stop the delivery
23116 from taking place.
23117 .next
23118 Batched addresses must also have the same errors address (where to send
23119 delivery errors), the same header additions and removals, the same user and
23120 group for the transport, and if a host list is present, the first host must
23121 be the same.
23122 .endlist
23123
23124 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23125 both when the file or pipe command is specified in the transport, and when it
23126 is specified by a &(redirect)& router, but all the batched addresses must of
23127 course be routed to the same file or pipe command. These two transports have an
23128 option called &%use_bsmtp%&, which causes them to deliver the message in
23129 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23130 &%check_string%& and &%escape_string%& options are forced to the values
23131 .code
23132 check_string = "."
23133 escape_string = ".."
23134 .endd
23135 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23136 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23137 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23138
23139 .cindex "&'Envelope-to:'& header line"
23140 If the generic &%envelope_to_add%& option is set for a batching transport, the
23141 &'Envelope-to:'& header that is added to the message contains all the addresses
23142 that are being processed together. If you are using a batching &(appendfile)&
23143 transport without &%use_bsmtp%&, the only way to preserve the recipient
23144 addresses is to set the &%envelope_to_add%& option.
23145
23146 .cindex "&(pipe)& transport" "with multiple addresses"
23147 .vindex "&$pipe_addresses$&"
23148 If you are using a &(pipe)& transport without BSMTP, and setting the
23149 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23150 the command. This is not a true variable; it is a bit of magic that causes each
23151 of the recipient addresses to be inserted into the command as a separate
23152 argument. This provides a way of accessing all the addresses that are being
23153 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23154 are specified by a &(redirect)& router.
23155
23156
23157
23158
23159 . ////////////////////////////////////////////////////////////////////////////
23160 . ////////////////////////////////////////////////////////////////////////////
23161
23162 .chapter "The appendfile transport" "CHAPappendfile"
23163 .scindex IIDapptra1 "&(appendfile)& transport"
23164 .scindex IIDapptra2 "transports" "&(appendfile)&"
23165 .cindex "directory creation"
23166 .cindex "creating directories"
23167 The &(appendfile)& transport delivers a message by appending it to an existing
23168 file, or by creating an entirely new file in a specified directory. Single
23169 files to which messages are appended can be in the traditional Unix mailbox
23170 format, or optionally in the MBX format supported by the Pine MUA and
23171 University of Washington IMAP daemon, &'inter alia'&. When each message is
23172 being delivered as a separate file, &"maildir"& format can optionally be used
23173 to give added protection against failures that happen part-way through the
23174 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23175 supported. For all file formats, Exim attempts to create as many levels of
23176 directory as necessary, provided that &%create_directory%& is set.
23177
23178 The code for the optional formats is not included in the Exim binary by
23179 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23180 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23181 included.
23182
23183 .cindex "quota" "system"
23184 Exim recognizes system quota errors, and generates an appropriate message. Exim
23185 also supports its own quota control within the transport, for use when the
23186 system facility is unavailable or cannot be used for some reason.
23187
23188 If there is an error while appending to a file (for example, quota exceeded or
23189 partition filled), Exim attempts to reset the file's length and last
23190 modification time back to what they were before. If there is an error while
23191 creating an entirely new file, the new file is removed.
23192
23193 Before appending to a file, a number of security checks are made, and the
23194 file is locked. A detailed description is given below, after the list of
23195 private options.
23196
23197 The &(appendfile)& transport is most commonly used for local deliveries to
23198 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23199 putting messages into files for remote delivery by some means other than Exim.
23200 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23201 option).
23202
23203
23204
23205 .section "The file and directory options" "SECTfildiropt"
23206 The &%file%& option specifies a single file, to which the message is appended;
23207 the &%directory%& option specifies a directory, in which a new file containing
23208 the message is created. Only one of these two options can be set, and for
23209 normal deliveries to mailboxes, one of them &'must'& be set.
23210
23211 .vindex "&$address_file$&"
23212 .vindex "&$local_part$&"
23213 However, &(appendfile)& is also used for delivering messages to files or
23214 directories whose names (or parts of names) are obtained from alias,
23215 forwarding, or filtering operations (for example, a &%save%& command in a
23216 user's Exim filter). When such a transport is running, &$local_part$& contains
23217 the local part that was aliased or forwarded, and &$address_file$& contains the
23218 name (or partial name) of the file or directory generated by the redirection
23219 operation. There are two cases:
23220
23221 .ilist
23222 If neither &%file%& nor &%directory%& is set, the redirection operation
23223 must specify an absolute path (one that begins with &`/`&). This is the most
23224 common case when users with local accounts use filtering to sort mail into
23225 different folders. See for example, the &(address_file)& transport in the
23226 default configuration. If the path ends with a slash, it is assumed to be the
23227 name of a directory. A delivery to a directory can also be forced by setting
23228 &%maildir_format%& or &%mailstore_format%&.
23229 .next
23230 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23231 used to determine the file or directory name for the delivery. Normally, the
23232 contents of &$address_file$& are used in some way in the string expansion.
23233 .endlist
23234 If the &%create_file%& option is set to a path which
23235 matches (see the option definition below for details)
23236 a file or directory name
23237 for the delivery, that name becomes de-tainted.
23238
23239 .cindex "tainted data" "in filenames"
23240 .cindex appendfile "tainted data"
23241 Tainted data may not be used for a file or directory name.
23242 This means that, for instance, &$local_part$& cannot be used directly
23243 as a component of a path.  It can however be used as the key for a lookup
23244 which returns a path (or component).
23245
23246
23247 .cindex "Sieve filter" "configuring &(appendfile)&"
23248 .cindex "Sieve filter" "relative mailbox path handling"
23249 As an example of the second case, consider an environment where users do not
23250 have home directories. They may be permitted to use Exim filter commands of the
23251 form:
23252 .code
23253 save folder23
23254 .endd
23255 or Sieve filter commands of the form:
23256 .code
23257 require "fileinto";
23258 fileinto "folder23";
23259 .endd
23260 In this situation, the expansion of &%file%& or &%directory%& in the transport
23261 must transform the relative path into an appropriate absolute filename. In the
23262 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23263 is used as a result of a &"keep"& action in the filter. This example shows one
23264 way of handling this requirement:
23265 .code
23266 file = ${if eq{$address_file}{inbox} \
23267             {/var/mail/$local_part_data} \
23268             {${if eq{${substr_0_1:$address_file}}{/} \
23269                   {$address_file} \
23270                   {$home/mail/$address_file} \
23271             }} \
23272        }
23273 .endd
23274 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23275 location, absolute paths are used without change, and other folders are in the
23276 &_mail_& directory within the home directory.
23277
23278 &*Note 1*&: While processing an Exim filter, a relative path such as
23279 &_folder23_& is turned into an absolute path if a home directory is known to
23280 the router. In particular, this is the case if &%check_local_user%& is set. If
23281 you want to prevent this happening at routing time, you can set
23282 &%router_home_directory%& empty. This forces the router to pass the relative
23283 path to the transport.
23284
23285 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23286 the &%file%& or &%directory%& option is still used if it is set.
23287
23288
23289
23290
23291 .section "Private options for appendfile" "SECID134"
23292 .cindex "options" "&(appendfile)& transport"
23293
23294
23295
23296 .option allow_fifo appendfile boolean false
23297 .cindex "fifo (named pipe)"
23298 .cindex "named pipe (fifo)"
23299 .cindex "pipe" "named (fifo)"
23300 Setting this option permits delivery to named pipes (FIFOs) as well as to
23301 regular files. If no process is reading the named pipe at delivery time, the
23302 delivery is deferred.
23303
23304
23305 .option allow_symlink appendfile boolean false
23306 .cindex "symbolic link" "to mailbox"
23307 .cindex "mailbox" "symbolic link"
23308 By default, &(appendfile)& will not deliver if the path name for the file is
23309 that of a symbolic link. Setting this option relaxes that constraint, but there
23310 are security issues involved in the use of symbolic links. Be sure you know
23311 what you are doing if you set this. Details of exactly what this option affects
23312 are included in the discussion which follows this list of options.
23313
23314
23315 .option batch_id appendfile string&!! unset
23316 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23317 However, batching is automatically disabled for &(appendfile)& deliveries that
23318 happen as a result of forwarding or aliasing or other redirection directly to a
23319 file.
23320
23321
23322 .option batch_max appendfile integer 1
23323 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23324
23325
23326 .option check_group appendfile boolean false
23327 When this option is set, the group owner of the file defined by the &%file%&
23328 option is checked to see that it is the same as the group under which the
23329 delivery process is running. The default setting is false because the default
23330 file mode is 0600, which means that the group is irrelevant.
23331
23332
23333 .option check_owner appendfile boolean true
23334 When this option is set, the owner of the file defined by the &%file%& option
23335 is checked to ensure that it is the same as the user under which the delivery
23336 process is running.
23337
23338
23339 .option check_string appendfile string "see below"
23340 .cindex "&""From""& line"
23341 As &(appendfile)& writes the message, the start of each line is tested for
23342 matching &%check_string%&, and if it does, the initial matching characters are
23343 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23344 a literal string, not a regular expression, and the case of any letters it
23345 contains is significant.
23346
23347 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23348 are forced to &"."& and &".."& respectively, and any settings in the
23349 configuration are ignored. Otherwise, they default to &"From&~"& and
23350 &">From&~"& when the &%file%& option is set, and unset when any of the
23351 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23352
23353 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23354 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23355 &"From&~"& indicates the start of a new message. All four options need changing
23356 if another format is used. For example, to deliver to mailboxes in MMDF format:
23357 .cindex "MMDF format mailbox"
23358 .cindex "mailbox" "MMDF format"
23359 .code
23360 check_string = "\1\1\1\1\n"
23361 escape_string = "\1\1\1\1 \n"
23362 message_prefix = "\1\1\1\1\n"
23363 message_suffix = "\1\1\1\1\n"
23364 .endd
23365 .option create_directory appendfile boolean true
23366 .cindex "directory creation"
23367 When this option is true, Exim attempts to create any missing superior
23368 directories for the file that it is about to write. A created directory's mode
23369 is given by the &%directory_mode%& option.
23370
23371 The group ownership of a newly created directory is highly dependent on the
23372 operating system (and possibly the file system) that is being used. For
23373 example, in Solaris, if the parent directory has the setgid bit set, its group
23374 is propagated to the child; if not, the currently set group is used. However,
23375 in FreeBSD, the parent's group is always used.
23376
23377
23378
23379 .option create_file appendfile string anywhere
23380 This option constrains the location of files and directories that are created
23381 by this transport. It applies to files defined by the &%file%& option and
23382 directories defined by the &%directory%& option. In the case of maildir
23383 delivery, it applies to the top level directory, not the maildir directories
23384 beneath.
23385
23386 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23387 &"belowhome"&, or to an absolute path.
23388
23389 In the second and third cases, a home directory must have been
23390 set for the transport, and the file or directory being created must
23391 reside within it.
23392 The "belowhome" checking additionally checks for attempts to use "../"
23393 to evade the testing.
23394 This option is not useful when an explicit filename is
23395 given for normal mailbox deliveries. It is intended for the case when filenames
23396 are generated from users' &_.forward_& files. These are usually handled
23397 by an &(appendfile)& transport called &%address_file%&. See also
23398 &%file_must_exist%&.
23399
23400 In the fourth case,
23401 the value given for this option must be an absolute path for an
23402 existing directory.
23403 The value is used for checking instead of a home directory;
23404 checking is done in "belowhome" mode.
23405
23406 .cindex "tainted data" "de-tainting"
23407 .cindex "de-tainting" "using appendfile create_file option"
23408 If "belowhome" checking is used, the file or directory path
23409 becomes de-tainted.
23410
23411
23412 .option directory appendfile string&!! unset
23413 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23414 or &%directory%& must be set, unless the delivery is the direct result of a
23415 redirection (see section &<<SECTfildiropt>>&).
23416
23417 When &%directory%& is set, the string is expanded, and the message is delivered
23418 into a new file or files in or below the given directory, instead of being
23419 appended to a single mailbox file. A number of different formats are provided
23420 (see &%maildir_format%& and &%mailstore_format%&), and see section
23421 &<<SECTopdir>>& for further details of this form of delivery.
23422
23423 The result of expansion must not be tainted, unless the &%create_file%& option
23424 specifies a path.
23425
23426
23427 .option directory_file appendfile string&!! "see below"
23428 .cindex "base62"
23429 .vindex "&$inode$&"
23430 When &%directory%& is set, but neither &%maildir_format%& nor
23431 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23432 whose name is obtained by expanding this string. The default value is:
23433 .code
23434 q${base62:$tod_epoch}-$inode
23435 .endd
23436 This generates a unique name from the current time, in base 62 form, and the
23437 inode of the file. The variable &$inode$& is available only when expanding this
23438 option.
23439
23440
23441 .option directory_mode appendfile "octal integer" 0700
23442 If &(appendfile)& creates any directories as a result of the
23443 &%create_directory%& option, their mode is specified by this option.
23444
23445
23446 .option escape_string appendfile string "see description"
23447 See &%check_string%& above.
23448
23449
23450 .option file appendfile string&!! unset
23451 This option is mutually exclusive with the &%directory%& option, but one of
23452 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23453 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23454 specifies a single file, to which the message is appended. One or more of
23455 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23456 &%file%&.
23457
23458 The result of expansion must not be tainted, unless the &%create_file%& option
23459 specifies a path.
23460
23461 .cindex "NFS" "lock file"
23462 .cindex "locking files"
23463 .cindex "lock files"
23464 If you are using more than one host to deliver over NFS into the same
23465 mailboxes, you should always use lock files.
23466
23467 The string value is expanded for each delivery, and must yield an absolute
23468 path. The most common settings of this option are variations on one of these
23469 examples:
23470 .code
23471 file = /var/spool/mail/$local_part_data
23472 file = /home/$local_part_data/inbox
23473 file = $home/inbox
23474 .endd
23475 .cindex "&""sticky""& bit"
23476 In the first example, all deliveries are done into the same directory. If Exim
23477 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23478 create a file in the directory, so the &"sticky"& bit must be turned on for
23479 deliveries to be possible, or alternatively the &%group%& option can be used to
23480 run the delivery under a group id which has write access to the directory.
23481
23482
23483
23484 .option file_format appendfile string unset
23485 .cindex "file" "mailbox; checking existing format"
23486 This option requests the transport to check the format of an existing file
23487 before adding to it. The check consists of matching a specific string at the
23488 start of the file. The value of the option consists of an even number of
23489 colon-separated strings. The first of each pair is the test string, and the
23490 second is the name of a transport. If the transport associated with a matched
23491 string is not the current transport, control is passed over to the other
23492 transport. For example, suppose the standard &(local_delivery)& transport has
23493 this added to it:
23494 .code
23495 file_format = "From       : local_delivery :\
23496                \1\1\1\1\n : local_mmdf_delivery"
23497 .endd
23498 Mailboxes that begin with &"From"& are still handled by this transport, but if
23499 a mailbox begins with four binary ones followed by a newline, control is passed
23500 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23501 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23502 is assumed to match the current transport. If the start of a mailbox doesn't
23503 match any string, or if the transport named for a given string is not defined,
23504 delivery is deferred.
23505
23506
23507 .option file_must_exist appendfile boolean false
23508 If this option is true, the file specified by the &%file%& option must exist.
23509 A temporary error occurs if it does not, causing delivery to be deferred.
23510 If this option is false, the file is created if it does not exist.
23511
23512
23513 .option lock_fcntl_timeout appendfile time 0s
23514 .cindex "timeout" "mailbox locking"
23515 .cindex "mailbox" "locking, blocking and non-blocking"
23516 .cindex "locking files"
23517 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23518 when locking an open mailbox file. If the call fails, the delivery process
23519 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23520 Non-blocking calls are used so that the file is not kept open during the wait
23521 for the lock; the reason for this is to make it as safe as possible for
23522 deliveries over NFS in the case when processes might be accessing an NFS
23523 mailbox without using a lock file. This should not be done, but
23524 misunderstandings and hence misconfigurations are not unknown.
23525
23526 On a busy system, however, the performance of a non-blocking lock approach is
23527 not as good as using a blocking lock with a timeout. In this case, the waiting
23528 is done inside the system call, and Exim's delivery process acquires the lock
23529 and can proceed as soon as the previous lock holder releases it.
23530
23531 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23532 timeout, are used. There may still be some retrying: the maximum number of
23533 retries is
23534 .code
23535 (lock_retries * lock_interval) / lock_fcntl_timeout
23536 .endd
23537 rounded up to the next whole number. In other words, the total time during
23538 which &(appendfile)& is trying to get a lock is roughly the same, unless
23539 &%lock_fcntl_timeout%& is set very large.
23540
23541 You should consider setting this option if you are getting a lot of delayed
23542 local deliveries because of errors of the form
23543 .code
23544 failed to lock mailbox /some/file (fcntl)
23545 .endd
23546
23547 .option lock_flock_timeout appendfile time 0s
23548 This timeout applies to file locking when using &[flock()]& (see
23549 &%use_flock%&); the timeout operates in a similar manner to
23550 &%lock_fcntl_timeout%&.
23551
23552
23553 .option lock_interval appendfile time 3s
23554 This specifies the time to wait between attempts to lock the file. See below
23555 for details of locking.
23556
23557
23558 .option lock_retries appendfile integer 10
23559 This specifies the maximum number of attempts to lock the file. A value of zero
23560 is treated as 1. See below for details of locking.
23561
23562
23563 .option lockfile_mode appendfile "octal integer" 0600
23564 This specifies the mode of the created lock file, when a lock file is being
23565 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23566
23567
23568 .option lockfile_timeout appendfile time 30m
23569 .cindex "timeout" "mailbox locking"
23570 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23571 exists and is older than this value, it is assumed to have been left behind by
23572 accident, and Exim attempts to remove it.
23573
23574
23575 .option mailbox_filecount appendfile string&!! unset
23576 .cindex "mailbox" "specifying size of"
23577 .cindex "size" "of mailbox"
23578 If this option is set, it is expanded, and the result is taken as the current
23579 number of files in the mailbox. It must be a decimal number, optionally
23580 followed by K or M. This provides a way of obtaining this information from an
23581 external source that maintains the data.
23582
23583
23584 .option mailbox_size appendfile string&!! unset
23585 .cindex "mailbox" "specifying size of"
23586 .cindex "size" "of mailbox"
23587 If this option is set, it is expanded, and the result is taken as the current
23588 size the mailbox. It must be a decimal number, optionally followed by K or M.
23589 This provides a way of obtaining this information from an external source that
23590 maintains the data. This is likely to be helpful for maildir deliveries where
23591 it is computationally expensive to compute the size of a mailbox.
23592
23593
23594
23595 .option maildir_format appendfile boolean false
23596 .cindex "maildir format" "specifying"
23597 If this option is set with the &%directory%& option, the delivery is into a new
23598 file, in the &"maildir"& format that is used by other mail software. When the
23599 transport is activated directly from a &(redirect)& router (for example, the
23600 &(address_file)& transport in the default configuration), setting
23601 &%maildir_format%& causes the path received from the router to be treated as a
23602 directory, whether or not it ends with &`/`&. This option is available only if
23603 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23604 &<<SECTmaildirdelivery>>& below for further details.
23605
23606
23607 .option maildir_quota_directory_regex appendfile string "See below"
23608 .cindex "maildir format" "quota; directories included in"
23609 .cindex "quota" "maildir; directories included in"
23610 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23611 a regular expression for specifying directories, relative to the quota
23612 directory (see &%quota_directory%&), that should be included in the quota
23613 calculation. The default value is:
23614 .code
23615 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23616 .endd
23617 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23618 (directories whose names begin with a dot). If you want to exclude the
23619 &_Trash_&
23620 folder from the count (as some sites do), you need to change this setting to
23621 .code
23622 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23623 .endd
23624 This uses a negative lookahead in the regular expression to exclude the
23625 directory whose name is &_.Trash_&. When a directory is excluded from quota
23626 calculations, quota processing is bypassed for any messages that are delivered
23627 directly into that directory.
23628
23629
23630 .option maildir_retries appendfile integer 10
23631 This option specifies the number of times to retry when writing a file in
23632 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23633
23634
23635 .option maildir_tag appendfile string&!! unset
23636 This option applies only to deliveries in maildir format, and is described in
23637 section &<<SECTmaildirdelivery>>& below.
23638
23639
23640 .option maildir_use_size_file appendfile&!! boolean false
23641 .cindex "maildir format" "&_maildirsize_& file"
23642 The result of string expansion for this option must be a valid boolean value.
23643 If it is true, it enables support for &_maildirsize_& files. Exim
23644 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23645 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23646 value is zero. See &%maildir_quota_directory_regex%& above and section
23647 &<<SECTmaildirdelivery>>& below for further details.
23648
23649 .option maildirfolder_create_regex appendfile string unset
23650 .cindex "maildir format" "&_maildirfolder_& file"
23651 .cindex "&_maildirfolder_&, creating"
23652 The value of this option is a regular expression. If it is unset, it has no
23653 effect. Otherwise, before a maildir delivery takes place, the pattern is
23654 matched against the name of the maildir directory, that is, the directory
23655 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23656 delivery. If there is a match, Exim checks for the existence of a file called
23657 &_maildirfolder_& in the directory, and creates it if it does not exist.
23658 See section &<<SECTmaildirdelivery>>& for more details.
23659
23660
23661 .option mailstore_format appendfile boolean false
23662 .cindex "mailstore format" "specifying"
23663 If this option is set with the &%directory%& option, the delivery is into two
23664 new files in  &"mailstore"& format. The option is available only if
23665 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23666 below for further details.
23667
23668
23669 .option mailstore_prefix appendfile string&!! unset
23670 This option applies only to deliveries in mailstore format, and is described in
23671 section &<<SECTopdir>>& below.
23672
23673
23674 .option mailstore_suffix appendfile string&!! unset
23675 This option applies only to deliveries in mailstore format, and is described in
23676 section &<<SECTopdir>>& below.
23677
23678
23679 .option mbx_format appendfile boolean false
23680 .cindex "locking files"
23681 .cindex "file" "locking"
23682 .cindex "file" "MBX format"
23683 .cindex "MBX format, specifying"
23684 This option is available only if Exim has been compiled with SUPPORT_MBX
23685 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23686 the message is appended to the mailbox file in MBX format instead of
23687 traditional Unix format. This format is supported by Pine4 and its associated
23688 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23689
23690 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23691 automatically changed by the use of &%mbx_format%&. They should normally be set
23692 empty when using MBX format, so this option almost always appears in this
23693 combination:
23694 .code
23695 mbx_format = true
23696 message_prefix =
23697 message_suffix =
23698 .endd
23699 If none of the locking options are mentioned in the configuration,
23700 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23701 is possible to specify the other kinds of locking with &%mbx_format%&, but
23702 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23703 interworks with &'c-client'&, providing for shared access to the mailbox. It
23704 should not be used if any program that does not use this form of locking is
23705 going to access the mailbox, nor should it be used if the mailbox file is NFS
23706 mounted, because it works only when the mailbox is accessed from a single host.
23707
23708 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23709 the standard version of &'c-client'&, because as long as it has a mailbox open
23710 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23711 append messages to it.
23712
23713
23714 .option message_prefix appendfile string&!! "see below"
23715 .cindex "&""From""& line"
23716 The string specified here is expanded and output at the start of every message.
23717 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23718 in which case it is:
23719 .code
23720 message_prefix = "From ${if def:return_path{$return_path}\
23721   {MAILER-DAEMON}} $tod_bsdinbox\n"
23722 .endd
23723 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23724 &`\n`& to &`\r\n`& in &%message_prefix%&.
23725
23726 .option message_suffix appendfile string&!! "see below"
23727 The string specified here is expanded and output at the end of every message.
23728 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23729 in which case it is a single newline character. The suffix can be suppressed by
23730 setting
23731 .code
23732 message_suffix =
23733 .endd
23734 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23735 &`\n`& to &`\r\n`& in &%message_suffix%&.
23736
23737 .option mode appendfile "octal integer" 0600
23738 If the output file is created, it is given this mode. If it already exists and
23739 has wider permissions, they are reduced to this mode. If it has narrower
23740 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23741 if the delivery is the result of a &%save%& command in a filter file specifying
23742 a particular mode, the mode of the output file is always forced to take that
23743 value, and this option is ignored.
23744
23745
23746 .option mode_fail_narrower appendfile boolean true
23747 This option applies in the case when an existing mailbox file has a narrower
23748 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23749 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23750 continues with the delivery attempt, using the existing mode of the file.
23751
23752
23753 .option notify_comsat appendfile boolean false
23754 If this option is true, the &'comsat'& daemon is notified after every
23755 successful delivery to a user mailbox. This is the daemon that notifies logged
23756 on users about incoming mail.
23757
23758
23759 .option quota appendfile string&!! unset
23760 .cindex "quota" "imposed by Exim"
23761 This option imposes a limit on the size of the file to which Exim is appending,
23762 or to the total space used in the directory tree when the &%directory%& option
23763 is set. In the latter case, computation of the space used is expensive, because
23764 all the files in the directory (and any sub-directories) have to be
23765 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23766 &%maildir_use_size_file%& for ways to avoid this in environments where users
23767 have no shell access to their mailboxes).
23768
23769 As there is no interlock against two simultaneous deliveries into a
23770 multi-file mailbox, it is possible for the quota to be overrun in this case.
23771 For single-file mailboxes, of course, an interlock is a necessity.
23772
23773 A file's size is taken as its &'used'& value. Because of blocking effects, this
23774 may be a lot less than the actual amount of disk space allocated to the file.
23775 If the sizes of a number of files are being added up, the rounding effect can
23776 become quite noticeable, especially on systems that have large block sizes.
23777 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23778 the obvious value which users understand most easily.
23779
23780 The value of the option is expanded, and must then be a numerical value
23781 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23782 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23783 and further option modifiers. If Exim is running on a system with
23784 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23785 be handled.
23786
23787 The option modifier &%no_check%& can be used to force delivery even if the over
23788 quota condition is met. The quota gets updated as usual.
23789
23790 &*Note*&: A value of zero is interpreted as &"no quota"&.
23791
23792 The expansion happens while Exim is running as root, before it changes uid for
23793 the delivery. This means that files that are inaccessible to the end user can
23794 be used to hold quota values that are looked up in the expansion. When delivery
23795 fails because this quota is exceeded, the handling of the error is as for
23796 system quota failures.
23797
23798 By default, Exim's quota checking mimics system quotas, and restricts the
23799 mailbox to the specified maximum size, though the value is not accurate to the
23800 last byte, owing to separator lines and additional headers that may get added
23801 during message delivery. When a mailbox is nearly full, large messages may get
23802 refused even though small ones are accepted, because the size of the current
23803 message is added to the quota when the check is made. This behaviour can be
23804 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23805 for exceeding the quota does not include the current message. Thus, deliveries
23806 continue until the quota has been exceeded; thereafter, no further messages are
23807 delivered. See also &%quota_warn_threshold%&.
23808
23809
23810 .option quota_directory appendfile string&!! unset
23811 This option defines the directory to check for quota purposes when delivering
23812 into individual files. The default is the delivery directory, or, if a file
23813 called &_maildirfolder_& exists in a maildir directory, the parent of the
23814 delivery directory.
23815
23816
23817 .option quota_filecount appendfile string&!! 0
23818 This option applies when the &%directory%& option is set. It limits the total
23819 number of files in the directory (compare the inode limit in system quotas). It
23820 can only be used if &%quota%& is also set. The value is expanded; an expansion
23821 failure causes delivery to be deferred. A value of zero is interpreted as
23822 &"no quota"&.
23823
23824 The option modifier &%no_check%& can be used to force delivery even if the over
23825 quota condition is met. The quota gets updated as usual.
23826
23827 .option quota_is_inclusive appendfile boolean true
23828 See &%quota%& above.
23829
23830
23831 .option quota_size_regex appendfile string unset
23832 This option applies when one of the delivery modes that writes a separate file
23833 for each message is being used. When Exim wants to find the size of one of
23834 these files in order to test the quota, it first checks &%quota_size_regex%&.
23835 If this is set to a regular expression that matches the filename, and it
23836 captures one string, that string is interpreted as a representation of the
23837 file's size. The value of &%quota_size_regex%& is not expanded.
23838
23839 This feature is useful only when users have no shell access to their mailboxes
23840 &-- otherwise they could defeat the quota simply by renaming the files. This
23841 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23842 the file length to the filename. For example:
23843 .code
23844 maildir_tag = ,S=$message_size
23845 quota_size_regex = ,S=(\d+)
23846 .endd
23847 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23848 number of lines in the message.
23849
23850 The regular expression should not assume that the length is at the end of the
23851 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23852 sometimes add other information onto the ends of message filenames.
23853
23854 Section &<<SECID136>>& contains further information.
23855
23856 This option should not be used when other message-handling software
23857 may duplicate messages by making hardlinks to the files.  When that is done Exim
23858 will count the message size once for each filename, in contrast with the actual
23859 disk usage.  When the option is not set, calculating total usage requires
23860 a system-call per file to get the size; the number of links is then available also
23861 as is used to adjust the effective size.
23862
23863
23864 .option quota_warn_message appendfile string&!! "see below"
23865 See below for the use of this option. If it is not set when
23866 &%quota_warn_threshold%& is set, it defaults to
23867 .code
23868 quota_warn_message = "\
23869   To: $local_part@$domain\n\
23870   Subject: Your mailbox\n\n\
23871   This message is automatically created \
23872   by mail delivery software.\n\n\
23873   The size of your mailbox has exceeded \
23874   a warning threshold that is\n\
23875   set by the system administrator.\n"
23876 .endd
23877
23878
23879 .option quota_warn_threshold appendfile string&!! 0
23880 .cindex "quota" "warning threshold"
23881 .cindex "mailbox" "size warning"
23882 .cindex "size" "of mailbox"
23883 This option is expanded in the same way as &%quota%& (see above). If the
23884 resulting value is greater than zero, and delivery of the message causes the
23885 size of the file or total space in the directory tree to cross the given
23886 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23887 may be specified as a percentage of it by following the value with a percent
23888 sign. For example:
23889 .code
23890 quota = 10M
23891 quota_warn_threshold = 75%
23892 .endd
23893 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23894 percent sign is ignored.
23895
23896 The warning message itself is specified by the &%quota_warn_message%& option,
23897 and it must start with a &'To:'& header line containing the recipient(s) of the
23898 warning message. These do not necessarily have to include the recipient(s) of
23899 the original message. A &'Subject:'& line should also normally be supplied. You
23900 can include any other header lines that you want. If you do not include a
23901 &'From:'& line, the default is:
23902 .code
23903 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23904 .endd
23905 .oindex &%errors_reply_to%&
23906 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23907 option.
23908
23909 The &%quota%& option does not have to be set in order to use this option; they
23910 are independent of one another except when the threshold is specified as a
23911 percentage.
23912
23913
23914 .option use_bsmtp appendfile boolean false
23915 .cindex "envelope from"
23916 .cindex "envelope sender"
23917 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23918 format, with the envelope sender and recipient(s) included as SMTP commands. If
23919 you want to include a leading HELO command with such messages, you can do
23920 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23921 for details of batch SMTP.
23922
23923
23924 .option use_crlf appendfile boolean false
23925 .cindex "carriage return"
23926 .cindex "linefeed"
23927 This option causes lines to be terminated with the two-character CRLF sequence
23928 (carriage return, linefeed) instead of just a linefeed character. In the case
23929 of batched SMTP, the byte sequence written to the file is then an exact image
23930 of what would be sent down a real SMTP connection.
23931
23932 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23933 (which are used to supply the traditional &"From&~"& and blank line separators
23934 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23935 carriage return characters if these are needed. In cases where these options
23936 have non-empty defaults, the values end with a single linefeed, so they must be
23937 changed to end with &`\r\n`& if &%use_crlf%& is set.
23938
23939
23940 .option use_fcntl_lock appendfile boolean "see below"
23941 This option controls the use of the &[fcntl()]& function to lock a file for
23942 exclusive use when a message is being appended. It is set by default unless
23943 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23944 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23945 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23946
23947
23948 .option use_flock_lock appendfile boolean false
23949 This option is provided to support the use of &[flock()]& for file locking, for
23950 the few situations where it is needed. Most modern operating systems support
23951 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23952 each other. Exim uses &[fcntl()]& locking by default.
23953
23954 This option is required only if you are using an operating system where
23955 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23956 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23957 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23958
23959 .cindex "Solaris" "&[flock()]& support"
23960 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23961 have it (and some, I think, provide a not quite right version built on top of
23962 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23963 the ability to use it, and any attempt to do so will cause a configuration
23964 error.
23965
23966 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23967 is just being mapped onto &[fcntl()]& by the OS).
23968
23969
23970 .option use_lockfile appendfile boolean "see below"
23971 If this option is turned off, Exim does not attempt to create a lock file when
23972 appending to a mailbox file. In this situation, the only locking is by
23973 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23974 sure that every MUA that is ever going to look at your users' mailboxes uses
23975 &[fcntl()]& rather than a lock file, and even then only when you are not
23976 delivering over NFS from more than one host.
23977
23978 .cindex "NFS" "lock file"
23979 In order to append to an NFS file safely from more than one host, it is
23980 necessary to take out a lock &'before'& opening the file, and the lock file
23981 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23982 file corruption.
23983
23984 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23985 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23986 except when &%mbx_format%& is set.
23987
23988
23989 .option use_mbx_lock appendfile boolean "see below"
23990 This option is available only if Exim has been compiled with SUPPORT_MBX
23991 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23992 locking rules be used. It is set by default if &%mbx_format%& is set and none
23993 of the locking options are mentioned in the configuration. The locking rules
23994 are the same as are used by the &'c-client'& library that underlies Pine and
23995 the IMAP4 and POP daemons that come with it (see the discussion below). The
23996 rules allow for shared access to the mailbox. However, this kind of locking
23997 does not work when the mailbox is NFS mounted.
23998
23999 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
24000 &%use_flock_lock%& to control what kind of locking is used in implementing the
24001 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
24002 without &%use_fcntl_lock%& or &%use_flock_lock%&.
24003
24004
24005
24006
24007 .section "Operational details for appending" "SECTopappend"
24008 .cindex "appending to a file"
24009 .cindex "file" "appending"
24010 Before appending to a file, the following preparations are made:
24011
24012 .ilist
24013 If the name of the file is &_/dev/null_&, no action is taken, and a success
24014 return is given.
24015
24016 .next
24017 .cindex "directory creation"
24018 If any directories on the file's path are missing, Exim creates them if the
24019 &%create_directory%& option is set. A created directory's mode is given by the
24020 &%directory_mode%& option.
24021
24022 .next
24023 If &%file_format%& is set, the format of an existing file is checked. If this
24024 indicates that a different transport should be used, control is passed to that
24025 transport.
24026
24027 .next
24028 .cindex "file" "locking"
24029 .cindex "locking files"
24030 .cindex "NFS" "lock file"
24031 If &%use_lockfile%& is set, a lock file is built in a way that will work
24032 reliably over NFS, as follows:
24033
24034 .olist
24035 Create a &"hitching post"& file whose name is that of the lock file with the
24036 current time, primary host name, and process id added, by opening for writing
24037 as a new file. If this fails with an access error, delivery is deferred.
24038 .next
24039 Close the hitching post file, and hard link it to the lock filename.
24040 .next
24041 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
24042 Unlink the hitching post name.
24043 .next
24044 Otherwise, use &[stat()]& to get information about the hitching post file, and
24045 then unlink hitching post name. If the number of links is exactly two, creation
24046 of the lock file succeeded but something (for example, an NFS server crash and
24047 restart) caused this fact not to be communicated to the &[link()]& call.
24048 .next
24049 If creation of the lock file failed, wait for &%lock_interval%& and try again,
24050 up to &%lock_retries%& times. However, since any program that writes to a
24051 mailbox should complete its task very quickly, it is reasonable to time out old
24052 lock files that are normally the result of user agent and system crashes. If an
24053 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
24054 it before trying again.
24055 .endlist olist
24056
24057 .next
24058 A call is made to &[lstat()]& to discover whether the main file exists, and if
24059 so, what its characteristics are. If &[lstat()]& fails for any reason other
24060 than non-existence, delivery is deferred.
24061
24062 .next
24063 .cindex "symbolic link" "to mailbox"
24064 .cindex "mailbox" "symbolic link"
24065 If the file does exist and is a symbolic link, delivery is deferred, unless the
24066 &%allow_symlink%& option is set, in which case the ownership of the link is
24067 checked, and then &[stat()]& is called to find out about the real file, which
24068 is then subjected to the checks below. The check on the top-level link
24069 ownership prevents one user creating a link for another's mailbox in a sticky
24070 directory, though allowing symbolic links in this case is definitely not a good
24071 idea. If there is a chain of symbolic links, the intermediate ones are not
24072 checked.
24073
24074 .next
24075 If the file already exists but is not a regular file, or if the file's owner
24076 and group (if the group is being checked &-- see &%check_group%& above) are
24077 different from the user and group under which the delivery is running,
24078 delivery is deferred.
24079
24080 .next
24081 If the file's permissions are more generous than specified, they are reduced.
24082 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
24083 is set false, in which case the delivery is tried using the existing
24084 permissions.
24085
24086 .next
24087 The file's inode number is saved, and the file is then opened for appending.
24088 If this fails because the file has vanished, &(appendfile)& behaves as if it
24089 hadn't existed (see below). For any other failures, delivery is deferred.
24090
24091 .next
24092 If the file is opened successfully, check that the inode number hasn't
24093 changed, that it is still a regular file, and that the owner and permissions
24094 have not changed. If anything is wrong, defer delivery and freeze the message.
24095
24096 .next
24097 If the file did not exist originally, defer delivery if the &%file_must_exist%&
24098 option is set. Otherwise, check that the file is being created in a permitted
24099 directory if the &%create_file%& option is set (deferring on failure), and then
24100 open for writing as a new file, with the O_EXCL and O_CREAT options,
24101 except when dealing with a symbolic link (the &%allow_symlink%& option must be
24102 set). In this case, which can happen if the link points to a non-existent file,
24103 the file is opened for writing using O_CREAT but not O_EXCL, because
24104 that prevents link following.
24105
24106 .next
24107 .cindex "loop" "while file testing"
24108 If opening fails because the file exists, obey the tests given above for
24109 existing files. However, to avoid looping in a situation where the file is
24110 being continuously created and destroyed, the exists/not-exists loop is broken
24111 after 10 repetitions, and the message is then frozen.
24112
24113 .next
24114 If opening fails with any other error, defer delivery.
24115
24116 .next
24117 .cindex "file" "locking"
24118 .cindex "locking files"
24119 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24120 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24121 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24122 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24123 file, and an exclusive lock on the file whose name is
24124 .code
24125 /tmp/.<device-number>.<inode-number>
24126 .endd
24127 using the device and inode numbers of the open mailbox file, in accordance with
24128 the MBX locking rules. This file is created with a mode that is specified by
24129 the &%lockfile_mode%& option.
24130
24131 If Exim fails to lock the file, there are two possible courses of action,
24132 depending on the value of the locking timeout. This is obtained from
24133 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24134
24135 If the timeout value is zero, the file is closed, Exim waits for
24136 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24137 to lock it again. This happens up to &%lock_retries%& times, after which the
24138 delivery is deferred.
24139
24140 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24141 &[flock()]& are used (with the given timeout), so there has already been some
24142 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24143 immediately. It retries up to
24144 .code
24145 (lock_retries * lock_interval) / <timeout>
24146 .endd
24147 times (rounded up).
24148 .endlist
24149
24150 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24151 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24152
24153
24154 .section "Operational details for delivery to a new file" "SECTopdir"
24155 .cindex "delivery" "to single file"
24156 .cindex "&""From""& line"
24157 When the &%directory%& option is set instead of &%file%&, each message is
24158 delivered into a newly-created file or set of files. When &(appendfile)& is
24159 activated directly from a &(redirect)& router, neither &%file%& nor
24160 &%directory%& is normally set, because the path for delivery is supplied by the
24161 router. (See for example, the &(address_file)& transport in the default
24162 configuration.) In this case, delivery is to a new file if either the path name
24163 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24164
24165 No locking is required while writing the message to a new file, so the various
24166 locking options of the transport are ignored. The &"From"& line that by default
24167 separates messages in a single file is not normally needed, nor is the escaping
24168 of message lines that start with &"From"&, and there is no need to ensure a
24169 newline at the end of each message. Consequently, the default values for
24170 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24171 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24172
24173 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24174 the files in the delivery directory by default. However, you can specify a
24175 different directory by setting &%quota_directory%&. Also, for maildir
24176 deliveries (see below) the &_maildirfolder_& convention is honoured.
24177
24178
24179 .cindex "maildir format"
24180 .cindex "mailstore format"
24181 There are three different ways in which delivery to individual files can be
24182 done, controlled by the settings of the &%maildir_format%& and
24183 &%mailstore_format%& options. Note that code to support maildir or mailstore
24184 formats is not included in the binary unless SUPPORT_MAILDIR or
24185 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24186
24187 .cindex "directory creation"
24188 In all three cases an attempt is made to create the directory and any necessary
24189 sub-directories if they do not exist, provided that the &%create_directory%&
24190 option is set (the default). The location of a created directory can be
24191 constrained by setting &%create_file%&. A created directory's mode is given by
24192 the &%directory_mode%& option. If creation fails, or if the
24193 &%create_directory%& option is not set when creation is required, delivery is
24194 deferred.
24195
24196
24197
24198 .section "Maildir delivery" "SECTmaildirdelivery"
24199 .cindex "maildir format" "description of"
24200 If the &%maildir_format%& option is true, Exim delivers each message by writing
24201 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24202 directory that is defined by the &%directory%& option (the &"delivery
24203 directory"&). If the delivery is successful, the file is renamed into the
24204 &_new_& subdirectory.
24205
24206 In the filename, <&'stime'&> is the current time of day in seconds, and
24207 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24208 Exim checks that the time-of-day clock has moved on by at least one microsecond
24209 before terminating the delivery process. This guarantees uniqueness for the
24210 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24211 opening it. If any response other than ENOENT (does not exist) is given,
24212 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24213
24214 Before Exim carries out a maildir delivery, it ensures that subdirectories
24215 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24216 do not exist, Exim tries to create them and any superior directories in their
24217 path, subject to the &%create_directory%& and &%create_file%& options. If the
24218 &%maildirfolder_create_regex%& option is set, and the regular expression it
24219 contains matches the delivery directory, Exim also ensures that a file called
24220 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24221 &_maildirfolder_& file cannot be created, delivery is deferred.
24222
24223 These features make it possible to use Exim to create all the necessary files
24224 and directories in a maildir mailbox, including subdirectories for maildir++
24225 folders. Consider this example:
24226 .code
24227 maildir_format = true
24228 directory = /var/mail/$local_part_data\
24229            ${if eq{$local_part_suffix}{}{}\
24230            {/.${substr_1:$local_part_suffix}}}
24231 maildirfolder_create_regex = /\.[^/]+$
24232 .endd
24233 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24234 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24235 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24236 not match this name, so Exim will not look for or create the file
24237 &_/var/mail/pimbo/maildirfolder_&, though it will create
24238 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24239
24240 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24241 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24242 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24243 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24244 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24245
24246 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24247 not inadvertently match the toplevel maildir directory, because a
24248 &_maildirfolder_& file at top level would completely break quota calculations.
24249
24250 .cindex "quota" "in maildir delivery"
24251 .cindex "maildir++"
24252 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24253 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24254 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24255 Exim assumes the directory is a maildir++ folder directory, which is one level
24256 down from the user's top level mailbox directory. This causes it to start at
24257 the parent directory instead of the current directory when calculating the
24258 amount of space used.
24259
24260 One problem with delivering into a multi-file mailbox is that it is
24261 computationally expensive to compute the size of the mailbox for quota
24262 checking. Various approaches have been taken to reduce the amount of work
24263 needed. The next two sections describe two of them. A third alternative is to
24264 use some external process for maintaining the size data, and use the expansion
24265 of the &%mailbox_size%& option as a way of importing it into Exim.
24266
24267
24268
24269
24270 .section "Using tags to record message sizes" "SECID135"
24271 If &%maildir_tag%& is set, the string is expanded for each delivery.
24272 When the maildir file is renamed into the &_new_& sub-directory, the
24273 tag is added to its name. However, if adding the tag takes the length of the
24274 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24275 the tag is dropped and the maildir file is created with no tag.
24276
24277
24278 .vindex "&$message_size$&"
24279 Tags can be used to encode the size of files in their names; see
24280 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24281 happens after the message has been written. The value of the &$message_size$&
24282 variable is set to the number of bytes actually written. If the expansion is
24283 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24284 be deferred. The expanded tag may contain any printing characters except &"/"&.
24285 Non-printing characters in the string are ignored; if the resulting string is
24286 empty, it is ignored. If it starts with an alphanumeric character, a leading
24287 colon is inserted; this default has not proven to be the path that popular
24288 maildir implementations have chosen (but changing it in Exim would break
24289 backwards compatibility).
24290
24291 For one common implementation, you might set:
24292 .code
24293 maildir_tag = ,S=${message_size}
24294 .endd
24295 but you should check the documentation of the other software to be sure.
24296
24297 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24298 as this allows Exim to extract the size from your tag, instead of having to
24299 &[stat()]& each message file.
24300
24301
24302 .section "Using a maildirsize file" "SECID136"
24303 .cindex "quota" "in maildir delivery"
24304 .cindex "maildir format" "&_maildirsize_& file"
24305 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24306 storing quota and message size information in a file called &_maildirsize_&
24307 within the toplevel maildir directory. If this file does not exist, Exim
24308 creates it, setting the quota from the &%quota%& option of the transport. If
24309 the maildir directory itself does not exist, it is created before any attempt
24310 to write a &_maildirsize_& file.
24311
24312 The &_maildirsize_& file is used to hold information about the sizes of
24313 messages in the maildir, thus speeding up quota calculations. The quota value
24314 in the file is just a cache; if the quota is changed in the transport, the new
24315 value overrides the cached value when the next message is delivered. The cache
24316 is maintained for the benefit of other programs that access the maildir and
24317 need to know the quota.
24318
24319 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24320 file is maintained (with a zero quota setting), but no quota is imposed.
24321
24322 A regular expression is available for controlling which directories in the
24323 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24324 See the description of the &%maildir_quota_directory_regex%& option above for
24325 details.
24326
24327
24328 .section "Mailstore delivery" "SECID137"
24329 .cindex "mailstore format" "description of"
24330 If the &%mailstore_format%& option is true, each message is written as two
24331 files in the given directory. A unique base name is constructed from the
24332 message id and the current delivery process, and the files that are written use
24333 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24334 contains the message's envelope, and the &_.msg_& file contains the message
24335 itself. The base name is placed in the variable &$mailstore_basename$&.
24336
24337 During delivery, the envelope is first written to a file with the suffix
24338 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24339 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24340 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24341 file before accessing either of them. An alternative approach is to wait for
24342 the absence of a &_.tmp_& file.
24343
24344 The envelope file starts with any text defined by the &%mailstore_prefix%&
24345 option, expanded and terminated by a newline if there isn't one. Then follows
24346 the sender address on one line, then all the recipient addresses, one per line.
24347 There can be more than one recipient only if the &%batch_max%& option is set
24348 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24349 appended to the file, followed by a newline if it does not end with one.
24350
24351 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24352 failure, it is ignored. Other expansion errors are treated as serious
24353 configuration errors, and delivery is deferred. The variable
24354 &$mailstore_basename$& is available for use during these expansions.
24355
24356
24357 .section "Non-special new file delivery" "SECID138"
24358 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24359 file is created directly in the named directory. For example, when delivering
24360 messages into files in batched SMTP format for later delivery to some host (see
24361 section &<<SECTbatchSMTP>>&), a setting such as
24362 .code
24363 directory = /var/bsmtp/$host
24364 .endd
24365 might be used. A message is written to a file with a temporary name, which is
24366 then renamed when the delivery is complete. The final name is obtained by
24367 expanding the contents of the &%directory_file%& option.
24368 .ecindex IIDapptra1
24369 .ecindex IIDapptra2
24370
24371
24372
24373
24374
24375
24376 . ////////////////////////////////////////////////////////////////////////////
24377 . ////////////////////////////////////////////////////////////////////////////
24378
24379 .chapter "The autoreply transport" "CHID8"
24380 .scindex IIDauttra1 "transports" "&(autoreply)&"
24381 .scindex IIDauttra2 "&(autoreply)& transport"
24382 The &(autoreply)& transport is not a true transport in that it does not cause
24383 the message to be transmitted. Instead, it generates a new mail message as an
24384 automatic reply to the incoming message. &'References:'& and
24385 &'Auto-Submitted:'& header lines are included. These are constructed according
24386 to the rules in RFCs 2822 and 3834, respectively.
24387
24388 If the router that passes the message to this transport does not have the
24389 &%unseen%& option set, the original message (for the current recipient) is not
24390 delivered anywhere. However, when the &%unseen%& option is set on the router
24391 that passes the message to this transport, routing of the address continues, so
24392 another router can set up a normal message delivery.
24393
24394
24395 The &(autoreply)& transport is usually run as the result of mail filtering, a
24396 &"vacation"& message being the standard example. However, it can also be run
24397 directly from a router like any other transport. To reduce the possibility of
24398 message cascades, messages created by the &(autoreply)& transport always have
24399 empty envelope sender addresses, like bounce messages.
24400
24401 The parameters of the message to be sent can be specified in the configuration
24402 by options described below. However, these are used only when the address
24403 passed to the transport does not contain its own reply information. When the
24404 transport is run as a consequence of a
24405 &%mail%&
24406 or &%vacation%& command in a filter file, the parameters of the message are
24407 supplied by the filter, and passed with the address. The transport's options
24408 that define the message are then ignored (so they are not usually set in this
24409 case). The message is specified entirely by the filter or by the transport; it
24410 is never built from a mixture of options. However, the &%file_optional%&,
24411 &%mode%&, and &%return_message%& options apply in all cases.
24412
24413 &(Autoreply)& is implemented as a local transport. When used as a result of a
24414 command in a user's filter file, &(autoreply)& normally runs under the uid and
24415 gid of the user, and with appropriate current and home directories (see chapter
24416 &<<CHAPenvironment>>&).
24417
24418 There is a subtle difference between routing a message to a &(pipe)& transport
24419 that generates some text to be returned to the sender, and routing it to an
24420 &(autoreply)& transport. This difference is noticeable only if more than one
24421 address from the same message is so handled. In the case of a pipe, the
24422 separate outputs from the different addresses are gathered up and returned to
24423 the sender in a single message, whereas if &(autoreply)& is used, a separate
24424 message is generated for each address that is passed to it.
24425
24426 Non-printing characters are not permitted in the header lines generated for the
24427 message that &(autoreply)& creates, with the exception of newlines that are
24428 immediately followed by white space. If any non-printing characters are found,
24429 the transport defers.
24430 Whether characters with the top bit set count as printing characters or not is
24431 controlled by the &%print_topbitchars%& global option.
24432
24433 If any of the generic options for manipulating headers (for example,
24434 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24435 of the original message that is included in the generated message when
24436 &%return_message%& is set. They do not apply to the generated message itself.
24437
24438 .vindex "&$sender_address$&"
24439 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24440 the message, indicating that there were no recipients, it does not treat this
24441 as an error. This means that autoreplies sent to &$sender_address$& when this
24442 is empty (because the incoming message is a bounce message) do not cause
24443 problems. They are just discarded.
24444
24445
24446
24447 .section "Private options for autoreply" "SECID139"
24448 .cindex "options" "&(autoreply)& transport"
24449
24450 .option bcc autoreply string&!! unset
24451 This specifies the addresses that are to receive &"blind carbon copies"& of the
24452 message when the message is specified by the transport.
24453
24454
24455 .option cc autoreply string&!! unset
24456 This specifies recipients of the message and the contents of the &'Cc:'& header
24457 when the message is specified by the transport.
24458
24459
24460 .option file autoreply string&!! unset
24461 The contents of the file are sent as the body of the message when the message
24462 is specified by the transport. If both &%file%& and &%text%& are set, the text
24463 string comes first.
24464
24465
24466 .option file_expand autoreply boolean false
24467 If this is set, the contents of the file named by the &%file%& option are
24468 subjected to string expansion as they are added to the message.
24469
24470
24471 .option file_optional autoreply boolean false
24472 If this option is true, no error is generated if the file named by the &%file%&
24473 option or passed with the address does not exist or cannot be read.
24474
24475
24476 .option from autoreply string&!! unset
24477 This specifies the contents of the &'From:'& header when the message is
24478 specified by the transport.
24479
24480
24481 .option headers autoreply string&!! unset
24482 This specifies additional RFC 2822 headers that are to be added to the message
24483 when the message is specified by the transport. Several can be given by using
24484 &"\n"& to separate them. There is no check on the format.
24485
24486
24487 .option log autoreply string&!! unset
24488 This option names a file in which a record of every message sent is logged when
24489 the message is specified by the transport.
24490
24491
24492 .option mode autoreply "octal integer" 0600
24493 If either the log file or the &"once"& file has to be created, this mode is
24494 used.
24495
24496
24497 .option never_mail autoreply "address list&!!" unset
24498 If any run of the transport creates a message with a recipient that matches any
24499 item in the list, that recipient is quietly discarded. If all recipients are
24500 discarded, no message is created. This applies both when the recipients are
24501 generated by a filter and when they are specified in the transport.
24502
24503
24504
24505 .option once autoreply string&!! unset
24506 This option names a file or DBM database in which a record of each &'To:'&
24507 recipient is kept when the message is specified by the transport. &*Note*&:
24508 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24509
24510 If &%once%& is unset, or is set to an empty string, the message is always sent.
24511 By default, if &%once%& is set to a non-empty filename, the message
24512 is not sent if a potential recipient is already listed in the database.
24513 However, if the &%once_repeat%& option specifies a time greater than zero, the
24514 message is sent if that much time has elapsed since a message was last sent to
24515 this recipient. A setting of zero time for &%once_repeat%& (the default)
24516 prevents a message from being sent a second time &-- in this case, zero means
24517 infinity.
24518
24519 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24520 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24521 greater than zero, it changes the way Exim implements the &%once%& option.
24522 Instead of using a DBM file to record every recipient it sends to, it uses a
24523 regular file, whose size will never get larger than the given value.
24524
24525 In the file, Exim keeps a linear list of recipient addresses and the times at
24526 which they were sent messages. If the file is full when a new address needs to
24527 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24528 means that a given recipient may receive multiple messages, but at
24529 unpredictable intervals that depend on the rate of turnover of addresses in the
24530 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24531
24532
24533 .option once_file_size autoreply integer 0
24534 See &%once%& above.
24535
24536
24537 .option once_repeat autoreply time&!! 0s
24538 See &%once%& above.
24539 After expansion, the value of this option must be a valid time value.
24540
24541
24542 .option reply_to autoreply string&!! unset
24543 This specifies the contents of the &'Reply-To:'& header when the message is
24544 specified by the transport.
24545
24546
24547 .option return_message autoreply boolean false
24548 If this is set, a copy of the original message is returned with the new
24549 message, subject to the maximum size set in the &%return_size_limit%& global
24550 configuration option.
24551
24552
24553 .option subject autoreply string&!! unset
24554 This specifies the contents of the &'Subject:'& header when the message is
24555 specified by the transport. It is tempting to quote the original subject in
24556 automatic responses. For example:
24557 .code
24558 subject = Re: $h_subject:
24559 .endd
24560 There is a danger in doing this, however. It may allow a third party to
24561 subscribe your users to an opt-in mailing list, provided that the list accepts
24562 bounce messages as subscription confirmations. Well-managed lists require a
24563 non-bounce message to confirm a subscription, so the danger is relatively
24564 small.
24565
24566
24567
24568 .option text autoreply string&!! unset
24569 This specifies a single string to be used as the body of the message when the
24570 message is specified by the transport. If both &%text%& and &%file%& are set,
24571 the text comes first.
24572
24573
24574 .option to autoreply string&!! unset
24575 This specifies recipients of the message and the contents of the &'To:'& header
24576 when the message is specified by the transport.
24577 .ecindex IIDauttra1
24578 .ecindex IIDauttra2
24579
24580
24581
24582
24583 . ////////////////////////////////////////////////////////////////////////////
24584 . ////////////////////////////////////////////////////////////////////////////
24585
24586 .chapter "The lmtp transport" "CHAPLMTP"
24587 .cindex "transports" "&(lmtp)&"
24588 .cindex "&(lmtp)& transport"
24589 .cindex "LMTP" "over a pipe"
24590 .cindex "LMTP" "over a unix-domain socket"
24591 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24592 specified command
24593 or by interacting with a Unix domain socket.
24594 This transport is something of a cross between the &(pipe)& and &(smtp)&
24595 transports. Exim also has support for using LMTP over TCP/IP; this is
24596 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24597 to be of minority interest, the default build-time configure in &_src/EDITME_&
24598 has it commented out. You need to ensure that
24599 .code
24600 TRANSPORT_LMTP=yes
24601 .endd
24602 .cindex "options" "&(lmtp)& transport"
24603 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24604 included in the Exim binary. The private options of the &(lmtp)& transport are
24605 as follows:
24606
24607 .option batch_id lmtp string&!! unset
24608 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24609
24610
24611 .option batch_max lmtp integer 1
24612 This limits the number of addresses that can be handled in a single delivery.
24613 Most LMTP servers can handle several addresses at once, so it is normally a
24614 good idea to increase this value. See the description of local delivery
24615 batching in chapter &<<CHAPbatching>>&.
24616
24617
24618 .option command lmtp string&!! unset
24619 This option must be set if &%socket%& is not set. The string is a command which
24620 is run in a separate process. It is split up into a command name and list of
24621 arguments, each of which is separately expanded (so expansion cannot change the
24622 number of arguments). The command is run directly, not via a shell. The message
24623 is passed to the new process using the standard input and output to operate the
24624 LMTP protocol.
24625
24626 .option ignore_quota lmtp boolean false
24627 .cindex "LMTP" "ignoring quota errors"
24628 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24629 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24630 in its response to the LHLO command.
24631
24632 .option socket lmtp string&!! unset
24633 This option must be set if &%command%& is not set. The result of expansion must
24634 be the name of a Unix domain socket. The transport connects to the socket and
24635 delivers the message to it using the LMTP protocol.
24636
24637
24638 .option timeout lmtp time 5m
24639 The transport is aborted if the created process or Unix domain socket does not
24640 respond to LMTP commands or message input within this timeout. Delivery
24641 is deferred, and will be tried again later. Here is an example of a typical
24642 LMTP transport:
24643 .code
24644 lmtp:
24645   driver = lmtp
24646   command = /some/local/lmtp/delivery/program
24647   batch_max = 20
24648   user = exim
24649 .endd
24650 This delivers up to 20 addresses at a time, in a mixture of domains if
24651 necessary, running as the user &'exim'&.
24652
24653
24654
24655 . ////////////////////////////////////////////////////////////////////////////
24656 . ////////////////////////////////////////////////////////////////////////////
24657
24658 .chapter "The pipe transport" "CHAPpipetransport"
24659 .scindex IIDpiptra1 "transports" "&(pipe)&"
24660 .scindex IIDpiptra2 "&(pipe)& transport"
24661 The &(pipe)& transport is used to deliver messages via a pipe to a command
24662 running in another process. One example is the use of &(pipe)& as a
24663 pseudo-remote transport for passing messages to some other delivery mechanism
24664 (such as UUCP). Another is the use by individual users to automatically process
24665 their incoming messages. The &(pipe)& transport can be used in one of the
24666 following ways:
24667
24668 .ilist
24669 .vindex "&$local_part$&"
24670 A router routes one address to a transport in the normal way, and the
24671 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24672 contains the local part of the address (as usual), and the command that is run
24673 is specified by the &%command%& option on the transport.
24674 .next
24675 .vindex "&$pipe_addresses$&"
24676 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24677 transport can handle more than one address in a single run. In this case, when
24678 more than one address is routed to the transport, &$local_part$& is not set
24679 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24680 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24681 that are routed to the transport.
24682 .next
24683 .vindex "&$address_pipe$&"
24684 A router redirects an address directly to a pipe command (for example, from an
24685 alias or forward file). In this case, &$address_pipe$& contains the text of the
24686 pipe command, and the &%command%& option on the transport is ignored unless
24687 &%force_command%& is set. If only one address is being transported
24688 (&%batch_max%& is not greater than one, or only one address was redirected to
24689 this pipe command), &$local_part$& contains the local part that was redirected.
24690 .endlist
24691
24692
24693 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24694 deliver messages over pipes using the LMTP interactive protocol. This is
24695 implemented by the &(lmtp)& transport.
24696
24697 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24698 &_.forward_& file, the command runs under the uid and gid of that user. In
24699 other cases, the uid and gid have to be specified explicitly, either on the
24700 transport or on the router that handles the address. Current and &"home"&
24701 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24702 details of the local delivery environment and chapter &<<CHAPbatching>>&
24703 for a discussion of local delivery batching.
24704
24705 .cindex "tainted data" "in pipe command"
24706 .cindex pipe "tainted data"
24707 Tainted data may not be used for the command name.
24708
24709
24710 .section "Concurrent delivery" "SECID140"
24711 If two messages arrive at almost the same time, and both are routed to a pipe
24712 delivery, the two pipe transports may be run concurrently. You must ensure that
24713 any pipe commands you set up are robust against this happening. If the commands
24714 write to a file, the &%exim_lock%& utility might be of use.
24715 Alternatively the &%max_parallel%& option could be used with a value
24716 of "1" to enforce serialization.
24717
24718
24719
24720
24721 .section "Returned status and data" "SECID141"
24722 .cindex "&(pipe)& transport" "returned data"
24723 If the command exits with a non-zero return code, the delivery is deemed to
24724 have failed, unless either the &%ignore_status%& option is set (in which case
24725 the return code is treated as zero), or the return code is one of those listed
24726 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24727 later"&. In this case, delivery is deferred. Details of a permanent failure are
24728 logged, but are not included in the bounce message, which merely contains
24729 &"local delivery failed"&.
24730
24731 If the command exits on a signal and the &%freeze_signal%& option is set then
24732 the message will be frozen in the queue. If that option is not set, a bounce
24733 will be sent as normal.
24734
24735 If the return code is greater than 128 and the command being run is a shell
24736 script, it normally means that the script was terminated by a signal whose
24737 value is the return code minus 128. The &%freeze_signal%& option does not
24738 apply in this case.
24739
24740 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24741 return code is set to 127. This is the value that a shell returns if it is
24742 asked to run a non-existent command. The wording for the log line suggests that
24743 a non-existent command may be the problem.
24744
24745 The &%return_output%& option can affect the result of a pipe delivery. If it is
24746 set and the command produces any output on its standard output or standard
24747 error streams, the command is considered to have failed, even if it gave a zero
24748 return code or if &%ignore_status%& is set. The output from the command is
24749 included as part of the bounce message. The &%return_fail_output%& option is
24750 similar, except that output is returned only when the command exits with a
24751 failure return code, that is, a value other than zero or a code that matches
24752 &%temp_errors%&.
24753
24754
24755
24756 .section "How the command is run" "SECThowcommandrun"
24757 .cindex "&(pipe)& transport" "path for command"
24758 The command line is (by default) broken down into a command name and arguments
24759 by the &(pipe)& transport itself. The &%allow_commands%& and
24760 &%restrict_to_path%& options can be used to restrict the commands that may be
24761 run.
24762
24763 .cindex "quoting" "in pipe command"
24764 Unquoted arguments are delimited by white space. If an argument appears in
24765 double quotes, backslash is interpreted as an escape character in the usual
24766 way. If an argument appears in single quotes, no escaping is done.
24767
24768 String expansion is applied to the command line except when it comes from a
24769 traditional &_.forward_& file (commands from a filter file are expanded). The
24770 expansion is applied to each argument in turn rather than to the whole line.
24771 For this reason, any string expansion item that contains white space must be
24772 quoted so as to be contained within a single argument. A setting such as
24773 .code
24774 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24775 .endd
24776 will not work, because the expansion item gets split between several
24777 arguments. You have to write
24778 .code
24779 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24780 .endd
24781 to ensure that it is all in one argument. The expansion is done in this way,
24782 argument by argument, so that the number of arguments cannot be changed as a
24783 result of expansion, and quotes or backslashes in inserted variables do not
24784 interact with external quoting. However, this leads to problems if you want to
24785 generate multiple arguments (or the command name plus arguments) from a single
24786 expansion. In this situation, the simplest solution is to use a shell. For
24787 example:
24788 .code
24789 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24790 .endd
24791
24792 .cindex "transport" "filter"
24793 .cindex "filter" "transport filter"
24794 .vindex "&$pipe_addresses$&"
24795 Special handling takes place when an argument consists of precisely the text
24796 &`$pipe_addresses`& (no quotes).
24797 This is not a general expansion variable; the only
24798 place this string is recognized is when it appears as an argument for a pipe or
24799 transport filter command. It causes each address that is being handled to be
24800 inserted in the argument list at that point &'as a separate argument'&. This
24801 avoids any problems with spaces or shell metacharacters, and is of use when a
24802 &(pipe)& transport is handling groups of addresses in a batch.
24803
24804 If &%force_command%& is enabled on the transport, special handling takes place
24805 for an argument that consists of precisely the text &`$address_pipe`&.  It
24806 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24807 argument is inserted in the argument list at that point
24808 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24809 the only item in the argument; in fact, if it were then &%force_command%&
24810 should behave as a no-op.  Rather, it should be used to adjust the command
24811 run while preserving the argument vector separation.
24812
24813 After splitting up into arguments and expansion, the resulting command is run
24814 in a subprocess directly from the transport, &'not'& under a shell. The
24815 message that is being delivered is supplied on the standard input, and the
24816 standard output and standard error are both connected to a single pipe that is
24817 read by Exim. The &%max_output%& option controls how much output the command
24818 may produce, and the &%return_output%& and &%return_fail_output%& options
24819 control what is done with it.
24820
24821 Not running the command under a shell (by default) lessens the security risks
24822 in cases when a command from a user's filter file is built out of data that was
24823 taken from an incoming message. If a shell is required, it can of course be
24824 explicitly specified as the command to be run. However, there are circumstances
24825 where existing commands (for example, in &_.forward_& files) expect to be run
24826 under a shell and cannot easily be modified. To allow for these cases, there is
24827 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24828 works. Instead of breaking up the command line as just described, it expands it
24829 as a single string and passes the result to &_/bin/sh_&. The
24830 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24831 with &%use_shell%&, and the whole mechanism is inherently less secure.
24832
24833
24834
24835 .section "Environment variables" "SECTpipeenv"
24836 .cindex "&(pipe)& transport" "environment for command"
24837 .cindex "environment" "&(pipe)& transport"
24838 The environment variables listed below are set up when the command is invoked.
24839 This list is a compromise for maximum compatibility with other MTAs. Note that
24840 the &%environment%& option can be used to add additional variables to this
24841 environment. The environment for the &(pipe)& transport is not subject
24842 to the &%add_environment%& and &%keep_environment%& main config options.
24843 &*Note*&: Using enviroment variables loses track of tainted data.
24844 Writers of &(pipe)& transport commands should be wary of data supplied
24845 by potential attackers.
24846 .display
24847 &`DOMAIN            `&   the domain of the address
24848 &`HOME              `&   the home directory, if set
24849 &`HOST              `&   the host name when called from a router (see below)
24850 &`LOCAL_PART        `&   see below
24851 &`LOCAL_PART_PREFIX `&   see below
24852 &`LOCAL_PART_SUFFIX `&   see below
24853 &`LOGNAME           `&   see below
24854 &`MESSAGE_ID        `&   Exim's local ID for the message
24855 &`PATH              `&   as specified by the &%path%& option below
24856 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24857 &`RECIPIENT         `&   the complete recipient address
24858 &`SENDER            `&   the sender of the message (empty if a bounce)
24859 &`SHELL             `&   &`/bin/sh`&
24860 &`TZ                `&   the value of the &%timezone%& option, if set
24861 &`USER              `&   see below
24862 .endd
24863 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24864 router, LOCAL_PART is set to the local part of the address. When it is
24865 called as a result of a forward or alias expansion, LOCAL_PART is set to
24866 the local part of the address that was expanded. In both cases, any affixes are
24867 removed from the local part, and made available in LOCAL_PART_PREFIX and
24868 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24869 same value as LOCAL_PART for compatibility with other MTAs.
24870
24871 .cindex "HOST"
24872 HOST is set only when a &(pipe)& transport is called from a router that
24873 associates hosts with an address, typically when using &(pipe)& as a
24874 pseudo-remote transport. HOST is set to the first host name specified by
24875 the router.
24876
24877 .cindex "HOME"
24878 If the transport's generic &%home_directory%& option is set, its value is used
24879 for the HOME environment variable. Otherwise, a home directory may be set
24880 by the router's &%transport_home_directory%& option, which defaults to the
24881 user's home directory if &%check_local_user%& is set.
24882
24883
24884 .section "Private options for pipe" "SECID142"
24885 .cindex "options" "&(pipe)& transport"
24886
24887
24888
24889 .option allow_commands pipe "string list&!!" unset
24890 .cindex "&(pipe)& transport" "permitted commands"
24891 The string is expanded, and is then interpreted as a colon-separated list of
24892 permitted commands. If &%restrict_to_path%& is not set, the only commands
24893 permitted are those in the &%allow_commands%& list. They need not be absolute
24894 paths; the &%path%& option is still used for relative paths. If
24895 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24896 in the &%allow_commands%& list, or a name without any slashes that is found on
24897 the path. In other words, if neither &%allow_commands%& nor
24898 &%restrict_to_path%& is set, there is no restriction on the command, but
24899 otherwise only commands that are permitted by one or the other are allowed. For
24900 example, if
24901 .code
24902 allow_commands = /usr/bin/vacation
24903 .endd
24904 and &%restrict_to_path%& is not set, the only permitted command is
24905 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24906 &%use_shell%& is set.
24907
24908
24909 .option batch_id pipe string&!! unset
24910 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24911
24912
24913 .option batch_max pipe integer 1
24914 This limits the number of addresses that can be handled in a single delivery.
24915 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24916
24917
24918 .option check_string pipe string unset
24919 As &(pipe)& writes the message, the start of each line is tested for matching
24920 &%check_string%&, and if it does, the initial matching characters are replaced
24921 by the contents of &%escape_string%&, provided both are set. The value of
24922 &%check_string%& is a literal string, not a regular expression, and the case of
24923 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24924 of &%check_string%& and &%escape_string%& are forced to values that implement
24925 the SMTP escaping protocol. Any settings made in the configuration file are
24926 ignored.
24927
24928
24929 .option command pipe string&!! unset
24930 This option need not be set when &(pipe)& is being used to deliver to pipes
24931 obtained directly from address redirections. In other cases, the option must be
24932 set, to provide a command to be run. It need not yield an absolute path (see
24933 the &%path%& option below). The command is split up into separate arguments by
24934 Exim, and each argument is separately expanded, as described in section
24935 &<<SECThowcommandrun>>& above.
24936
24937 .cindex "tainted data"
24938 No part of the resulting command may be tainted.
24939
24940
24941 .option environment pipe "string list&!!" unset
24942 .cindex "&(pipe)& transport" "environment for command"
24943 .cindex "environment" "&(pipe)& transport"
24944 This option is used to add additional variables to the environment in which the
24945 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24946 a string which is expanded, and then interpreted as a colon-separated list of
24947 environment settings of the form <&'name'&>=<&'value'&>.
24948
24949
24950 .option escape_string pipe string unset
24951 See &%check_string%& above.
24952
24953
24954 .option freeze_exec_fail pipe boolean false
24955 .cindex "exec failure"
24956 .cindex "failure of exec"
24957 .cindex "&(pipe)& transport" "failure of exec"
24958 Failure to exec the command in a pipe transport is by default treated like
24959 any other failure while running the command. However, if &%freeze_exec_fail%&
24960 is set, failure to exec is treated specially, and causes the message to be
24961 frozen, whatever the setting of &%ignore_status%&.
24962
24963
24964 .option freeze_signal pipe boolean false
24965 .cindex "signal exit"
24966 .cindex "&(pipe)& transport", "signal exit"
24967 Normally if the process run by a command in a pipe transport exits on a signal,
24968 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24969 frozen in Exim's queue instead.
24970
24971
24972 .option force_command pipe boolean false
24973 .cindex "force command"
24974 .cindex "&(pipe)& transport", "force command"
24975 Normally when a router redirects an address directly to a pipe command
24976 the &%command%& option on the transport is ignored.  If &%force_command%&
24977 is set, the &%command%& option will used. This is especially
24978 useful for forcing a wrapper or additional argument to be added to the
24979 command. For example:
24980 .code
24981 command = /usr/bin/remote_exec myhost -- $address_pipe
24982 force_command
24983 .endd
24984
24985 Note that &$address_pipe$& is handled specially in &%command%& when
24986 &%force_command%& is set, expanding out to the original argument vector as
24987 separate items, similarly to a Unix shell &`"$@"`& construct.
24988
24989
24990 .option ignore_status pipe boolean false
24991 If this option is true, the status returned by the subprocess that is set up to
24992 run the command is ignored, and Exim behaves as if zero had been returned.
24993 Otherwise, a non-zero status or termination by signal causes an error return
24994 from the transport unless the status value is one of those listed in
24995 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24996
24997 &*Note*&: This option does not apply to timeouts, which do not return a status.
24998 See the &%timeout_defer%& option for how timeouts are handled.
24999
25000
25001 .option log_defer_output pipe boolean false
25002 .cindex "&(pipe)& transport" "logging output"
25003 If this option is set, and the status returned by the command is
25004 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
25005 and any output was produced on stdout or stderr, the first line of it is
25006 written to the main log.
25007
25008
25009 .option log_fail_output pipe boolean false
25010 If this option is set, and the command returns any output on stdout or
25011 stderr, and also ends with a return code that is neither zero nor one of
25012 the return codes listed in &%temp_errors%& (that is, the delivery
25013 failed), the first line of output is written to the main log. This
25014 option and &%log_output%& are mutually exclusive.  Only one of them may
25015 be set.
25016
25017
25018 .option log_output pipe boolean false
25019 If this option is set and the command returns any output on stdout or
25020 stderr, the first line of output is written to the main log, whatever
25021 the return code. This option and &%log_fail_output%& are mutually
25022 exclusive. Only one of them may be set.
25023
25024
25025 .option max_output pipe integer 20K
25026 This specifies the maximum amount of output that the command may produce on its
25027 standard output and standard error file combined. If the limit is exceeded, the
25028 process running the command is killed. This is intended as a safety measure to
25029 catch runaway processes. The limit is applied independently of the settings of
25030 the options that control what is done with such output (for example,
25031 &%return_output%&). Because of buffering effects, the amount of output may
25032 exceed the limit by a small amount before Exim notices.
25033
25034
25035 .option message_prefix pipe string&!! "see below"
25036 The string specified here is expanded and output at the start of every message.
25037 The default is unset if &%use_bsmtp%& is set. Otherwise it is
25038 .code
25039 message_prefix = \
25040   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
25041   ${tod_bsdinbox}\n
25042 .endd
25043 .cindex "Cyrus"
25044 .cindex "&%tmail%&"
25045 .cindex "&""From""& line"
25046 This is required by the commonly used &_/usr/bin/vacation_& program.
25047 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
25048 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
25049 setting
25050 .code
25051 message_prefix =
25052 .endd
25053 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
25054 &`\n`& to &`\r\n`& in &%message_prefix%&.
25055
25056
25057 .option message_suffix pipe string&!! "see below"
25058 The string specified here is expanded and output at the end of every message.
25059 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
25060 The suffix can be suppressed by setting
25061 .code
25062 message_suffix =
25063 .endd
25064 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
25065 &`\n`& to &`\r\n`& in &%message_suffix%&.
25066
25067
25068 .option path pipe string&!! "/bin:/usr/bin"
25069 This option is expanded and
25070 specifies the string that is set up in the PATH environment
25071 variable of the subprocess.
25072 If the &%command%& option does not yield an absolute path name, the command is
25073 sought in the PATH directories, in the usual way. &*Warning*&: This does not
25074 apply to a command specified as a transport filter.
25075
25076
25077 .option permit_coredump pipe boolean false
25078 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
25079 a core-dump of a pipe command, enable this command.  This enables core-dumps
25080 during delivery and affects both the Exim binary and the pipe command run.
25081 It is recommended that this option remain off unless and until you have a need
25082 for it and that this only be enabled when needed, as the risk of excessive
25083 resource consumption can be quite high.  Note also that Exim is typically
25084 installed as a setuid binary and most operating systems will inhibit coredumps
25085 of these by default, so further OS-specific action may be required.
25086
25087
25088 .option pipe_as_creator pipe boolean false
25089 .cindex "uid (user id)" "local delivery"
25090 If the generic &%user%& option is not set and this option is true, the delivery
25091 process is run under the uid that was in force when Exim was originally called
25092 to accept the message. If the group id is not otherwise set (via the generic
25093 &%group%& option), the gid that was in force when Exim was originally called to
25094 accept the message is used.
25095
25096
25097 .option restrict_to_path pipe boolean false
25098 When this option is set, any command name not listed in &%allow_commands%& must
25099 contain no slashes. The command is searched for only in the directories listed
25100 in the &%path%& option. This option is intended for use in the case when a pipe
25101 command has been generated from a user's &_.forward_& file. This is usually
25102 handled by a &(pipe)& transport called &%address_pipe%&.
25103
25104
25105 .option return_fail_output pipe boolean false
25106 If this option is true, and the command produced any output and ended with a
25107 return code other than zero or one of the codes listed in &%temp_errors%& (that
25108 is, the delivery failed), the output is returned in the bounce message.
25109 However, if the message has a null sender (that is, it is itself a bounce
25110 message), output from the command is discarded. This option and
25111 &%return_output%& are mutually exclusive. Only one of them may be set.
25112
25113
25114
25115 .option return_output pipe boolean false
25116 If this option is true, and the command produced any output, the delivery is
25117 deemed to have failed whatever the return code from the command, and the output
25118 is returned in the bounce message. Otherwise, the output is just discarded.
25119 However, if the message has a null sender (that is, it is a bounce message),
25120 output from the command is always discarded, whatever the setting of this
25121 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25122 of them may be set.
25123
25124
25125
25126 .option temp_errors pipe "string list" "see below"
25127 .cindex "&(pipe)& transport" "temporary failure"
25128 This option contains either a colon-separated list of numbers, or a single
25129 asterisk. If &%ignore_status%& is false
25130 and &%return_output%& is not set,
25131 and the command exits with a non-zero return code, the failure is treated as
25132 temporary and the delivery is deferred if the return code matches one of the
25133 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25134 codes are treated as permanent errors. The default setting contains the codes
25135 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25136 compiled on a system that does not define these macros, it assumes values of 75
25137 and 73, respectively.
25138
25139
25140 .option timeout pipe time 1h
25141 If the command fails to complete within this time, it is killed. This normally
25142 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25143 specifies no timeout. In order to ensure that any subprocesses created by the
25144 command are also killed, Exim makes the initial process a process group leader,
25145 and kills the whole process group on a timeout. However, this can be defeated
25146 if one of the processes starts a new process group.
25147
25148 .option timeout_defer pipe boolean false
25149 A timeout in a &(pipe)& transport, either in the command that the transport
25150 runs, or in a transport filter that is associated with it, is by default
25151 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25152 is set true, both kinds of timeout become temporary errors, causing the
25153 delivery to be deferred.
25154
25155 .option umask pipe "octal integer" 022
25156 This specifies the umask setting for the subprocess that runs the command.
25157
25158
25159 .option use_bsmtp pipe boolean false
25160 .cindex "envelope sender"
25161 If this option is set true, the &(pipe)& transport writes messages in &"batch
25162 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25163 commands. If you want to include a leading HELO command with such messages,
25164 you can do so by setting the &%message_prefix%& option. See section
25165 &<<SECTbatchSMTP>>& for details of batch SMTP.
25166
25167 .option use_classresources pipe boolean false
25168 .cindex "class resources (BSD)"
25169 This option is available only when Exim is running on FreeBSD, NetBSD, or
25170 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25171 resource limits when a &(pipe)& transport is run to perform a delivery. The
25172 limits for the uid under which the pipe is to run are obtained from the login
25173 class database.
25174
25175
25176 .option use_crlf pipe boolean false
25177 .cindex "carriage return"
25178 .cindex "linefeed"
25179 This option causes lines to be terminated with the two-character CRLF sequence
25180 (carriage return, linefeed) instead of just a linefeed character. In the case
25181 of batched SMTP, the byte sequence written to the pipe is then an exact image
25182 of what would be sent down a real SMTP connection.
25183
25184 The contents of the &%message_prefix%& and &%message_suffix%& options are
25185 written verbatim, so must contain their own carriage return characters if these
25186 are needed. When &%use_bsmtp%& is not set, the default values for both
25187 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25188 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25189
25190
25191 .option use_shell pipe boolean false
25192 .vindex "&$pipe_addresses$&"
25193 If this option is set, it causes the command to be passed to &_/bin/sh_&
25194 instead of being run directly from the transport, as described in section
25195 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25196 where the command is expected to be run under a shell and cannot easily be
25197 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25198 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25199 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25200 its &%-c%& option.
25201
25202
25203
25204 .section "Using an external local delivery agent" "SECID143"
25205 .cindex "local delivery" "using an external agent"
25206 .cindex "&'procmail'&"
25207 .cindex "external local delivery"
25208 .cindex "delivery" "&'procmail'&"
25209 .cindex "delivery" "by external agent"
25210 The &(pipe)& transport can be used to pass all messages that require local
25211 delivery to a separate local delivery agent such as &%procmail%&. When doing
25212 this, care must be taken to ensure that the pipe is run under an appropriate
25213 uid and gid. In some configurations one wants this to be a uid that is trusted
25214 by the delivery agent to supply the correct sender of the message. It may be
25215 necessary to recompile or reconfigure the delivery agent so that it trusts an
25216 appropriate user. The following is an example transport and router
25217 configuration for &%procmail%&:
25218 .code
25219 # transport
25220 procmail_pipe:
25221   driver = pipe
25222   command = /usr/local/bin/procmail -d $local_part_data
25223   return_path_add
25224   delivery_date_add
25225   envelope_to_add
25226   check_string = "From "
25227   escape_string = ">From "
25228   umask = 077
25229   user = $local_part_data
25230   group = mail
25231
25232 # router
25233 procmail:
25234   driver = accept
25235   check_local_user
25236   transport = procmail_pipe
25237 .endd
25238 In this example, the pipe is run as the local user, but with the group set to
25239 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25240 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25241 user to supply a correct sender address. If you do not specify either a
25242 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25243 home directory is the user's home directory by default.
25244
25245 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25246 .code
25247 IFS=" "
25248 .endd
25249 as shown in some &%procmail%& documentation, because Exim does not by default
25250 use a shell to run pipe commands.
25251
25252 .cindex "Cyrus"
25253 The next example shows a transport and a router for a system where local
25254 deliveries are handled by the Cyrus IMAP server.
25255 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25256 . but that suffix is tainted so cannot be used in a command arg
25257 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25258 .code
25259 # transport
25260 local_delivery_cyrus:
25261   driver = pipe
25262   command = /usr/cyrus/bin/deliver \
25263             -- $local_part_data
25264   user = cyrus
25265   group = mail
25266   return_output
25267   log_output
25268   message_prefix =
25269   message_suffix =
25270
25271 # router
25272 local_user_cyrus:
25273   driver = accept
25274   check_local_user
25275   transport = local_delivery_cyrus
25276 .endd
25277 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25278 &%return_output%& to cause any text written by Cyrus to be returned to the
25279 sender.
25280 .ecindex IIDpiptra1
25281 .ecindex IIDpiptra2
25282
25283
25284 . ////////////////////////////////////////////////////////////////////////////
25285 . ////////////////////////////////////////////////////////////////////////////
25286
25287 .chapter "The smtp transport" "CHAPsmtptrans"
25288 .scindex IIDsmttra1 "transports" "&(smtp)&"
25289 .scindex IIDsmttra2 "&(smtp)& transport"
25290 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25291 or LMTP protocol. The list of hosts to try can either be taken from the address
25292 that is being processed (having been set up by the router), or specified
25293 explicitly for the transport. Timeout and retry processing (see chapter
25294 &<<CHAPretry>>&) is applied to each IP address independently.
25295
25296
25297 .section "Multiple messages on a single connection" "SECID144"
25298 The sending of multiple messages over a single TCP/IP connection can arise in
25299 two ways:
25300
25301 .ilist
25302 If a message contains more than &%max_rcpt%& (see below) addresses that are
25303 routed to the same host, more than one copy of the message has to be sent to
25304 that host. In this situation, multiple copies may be sent in a single run of
25305 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25306 does when it has too many addresses to send in one message also depends on the
25307 value of the global &%remote_max_parallel%& option. Details are given in
25308 section &<<SECToutSMTPTCP>>&.)
25309 .next
25310 .cindex "hints database" "remembering routing"
25311 When a message has been successfully delivered over a TCP/IP connection, Exim
25312 looks in its hints database to see if there are any other messages awaiting a
25313 connection to the same host. If there are, a new delivery process is started
25314 for one of them, and the current TCP/IP connection is passed on to it. The new
25315 process may in turn send multiple copies and possibly create yet another
25316 process.
25317 .endlist
25318
25319
25320 For each copy sent over the same TCP/IP connection, a sequence counter is
25321 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25322 no further messages are sent over that connection.
25323
25324
25325
25326 .section "Use of the $host and $host_address variables" "SECID145"
25327 .vindex "&$host$&"
25328 .vindex "&$host_address$&"
25329 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25330 &$host_address$& are the name and IP address of the first host on the host list
25331 passed by the router. However, when the transport is about to connect to a
25332 specific host, and while it is connected to that host, &$host$& and
25333 &$host_address$& are set to the values for that host. These are the values
25334 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25335 &%serialize_hosts%&, and the various TLS options are expanded.
25336
25337
25338 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25339 .vindex &$tls_bits$&
25340 .vindex &$tls_cipher$&
25341 .vindex &$tls_peerdn$&
25342 .vindex &$tls_sni$&
25343 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25344 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25345 are the values that were set when the message was received.
25346 These are the values that are used for options that are expanded before any
25347 SMTP connections are made. Just before each connection is made, these four
25348 variables are emptied. If TLS is subsequently started, they are set to the
25349 appropriate values for the outgoing connection, and these are the values that
25350 are in force when any authenticators are run and when the
25351 &%authenticated_sender%& option is expanded.
25352
25353 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25354 and will be removed in a future release.
25355
25356
25357 .section "Private options for smtp" "SECID146"
25358 .cindex "options" "&(smtp)& transport"
25359 The private options of the &(smtp)& transport are as follows:
25360
25361
25362 .option address_retry_include_sender smtp boolean true
25363 .cindex "4&'xx'& responses" "retrying after"
25364 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25365 is the combination of sender and recipient that is delayed in subsequent queue
25366 runs until the retry time is reached. You can delay the recipient without
25367 reference to the sender (which is what earlier versions of Exim did), by
25368 setting &%address_retry_include_sender%& false. However, this can lead to
25369 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25370
25371 .option allow_localhost smtp boolean false
25372 .cindex "local host" "sending to"
25373 .cindex "fallback" "hosts specified on transport"
25374 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25375 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25376 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25377 the delivery anyway. This should be used only in special cases when the
25378 configuration ensures that no looping will result (for example, a differently
25379 configured Exim is listening on the port to which the message is sent).
25380
25381
25382 .option authenticated_sender smtp string&!! unset
25383 .cindex "Cyrus"
25384 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25385 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25386 overriding any existing authenticated sender value. If the string expansion is
25387 forced to fail, the option is ignored. Other expansion failures cause delivery
25388 to be deferred. If the result of expansion is an empty string, that is also
25389 ignored.
25390
25391 The expansion happens after the outgoing connection has been made and TLS
25392 started, if required. This means that the &$host$&, &$host_address$&,
25393 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25394 particular connection.
25395
25396 If the SMTP session is not authenticated, the expansion of
25397 &%authenticated_sender%& still happens (and can cause the delivery to be
25398 deferred if it fails), but no AUTH= item is added to MAIL commands
25399 unless &%authenticated_sender_force%& is true.
25400
25401 This option allows you to use the &(smtp)& transport in LMTP mode to
25402 deliver mail to Cyrus IMAP and provide the proper local part as the
25403 &"authenticated sender"&, via a setting such as:
25404 .code
25405 authenticated_sender = $local_part
25406 .endd
25407 This removes the need for IMAP subfolders to be assigned special ACLs to
25408 allow direct delivery to those subfolders.
25409
25410 Because of expected uses such as that just described for Cyrus (when no
25411 domain is involved), there is no checking on the syntax of the provided
25412 value.
25413
25414
25415 .option authenticated_sender_force smtp boolean false
25416 If this option is set true, the &%authenticated_sender%& option's value
25417 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25418 authenticated as a client.
25419
25420
25421 .option command_timeout smtp time 5m
25422 .cindex timeout "smtp transport command"
25423 This sets a timeout for receiving a response to an SMTP command that has been
25424 sent out. It is also used when waiting for the initial banner line from the
25425 remote host. Its value must not be zero.
25426
25427
25428 .option connect_timeout smtp time 5m
25429 .cindex timeout "smtp transport connect"
25430 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25431 to a remote host. A setting of zero allows the system timeout (typically
25432 several minutes) to act. To have any effect, the value of this option must be
25433 less than the system timeout. However, it has been observed that on some
25434 systems there is no system timeout, which is why the default value for this
25435 option is 5 minutes, a value recommended by RFC 1123.
25436
25437
25438 .option connection_max_messages smtp integer 500
25439 .cindex "SMTP" "passed connection"
25440 .cindex "SMTP" "multiple deliveries"
25441 .cindex "multiple SMTP deliveries"
25442 This controls the maximum number of separate message deliveries that are sent
25443 over a single TCP/IP connection. If the value is zero, there is no limit.
25444 For testing purposes, this value can be overridden by the &%-oB%& command line
25445 option.
25446
25447 .cindex "ESMTP extensions" LIMITS
25448 If the peer advertises a LIMITS extension with a MAILMAX value,
25449 and either TLSS is in use or was not advertised,
25450 that value also constrains the result of this option.
25451
25452
25453 .option dane_require_tls_ciphers smtp string&!! unset
25454 .cindex "TLS" "requiring specific ciphers for DANE"
25455 .cindex "cipher" "requiring specific"
25456 .cindex DANE "TLS ciphers"
25457 This option may be used to override &%tls_require_ciphers%& for connections
25458 where DANE has been determined to be in effect.
25459 If not set, then &%tls_require_ciphers%& will be used.
25460 Normal SMTP delivery is not able to make strong demands of TLS cipher
25461 configuration, because delivery will fall back to plaintext.  Once DANE has
25462 been determined to be in effect, there is no plaintext fallback and making the
25463 TLS cipherlist configuration stronger will increase security, rather than
25464 counter-intuitively decreasing it.
25465 If the option expands to be empty or is forced to fail, then it will
25466 be treated as unset and &%tls_require_ciphers%& will be used instead.
25467
25468
25469 .option data_timeout smtp time 5m
25470 .cindex timeout "for transmitted SMTP data blocks"
25471 This sets a timeout for the transmission of each block in the data portion of
25472 the message. As a result, the overall timeout for a message depends on the size
25473 of the message. Its value must not be zero. See also &%final_timeout%&.
25474
25475
25476 .option dkim_canon smtp string&!! unset
25477 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25478 .option dkim_domain smtp "string list&!!" unset
25479 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25480 .option dkim_hash smtp string&!! sha256
25481 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25482 .option dkim_identity smtp string&!! unset
25483 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25484 .option dkim_private_key smtp string&!! unset
25485 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25486 .option dkim_selector smtp string&!! unset
25487 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25488 .option dkim_strict smtp string&!! unset
25489 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25490 .option dkim_sign_headers smtp string&!! "per RFC"
25491 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25492 .option dkim_timestamps smtp string&!! unset
25493 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25494
25495
25496 .option delay_after_cutoff smtp boolean true
25497 .cindex "final cutoff" "retries, controlling"
25498 .cindex retry "final cutoff"
25499 This option controls what happens when all remote IP addresses for a given
25500 domain have been inaccessible for so long that they have passed their retry
25501 cutoff times.
25502
25503 In the default state, if the next retry time has not been reached for any of
25504 them, the address is bounced without trying any deliveries. In other words,
25505 Exim delays retrying an IP address after the final cutoff time until a new
25506 retry time is reached, and can therefore bounce an address without ever trying
25507 a delivery, when machines have been down for a long time. Some people are
25508 unhappy at this prospect, so...
25509
25510 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25511 addresses are past their final cutoff time, Exim tries to deliver to those
25512 IP addresses that have not been tried since the message arrived. If there are
25513 none, of if they all fail, the address is bounced. In other words, it does not
25514 delay when a new message arrives, but immediately tries those expired IP
25515 addresses that haven't been tried since the message arrived. If there is a
25516 continuous stream of messages for the dead hosts, unsetting
25517 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25518 to them.
25519
25520
25521 .option dns_qualify_single smtp boolean true
25522 If the &%hosts%& or &%fallback_hosts%& option is being used,
25523 and the &%gethostbyname%& option is false,
25524 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25525 in chapter &<<CHAPdnslookup>>& for more details.
25526
25527
25528 .option dns_search_parents smtp boolean false
25529 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25530 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25531 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25532 details.
25533
25534
25535 .option dnssec_request_domains smtp "domain list&!!" *
25536 .cindex "MX record" "security"
25537 .cindex "DNSSEC" "MX lookup"
25538 .cindex "security" "MX lookup"
25539 .cindex "DNS" "DNSSEC"
25540 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25541 the DNSSEC request bit set. Setting this transport option is only useful if the
25542 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25543 router option.
25544
25545
25546
25547 .option dnssec_require_domains smtp "domain list&!!" unset
25548 .cindex "MX record" "security"
25549 .cindex "DNSSEC" "MX lookup"
25550 .cindex "security" "MX lookup"
25551 .cindex "DNS" "DNSSEC"
25552 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25553 the DNSSEC request bit set.  Setting this transport option is only
25554 useful if the transport overrides or sets the host names. See the
25555 &%dnssec_require_domains%& router option.
25556
25557
25558
25559 .option dscp smtp string&!! unset
25560 .cindex "DCSP" "outbound"
25561 This option causes the DSCP value associated with a socket to be set to one
25562 of a number of fixed strings or to numeric value.
25563 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25564 Common values include &`throughput`&, &`mincost`&, and on newer systems
25565 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25566
25567 The outbound packets from Exim will be marked with this value in the header
25568 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25569 that these values will have any effect, not be stripped by networking
25570 equipment, or do much of anything without cooperation with your Network
25571 Engineer and those of all network operators between the source and destination.
25572
25573
25574 .option fallback_hosts smtp "string list" unset
25575 .cindex "fallback" "hosts specified on transport"
25576 String expansion is not applied to this option. The argument must be a
25577 colon-separated list of host names or IP addresses, optionally also including
25578 port numbers, though the separator can be changed, as described in section
25579 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25580 item in a &%route_list%& setting for the &(manualroute)& router, as described
25581 in section &<<SECTformatonehostitem>>&.
25582
25583 Fallback hosts can also be specified on routers, which associate them with the
25584 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25585 &%fallback_hosts%& specified on the transport is used only if the address does
25586 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25587 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25588 However, &%hosts_randomize%& does apply to fallback host lists.
25589
25590 If Exim is unable to deliver to any of the hosts for a particular address, and
25591 the errors are not permanent rejections, the address is put on a separate
25592 transport queue with its host list replaced by the fallback hosts, unless the
25593 address was routed via MX records and the current host was in the original MX
25594 list. In that situation, the fallback host list is not used.
25595
25596 Once normal deliveries are complete, the fallback queue is delivered by
25597 re-running the same transports with the new host lists. If several failing
25598 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25599 copy of the message is sent.
25600
25601 The resolution of the host names on the fallback list is controlled by the
25602 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25603 both to cases when the host list comes with the address and when it is taken
25604 from &%hosts%&. This option provides a &"use a smart host only if delivery
25605 fails"& facility.
25606
25607
25608 .option final_timeout smtp time 10m
25609 .cindex timeout "for transmitted SMTP data accept"
25610 This is the timeout that applies while waiting for the response to the final
25611 line containing just &"."& that terminates a message. Its value must not be
25612 zero.
25613
25614 .option gethostbyname smtp boolean false
25615 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25616 being used, names are looked up using &[gethostbyname()]&
25617 (or &[getipnodebyname()]& when available)
25618 instead of using the DNS. Of course, that function may in fact use the DNS, but
25619 it may also consult other sources of information such as &_/etc/hosts_&.
25620
25621 .option gnutls_compat_mode smtp boolean unset
25622 This option controls whether GnuTLS is used in compatibility mode in an Exim
25623 server. This reduces security slightly, but improves interworking with older
25624 implementations of TLS.
25625
25626 .option helo_data smtp string&!! "see below"
25627 .cindex "HELO" "argument, setting"
25628 .cindex "EHLO" "argument, setting"
25629 .cindex "LHLO argument setting"
25630 The value of this option is expanded after a connection to a another host has
25631 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25632 command that starts the outgoing SMTP or LMTP session. The default value of the
25633 option is:
25634 .code
25635 $primary_hostname
25636 .endd
25637 During the expansion, the variables &$host$& and &$host_address$& are set to
25638 the identity of the remote host, and the variables &$sending_ip_address$& and
25639 &$sending_port$& are set to the local IP address and port number that are being
25640 used. These variables can be used to generate different values for different
25641 servers or different local IP addresses. For example, if you want the string
25642 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25643 interface address, you could use this:
25644 .code
25645 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25646   {${listextract{1}{<\n $value}}} \
25647   {$primary_hostname}}
25648 .endd
25649 The use of &%helo_data%& applies both to sending messages and when doing
25650 callouts.
25651
25652 .option host_name_extract smtp "string list&!!" "see below"
25653 .cindex "load balancer" "hosts behind"
25654 .cindex TLS resumption
25655 Some mail-accepting sites
25656 (notably Microsoft)
25657 operate many servers behind a network load-balancer.  When this is done,
25658 with separated TLS session caches, TLS session resuption becomes problematic.
25659 It will only succeed when the same server happens to be selected by the
25660 load-balancer, matching the session stored in the client's cache.
25661
25662 Exim can pull out a server name, if there is one, from the response to the
25663 client's SMTP EHLO command.
25664 For normal STARTTLS use, the default value of this option:
25665 .code
25666     ${if and { {match {$host} {.outlook.com\$}} \
25667                {match {$item} {\N^250-([\w.]+)\s\N}} \
25668              } {$1}}
25669 .endd
25670 suffices for one known case.
25671
25672 During the expansion of this option the &$item$& variable will have the
25673 server's EHLO response.
25674
25675 For TLS-on-connect connections we do not have an EHLO
25676 response to use. Because of this the default value of this option is
25677 set to a static string for those cases, meaning that resumption will
25678 always be attempted if permitted by the &%tls_resumption_hosts%& option.
25679
25680 The result of the option expansion is included in the key used to store and
25681 retrieve the TLS session, for session resumption.
25682
25683 Operators of high-load sites may wish to evaluate their logs for indications
25684 of other destination sites operating load-balancers, and develop a suitable
25685 expression for this option.
25686 The smtp:ehlo event and the &$tls_out_resumption$& variable
25687 will be useful for such work.
25688
25689 .option hosts smtp "string list&!!" unset
25690 Hosts are associated with an address by a router such as &(dnslookup)&, which
25691 finds the hosts by looking up the address domain in the DNS, or by
25692 &(manualroute)&, which has lists of hosts in its configuration. However,
25693 email addresses can be passed to the &(smtp)& transport by any router, and not
25694 all of them can provide an associated list of hosts.
25695
25696 The &%hosts%& option specifies a list of hosts to be used if the address being
25697 processed does not have any hosts associated with it. The hosts specified by
25698 &%hosts%& are also used, whether or not the address has its own hosts, if
25699 &%hosts_override%& is set.
25700
25701 The string is first expanded, before being interpreted as a colon-separated
25702 list of host names or IP addresses, possibly including port numbers. The
25703 separator may be changed to something other than colon, as described in section
25704 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25705 item in a &%route_list%& setting for the &(manualroute)& router, as described
25706 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25707 of the &(manualroute)& router is not available here.
25708
25709 If the expansion fails, delivery is deferred. Unless the failure was caused by
25710 the inability to complete a lookup, the error is logged to the panic log as
25711 well as the main log. Host names are looked up either by searching directly for
25712 address records in the DNS or by calling &[gethostbyname()]& (or
25713 &[getipnodebyname()]& when available), depending on the setting of the
25714 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25715 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25716 address are used.
25717
25718 During delivery, the hosts are tried in order, subject to their retry status,
25719 unless &%hosts_randomize%& is set.
25720
25721
25722 .option hosts_avoid_esmtp smtp "host list&!!" unset
25723 .cindex "ESMTP, avoiding use of"
25724 .cindex "HELO" "forcing use of"
25725 .cindex "EHLO" "avoiding use of"
25726 .cindex "PIPELINING" "avoiding the use of"
25727 This option is for use with broken hosts that announce ESMTP facilities (for
25728 example, PIPELINING) and then fail to implement them properly. When a host
25729 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25730 start of the SMTP session. This means that it cannot use any of the ESMTP
25731 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25732
25733
25734 .option hosts_avoid_pipelining smtp "host list&!!" unset
25735 .cindex "PIPELINING" "avoiding the use of"
25736 .cindex "ESMTP extensions" PIPELINING
25737 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25738 that matches this list, even if the server host advertises PIPELINING support.
25739
25740 .option hosts_pipe_connect smtp "host list&!!" unset
25741 .cindex "pipelining" "early connection"
25742 .cindex "pipelining" PIPECONNECT
25743 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25744 this option controls which to hosts the facility watched for
25745 and recorded, and used for subsequent connections.
25746
25747 The retry hints database is used for the record,
25748 and records are subject to the &%retry_data_expire%& option.
25749 When used, the pipelining saves on roundtrip times.
25750 It also turns SMTP into a client-first protocol
25751 so combines well with TCP Fast Open.
25752
25753 See also the &%pipelining_connect_advertise_hosts%& main option.
25754
25755 Note:
25756 When the facility is used, if the transport &%interface%& option is unset
25757 the &%helo_data%& option
25758 will be expanded before the &$sending_ip_address$& variable
25759 is filled in.
25760 A check is made for the use of that variable, without the
25761 presence of a &"def:"& test on it, but suitably complex coding
25762 can avoid the check and produce unexpected results.
25763 You have been warned.
25764
25765
25766 .option hosts_avoid_tls smtp "host list&!!" unset
25767 .cindex "TLS" "avoiding for certain hosts"
25768 Exim will not try to start a TLS session when delivering to any host that
25769 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25770
25771 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25772 .cindex "TLS" "avoiding for certain hosts"
25773 Exim will not try to start a TLS session for a verify callout,
25774 or when delivering in cutthrough mode,
25775 to any host that matches this list.
25776
25777
25778 .option hosts_max_try smtp integer 5
25779 .cindex "host" "maximum number to try"
25780 .cindex "limit" "number of hosts tried"
25781 .cindex "limit" "number of MX tried"
25782 .cindex "MX record" "maximum tried"
25783 This option limits the number of IP addresses that are tried for any one
25784 delivery in cases where there are temporary delivery errors. Section
25785 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25786
25787
25788 .option hosts_max_try_hardlimit smtp integer 50
25789 This is an additional check on the maximum number of IP addresses that Exim
25790 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25791 why it exists.
25792
25793
25794
25795 .option hosts_nopass_tls smtp "host list&!!" unset
25796 .cindex "TLS" "passing connection"
25797 .cindex "multiple SMTP deliveries"
25798 .cindex "TLS" "multiple message deliveries"
25799 For any host that matches this list, a connection on which a TLS session has
25800 been started will not be passed to a new delivery process for sending another
25801 message on the same connection. See section &<<SECTmulmessam>>& for an
25802 explanation of when this might be needed.
25803
25804 .option hosts_noproxy_tls smtp "host list&!!" unset
25805 .cindex "TLS" "passing connection"
25806 .cindex "multiple SMTP deliveries"
25807 .cindex "TLS" "multiple message deliveries"
25808 For any host that matches this list, a TLS session which has
25809 been started will not be passed to a new delivery process for sending another
25810 message on the same session.
25811
25812 The traditional implementation closes down TLS and re-starts it in the new
25813 process, on the same open TCP connection, for each successive message
25814 sent.  If permitted by this option a pipe to to the new process is set up
25815 instead, and the original process maintains the TLS connection and proxies
25816 the SMTP connection from and to the new process and any subsequents.
25817 The new process has no access to TLS information, so cannot include it in
25818 logging.
25819
25820
25821
25822 .option hosts_override smtp boolean false
25823 If this option is set and the &%hosts%& option is also set, any hosts that are
25824 attached to the address are ignored, and instead the hosts specified by the
25825 &%hosts%& option are always used. This option does not apply to
25826 &%fallback_hosts%&.
25827
25828
25829 .option hosts_randomize smtp boolean false
25830 .cindex "randomized host list"
25831 .cindex "host" "list of; randomized"
25832 .cindex "fallback" "randomized hosts"
25833 If this option is set, and either the list of hosts is taken from the
25834 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25835 were not obtained from MX records (this includes fallback hosts from the
25836 router), and were not randomized by the router, the order of trying the hosts
25837 is randomized each time the transport runs. Randomizing the order of a host
25838 list can be used to do crude load sharing.
25839
25840 When &%hosts_randomize%& is true, a host list may be split into groups whose
25841 order is separately randomized. This makes it possible to set up MX-like
25842 behaviour. The boundaries between groups are indicated by an item that is just
25843 &`+`& in the host list. For example:
25844 .code
25845 hosts = host1:host2:host3:+:host4:host5
25846 .endd
25847 The order of the first three hosts and the order of the last two hosts is
25848 randomized for each use, but the first three always end up before the last two.
25849 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25850
25851 .option hosts_require_auth smtp "host list&!!" unset
25852 .cindex "authentication" "required by client"
25853 This option provides a list of servers for which authentication must succeed
25854 before Exim will try to transfer a message. If authentication fails for
25855 servers which are not in this list, Exim tries to send unauthenticated. If
25856 authentication fails for one of these servers, delivery is deferred. This
25857 temporary error is detectable in the retry rules, so it can be turned into a
25858 hard failure if required. See also &%hosts_try_auth%&, and chapter
25859 &<<CHAPSMTPAUTH>>& for details of authentication.
25860
25861
25862 .option hosts_request_ocsp smtp "host list&!!" "see below"
25863 .cindex "TLS" "requiring for certain servers"
25864 Exim will request a Certificate Status on a
25865 TLS session for any host that matches this list.
25866 &%tls_verify_certificates%& should also be set for the transport.
25867
25868 The default is &"**"& if DANE is not in use for the connection,
25869 or if DANE-TA us used.
25870 It is empty if DANE-EE is used.
25871
25872 .option hosts_require_alpn smtp "host list&!!" unset
25873 .cindex ALPN "require negotiation in client"
25874 .cindex TLS ALPN
25875 .cindex TLS "Application Layer Protocol Names"
25876 If the TLS library supports ALPN
25877 then a successful negotiation of ALPN will be required for any host
25878 matching the list, for TLS to be used.
25879 See also the &%tls_alpn%& option.
25880
25881 &*Note*&: prevention of fallback to in-clear connection is not
25882 managed by this option; see &%hosts_require_tls%&.
25883
25884 .option hosts_require_dane smtp "host list&!!" unset
25885 .cindex DANE "transport options"
25886 .cindex DANE "requiring for certain servers"
25887 If built with DANE support, Exim  will require that a DNSSEC-validated
25888 TLSA record is present for any host matching the list,
25889 and that a DANE-verified TLS connection is made.
25890 There will be no fallback to in-clear communication.
25891 See the &%dnssec_request_domains%& router and transport options.
25892 See section &<<SECDANE>>&.
25893
25894 .option hosts_require_ocsp smtp "host list&!!" unset
25895 .cindex "TLS" "requiring for certain servers"
25896 Exim will request, and check for a valid Certificate Status being given, on a
25897 TLS session for any host that matches this list.
25898 &%tls_verify_certificates%& should also be set for the transport.
25899
25900 .option hosts_require_tls smtp "host list&!!" unset
25901 .cindex "TLS" "requiring for certain servers"
25902 Exim will insist on using a TLS session when delivering to any host that
25903 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25904 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25905 incoming messages, use an appropriate ACL.
25906
25907 .option hosts_try_auth smtp "host list&!!" unset
25908 .cindex "authentication" "optional in client"
25909 This option provides a list of servers to which, provided they announce
25910 authentication support, Exim will attempt to authenticate as a client when it
25911 connects. If authentication fails
25912 and &%hosts_require_auth%& permits,
25913 Exim will try to transfer the message unauthenticated.
25914 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25915
25916 .option hosts_try_chunking smtp "host list&!!" *
25917 .cindex CHUNKING "enabling, in client"
25918 .cindex BDAT "SMTP command"
25919 .cindex "RFC 3030" "CHUNKING"
25920 This option provides a list of servers to which, provided they announce
25921 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25922 Unless DKIM signing is being done,
25923 BDAT will not be used in conjunction with a transport filter.
25924
25925 .option hosts_try_dane smtp "host list&!!" *
25926 .cindex DANE "transport options"
25927 .cindex DANE "attempting for certain servers"
25928 If built with DANE support, Exim  will look up a
25929 TLSA record for any host matching the list,
25930 If one is found and that lookup was DNSSEC-validated,
25931 then Exim requires that a DANE-verified TLS connection is made for that host;
25932 there will be no fallback to in-clear communication.
25933 See the &%dnssec_request_domains%& router and transport options.
25934 See section &<<SECDANE>>&.
25935
25936 .option hosts_try_fastopen smtp "host list&!!" *
25937 .cindex "fast open, TCP" "enabling, in client"
25938 .cindex "TCP Fast Open" "enabling, in client"
25939 .cindex "RFC 7413" "TCP Fast Open"
25940 This option provides a list of servers to which, provided
25941 the facility is supported by this system, Exim will attempt to
25942 perform a TCP Fast Open.
25943 No data is sent on the SYN segment but, if the remote server also
25944 supports the facility, it can send its SMTP banner immediately after
25945 the SYN,ACK segment.  This can save up to one round-trip time.
25946
25947 The facility is only active for previously-contacted servers,
25948 as the initiator must present a cookie in the SYN segment.
25949
25950 On (at least some) current Linux distributions the facility must be enabled
25951 in the kernel by the sysadmin before the support is usable.
25952 There is no option for control of the server side; if the system supports
25953 it it is always enabled.  Note that lengthy operations in the connect ACL,
25954 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25955
25956 .option hosts_try_prdr smtp "host list&!!" *
25957 .cindex "PRDR" "enabling, optional in client"
25958 .cindex "ESMTP extensions" PRDR
25959 This option provides a list of servers to which, provided they announce
25960 PRDR support, Exim will attempt to negotiate PRDR
25961 for multi-recipient messages.
25962 The option can usually be left as default.
25963
25964 .option interface smtp "string list&!!" unset
25965 .cindex "bind IP address"
25966 .cindex "IP address" "binding"
25967 .vindex "&$host$&"
25968 .vindex "&$host_address$&"
25969 This option specifies which interface to bind to when making an outgoing SMTP
25970 call. The value is an IP address, not an interface name such as
25971 &`eth0`&. Do not confuse this with the interface address that was used when a
25972 message was received, which is in &$received_ip_address$&, formerly known as
25973 &$interface_address$&. The name was changed to minimize confusion with the
25974 outgoing interface address. There is no variable that contains an outgoing
25975 interface address because, unless it is set by this option, its value is
25976 unknown.
25977
25978 During the expansion of the &%interface%& option the variables &$host$& and
25979 &$host_address$& refer to the host to which a connection is about to be made
25980 during the expansion of the string. Forced expansion failure, or an empty
25981 string result causes the option to be ignored. Otherwise, after expansion, the
25982 string must be a list of IP addresses, colon-separated by default, but the
25983 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25984 For example:
25985 .code
25986 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25987 .endd
25988 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25989 connection. If none of them are the correct type, the option is ignored. If
25990 &%interface%& is not set, or is ignored, the system's IP functions choose which
25991 interface to use if the host has more than one.
25992
25993
25994 .option keepalive smtp boolean true
25995 .cindex "keepalive" "on outgoing connection"
25996 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25997 connections. When set, it causes the kernel to probe idle connections
25998 periodically, by sending packets with &"old"& sequence numbers. The other end
25999 of the connection should send a acknowledgment if the connection is still okay
26000 or a reset if the connection has been aborted. The reason for doing this is
26001 that it has the beneficial effect of freeing up certain types of connection
26002 that can get stuck when the remote host is disconnected without tidying up the
26003 TCP/IP call properly. The keepalive mechanism takes several hours to detect
26004 unreachable hosts.
26005
26006
26007 .option lmtp_ignore_quota smtp boolean false
26008 .cindex "LMTP" "ignoring quota errors"
26009 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
26010 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
26011 has advertised support for IGNOREQUOTA in its response to the LHLO command.
26012
26013 .option max_rcpt smtp integer&!! 100
26014 .cindex "RCPT" "maximum number of outgoing"
26015 This option,
26016 after expansion,
26017 limits the number of RCPT commands that are sent in a single
26018 SMTP message transaction.
26019 A value setting of zero disables the limit.
26020
26021 If a constant is given,
26022 each set of addresses is treated independently, and
26023 so can cause parallel connections to the same host if &%remote_max_parallel%&
26024 permits this.
26025
26026 .cindex "ESMTP extensions" LIMITS
26027 If the peer advertises a LIMITS extension with a RCPTMAX value,
26028 and either TLSS is in use or was not advertised,
26029 that value also constrains the result of this option
26030 and no parallel connections will be caused on meeting the RCPTMAX limit.
26031
26032
26033 .option message_linelength_limit smtp integer 998
26034 .cindex "line length" limit
26035 This option sets the maximum line length, in bytes, that the transport
26036 will send.  Any messages with lines exceeding the given value
26037 (before a transport filter, if any)
26038 will fail and a failure-DSN ("bounce") message will if possible be returned
26039 to the sender.
26040 The default value is that defined by the SMTP standards.
26041
26042 It is generally wise to also check in the data ACL so that messages
26043 received via SMTP can be refused without producing a bounce.
26044
26045
26046 .option multi_domain smtp boolean&!! true
26047 .vindex "&$domain$&"
26048 When this option is set, the &(smtp)& transport can handle a number of
26049 addresses containing a mixture of different domains provided they all resolve
26050 to the same list of hosts. Turning the option off restricts the transport to
26051 handling only one domain at a time. This is useful if you want to use
26052 &$domain$& in an expansion for the transport, because it is set only when there
26053 is a single domain involved in a remote delivery.
26054
26055 It is expanded per-address and can depend on any of
26056 &$address_data$&, &$domain_data$&, &$local_part_data$&,
26057 &$host$&, &$host_address$& and &$host_port$&.
26058
26059 If the connection is DANE-enabled then this option is ignored;
26060 only messages having the domain used for the DANE TLSA lookup are
26061 sent on the connection.
26062
26063 .cindex "ESMTP extensions" LIMITS
26064 If the peer advertises a LIMITS extension with a RCPTDOMAINMAX value,
26065 and either TLSS is in use or was not advertised,
26066 this option is regarded as being false.
26067
26068
26069 .option port smtp string&!! "see below"
26070 .cindex "port" "sending TCP/IP"
26071 .cindex "TCP/IP" "setting outgoing port"
26072 This option specifies the TCP/IP port on the server to which Exim connects.
26073 &*Note:*& Do not confuse this with the port that was used when a message was
26074 received, which is in &$received_port$&, formerly known as &$interface_port$&.
26075 The name was changed to minimize confusion with the outgoing port. There is no
26076 variable that contains an outgoing port.
26077
26078 If the value of this option begins with a digit it is taken as a port number;
26079 otherwise it is looked up using &[getservbyname()]&. The default value is
26080 normally &"smtp"&,
26081 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
26082 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
26083 If the expansion fails, or if a port number cannot be found, delivery
26084 is deferred.
26085
26086 Note that at least one Linux distribution has been seen failing
26087 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
26088
26089
26090
26091 .option protocol smtp string smtp
26092 .cindex "LMTP" "over TCP/IP"
26093 .cindex "ssmtp protocol" "outbound"
26094 .cindex "TLS" "SSL-on-connect outbound"
26095 .vindex "&$port$&"
26096 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
26097 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
26098 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
26099 deliveries into closed message stores. Exim also has support for running LMTP
26100 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
26101
26102 &*Note*&: When using LMTP it should be considered whether the default values
26103 for some other features, such as DANE, are appropriate.
26104
26105 If this option is set to &"smtps"&, the default value for the &%port%& option
26106 changes to &"smtps"&, and the transport initiates TLS immediately after
26107 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
26108 The Internet standards bodies used to strongly discourage use of this mode,
26109 but as of RFC 8314 it is preferred over STARTTLS for message submission
26110 (as distinct from MTA-MTA communication).
26111
26112
26113 .option retry_include_ip_address smtp boolean&!! true
26114 Exim normally includes both the host name and the IP address in the key it
26115 constructs for indexing retry data after a temporary delivery failure. This
26116 means that when one of several IP addresses for a host is failing, it gets
26117 tried periodically (controlled by the retry rules), but use of the other IP
26118 addresses is not affected.
26119
26120 However, in some dialup environments hosts are assigned a different IP address
26121 each time they connect. In this situation the use of the IP address as part of
26122 the retry key leads to undesirable behaviour. Setting this option false causes
26123 Exim to use only the host name.
26124 Since it is expanded it can be made to depend on the host or domain.
26125
26126
26127 .option serialize_hosts smtp "host list&!!" unset
26128 .cindex "serializing connections"
26129 .cindex "host" "serializing connections"
26130 Because Exim operates in a distributed manner, if several messages for the same
26131 host arrive at around the same time, more than one simultaneous connection to
26132 the remote host can occur. This is not usually a problem except when there is a
26133 slow link between the hosts. In that situation it may be helpful to restrict
26134 Exim to one connection at a time. This can be done by setting
26135 &%serialize_hosts%& to match the relevant hosts.
26136
26137 .cindex "hints database" "serializing deliveries to a host"
26138 Exim implements serialization by means of a hints database in which a record is
26139 written whenever a process connects to one of the restricted hosts. The record
26140 is deleted when the connection is completed. Obviously there is scope for
26141 records to get left lying around if there is a system or program crash. To
26142 guard against this, Exim ignores any records that are more than six hours old.
26143
26144 If you set up this kind of serialization, you should also arrange to delete the
26145 relevant hints database whenever your system reboots. The names of the files
26146 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26147 may be one or two files, depending on the type of DBM in use. The same files
26148 are used for ETRN serialization.
26149
26150 See also the &%max_parallel%& generic transport option.
26151
26152
26153 .option size_addition smtp integer 1024
26154 .cindex "SIZE" "ESMTP extension"
26155 .cindex "message" "size issue for transport filter"
26156 .cindex "size" "of message"
26157 .cindex "transport" "filter"
26158 .cindex "filter" "transport filter"
26159 If a remote SMTP server indicates that it supports the SIZE option of the
26160 MAIL command, Exim uses this to pass over the message size at the start of
26161 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26162 sends, to allow for headers and other text that may be added during delivery by
26163 configuration options or in a transport filter. It may be necessary to increase
26164 this if a lot of text is added to messages.
26165
26166 Alternatively, if the value of &%size_addition%& is set negative, it disables
26167 the use of the SIZE option altogether.
26168
26169
26170 .option socks_proxy smtp string&!! unset
26171 .cindex proxy SOCKS
26172 This option enables use of SOCKS proxies for connections made by the
26173 transport.  For details see section &<<SECTproxySOCKS>>&.
26174
26175
26176 .option tls_alpn smtp string&!! unset
26177 .cindex TLS "Application Layer Protocol Names"
26178 .cindex TLS ALPN
26179 .cindex ALPN "set name in client"
26180 If this option is set
26181 and the TLS library supports ALPN,
26182 the value given is used.
26183
26184 As of writing no value has been standardised for email use.
26185 The authors suggest using &"smtp"&.
26186
26187
26188
26189 .option tls_certificate smtp string&!! unset
26190 .cindex "TLS" "client certificate, location of"
26191 .cindex "certificate" "client, location of"
26192 .vindex "&$host$&"
26193 .vindex "&$host_address$&"
26194 The value of this option must be the absolute path to a file which contains the
26195 client's certificate, for possible use when sending a message over an encrypted
26196 connection. The values of &$host$& and &$host_address$& are set to the name and
26197 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26198 details of TLS.
26199
26200 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26201 certificate when sending messages as a client. The global option of the same
26202 name specifies the certificate for Exim as a server; it is not automatically
26203 assumed that the same certificate should be used when Exim is operating as a
26204 client.
26205
26206
26207 .option tls_crl smtp string&!! unset
26208 .cindex "TLS" "client certificate revocation list"
26209 .cindex "certificate" "revocation list for client"
26210 This option specifies a certificate revocation list. The expanded value must
26211 be the name of a file that contains a CRL in PEM format.
26212
26213
26214 .option tls_dh_min_bits smtp integer 1024
26215 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26216 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26217 key agreement is negotiated, the server will provide a large prime number
26218 for use.  This option establishes the minimum acceptable size of that number.
26219 If the parameter offered by the server is too small, then the TLS handshake
26220 will fail.
26221
26222 Only supported when using GnuTLS.
26223
26224
26225 .option tls_privatekey smtp string&!! unset
26226 .cindex "TLS" "client private key, location of"
26227 .vindex "&$host$&"
26228 .vindex "&$host_address$&"
26229 The value of this option must be the absolute path to a file which contains the
26230 client's private key. This is used when sending a message over an encrypted
26231 connection using a client certificate. The values of &$host$& and
26232 &$host_address$& are set to the name and address of the server during the
26233 expansion. If this option is unset, or the expansion is forced to fail, or the
26234 result is an empty string, the private key is assumed to be in the same file as
26235 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26236
26237
26238 .option tls_require_ciphers smtp string&!! unset
26239 .cindex "TLS" "requiring specific ciphers"
26240 .cindex "cipher" "requiring specific"
26241 .vindex "&$host$&"
26242 .vindex "&$host_address$&"
26243 The value of this option must be a list of permitted cipher suites, for use
26244 when setting up an outgoing encrypted connection. (There is a global option of
26245 the same name for controlling incoming connections.) The values of &$host$& and
26246 &$host_address$& are set to the name and address of the server during the
26247 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26248 is used in different ways by OpenSSL and GnuTLS (see sections
26249 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26250 ciphers is a preference order.
26251
26252
26253 .option tls_resumption_hosts smtp "host list&!!" unset
26254 .cindex TLS resumption
26255 This option controls which connections to use the TLS resumption feature.
26256 See &<<SECTresumption>>& for details.
26257
26258
26259
26260 .option tls_sni smtp string&!! unset
26261 .cindex "TLS" "Server Name Indication"
26262 .cindex "TLS" SNI
26263 .cindex SNI "setting in client"
26264 .vindex "&$tls_sni$&"
26265 If this option is set
26266 and the connection is not DANE-validated
26267 then it sets the $tls_out_sni variable and causes any
26268 TLS session to pass this value as the Server Name Indication extension to
26269 the remote side, which can be used by the remote side to select an appropriate
26270 certificate and private key for the session.
26271
26272 See &<<SECTtlssni>>& for more information.
26273
26274 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26275 TLS extensions.
26276
26277
26278
26279
26280 .option tls_tempfail_tryclear smtp boolean true
26281 .cindex "4&'xx'& responses" "to STARTTLS"
26282 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26283 setting up a TLS session, this option determines whether or not Exim should try
26284 to deliver the message unencrypted. If it is set false, delivery to the
26285 current host is deferred; if there are other hosts, they are tried. If this
26286 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26287 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26288 TLS negotiation fails, Exim closes the current connection (because it is in an
26289 unknown state), opens a new one to the same host, and then tries the delivery
26290 in clear.
26291
26292
26293 .option tls_try_verify_hosts smtp "host list&!!" *
26294 .cindex "TLS" "server certificate verification"
26295 .cindex "certificate" "verification of server"
26296 This option gives a list of hosts for which, on encrypted connections,
26297 certificate verification will be tried but need not succeed.
26298 The &%tls_verify_certificates%& option must also be set.
26299 Note that unless the host is in this list
26300 TLS connections will be denied to hosts using self-signed certificates
26301 when &%tls_verify_certificates%& is matched.
26302 The &$tls_out_certificate_verified$& variable is set when
26303 certificate verification succeeds.
26304
26305
26306 .option tls_verify_cert_hostnames smtp "host list&!!" *
26307 .cindex "TLS" "server certificate hostname verification"
26308 .cindex "certificate" "verification of server"
26309 This option give a list of hosts for which,
26310 while verifying the server certificate,
26311 checks will be included on the host name
26312 (note that this will generally be the result of a DNS MX lookup)
26313 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26314 Wildcard names are permitted,
26315 limited to being the initial component of a 3-or-more component FQDN.
26316
26317 There is no equivalent checking on client certificates.
26318
26319
26320 .option tls_verify_certificates smtp string&!! system
26321 .cindex "TLS" "server certificate verification"
26322 .cindex "certificate" "verification of server"
26323 .vindex "&$host$&"
26324 .vindex "&$host_address$&"
26325 The value of this option must be either the
26326 word "system"
26327 or the absolute path to
26328 a file or directory containing permitted certificates for servers,
26329 for use when setting up an encrypted connection.
26330
26331 The "system" value for the option will use a location compiled into the SSL library.
26332 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26333 is taken as empty and an explicit location
26334 must be specified.
26335
26336 The use of a directory for the option value is not available for GnuTLS versions
26337 preceding 3.3.6 and a single file must be used.
26338
26339 With OpenSSL the certificates specified
26340 explicitly
26341 either by file or directory
26342 are added to those given by the system default location.
26343
26344 The values of &$host$& and
26345 &$host_address$& are set to the name and address of the server during the
26346 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26347
26348 For back-compatibility,
26349 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26350 (a single-colon empty list counts as being set)
26351 and certificate verification fails the TLS connection is closed.
26352
26353
26354 .option tls_verify_hosts smtp "host list&!!" unset
26355 .cindex "TLS" "server certificate verification"
26356 .cindex "certificate" "verification of server"
26357 This option gives a list of hosts for which, on encrypted connections,
26358 certificate verification must succeed.
26359 The &%tls_verify_certificates%& option must also be set.
26360 If both this option and &%tls_try_verify_hosts%& are unset
26361 operation is as if this option selected all hosts.
26362 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26363 that connections use TLS.
26364 Fallback to in-clear communication will be done unless restricted by
26365 the &%hosts_require_tls%& option.
26366
26367 .option utf8_downconvert smtp integer&!! -1
26368 .cindex utf8 "address downconversion"
26369 .cindex i18n "utf8 address downconversion"
26370 If built with internationalization support,
26371 this option controls conversion of UTF-8 in message envelope addresses
26372 to a-label form.
26373 If, after expansion, the value is 1, 0, or -1 then this value overrides
26374 any value previously set for the message.  Otherwise, any previously
26375 set value is used.  To permit use of a previous value,
26376 set this option to an empty string.
26377 For details on the values see section &<<SECTi18nMTA>>&.
26378
26379
26380
26381
26382 .section "How the limits for the number of hosts to try are used" &&&
26383          "SECTvalhosmax"
26384 .cindex "host" "maximum number to try"
26385 .cindex "limit" "hosts; maximum number tried"
26386 There are two options that are concerned with the number of hosts that are
26387 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26388 &%hosts_max_try_hardlimit%&.
26389
26390
26391 The &%hosts_max_try%& option limits the number of hosts that are tried
26392 for a single delivery. However, despite the term &"host"& in its name, the
26393 option actually applies to each IP address independently. In other words, a
26394 multihomed host is treated as several independent hosts, just as it is for
26395 retrying.
26396
26397 Many of the larger ISPs have multiple MX records which often point to
26398 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26399 created as a result of routing one of these domains.
26400
26401 Trying every single IP address on such a long list does not seem sensible; if
26402 several at the top of the list fail, it is reasonable to assume there is some
26403 problem that is likely to affect all of them. Roughly speaking, the value of
26404 &%hosts_max_try%& is the maximum number that are tried before deferring the
26405 delivery. However, the logic cannot be quite that simple.
26406
26407 Firstly, IP addresses that are skipped because their retry times have not
26408 arrived do not count, and in addition, addresses that are past their retry
26409 limits are also not counted, even when they are tried. This means that when
26410 some IP addresses are past their retry limits, more than the value of
26411 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26412 that all IP addresses are considered before timing out an email address (but
26413 see below for an exception).
26414
26415 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26416 list to see if there is a subsequent host with a different (higher valued) MX.
26417 If there is, that host is considered next, and the current IP address is used
26418 but not counted. This behaviour helps in the case of a domain with a retry rule
26419 that hardly ever delays any hosts, as is now explained:
26420
26421 Consider the case of a long list of hosts with one MX value, and a few with a
26422 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26423 hosts at the top of the list are tried at first. With the default retry rule,
26424 which specifies increasing retry times, the higher MX hosts are eventually
26425 tried when those at the top of the list are skipped because they have not
26426 reached their retry times.
26427
26428 However, it is common practice to put a fixed short retry time on domains for
26429 large ISPs, on the grounds that their servers are rarely down for very long.
26430 Unfortunately, these are exactly the domains that tend to resolve to long lists
26431 of hosts. The short retry time means that the lowest MX hosts are tried every
26432 time. The attempts may be in a different order because of random sorting, but
26433 without the special MX check, the higher MX hosts would never be tried until
26434 all the lower MX hosts had timed out (which might be several days), because
26435 there are always some lower MX hosts that have reached their retry times. With
26436 the special check, Exim considers at least one IP address from each MX value at
26437 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26438 reached.
26439
26440 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26441 particular, Exim normally eventually tries all the IP addresses before timing
26442 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26443 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26444 been set up with hundreds of IP addresses for some domains. It can
26445 take a very long time indeed for an address to time out in these cases.
26446
26447 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26448 Exim never tries more than this number of IP addresses; if it hits this limit
26449 and they are all timed out, the email address is bounced, even though not all
26450 possible IP addresses have been tried.
26451 .ecindex IIDsmttra1
26452 .ecindex IIDsmttra2
26453
26454
26455
26456
26457
26458 . ////////////////////////////////////////////////////////////////////////////
26459 . ////////////////////////////////////////////////////////////////////////////
26460
26461 .chapter "Address rewriting" "CHAPrewrite"
26462 .scindex IIDaddrew "rewriting" "addresses"
26463 There are some circumstances in which Exim automatically rewrites domains in
26464 addresses. The two most common are when an address is given without a domain
26465 (referred to as an &"unqualified address"&) or when an address contains an
26466 abbreviated domain that is expanded by DNS lookup.
26467
26468 Unqualified envelope addresses are accepted only for locally submitted
26469 messages, or for messages that are received from hosts matching
26470 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26471 appropriate. Unqualified addresses in header lines are qualified if they are in
26472 locally submitted messages, or messages from hosts that are permitted to send
26473 unqualified envelope addresses. Otherwise, unqualified addresses in header
26474 lines are neither qualified nor rewritten.
26475
26476 One situation in which Exim does &'not'& automatically rewrite a domain is
26477 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26478 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26479 do this. The new RFCs do not contain this suggestion.
26480
26481
26482 .section "Explicitly configured address rewriting" "SECID147"
26483 This chapter describes the rewriting rules that can be used in the
26484 main rewrite section of the configuration file, and also in the generic
26485 &%headers_rewrite%& option that can be set on any transport.
26486
26487 Some people believe that configured address rewriting is a Mortal Sin.
26488 Others believe that life is not possible without it. Exim provides the
26489 facility; you do not have to use it.
26490
26491 The main rewriting rules that appear in the &"rewrite"& section of the
26492 configuration file are applied to addresses in incoming messages, both envelope
26493 addresses and addresses in header lines. Each rule specifies the types of
26494 address to which it applies.
26495
26496 Whether or not addresses in header lines are rewritten depends on the origin of
26497 the headers and the type of rewriting. Global rewriting, that is, rewriting
26498 rules from the rewrite section of the configuration file, is applied only to
26499 those headers that were received with the message. Header lines that are added
26500 by ACLs or by a system filter or by individual routers or transports (which
26501 are specific to individual recipient addresses) are not rewritten by the global
26502 rules.
26503
26504 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26505 applies all headers except those added by routers and transports. That is, as
26506 well as the headers that were received with the message, it also applies to
26507 headers that were added by an ACL or a system filter.
26508
26509
26510 In general, rewriting addresses from your own system or domain has some
26511 legitimacy. Rewriting other addresses should be done only with great care and
26512 in special circumstances. The author of Exim believes that rewriting should be
26513 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26514 Although it can sometimes be used as a routing tool, this is very strongly
26515 discouraged.
26516
26517 There are two commonly encountered circumstances where rewriting is used, as
26518 illustrated by these examples:
26519
26520 .ilist
26521 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26522 exchange mail with each other behind a firewall, but there is only a single
26523 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26524 &'hitch.fict.example'& when sending mail off-site.
26525 .next
26526 A host rewrites the local parts of its own users so that, for example,
26527 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26528 .endlist
26529
26530
26531
26532 .section "When does rewriting happen?" "SECID148"
26533 .cindex "rewriting" "timing of"
26534 .cindex "&ACL;" "rewriting addresses in"
26535 Configured address rewriting can take place at several different stages of a
26536 message's processing.
26537
26538 .vindex "&$sender_address$&"
26539 At the start of an ACL for MAIL, the sender address may have been rewritten
26540 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26541 ordinary rewrite rules have yet been applied. If, however, the sender address
26542 is verified in the ACL, it is rewritten before verification, and remains
26543 rewritten thereafter. The subsequent value of &$sender_address$& is the
26544 rewritten address. This also applies if sender verification happens in a
26545 RCPT ACL. Otherwise, when the sender address is not verified, it is
26546 rewritten as soon as a message's header lines have been received.
26547
26548 .vindex "&$domain$&"
26549 .vindex "&$local_part$&"
26550 Similarly, at the start of an ACL for RCPT, the current recipient's address
26551 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26552 rewrite rules have yet been applied to it. However, the behaviour is different
26553 from the sender address when a recipient is verified. The address is rewritten
26554 for the verification, but the rewriting is not remembered at this stage. The
26555 value of &$local_part$& and &$domain$& after verification are always the same
26556 as they were before (that is, they contain the unrewritten &-- except for
26557 SMTP-time rewriting &-- address).
26558
26559 As soon as a message's header lines have been received, all the envelope
26560 recipient addresses are permanently rewritten, and rewriting is also applied to
26561 the addresses in the header lines (if configured). This happens before adding
26562 any header lines that were specified in MAIL or RCPT ACLs, and
26563 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26564 before the DATA ACL and &[local_scan()]& functions are run.
26565
26566 When an address is being routed, either for delivery or for verification,
26567 rewriting is applied immediately to child addresses that are generated by
26568 redirection, unless &%no_rewrite%& is set on the router.
26569
26570 .cindex "envelope from"
26571 .cindex "envelope sender" "rewriting at transport time"
26572 .cindex "rewriting" "at transport time"
26573 .cindex "header lines" "rewriting at transport time"
26574 At transport time, additional rewriting of addresses in header lines can be
26575 specified by setting the generic &%headers_rewrite%& option on a transport.
26576 This option contains rules that are identical in form to those in the rewrite
26577 section of the configuration file. They are applied to the original message
26578 header lines and any that were added by ACLs or a system filter. They are not
26579 applied to header lines that are added by routers or the transport.
26580
26581 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26582 transport option. However, it is not possible to rewrite envelope recipients at
26583 transport time.
26584
26585
26586
26587
26588 .section "Testing the rewriting rules that apply on input" "SECID149"
26589 .cindex "rewriting" "testing"
26590 .cindex "testing" "rewriting"
26591 Exim's input rewriting configuration appears in a part of the runtime
26592 configuration file headed by &"begin rewrite"&. It can be tested by the
26593 &%-brw%& command line option. This takes an address (which can be a full RFC
26594 2822 address) as its argument. The output is a list of how the address would be
26595 transformed by the rewriting rules for each of the different places it might
26596 appear in an incoming message, that is, for each different header and for the
26597 envelope sender and recipient fields. For example,
26598 .code
26599 exim -brw ph10@exim.workshop.example
26600 .endd
26601 might produce the output
26602 .code
26603 sender: Philip.Hazel@exim.workshop.example
26604 from: Philip.Hazel@exim.workshop.example
26605 to: ph10@exim.workshop.example
26606 cc: ph10@exim.workshop.example
26607 bcc: ph10@exim.workshop.example
26608 reply-to: Philip.Hazel@exim.workshop.example
26609 env-from: Philip.Hazel@exim.workshop.example
26610 env-to: ph10@exim.workshop.example
26611 .endd
26612 which shows that rewriting has been set up for that address when used in any of
26613 the source fields, but not when it appears as a recipient address. At the
26614 present time, there is no equivalent way of testing rewriting rules that are
26615 set for a particular transport.
26616
26617
26618 .section "Rewriting rules" "SECID150"
26619 .cindex "rewriting" "rules"
26620 The rewrite section of the configuration file consists of lines of rewriting
26621 rules in the form
26622 .display
26623 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26624 .endd
26625 Rewriting rules that are specified for the &%headers_rewrite%& generic
26626 transport option are given as a colon-separated list. Each item in the list
26627 takes the same form as a line in the main rewriting configuration (except that
26628 any colons must be doubled, of course).
26629
26630 The formats of source patterns and replacement strings are described below.
26631 Each is terminated by white space, unless enclosed in double quotes, in which
26632 case normal quoting conventions apply inside the quotes. The flags are single
26633 characters which may appear in any order. Spaces and tabs between them are
26634 ignored.
26635
26636 For each address that could potentially be rewritten, the rules are scanned in
26637 order, and replacements for the address from earlier rules can themselves be
26638 replaced by later rules (but see the &"q"& and &"R"& flags).
26639
26640 The order in which addresses are rewritten is undefined, may change between
26641 releases, and must not be relied on, with one exception: when a message is
26642 received, the envelope sender is always rewritten first, before any header
26643 lines are rewritten. For example, the replacement string for a rewrite of an
26644 address in &'To:'& must not assume that the message's address in &'From:'& has
26645 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26646 that the envelope sender has already been rewritten.
26647
26648 .vindex "&$domain$&"
26649 .vindex "&$local_part$&"
26650 The variables &$local_part$& and &$domain$& can be used in the replacement
26651 string to refer to the address that is being rewritten. Note that lookup-driven
26652 rewriting can be done by a rule of the form
26653 .code
26654 *@*   ${lookup ...
26655 .endd
26656 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26657 refer to the address that is being rewritten.
26658
26659
26660 .section "Rewriting patterns" "SECID151"
26661 .cindex "rewriting" "patterns"
26662 .cindex "address list" "in a rewriting pattern"
26663 The source pattern in a rewriting rule is any item which may appear in an
26664 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26665 single-item address list, which means that it is expanded before being tested
26666 against the address. As always, if you use a regular expression as a pattern,
26667 you must take care to escape dollar and backslash characters, or use the &`\N`&
26668 facility to suppress string expansion within the regular expression.
26669
26670 Domains in patterns should be given in lower case. Local parts in patterns are
26671 case-sensitive. If you want to do case-insensitive matching of local parts, you
26672 can use a regular expression that starts with &`^(?i)`&.
26673
26674 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26675 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26676 depending on the type of match which occurred. These can be used in the
26677 replacement string to insert portions of the incoming address. &$0$& always
26678 refers to the complete incoming address. When a regular expression is used, the
26679 numerical variables are set from its capturing subexpressions. For other types
26680 of pattern they are set as follows:
26681
26682 .ilist
26683 If a local part or domain starts with an asterisk, the numerical variables
26684 refer to the character strings matched by asterisks, with &$1$& associated with
26685 the first asterisk, and &$2$& with the second, if present. For example, if the
26686 pattern
26687 .code
26688 *queen@*.fict.example
26689 .endd
26690 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26691 .code
26692 $0 = hearts-queen@wonderland.fict.example
26693 $1 = hearts-
26694 $2 = wonderland
26695 .endd
26696 Note that if the local part does not start with an asterisk, but the domain
26697 does, it is &$1$& that contains the wild part of the domain.
26698
26699 .next
26700 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26701 of the domain are placed in the next available numerical variables. Suppose,
26702 for example, that the address &'foo@bar.baz.example'& is processed by a
26703 rewriting rule of the form
26704 .display
26705 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26706 .endd
26707 and the key in the file that matches the domain is &`*.baz.example`&. Then
26708 .code
26709 $1 = foo
26710 $2 = bar
26711 $3 = baz.example
26712 .endd
26713 If the address &'foo@baz.example'& is looked up, this matches the same
26714 wildcard file entry, and in this case &$2$& is set to the empty string, but
26715 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26716 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26717 whole domain. For non-partial domain lookups, no numerical variables are set.
26718 .endlist
26719
26720
26721 .section "Rewriting replacements" "SECID152"
26722 .cindex "rewriting" "replacements"
26723 If the replacement string for a rule is a single asterisk, addresses that
26724 match the pattern and the flags are &'not'& rewritten, and no subsequent
26725 rewriting rules are scanned. For example,
26726 .code
26727 hatta@lookingglass.fict.example  *  f
26728 .endd
26729 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26730 &'From:'& headers.
26731
26732 .vindex "&$domain$&"
26733 .vindex "&$local_part$&"
26734 If the replacement string is not a single asterisk, it is expanded, and must
26735 yield a fully qualified address. Within the expansion, the variables
26736 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26737 Any letters they contain retain their original case &-- they are not lower
26738 cased. The numerical variables are set up according to the type of pattern that
26739 matched the address, as described above. If the expansion is forced to fail by
26740 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26741 current rule is abandoned, but subsequent rules may take effect. Any other
26742 expansion failure causes the entire rewriting operation to be abandoned, and an
26743 entry written to the panic log.
26744
26745
26746
26747 .subsection "Rewriting flags" "SSECID153"
26748 There are three different kinds of flag that may appear on rewriting rules:
26749
26750 .ilist
26751 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26752 c, f, h, r, s, t.
26753 .next
26754 A flag that specifies rewriting at SMTP time: S.
26755 .next
26756 Flags that control the rewriting process: Q, q, R, w.
26757 .endlist
26758
26759 For rules that are part of the &%headers_rewrite%& generic transport option,
26760 E, F, T, and S are not permitted.
26761
26762
26763
26764 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26765          "SSECID154"
26766 .cindex rewriting flags
26767 If none of the following flag letters, nor the &"S"& flag (see section
26768 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26769 and to both the sender and recipient fields of the envelope, whereas a
26770 transport-time rewriting rule just applies to all headers. Otherwise, the
26771 rewriting rule is skipped unless the relevant addresses are being processed.
26772 .display
26773 &`E`&       rewrite all envelope fields
26774 &`F`&       rewrite the envelope From field
26775 &`T`&       rewrite the envelope To field
26776 &`b`&       rewrite the &'Bcc:'& header
26777 &`c`&       rewrite the &'Cc:'& header
26778 &`f`&       rewrite the &'From:'& header
26779 &`h`&       rewrite all headers
26780 &`r`&       rewrite the &'Reply-To:'& header
26781 &`s`&       rewrite the &'Sender:'& header
26782 &`t`&       rewrite the &'To:'& header
26783 .endd
26784 "All headers" means all of the headers listed above that can be selected
26785 individually, plus their &'Resent-'& versions. It does not include
26786 other headers such as &'Subject:'& etc.
26787
26788 You should be particularly careful about rewriting &'Sender:'& headers, and
26789 restrict this to special known cases in your own domains.
26790
26791
26792 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26793 .cindex SMTP "rewriting malformed addresses"
26794 .cindex RCPT "rewriting argument of"
26795 .cindex MAIL "rewriting argument of"
26796 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26797 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26798 before any other processing; even before syntax checking. The pattern is
26799 required to be a regular expression, and it is matched against the whole of the
26800 data for the command, including any surrounding angle brackets.
26801
26802 .vindex "&$domain$&"
26803 .vindex "&$local_part$&"
26804 This form of rewrite rule allows for the handling of addresses that are not
26805 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26806 input). Because the input is not required to be a syntactically valid address,
26807 the variables &$local_part$& and &$domain$& are not available during the
26808 expansion of the replacement string. The result of rewriting replaces the
26809 original address in the MAIL or RCPT command.
26810
26811
26812 .subsection "Flags controlling the rewriting process" SSECID155
26813 There are four flags which control the way the rewriting process works. These
26814 take effect only when a rule is invoked, that is, when the address is of the
26815 correct type (matches the flags) and matches the pattern:
26816
26817 .ilist
26818 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26819 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26820 absence of &"Q"& the rewritten address must always include a domain.
26821 .next
26822 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26823 even if no rewriting actually takes place because of a &"fail"& in the
26824 expansion. The &"q"& flag is not effective if the address is of the wrong type
26825 (does not match the flags) or does not match the pattern.
26826 .next
26827 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26828 address, up to ten times. It can be combined with the &"q"& flag, to stop
26829 rewriting once it fails to match (after at least one successful rewrite).
26830 .next
26831 .cindex "rewriting" "whole addresses"
26832 When an address in a header is rewritten, the rewriting normally applies only
26833 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26834 left unchanged. For example, rewriting might change
26835 .code
26836 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26837 .endd
26838 into
26839 .code
26840 From: Ford Prefect <prefectf@hitch.fict.example>
26841 .endd
26842 .cindex "RFC 2047"
26843 Sometimes there is a need to replace the whole address item, and this can be
26844 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26845 causes an address in a header line to be rewritten, the entire address is
26846 replaced, not just the working part. The replacement must be a complete RFC
26847 2822 address, including the angle brackets if necessary. If text outside angle
26848 brackets contains a character whose value is greater than 126 or less than 32
26849 (except for tab), the text is encoded according to RFC 2047. The character set
26850 is taken from &%headers_charset%&, which gets its default at build time.
26851
26852 When the &"w"& flag is set on a rule that causes an envelope address to be
26853 rewritten, all but the working part of the replacement address is discarded.
26854 .endlist
26855
26856
26857 .section "Rewriting examples" "SECID156"
26858 Here is an example of the two common rewriting paradigms:
26859 .code
26860 *@*.hitch.fict.example  $1@hitch.fict.example
26861 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26862                      {$value}fail}@hitch.fict.example bctfrF
26863 .endd
26864 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26865 the string expansion to fail if the lookup does not succeed. In this context it
26866 has the effect of leaving the original address unchanged, but Exim goes on to
26867 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26868 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26869 explicitly, which would cause the rewritten address to be the same as before,
26870 at the cost of a small bit of processing. Not supplying either of these is an
26871 error, since the rewritten address would then contain no local part.
26872
26873 The first example above replaces the domain with a superior, more general
26874 domain. This may not be desirable for certain local parts. If the rule
26875 .code
26876 root@*.hitch.fict.example  *
26877 .endd
26878 were inserted before the first rule, rewriting would be suppressed for the
26879 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26880
26881 Rewriting can be made conditional on a number of tests, by making use of
26882 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26883 messages that originate outside the local host:
26884 .code
26885 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26886                          {$1@hitch.fict.example}fail}"
26887 .endd
26888 The replacement string is quoted in this example because it contains white
26889 space.
26890
26891 .cindex "rewriting" "bang paths"
26892 .cindex "bang paths" "rewriting"
26893 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26894 an address it treats it as an unqualified local part which it qualifies with
26895 the local qualification domain (if the source of the message is local or if the
26896 remote host is permitted to send unqualified addresses). Rewriting can
26897 sometimes be used to handle simple bang paths with a fixed number of
26898 components. For example, the rule
26899 .code
26900 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26901 .endd
26902 rewrites a two-component bang path &'host.name!user'& as the domain address
26903 &'user@host.name'&. However, there is a security implication in using this as
26904 a global rewriting rule for envelope addresses. It can provide a backdoor
26905 method for using your system as a relay, because the incoming addresses appear
26906 to be local. If the bang path addresses are received via SMTP, it is safer to
26907 use the &"S"& flag to rewrite them as they are received, so that relay checking
26908 can be done on the rewritten addresses.
26909 .ecindex IIDaddrew
26910
26911
26912
26913
26914
26915 . ////////////////////////////////////////////////////////////////////////////
26916 . ////////////////////////////////////////////////////////////////////////////
26917
26918 .chapter "Retry configuration" "CHAPretry"
26919 .scindex IIDretconf1 "retry" "configuration, description of"
26920 .scindex IIDregconf2 "configuration file" "retry section"
26921 The &"retry"& section of the runtime configuration file contains a list of
26922 retry rules that control how often Exim tries to deliver messages that cannot
26923 be delivered at the first attempt. If there are no retry rules (the section is
26924 empty or not present), there are no retries. In this situation, temporary
26925 errors are treated as permanent. The default configuration contains a single,
26926 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26927 line option can be used to test which retry rule will be used for a given
26928 address, domain and error.
26929
26930 The most common cause of retries is temporary failure to deliver to a remote
26931 host because the host is down, or inaccessible because of a network problem.
26932 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26933 address) basis, not on a per-message basis. Thus, if one message has recently
26934 been delayed, delivery of a new message to the same host is not immediately
26935 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26936 log selector is set, the message
26937 .cindex "retry" "time not reached"
26938 &"retry time not reached"& is written to the main log whenever a delivery is
26939 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26940 the handling of errors during remote deliveries.
26941
26942 Retry processing applies to routing as well as to delivering, except as covered
26943 in the next paragraph. The retry rules do not distinguish between these
26944 actions. It is not possible, for example, to specify different behaviour for
26945 failures to route the domain &'snark.fict.example'& and failures to deliver to
26946 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26947 added complication, so did not implement it. However, although they share the
26948 same retry rule, the actual retry times for routing and transporting a given
26949 domain are maintained independently.
26950
26951 When a delivery is not part of a queue run (typically an immediate delivery on
26952 receipt of a message), the routers are always run, and local deliveries are
26953 always attempted, even if retry times are set for them. This makes for better
26954 behaviour if one particular message is causing problems (for example, causing
26955 quota overflow, or provoking an error in a filter file). If such a delivery
26956 suffers a temporary failure, the retry data is updated as normal, and
26957 subsequent delivery attempts from queue runs occur only when the retry time for
26958 the local address is reached.
26959
26960 .section "Changing retry rules" "SECID157"
26961 If you change the retry rules in your configuration, you should consider
26962 whether or not to delete the retry data that is stored in Exim's spool area in
26963 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26964 always safe; that is why they are called &"hints"&.
26965
26966 The hints retry data contains suggested retry times based on the previous
26967 rules. In the case of a long-running problem with a remote host, it might
26968 record the fact that the host has timed out. If your new rules increase the
26969 timeout time for such a host, you should definitely remove the old retry data
26970 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26971 messages that it should now be retaining.
26972
26973
26974
26975 .section "Format of retry rules" "SECID158"
26976 .cindex "retry" "rules"
26977 Each retry rule occupies one line and consists of three or four parts,
26978 separated by white space: a pattern, an error name, an optional list of sender
26979 addresses, and a list of retry parameters. The pattern and sender lists must be
26980 enclosed in double quotes if they contain white space. The rules are searched
26981 in order until one is found where the pattern, error name, and sender list (if
26982 present) match the failing host or address, the error that occurred, and the
26983 message's sender, respectively.
26984
26985
26986 The pattern is any single item that may appear in an address list (see section
26987 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26988 which means that it is expanded before being tested against the address that
26989 has been delayed. A negated address list item is permitted. Address
26990 list processing treats a plain domain name as if it were preceded by &"*@"&,
26991 which makes it possible for many retry rules to start with just a domain. For
26992 example,
26993 .code
26994 lookingglass.fict.example        *  F,24h,30m;
26995 .endd
26996 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26997 whereas
26998 .code
26999 alice@lookingglass.fict.example  *  F,24h,30m;
27000 .endd
27001 applies only to temporary failures involving the local part &%alice%&.
27002 In practice, almost all rules start with a domain name pattern without a local
27003 part.
27004
27005 .cindex "regular expressions" "in retry rules"
27006 &*Warning*&: If you use a regular expression in a retry rule pattern, it
27007 must match a complete address, not just a domain, because that is how regular
27008 expressions work in address lists.
27009 .display
27010 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
27011 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
27012 .endd
27013
27014
27015 .section "Choosing which retry rule to use for address errors" "SECID159"
27016 When Exim is looking for a retry rule after a routing attempt has failed (for
27017 example, after a DNS timeout), each line in the retry configuration is tested
27018 against the complete address only if &%retry_use_local_part%& is set for the
27019 router. Otherwise, only the domain is used, except when matching against a
27020 regular expression, when the local part of the address is replaced with &"*"&.
27021 A domain on its own can match a domain pattern, or a pattern that starts with
27022 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
27023 &%check_local_user%& is true, and false for other routers.
27024
27025 Similarly, when Exim is looking for a retry rule after a local delivery has
27026 failed (for example, after a mailbox full error), each line in the retry
27027 configuration is tested against the complete address only if
27028 &%retry_use_local_part%& is set for the transport (it defaults true for all
27029 local transports).
27030
27031 .cindex "4&'xx'& responses" "retry rules for"
27032 However, when Exim is looking for a retry rule after a remote delivery attempt
27033 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
27034 whole address is always used as the key when searching the retry rules. The
27035 rule that is found is used to create a retry time for the combination of the
27036 failing address and the message's sender. It is the combination of sender and
27037 recipient that is delayed in subsequent queue runs until its retry time is
27038 reached. You can delay the recipient without regard to the sender by setting
27039 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
27040 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
27041 commands.
27042
27043
27044
27045 .section "Choosing which retry rule to use for host and message errors" &&&
27046          "SECID160"
27047 For a temporary error that is not related to an individual address (for
27048 example, a connection timeout), each line in the retry configuration is checked
27049 twice. First, the name of the remote host is used as a domain name (preceded by
27050 &"*@"& when matching a regular expression). If this does not match the line,
27051 the domain from the email address is tried in a similar fashion. For example,
27052 suppose the MX records for &'a.b.c.example'& are
27053 .code
27054 a.b.c.example  MX  5  x.y.z.example
27055                MX  6  p.q.r.example
27056                MX  7  m.n.o.example
27057 .endd
27058 and the retry rules are
27059 .code
27060 p.q.r.example    *      F,24h,30m;
27061 a.b.c.example    *      F,4d,45m;
27062 .endd
27063 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
27064 first rule matches neither the host nor the domain, so Exim looks at the second
27065 rule. This does not match the host, but it does match the domain, so it is used
27066 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
27067 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
27068 first retry rule is used, because it matches the host.
27069
27070 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
27071 first rule to determine retry times, but for all the other hosts for the domain
27072 &'a.b.c.example'&, the second rule is used. The second rule is also used if
27073 routing to &'a.b.c.example'& suffers a temporary failure.
27074
27075 &*Note*&: The host name is used when matching the patterns, not its IP address.
27076 However, if a message is routed directly to an IP address without the use of a
27077 host name, for example, if a &(manualroute)& router contains a setting such as:
27078 .code
27079 route_list = *.a.example  192.168.34.23
27080 .endd
27081 then the &"host name"& that is used when searching for a retry rule is the
27082 textual form of the IP address.
27083
27084 .section "Retry rules for specific errors" "SECID161"
27085 .cindex "retry" "specific errors; specifying"
27086 The second field in a retry rule is the name of a particular error, or an
27087 asterisk, which matches any error. The errors that can be tested for are:
27088
27089 .vlist
27090 .vitem &%auth_failed%&
27091 Authentication failed when trying to send to a host in the
27092 &%hosts_require_auth%& list in an &(smtp)& transport.
27093
27094 .vitem &%data_4xx%&
27095 A 4&'xx'& error was received for an outgoing DATA command, either immediately
27096 after the command, or after sending the message's data.
27097
27098 .vitem &%mail_4xx%&
27099 A 4&'xx'& error was received for an outgoing MAIL command.
27100
27101 .vitem &%rcpt_4xx%&
27102 A 4&'xx'& error was received for an outgoing RCPT command.
27103 .endlist
27104
27105 For the three 4&'xx'& errors, either the first or both of the x's can be given
27106 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
27107 recognize 452 errors given to RCPT commands for addresses in a certain domain,
27108 and have retries every ten minutes with a one-hour timeout, you could set up a
27109 retry rule of this form:
27110 .code
27111 the.domain.name  rcpt_452   F,1h,10m
27112 .endd
27113 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
27114 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
27115
27116 .vlist
27117 .vitem &%lost_connection%&
27118 A server unexpectedly closed the SMTP connection. There may, of course,
27119 legitimate reasons for this (host died, network died), but if it repeats a lot
27120 for the same host, it indicates something odd.
27121
27122 .vitem &%lookup%&
27123 A DNS lookup for a host failed.
27124 Note that a &%dnslookup%& router will need to have matched
27125 its &%fail_defer_domains%& option for this retry type to be usable.
27126 Also note that a &%manualroute%& router will probably need
27127 its &%host_find_failed%& option set to &%defer%&.
27128
27129 .vitem &%refused_MX%&
27130 A connection to a host obtained from an MX record was refused.
27131
27132 .vitem &%refused_A%&
27133 A connection to a host not obtained from an MX record was refused.
27134
27135 .vitem &%refused%&
27136 A connection was refused.
27137
27138 .vitem &%timeout_connect_MX%&
27139 A connection attempt to a host obtained from an MX record timed out.
27140
27141 .vitem &%timeout_connect_A%&
27142 A connection attempt to a host not obtained from an MX record timed out.
27143
27144 .vitem &%timeout_connect%&
27145 A connection attempt timed out.
27146
27147 .vitem &%timeout_MX%&
27148 There was a timeout while connecting or during an SMTP session with a host
27149 obtained from an MX record.
27150
27151 .vitem &%timeout_A%&
27152 There was a timeout while connecting or during an SMTP session with a host not
27153 obtained from an MX record.
27154
27155 .vitem &%timeout%&
27156 There was a timeout while connecting or during an SMTP session.
27157
27158 .vitem &%tls_required%&
27159 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27160 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27161 to STARTTLS, or there was a problem setting up the TLS connection.
27162
27163 .vitem &%quota%&
27164 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27165 transport.
27166
27167 .vitem &%quota_%&<&'time'&>
27168 .cindex "quota" "error testing in retry rule"
27169 .cindex "retry" "quota error testing"
27170 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27171 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27172 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27173 for four days.
27174 .endlist
27175
27176 .cindex "mailbox" "time of last read"
27177 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27178 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27179 it should be based on the last time that the user accessed the mailbox.
27180 However, it is not always possible to determine this. Exim uses the following
27181 heuristic rules:
27182
27183 .ilist
27184 If the mailbox is a single file, the time of last access (the &"atime"&) is
27185 used. As no new messages are being delivered (because the mailbox is over
27186 quota), Exim does not access the file, so this is the time of last user access.
27187 .next
27188 .cindex "maildir format" "time of last read"
27189 For a maildir delivery, the time of last modification of the &_new_&
27190 subdirectory is used. As the mailbox is over quota, no new files are created in
27191 the &_new_& subdirectory, because no new messages are being delivered. Any
27192 change to the &_new_& subdirectory is therefore assumed to be the result of an
27193 MUA moving a new message to the &_cur_& directory when it is first read. The
27194 time that is used is therefore the last time that the user read a new message.
27195 .next
27196 For other kinds of multi-file mailbox, the time of last access cannot be
27197 obtained, so a retry rule that uses this type of error field is never matched.
27198 .endlist
27199
27200 The quota errors apply both to system-enforced quotas and to Exim's own quota
27201 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27202 when a local delivery is deferred because a partition is full (the ENOSPC
27203 error).
27204
27205
27206
27207 .section "Retry rules for specified senders" "SECID162"
27208 .cindex "retry" "rules; sender-specific"
27209 You can specify retry rules that apply only when the failing message has a
27210 specific sender. In particular, this can be used to define retry rules that
27211 apply only to bounce messages. The third item in a retry rule can be of this
27212 form:
27213 .display
27214 &`senders=`&<&'address list'&>
27215 .endd
27216 The retry timings themselves are then the fourth item. For example:
27217 .code
27218 *   rcpt_4xx   senders=:   F,1h,30m
27219 .endd
27220 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27221 host. If the address list contains white space, it must be enclosed in quotes.
27222 For example:
27223 .code
27224 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27225 .endd
27226 &*Warning*&: This facility can be unhelpful if it is used for host errors
27227 (which do not depend on the recipient). The reason is that the sender is used
27228 only to match the retry rule. Once the rule has been found for a host error,
27229 its contents are used to set a retry time for the host, and this will apply to
27230 all messages, not just those with specific senders.
27231
27232 When testing retry rules using &%-brt%&, you can supply a sender using the
27233 &%-f%& command line option, like this:
27234 .code
27235 exim -f "" -brt user@dom.ain
27236 .endd
27237 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27238 list is never matched.
27239
27240
27241
27242
27243
27244 .section "Retry parameters" "SECID163"
27245 .cindex "retry" "parameters in rules"
27246 The third (or fourth, if a senders list is present) field in a retry rule is a
27247 sequence of retry parameter sets, separated by semicolons. Each set consists of
27248 .display
27249 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27250 .endd
27251 The letter identifies the algorithm for computing a new retry time; the cutoff
27252 time is the time beyond which this algorithm no longer applies, and the
27253 arguments vary the algorithm's action. The cutoff time is measured from the
27254 time that the first failure for the domain (combined with the local part if
27255 relevant) was detected, not from the time the message was received.
27256
27257 .cindex "retry" "algorithms"
27258 .cindex "retry" "fixed intervals"
27259 .cindex "retry" "increasing intervals"
27260 .cindex "retry" "random intervals"
27261 The available algorithms are:
27262
27263 .ilist
27264 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27265 the interval.
27266 .next
27267 &'G'&: retry at geometrically increasing intervals. The first argument
27268 specifies a starting value for the interval, and the second a multiplier, which
27269 is used to increase the size of the interval at each retry.
27270 .next
27271 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27272 retry, the previous interval is multiplied by the factor in order to get a
27273 maximum for the next interval. The minimum interval is the first argument of
27274 the parameter, and an actual interval is chosen randomly between them. Such a
27275 rule has been found to be helpful in cluster configurations when all the
27276 members of the cluster restart at once, and may therefore synchronize their
27277 queue processing times.
27278 .endlist
27279
27280 When computing the next retry time, the algorithm definitions are scanned in
27281 order until one whose cutoff time has not yet passed is reached. This is then
27282 used to compute a new retry time that is later than the current time. In the
27283 case of fixed interval retries, this simply means adding the interval to the
27284 current time. For geometrically increasing intervals, retry intervals are
27285 computed from the rule's parameters until one that is greater than the previous
27286 interval is found. The main configuration variable
27287 .cindex "limit" "retry interval"
27288 .cindex "retry" "interval, maximum"
27289 .oindex "&%retry_interval_max%&"
27290 &%retry_interval_max%& limits the maximum interval between retries. It
27291 cannot be set greater than &`24h`&, which is its default value.
27292
27293 A single remote domain may have a number of hosts associated with it, and each
27294 host may have more than one IP address. Retry algorithms are selected on the
27295 basis of the domain name, but are applied to each IP address independently. If,
27296 for example, a host has two IP addresses and one is unusable, Exim will
27297 generate retry times for it and will not try to use it until its next retry
27298 time comes. Thus the good IP address is likely to be tried first most of the
27299 time.
27300
27301 .cindex "hints database" "use for retrying"
27302 Retry times are hints rather than promises. Exim does not make any attempt to
27303 run deliveries exactly at the computed times. Instead, a queue runner process
27304 starts delivery processes for delayed messages periodically, and these attempt
27305 new deliveries only for those addresses that have passed their next retry time.
27306 If a new message arrives for a deferred address, an immediate delivery attempt
27307 occurs only if the address has passed its retry time. In the absence of new
27308 messages, the minimum time between retries is the interval between queue runner
27309 processes. There is not much point in setting retry times of five minutes if
27310 your queue runners happen only once an hour, unless there are a significant
27311 number of incoming messages (which might be the case on a system that is
27312 sending everything to a smart host, for example).
27313
27314 The data in the retry hints database can be inspected by using the
27315 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27316 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27317 &'exinext'& utility script can be used to find out what the next retry times
27318 are for the hosts associated with a particular mail domain, and also for local
27319 deliveries that have been deferred.
27320
27321
27322 .section "Retry rule examples" "SECID164"
27323 Here are some example retry rules:
27324 .code
27325 alice@wonderland.fict.example quota_5d  F,7d,3h
27326 wonderland.fict.example       quota_5d
27327 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27328 lookingglass.fict.example     *         F,24h,30m;
27329 *                 refused_A   F,2h,20m;
27330 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27331 .endd
27332 The first rule sets up special handling for mail to
27333 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27334 mailbox has not been read for at least 5 days. Retries continue every three
27335 hours for 7 days. The second rule handles over-quota errors for all other local
27336 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27337 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27338 fail are bounced immediately if the mailbox has not been read for at least 5
27339 days.
27340
27341 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27342 happen every 15 minutes for an hour, then with geometrically increasing
27343 intervals until two days have passed since a delivery first failed. After the
27344 first hour there is a delay of one hour, then two hours, then four hours, and
27345 so on (this is a rather extreme example).
27346
27347 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27348 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27349 all other domains, with special action for connection refusal from hosts that
27350 were not obtained from an MX record.
27351
27352 The final rule in a retry configuration should always have asterisks in the
27353 first two fields so as to provide a general catch-all for any addresses that do
27354 not have their own special handling. This example tries every 15 minutes for 2
27355 hours, then with intervals starting at one hour and increasing by a factor of
27356 1.5 up to 16 hours, then every 8 hours up to 5 days.
27357
27358
27359
27360 .section "Timeout of retry data" "SECID165"
27361 .cindex "timeout" "of retry data"
27362 .oindex "&%retry_data_expire%&"
27363 .cindex "hints database" "data expiry"
27364 .cindex "retry" "timeout of data"
27365 Exim timestamps the data that it writes to its retry hints database. When it
27366 consults the data during a delivery it ignores any that is older than the value
27367 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27368 been tried for 7 days, Exim will try to deliver to it immediately a message
27369 arrives, and if that fails, it will calculate a retry time as if it were
27370 failing for the first time.
27371
27372 This improves the behaviour for messages routed to rarely-used hosts such as MX
27373 backups. If such a host was down at one time, and happens to be down again when
27374 Exim tries a month later, using the old retry data would imply that it had been
27375 down all the time, which is not a justified assumption.
27376
27377 If a host really is permanently dead, this behaviour causes a burst of retries
27378 every now and again, but only if messages routed to it are rare. If there is a
27379 message at least once every 7 days the retry data never expires.
27380
27381
27382
27383
27384 .section "Long-term failures" "SECID166"
27385 .cindex "delivery failure, long-term"
27386 .cindex "retry" "after long-term failure"
27387 Special processing happens when an email address has been failing for so long
27388 that the cutoff time for the last algorithm is reached. For example, using the
27389 default retry rule:
27390 .code
27391 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27392 .endd
27393 the cutoff time is four days. Reaching the retry cutoff is independent of how
27394 long any specific message has been failing; it is the length of continuous
27395 failure for the recipient address that counts.
27396
27397 When the cutoff time is reached for a local delivery, or for all the IP
27398 addresses associated with a remote delivery, a subsequent delivery failure
27399 causes Exim to give up on the address, and a bounce message is generated.
27400 In order to cater for new messages that use the failing address, a next retry
27401 time is still computed from the final algorithm, and is used as follows:
27402
27403 For local deliveries, one delivery attempt is always made for any subsequent
27404 messages. If this delivery fails, the address fails immediately. The
27405 post-cutoff retry time is not used.
27406
27407 .cindex "final cutoff" "retries, controlling"
27408 .cindex retry "final cutoff"
27409 If the delivery is remote, there are two possibilities, controlled by the
27410 .oindex "&%delay_after_cutoff%&"
27411 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27412 default. Until the post-cutoff retry time for one of the IP addresses,
27413 as set by the &%retry_data_expire%& option, is
27414 reached, the failing email address is bounced immediately, without a delivery
27415 attempt taking place. After that time, one new delivery attempt is made to
27416 those IP addresses that are past their retry times, and if that still fails,
27417 the address is bounced and new retry times are computed.
27418
27419 In other words, when all the hosts for a given email address have been failing
27420 for a long time, Exim bounces rather then defers until one of the hosts' retry
27421 times is reached. Then it tries once, and bounces if that attempt fails. This
27422 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27423 to a broken destination, but if the host does recover, Exim will eventually
27424 notice.
27425
27426 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27427 addresses are past their final cutoff time, Exim tries to deliver to those IP
27428 addresses that have not been tried since the message arrived. If there are
27429 no suitable IP addresses, or if they all fail, the address is bounced. In other
27430 words, it does not delay when a new message arrives, but tries the expired
27431 addresses immediately, unless they have been tried since the message arrived.
27432 If there is a continuous stream of messages for the failing domains, setting
27433 &%delay_after_cutoff%& false means that there will be many more attempts to
27434 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27435 true.
27436
27437 .section "Deliveries that work intermittently" "SECID167"
27438 .cindex "retry" "intermittently working deliveries"
27439 Some additional logic is needed to cope with cases where a host is
27440 intermittently available, or when a message has some attribute that prevents
27441 its delivery when others to the same address get through. In this situation,
27442 because some messages are successfully delivered, the &"retry clock"& for the
27443 host or address keeps getting reset by the successful deliveries, and so
27444 failing messages remain in the queue for ever because the cutoff time is never
27445 reached.
27446
27447 Two exceptional actions are applied to prevent this happening. The first
27448 applies to errors that are related to a message rather than a remote host.
27449 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27450 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27451 commands, and quota failures. For this type of error, if a message's arrival
27452 time is earlier than the &"first failed"& time for the error, the earlier time
27453 is used when scanning the retry rules to decide when to try next and when to
27454 time out the address.
27455
27456 The exceptional second action applies in all cases. If a message has been on
27457 the queue for longer than the cutoff time of any applicable retry rule for a
27458 given address, a delivery is attempted for that address, even if it is not yet
27459 time, and if this delivery fails, the address is timed out. A new retry time is
27460 not computed in this case, so that other messages for the same address are
27461 considered immediately.
27462 .ecindex IIDretconf1
27463 .ecindex IIDregconf2
27464
27465
27466
27467
27468
27469
27470 . ////////////////////////////////////////////////////////////////////////////
27471 . ////////////////////////////////////////////////////////////////////////////
27472
27473 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27474 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27475 .scindex IIDauthconf2 "authentication"
27476 The &"authenticators"& section of Exim's runtime configuration is concerned
27477 with SMTP authentication. This facility is an extension to the SMTP protocol,
27478 described in RFC 2554, which allows a client SMTP host to authenticate itself
27479 to a server. This is a common way for a server to recognize clients that are
27480 permitted to use it as a relay. SMTP authentication is not of relevance to the
27481 transfer of mail between servers that have no managerial connection with each
27482 other.
27483
27484 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27485 prior to Exim 4.95 names would be silently truncated at this length, but now
27486 it is enforced.
27487
27488 .cindex "AUTH" "description of"
27489 .cindex "ESMTP extensions" AUTH
27490 Very briefly, the way SMTP authentication works is as follows:
27491
27492 .olist
27493 The server advertises a number of authentication &'mechanisms'& in response to
27494 the client's EHLO command.
27495 .next
27496 The client issues an AUTH command, naming a specific mechanism. The command
27497 may, optionally, contain some authentication data.
27498 .next
27499 The server may issue one or more &'challenges'&, to which the client must send
27500 appropriate responses. In simple authentication mechanisms, the challenges are
27501 just prompts for user names and passwords. The server does not have to issue
27502 any challenges &-- in some mechanisms the relevant data may all be transmitted
27503 with the AUTH command.
27504 .next
27505 The server either accepts or denies authentication.
27506 .next
27507 If authentication succeeds, the client may optionally make use of the AUTH
27508 option on the MAIL command to pass an authenticated sender in subsequent
27509 mail transactions. Authentication lasts for the remainder of the SMTP
27510 connection.
27511 .next
27512 If authentication fails, the client may give up, or it may try a different
27513 authentication mechanism, or it may try transferring mail over the
27514 unauthenticated connection.
27515 .endlist
27516
27517 If you are setting up a client, and want to know which authentication
27518 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27519 SMTP port) on the server, and issue an EHLO command. The response to this
27520 includes the list of supported mechanisms. For example:
27521 .display
27522 &`$ `&&*&`telnet server.example 25`&*&
27523 &`Trying 192.168.34.25...`&
27524 &`Connected to server.example.`&
27525 &`Escape character is &#x0027;^]&#x0027;.`&
27526 &`220 server.example ESMTP Exim 4.20 ...`&
27527 &*&`ehlo client.example`&*&
27528 &`250-server.example Hello client.example [10.8.4.5]`&
27529 &`250-SIZE 52428800`&
27530 &`250-PIPELINING`&
27531 &`250-AUTH PLAIN`&
27532 &`250 HELP`&
27533 .endd
27534 The second-last line of this example output shows that the server supports
27535 authentication using the PLAIN mechanism. In Exim, the different authentication
27536 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27537 routers and transports, which authenticators are included in the binary is
27538 controlled by build-time definitions. The following are currently available,
27539 included by setting
27540 .code
27541 AUTH_CRAM_MD5=yes
27542 AUTH_CYRUS_SASL=yes
27543 AUTH_DOVECOT=yes
27544 AUTH_EXTERNAL=yes
27545 AUTH_GSASL=yes
27546 AUTH_HEIMDAL_GSSAPI=yes
27547 AUTH_PLAINTEXT=yes
27548 AUTH_SPA=yes
27549 AUTH_TLS=yes
27550 .endd
27551 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27552 authentication mechanism (RFC 2195), and the second provides an interface to
27553 the Cyrus SASL authentication library.
27554 The third is an interface to Dovecot's authentication system, delegating the
27555 work via a socket interface.
27556 The fourth provides for negotiation of authentication done via non-SMTP means,
27557 as defined by RFC 4422 Appendix A.
27558 The fifth provides an interface to the GNU SASL authentication library, which
27559 provides mechanisms but typically not data sources.
27560 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27561 supporting setting a server keytab.
27562 The seventh can be configured to support
27563 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27564 not formally documented, but used by several MUAs.
27565 The eighth authenticator
27566 supports Microsoft's &'Secure Password Authentication'& mechanism.
27567 The last is an Exim authenticator but not an SMTP one;
27568 instead it can use information from a TLS negotiation.
27569
27570 The authenticators are configured using the same syntax as other drivers (see
27571 section &<<SECTfordricon>>&). If no authenticators are required, no
27572 authentication section need be present in the configuration file. Each
27573 authenticator can in principle have both server and client functions. When Exim
27574 is receiving SMTP mail, it is acting as a server; when it is sending out
27575 messages over SMTP, it is acting as a client. Authenticator configuration
27576 options are provided for use in both these circumstances.
27577
27578 To make it clear which options apply to which situation, the prefixes
27579 &%server_%& and &%client_%& are used on option names that are specific to
27580 either the server or the client function, respectively. Server and client
27581 functions are disabled if none of their options are set. If an authenticator is
27582 to be used for both server and client functions, a single definition, using
27583 both sets of options, is required. For example:
27584 .code
27585 cram:
27586   driver = cram_md5
27587   public_name = CRAM-MD5
27588   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27589   client_name = ph10
27590   client_secret = secret2
27591 .endd
27592 The &%server_%& option is used when Exim is acting as a server, and the
27593 &%client_%& options when it is acting as a client.
27594
27595 Descriptions of the individual authenticators are given in subsequent chapters.
27596 The remainder of this chapter covers the generic options for the
27597 authenticators, followed by general discussion of the way authentication works
27598 in Exim.
27599
27600 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27601 per-mechanism basis.  Please read carefully to determine which variables hold
27602 account labels such as usercodes and which hold passwords or other
27603 authenticating data.
27604
27605 Note that some mechanisms support two different identifiers for accounts: the
27606 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27607 and &'authz'& are commonly encountered.  The American spelling is standard here.
27608 Conceptually, authentication data such as passwords are tied to the identifier
27609 used to authenticate; servers may have rules to permit one user to act as a
27610 second user, so that after login the session is treated as though that second
27611 user had logged in.  That second user is the &'authorization id'&.  A robust
27612 configuration might confirm that the &'authz'& field is empty or matches the
27613 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27614 as verified data, the &'authz'& as an unverified request which the server might
27615 choose to honour.
27616
27617 A &'realm'& is a text string, typically a domain name, presented by a server
27618 to a client to help it select an account and credentials to use.  In some
27619 mechanisms, the client and server provably agree on the realm, but clients
27620 typically can not treat the realm as secure data to be blindly trusted.
27621
27622
27623
27624 .section "Generic options for authenticators" "SECID168"
27625 .cindex "authentication" "generic options"
27626 .cindex "options" "generic; for authenticators"
27627
27628 .option client_condition authenticators string&!! unset
27629 When Exim is authenticating as a client, it skips any authenticator whose
27630 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27631 used, for example, to skip plain text authenticators when the connection is not
27632 encrypted by a setting such as:
27633 .code
27634 client_condition = ${if !eq{$tls_out_cipher}{}}
27635 .endd
27636
27637
27638 .option client_set_id authenticators string&!! unset
27639 When client authentication succeeds, this condition is expanded; the
27640 result is used in the log lines for outbound messages.
27641 Typically it will be the user name used for authentication.
27642
27643
27644 .option driver authenticators string unset
27645 This option must always be set. It specifies which of the available
27646 authenticators is to be used.
27647
27648
27649 .option public_name authenticators string unset
27650 This option specifies the name of the authentication mechanism that the driver
27651 implements, and by which it is known to the outside world. These names should
27652 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27653 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27654 defaults to the driver's instance name.
27655
27656
27657 .option server_advertise_condition authenticators string&!! unset
27658 When a server is about to advertise an authentication mechanism, the condition
27659 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27660 mechanism is not advertised.
27661 If the expansion fails, the mechanism is not advertised. If the failure was not
27662 forced, and was not caused by a lookup defer, the incident is logged.
27663 See section &<<SECTauthexiser>>& below for further discussion.
27664
27665
27666 .option server_condition authenticators string&!! unset
27667 This option must be set for a &%plaintext%& server authenticator, where it
27668 is used directly to control authentication. See section &<<SECTplainserver>>&
27669 for details.
27670
27671 For the &(gsasl)& authenticator, this option is required for various
27672 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27673
27674 For the other authenticators, &%server_condition%& can be used as an additional
27675 authentication or authorization mechanism that is applied after the other
27676 authenticator conditions succeed. If it is set, it is expanded when the
27677 authenticator would otherwise return a success code. If the expansion is forced
27678 to fail, authentication fails. Any other expansion failure causes a temporary
27679 error code to be returned. If the result of a successful expansion is an empty
27680 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27681 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27682 other result, a temporary error code is returned, with the expanded string as
27683 the error text.
27684
27685
27686 .option server_debug_print authenticators string&!! unset
27687 If this option is set and authentication debugging is enabled (see the &%-d%&
27688 command line option), the string is expanded and included in the debugging
27689 output when the authenticator is run as a server. This can help with checking
27690 out the values of variables.
27691 If expansion of the string fails, the error message is written to the debugging
27692 output, and Exim carries on processing.
27693
27694
27695 .option server_set_id authenticators string&!! unset
27696 .vindex "&$authenticated_id$&"
27697 .vindex "&$authenticated_fail_id$&"
27698 When an Exim server successfully authenticates a client, this string is
27699 expanded using data from the authentication, and preserved for any incoming
27700 messages in the variable &$authenticated_id$&. It is also included in the log
27701 lines for incoming messages. For example, a user/password authenticator
27702 configuration might preserve the user name that was used to authenticate, and
27703 refer to it subsequently during delivery of the message.
27704 On a failing authentication the expansion result is instead saved in
27705 the &$authenticated_fail_id$& variable.
27706 If expansion fails, the option is ignored.
27707
27708
27709 .option server_mail_auth_condition authenticators string&!! unset
27710 This option allows a server to discard authenticated sender addresses supplied
27711 as part of MAIL commands in SMTP connections that are authenticated by the
27712 driver on which &%server_mail_auth_condition%& is set. The option is not used
27713 as part of the authentication process; instead its (unexpanded) value is
27714 remembered for later use.
27715 How it is used is described in the following section.
27716
27717
27718
27719
27720
27721 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27722 .cindex "authentication" "sender; authenticated"
27723 .cindex "AUTH" "on MAIL command"
27724 When a client supplied an AUTH= item on a MAIL command, Exim applies
27725 the following checks before accepting it as the authenticated sender of the
27726 message:
27727
27728 .ilist
27729 If the connection is not using extended SMTP (that is, HELO was used rather
27730 than EHLO), the use of AUTH= is a syntax error.
27731 .next
27732 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27733 .next
27734 .vindex "&$authenticated_sender$&"
27735 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27736 running, the value of &$authenticated_sender$& is set to the value obtained
27737 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27738 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27739 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27740 given for the MAIL command.
27741 .next
27742 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27743 is accepted and placed in &$authenticated_sender$& only if the client has
27744 authenticated.
27745 .next
27746 If the AUTH= value was accepted by either of the two previous rules, and
27747 the client has authenticated, and the authenticator has a setting for the
27748 &%server_mail_auth_condition%&, the condition is checked at this point. The
27749 valued that was saved from the authenticator is expanded. If the expansion
27750 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27751 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27752 the value of &$authenticated_sender$& is retained and passed on with the
27753 message.
27754 .endlist
27755
27756
27757 When &$authenticated_sender$& is set for a message, it is passed on to other
27758 hosts to which Exim authenticates as a client. Do not confuse this value with
27759 &$authenticated_id$&, which is a string obtained from the authentication
27760 process, and which is not usually a complete email address.
27761
27762 .vindex "&$sender_address$&"
27763 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27764 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27765 therefore make use of &$authenticated_sender$&. The converse is not true: the
27766 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27767 ACL is run.
27768
27769
27770
27771 .section "Authentication on an Exim server" "SECTauthexiser"
27772 .cindex "authentication" "on an Exim server"
27773 When Exim receives an EHLO command, it advertises the public names of those
27774 authenticators that are configured as servers, subject to the following
27775 conditions:
27776
27777 .ilist
27778 The client host must match &%auth_advertise_hosts%& (default *).
27779 .next
27780 If the &%server_advertise_condition%& option is set, its expansion must not
27781 yield the empty string, &"0"&, &"no"&, or &"false"&.
27782 .endlist
27783
27784 The order in which the authenticators are defined controls the order in which
27785 the mechanisms are advertised.
27786
27787 Some mail clients (for example, some versions of Netscape) require the user to
27788 provide a name and password for authentication whenever AUTH is advertised,
27789 even though authentication may not in fact be needed (for example, Exim may be
27790 set up to allow unconditional relaying from the client by an IP address check).
27791 You can make such clients more friendly by not advertising AUTH to them.
27792 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27793 that runs for RCPT) to relay without authentication, you should set
27794 .code
27795 auth_advertise_hosts = ! 10.9.8.0/24
27796 .endd
27797 so that no authentication mechanisms are advertised to them.
27798
27799 The &%server_advertise_condition%& controls the advertisement of individual
27800 authentication mechanisms. For example, it can be used to restrict the
27801 advertisement of a particular mechanism to encrypted connections, by a setting
27802 such as:
27803 .code
27804 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27805 .endd
27806 .vindex "&$tls_in_cipher$&"
27807 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27808 yields &"yes"&, which allows the advertisement to happen.
27809
27810 When an Exim server receives an AUTH command from a client, it rejects it
27811 immediately if AUTH was not advertised in response to an earlier EHLO
27812 command. This is the case if
27813
27814 .ilist
27815 The client host does not match &%auth_advertise_hosts%&; or
27816 .next
27817 No authenticators are configured with server options; or
27818 .next
27819 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27820 server authenticators.
27821 .endlist
27822
27823
27824 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27825 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27826 AUTH is accepted from any client host.
27827
27828 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27829 server authentication mechanism that was advertised in response to EHLO and
27830 that matches the one named in the AUTH command. If it finds one, it runs
27831 the appropriate authentication protocol, and authentication either succeeds or
27832 fails. If there is no matching advertised mechanism, the AUTH command is
27833 rejected with a 504 error.
27834
27835 .vindex "&$received_protocol$&"
27836 .vindex "&$sender_host_authenticated$&"
27837 When a message is received from an authenticated host, the value of
27838 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27839 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27840 public name) of the authenticator driver that successfully authenticated the
27841 client from which the message was received. This variable is empty if there was
27842 no successful authentication.
27843
27844 .cindex authentication "expansion item"
27845 Successful authentication sets up information used by the
27846 &%authresults%& expansion item.
27847
27848 .cindex authentication "failure event, server"
27849 If an authenticator is run and does not succeed,
27850 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27851 While the event is being processed the variables
27852 &$sender_host_authenticated$& (with the authenticator name)
27853 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27854 will be valid.
27855 If the event is serviced and a string is returned then the string will be logged
27856 instead of the default log line.
27857 See <<CHAPevents>> for details on events.
27858
27859
27860 .section "Testing server authentication" "SECID169"
27861 .cindex "authentication" "testing a server"
27862 .cindex "AUTH" "testing a server"
27863 .cindex "base64 encoding" "creating authentication test data"
27864 Exim's &%-bh%& option can be useful for testing server authentication
27865 configurations. The data for the AUTH command has to be sent using base64
27866 encoding. A quick way to produce such data for testing is the following Perl
27867 script:
27868 .code
27869 use MIME::Base64;
27870 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27871 .endd
27872 .cindex "binary zero" "in authentication data"
27873 This interprets its argument as a Perl string, and then encodes it. The
27874 interpretation as a Perl string allows binary zeros, which are required for
27875 some kinds of authentication, to be included in the data. For example, a
27876 command line to run this script on such data might be
27877 .code
27878 encode '\0user\0password'
27879 .endd
27880 Note the use of single quotes to prevent the shell interpreting the
27881 backslashes, so that they can be interpreted by Perl to specify characters
27882 whose code value is zero.
27883
27884 &*Warning 1*&: If either of the user or password strings starts with an octal
27885 digit, you must use three zeros instead of one after the leading backslash. If
27886 you do not, the octal digit that starts your string will be incorrectly
27887 interpreted as part of the code for the first character.
27888
27889 &*Warning 2*&: If there are characters in the strings that Perl interprets
27890 specially, you must use a Perl escape to prevent them being misinterpreted. For
27891 example, a command such as
27892 .code
27893 encode '\0user@domain.com\0pas$$word'
27894 .endd
27895 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27896
27897 If you have the &%mimencode%& command installed, another way to produce
27898 base64-encoded strings is to run the command
27899 .code
27900 echo -e -n `\0user\0password' | mimencode
27901 .endd
27902 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27903 in the argument, and the &%-n%& option specifies no newline at the end of its
27904 output. However, not all versions of &%echo%& recognize these options, so you
27905 should check your version before relying on this suggestion.
27906
27907
27908
27909 .section "Authentication by an Exim client" "SECID170"
27910 .cindex "authentication" "on an Exim client"
27911 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27912 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27913 announces support for authentication, and the host matches an entry in either
27914 of these options, Exim (as a client) tries to authenticate as follows:
27915
27916 .ilist
27917 For each authenticator that is configured as a client, in the order in which
27918 they are defined in the configuration, it searches the authentication
27919 mechanisms announced by the server for one whose name matches the public name
27920 of the authenticator.
27921 .next
27922 .vindex "&$host$&"
27923 .vindex "&$host_address$&"
27924 When it finds one that matches, it runs the authenticator's client code. The
27925 variables &$host$& and &$host_address$& are available for any string expansions
27926 that the client might do. They are set to the server's name and IP address. If
27927 any expansion is forced to fail, the authentication attempt is abandoned, and
27928 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27929 delivery to be deferred.
27930 .next
27931 If the result of the authentication attempt is a temporary error or a timeout,
27932 Exim abandons trying to send the message to the host for the moment. It will
27933 try again later. If there are any backup hosts available, they are tried in the
27934 usual way.
27935
27936 .next
27937 .cindex authentication "failure event, client"
27938 If the response to authentication is a permanent error (5&'xx'& code),
27939 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27940 While the event is being processed the variable
27941 &$sender_host_authenticated$& (with the authenticator name)
27942 will be valid.
27943 If the event is serviced and a string is returned then the string will be logged.
27944 See <<CHAPevents>> for details on events.
27945
27946 .next
27947 If the response to authentication is a permanent error (5&'xx'& code), Exim
27948 carries on searching the list of authenticators and tries another one if
27949 possible. If all authentication attempts give permanent errors, or if there are
27950 no attempts because no mechanisms match (or option expansions force failure),
27951 what happens depends on whether the host matches &%hosts_require_auth%& or
27952 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27953 delivery is deferred. The error can be detected in the retry rules, and thereby
27954 turned into a permanent error if you wish. In the second case, Exim tries to
27955 deliver the message unauthenticated.
27956 .endlist
27957
27958 Note that the hostlist test for whether to do authentication can be
27959 confused if name-IP lookups change between the time the peer is decided
27960 upon and the time that the transport runs.  For example, with a manualroute
27961 router given a host name, and with DNS "round-robin" used by that name: if
27962 the local resolver cache times out between the router and the transport
27963 running, the transport may get an IP for the name for its authentication
27964 check which does not match the connection peer IP.
27965 No authentication will then be done, despite the names being identical.
27966
27967 For such cases use a separate transport which always authenticates.
27968
27969 .cindex "AUTH" "on MAIL command"
27970 When Exim has authenticated itself to a remote server, it adds the AUTH
27971 parameter to the MAIL commands it sends, if it has an authenticated sender for
27972 the message. If the message came from a remote host, the authenticated sender
27973 is the one that was receiving on an incoming MAIL command, provided that the
27974 incoming connection was authenticated and the &%server_mail_auth%& condition
27975 allowed the authenticated sender to be retained. If a local process calls Exim
27976 to send a message, the sender address that is built from the login name and
27977 &%qualify_domain%& is treated as authenticated. However, if the
27978 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27979 the authenticated sender that was received with the message.
27980 .ecindex IIDauthconf1
27981 .ecindex IIDauthconf2
27982
27983
27984
27985
27986
27987
27988 . ////////////////////////////////////////////////////////////////////////////
27989 . ////////////////////////////////////////////////////////////////////////////
27990
27991 .chapter "The plaintext authenticator" "CHAPplaintext"
27992 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27993 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27994 The &(plaintext)& authenticator can be configured to support the PLAIN and
27995 LOGIN authentication mechanisms, both of which transfer authentication data as
27996 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27997 security risk; you are strongly advised to insist on the use of SMTP encryption
27998 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27999 use unencrypted plain text, you should not use the same passwords for SMTP
28000 connections as you do for login accounts.
28001
28002 .section "Avoiding cleartext use" "SECTplain_TLS"
28003 The following generic option settings will disable &(plaintext)& authenticators when
28004 TLS is not being used:
28005 .code
28006   server_advertise_condition = ${if def:tls_in_cipher }
28007   client_condition =           ${if def:tls_out_cipher}
28008 .endd
28009
28010 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
28011 but is still vulnerable to a Man In The Middle attack unless certificates
28012 (including their names) have been properly verified.
28013
28014 .section "Plaintext server options" "SECID171"
28015 .cindex "options" "&(plaintext)& authenticator (server)"
28016 When configured as a server, &(plaintext)& uses the following options:
28017
28018 .option server_condition authenticators string&!! unset
28019 This is actually a global authentication option, but it must be set in order to
28020 configure the &(plaintext)& driver as a server. Its use is described below.
28021
28022 .option server_prompts plaintext "string list&!!" unset
28023 The contents of this option, after expansion, must be a colon-separated list of
28024 prompt strings. If expansion fails, a temporary authentication rejection is
28025 given.
28026
28027 .section "Using plaintext in a server" "SECTplainserver"
28028 .cindex "AUTH" "in &(plaintext)& authenticator"
28029 .cindex "binary zero" "in &(plaintext)& authenticator"
28030 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28031         "in &(plaintext)& authenticator"
28032 .vindex "&$auth1$&, &$auth2$&, etc"
28033 .cindex "base64 encoding" "in &(plaintext)& authenticator"
28034
28035 When running as a server, &(plaintext)& performs the authentication test by
28036 expanding a string. The data sent by the client with the AUTH command, or in
28037 response to subsequent prompts, is base64 encoded, and so may contain any byte
28038 values when decoded. If any data is supplied with the command, it is treated as
28039 a list of strings, separated by NULs (binary zeros), the first three of which
28040 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
28041 (neither LOGIN nor PLAIN uses more than three strings).
28042
28043 For compatibility with previous releases of Exim, the values are also placed in
28044 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
28045 variables for this purpose is now deprecated, as it can lead to confusion in
28046 string expansions that also use them for other things.
28047
28048 If there are more strings in &%server_prompts%& than the number of strings
28049 supplied with the AUTH command, the remaining prompts are used to obtain more
28050 data. Each response from the client may be a list of NUL-separated strings.
28051
28052 .vindex "&$authenticated_id$&"
28053 Once a sufficient number of data strings have been received,
28054 &%server_condition%& is expanded. If the expansion is forced to fail,
28055 authentication fails. Any other expansion failure causes a temporary error code
28056 to be returned. If the result of a successful expansion is an empty string,
28057 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28058 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28059 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28060 For any other result, a temporary error code is returned, with the expanded
28061 string as the error text.
28062
28063 &*Warning*&: If you use a lookup in the expansion to find the user's
28064 password, be sure to make the authentication fail if the user is unknown.
28065 There are good and bad examples at the end of the next section.
28066
28067
28068
28069 .section "The PLAIN authentication mechanism" "SECID172"
28070 .cindex "PLAIN authentication mechanism"
28071 .cindex authentication PLAIN
28072 .cindex "binary zero" "in &(plaintext)& authenticator"
28073 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
28074 sent as one item of data (that is, one combined string containing two NUL
28075 separators). The data is sent either as part of the AUTH command, or
28076 subsequently in response to an empty prompt from the server.
28077
28078 The second and third strings are a user name and a corresponding password.
28079 Using a single fixed user name and password as an example, this could be
28080 configured as follows:
28081 .code
28082 fixed_plain:
28083   driver = plaintext
28084   public_name = PLAIN
28085   server_prompts = :
28086   server_condition = \
28087     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
28088   server_set_id = $auth2
28089 .endd
28090 Note that the default result strings from &%if%& (&"true"& or an empty string)
28091 are exactly what we want here, so they need not be specified. Obviously, if the
28092 password contains expansion-significant characters such as dollar, backslash,
28093 or closing brace, they have to be escaped.
28094
28095 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
28096 the end of a string list are ignored). If all the data comes as part of the
28097 AUTH command, as is commonly the case, the prompt is not used. This
28098 authenticator is advertised in the response to EHLO as
28099 .code
28100 250-AUTH PLAIN
28101 .endd
28102 and a client host can authenticate itself by sending the command
28103 .code
28104 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
28105 .endd
28106 As this contains three strings (more than the number of prompts), no further
28107 data is required from the client. Alternatively, the client may just send
28108 .code
28109 AUTH PLAIN
28110 .endd
28111 to initiate authentication, in which case the server replies with an empty
28112 prompt. The client must respond with the combined data string.
28113
28114 The data string is base64 encoded, as required by the RFC. This example,
28115 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
28116 represents a zero byte. This is split up into three strings, the first of which
28117 is empty. The &%server_condition%& option in the authenticator checks that the
28118 second two are &`username`& and &`mysecret`& respectively.
28119
28120 Having just one fixed user name and password, as in this example, is not very
28121 realistic, though for a small organization with only a handful of
28122 authenticating clients it could make sense.
28123
28124 A more sophisticated instance of this authenticator could use the user name in
28125 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
28126 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
28127 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
28128 This is an incorrect example:
28129 .code
28130 server_condition = \
28131   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28132 .endd
28133 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28134 which it then compares to the supplied password (&$auth3$&). Why is this example
28135 incorrect? It works fine for existing users, but consider what happens if a
28136 non-existent user name is given. The lookup fails, but as no success/failure
28137 strings are given for the lookup, it yields an empty string. Thus, to defeat
28138 the authentication, all a client has to do is to supply a non-existent user
28139 name and an empty password. The correct way of writing this test is:
28140 .code
28141 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28142   {${if eq{$value}{$auth3}}} {false}}
28143 .endd
28144 In this case, if the lookup succeeds, the result is checked; if the lookup
28145 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28146 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28147 always fails if its second argument is empty. However, the second way of
28148 writing the test makes the logic clearer.
28149
28150
28151 .section "The LOGIN authentication mechanism" "SECID173"
28152 .cindex "LOGIN authentication mechanism"
28153 .cindex authentication LOGIN
28154 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28155 in a number of programs. No data is sent with the AUTH command. Instead, a
28156 user name and password are supplied separately, in response to prompts. The
28157 plaintext authenticator can be configured to support this as in this example:
28158 .code
28159 fixed_login:
28160   driver = plaintext
28161   public_name = LOGIN
28162   server_prompts = User Name : Password
28163   server_condition = \
28164     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28165   server_set_id = $auth1
28166 .endd
28167 Because of the way plaintext operates, this authenticator accepts data supplied
28168 with the AUTH command (in contravention of the specification of LOGIN), but
28169 if the client does not supply it (as is the case for LOGIN clients), the prompt
28170 strings are used to obtain two data items.
28171
28172 Some clients are very particular about the precise text of the prompts. For
28173 example, Outlook Express is reported to recognize only &"Username:"& and
28174 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28175 strings. It uses the &%ldapauth%& expansion condition to check the user
28176 name and password by binding to an LDAP server:
28177 .code
28178 login:
28179   driver = plaintext
28180   public_name = LOGIN
28181   server_prompts = Username:: : Password::
28182   server_condition = ${if and{{ \
28183     !eq{}{$auth1} }{ \
28184     ldapauth{\
28185       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28186       pass=${quote:$auth2} \
28187       ldap://ldap.example.org/} }} }
28188   server_set_id = uid=$auth1,ou=people,o=example.org
28189 .endd
28190 We have to check that the username is not empty before using it, because LDAP
28191 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28192 operator to correctly quote the DN for authentication. However, the basic
28193 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28194 correct one to use for the password, because quoting is needed only to make
28195 the password conform to the Exim syntax. At the LDAP level, the password is an
28196 uninterpreted string.
28197
28198
28199 .section "Support for different kinds of authentication" "SECID174"
28200 A number of string expansion features are provided for the purpose of
28201 interfacing to different ways of user authentication. These include checking
28202 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28203 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28204 &<<SECTexpcond>>&.
28205
28206
28207
28208
28209 .section "Using plaintext in a client" "SECID175"
28210 .cindex "options" "&(plaintext)& authenticator (client)"
28211 The &(plaintext)& authenticator has two client options:
28212
28213 .option client_ignore_invalid_base64 plaintext boolean false
28214 If the client receives a server prompt that is not a valid base64 string,
28215 authentication is abandoned by default. However, if this option is set true,
28216 the error in the challenge is ignored and the client sends the response as
28217 usual.
28218
28219 .option client_send plaintext string&!! unset
28220 The string is a colon-separated list of authentication data strings. Each
28221 string is independently expanded before being sent to the server. The first
28222 string is sent with the AUTH command; any more strings are sent in response
28223 to prompts from the server. Before each string is expanded, the value of the
28224 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28225 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28226 way. Thus, the prompt that is received in response to sending the first string
28227 (with the AUTH command) can be used in the expansion of the second string, and
28228 so on. If an invalid base64 string is received when
28229 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28230 &$auth$&<&'n'&> variable.
28231
28232 &*Note*&: You cannot use expansion to create multiple strings, because
28233 splitting takes priority and happens first.
28234
28235 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28236 the data, further processing is applied to each string before it is sent. If
28237 there are any single circumflex characters in the string, they are converted to
28238 NULs. Should an actual circumflex be required as data, it must be doubled in
28239 the string.
28240
28241 This is an example of a client configuration that implements the PLAIN
28242 authentication mechanism with a fixed user name and password:
28243 .code
28244 fixed_plain:
28245   driver = plaintext
28246   public_name = PLAIN
28247   client_send = ^username^mysecret
28248 .endd
28249 The lack of colons means that the entire text is sent with the AUTH
28250 command, with the circumflex characters converted to NULs.
28251 Note that due to the ambiguity of parsing three consectutive circumflex characters
28252 there is no way to provide a password having a leading circumflex.
28253
28254
28255 A similar example
28256 that uses the LOGIN mechanism is:
28257 .code
28258 fixed_login:
28259   driver = plaintext
28260   public_name = LOGIN
28261   client_send = : username : mysecret
28262 .endd
28263 The initial colon means that the first string is empty, so no data is sent with
28264 the AUTH command itself. The remaining strings are sent in response to
28265 prompts.
28266 .ecindex IIDplaiauth1
28267 .ecindex IIDplaiauth2
28268
28269
28270
28271
28272 . ////////////////////////////////////////////////////////////////////////////
28273 . ////////////////////////////////////////////////////////////////////////////
28274
28275 .chapter "The cram_md5 authenticator" "CHID9"
28276 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28277 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28278 .cindex "CRAM-MD5 authentication mechanism"
28279 .cindex authentication CRAM-MD5
28280 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28281 sends a challenge string to the client, and the response consists of a user
28282 name and the CRAM-MD5 digest of the challenge string combined with a secret
28283 string (password) which is known to both server and client. Thus, the secret
28284 is not sent over the network as plain text, which makes this authenticator more
28285 secure than &(plaintext)&. However, the downside is that the secret has to be
28286 available in plain text at either end.
28287
28288
28289 .section "Using cram_md5 as a server" "SECID176"
28290 .cindex "options" "&(cram_md5)& authenticator (server)"
28291 This authenticator has one server option, which must be set to configure the
28292 authenticator as a server:
28293
28294 .option server_secret cram_md5 string&!! unset
28295 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28296 When the server receives the client's response, the user name is placed in
28297 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28298 obtain the password for that user. The server then computes the CRAM-MD5 digest
28299 that the client should have sent, and checks that it received the correct
28300 string. If the expansion of &%server_secret%& is forced to fail, authentication
28301 fails. If the expansion fails for some other reason, a temporary error code is
28302 returned to the client.
28303
28304 For compatibility with previous releases of Exim, the user name is also placed
28305 in &$1$&. However, the use of this variables for this purpose is now
28306 deprecated, as it can lead to confusion in string expansions that also use
28307 numeric variables for other things.
28308
28309 For example, the following authenticator checks that the user name given by the
28310 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28311 user name, authentication fails.
28312 .code
28313 fixed_cram:
28314   driver = cram_md5
28315   public_name = CRAM-MD5
28316   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28317   server_set_id = $auth1
28318 .endd
28319 .vindex "&$authenticated_id$&"
28320 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28321 name in &$authenticated_id$&. A more typical configuration might look up the
28322 secret string in a file, using the user name as the key. For example:
28323 .code
28324 lookup_cram:
28325   driver = cram_md5
28326   public_name = CRAM-MD5
28327   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28328                   {$value}fail}
28329   server_set_id = $auth1
28330 .endd
28331 Note that this expansion explicitly forces failure if the lookup fails
28332 because &$auth1$& contains an unknown user name.
28333
28334 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28335 using the relevant libraries, you need to know the realm to specify in the
28336 lookup and then ask for the &"userPassword"& attribute for that user in that
28337 realm, with:
28338 .code
28339 cyrusless_crammd5:
28340   driver = cram_md5
28341   public_name = CRAM-MD5
28342   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28343                   dbmjz{/etc/sasldb2}{$value}fail}
28344   server_set_id = $auth1
28345 .endd
28346
28347 .section "Using cram_md5 as a client" "SECID177"
28348 .cindex "options" "&(cram_md5)& authenticator (client)"
28349 When used as a client, the &(cram_md5)& authenticator has two options:
28350
28351
28352
28353 .option client_name cram_md5 string&!! "the primary host name"
28354 This string is expanded, and the result used as the user name data when
28355 computing the response to the server's challenge.
28356
28357
28358 .option client_secret cram_md5 string&!! unset
28359 This option must be set for the authenticator to work as a client. Its value is
28360 expanded and the result used as the secret string when computing the response.
28361
28362
28363 .vindex "&$host$&"
28364 .vindex "&$host_address$&"
28365 Different user names and secrets can be used for different servers by referring
28366 to &$host$& or &$host_address$& in the options. Forced failure of either
28367 expansion string is treated as an indication that this authenticator is not
28368 prepared to handle this case. Exim moves on to the next configured client
28369 authenticator. Any other expansion failure causes Exim to give up trying to
28370 send the message to the current server.
28371
28372 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28373 strings, is:
28374 .code
28375 fixed_cram:
28376   driver = cram_md5
28377   public_name = CRAM-MD5
28378   client_name = ph10
28379   client_secret = secret
28380 .endd
28381 .ecindex IIDcramauth1
28382 .ecindex IIDcramauth2
28383
28384
28385
28386 . ////////////////////////////////////////////////////////////////////////////
28387 . ////////////////////////////////////////////////////////////////////////////
28388
28389 .chapter "The cyrus_sasl authenticator" "CHID10"
28390 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28391 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28392 .cindex "Cyrus" "SASL library"
28393 .cindex "Kerberos"
28394 The code for this authenticator was provided by Matthew Byng-Maddick while
28395 at A L Digital Ltd.
28396
28397 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28398 library implementation of the RFC 2222 (&"Simple Authentication and Security
28399 Layer"&). This library supports a number of authentication mechanisms,
28400 including PLAIN and LOGIN, but also several others that Exim does not support
28401 directly. In particular, there is support for Kerberos authentication.
28402
28403 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28404 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28405 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28406 name of the driver to determine which mechanism to support.
28407
28408 Where access to some kind of secret file is required, for example, in GSSAPI
28409 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28410 user, and that the Cyrus SASL library has no way of escalating privileges
28411 by default. You may also find you need to set environment variables,
28412 depending on the driver you are using.
28413
28414 The application name provided by Exim is &"exim"&, so various SASL options may
28415 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28416 Kerberos, note that because of limitations in the GSSAPI interface,
28417 changing the server keytab might need to be communicated down to the Kerberos
28418 layer independently. The mechanism for doing so is dependent upon the Kerberos
28419 implementation.
28420
28421 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28422 may be set to point to an alternative keytab file. Exim will pass this
28423 variable through from its own inherited environment when started as root or the
28424 Exim user. The keytab file needs to be readable by the Exim user.
28425 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28426 environment variable.  In practice, for those releases, the Cyrus authenticator
28427 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28428 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28429
28430
28431 .section "Using cyrus_sasl as a server" "SECID178"
28432 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28433 (on a successful authentication) into &$auth1$&. For compatibility with
28434 previous releases of Exim, the username is also placed in &$1$&. However, the
28435 use of this variable for this purpose is now deprecated, as it can lead to
28436 confusion in string expansions that also use numeric variables for other
28437 things.
28438
28439
28440 .option server_hostname cyrus_sasl string&!! "see below"
28441 This option selects the hostname that is used when communicating with the
28442 library. The default value is &`$primary_hostname`&. It is up to the underlying
28443 SASL plug-in what it does with this data.
28444
28445
28446 .option server_mech cyrus_sasl string "see below"
28447 This option selects the authentication mechanism this driver should use. The
28448 default is the value of the generic &%public_name%& option. This option allows
28449 you to use a different underlying mechanism from the advertised name. For
28450 example:
28451 .code
28452 sasl:
28453   driver = cyrus_sasl
28454   public_name = X-ANYTHING
28455   server_mech = CRAM-MD5
28456   server_set_id = $auth1
28457 .endd
28458
28459 .option server_realm cyrus_sasl string&!! unset
28460 This specifies the SASL realm that the server claims to be in.
28461
28462
28463 .option server_service cyrus_sasl string &`smtp`&
28464 This is the SASL service that the server claims to implement.
28465
28466
28467 For straightforward cases, you do not need to set any of the authenticator's
28468 private options. All you need to do is to specify an appropriate mechanism as
28469 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28470 PLAIN, you could have two authenticators as follows:
28471 .code
28472 sasl_cram_md5:
28473   driver = cyrus_sasl
28474   public_name = CRAM-MD5
28475   server_set_id = $auth1
28476
28477 sasl_plain:
28478   driver = cyrus_sasl
28479   public_name = PLAIN
28480   server_set_id = $auth2
28481 .endd
28482 Cyrus SASL does implement the LOGIN authentication method, even though it is
28483 not a standard method. It is disabled by default in the source distribution,
28484 but it is present in many binary distributions.
28485 .ecindex IIDcyrauth1
28486 .ecindex IIDcyrauth2
28487
28488
28489
28490
28491 . ////////////////////////////////////////////////////////////////////////////
28492 . ////////////////////////////////////////////////////////////////////////////
28493 .chapter "The dovecot authenticator" "CHAPdovecot"
28494 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28495 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28496 This authenticator is an interface to the authentication facility of the
28497 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28498 Note that Dovecot must be configured to use auth-client not auth-userdb.
28499 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28500 to use the same mechanisms for SMTP authentication. This is a server
28501 authenticator only. There is only one non-generic option:
28502
28503 .option server_socket dovecot string unset
28504
28505 This option must specify the UNIX socket that is the interface to Dovecot
28506 authentication. The &%public_name%& option must specify an authentication
28507 mechanism that Dovecot is configured to support. You can have several
28508 authenticators for different mechanisms. For example:
28509 .code
28510 dovecot_plain:
28511   driver = dovecot
28512   public_name = PLAIN
28513   server_advertise_condition = ${if def:tls_in_cipher}
28514   server_socket = /var/run/dovecot/auth-client
28515   server_set_id = $auth1
28516
28517 dovecot_ntlm:
28518   driver = dovecot
28519   public_name = NTLM
28520   server_socket = /var/run/dovecot/auth-client
28521   server_set_id = $auth1
28522 .endd
28523
28524 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28525 should not be advertised on cleartext SMTP connections.
28526 See the discussion in section &<<SECTplain_TLS>>&.
28527
28528 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28529 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28530 option is passed in the Dovecot authentication command. If, for a TLS
28531 connection, a client certificate has been verified, the &"valid-client-cert"&
28532 option is passed. When authentication succeeds, the identity of the user
28533 who authenticated is placed in &$auth1$&.
28534
28535 The Dovecot configuration to match the above will look
28536 something like:
28537 .code
28538 conf.d/10-master.conf :-
28539
28540 service auth {
28541 ...
28542 #SASL
28543   unix_listener auth-client {
28544     mode = 0660
28545     user = mail
28546   }
28547 ...
28548 }
28549
28550 conf.d/10-auth.conf :-
28551
28552 auth_mechanisms = plain login ntlm
28553 .endd
28554
28555 .ecindex IIDdcotauth1
28556 .ecindex IIDdcotauth2
28557
28558
28559 . ////////////////////////////////////////////////////////////////////////////
28560 . ////////////////////////////////////////////////////////////////////////////
28561 .chapter "The gsasl authenticator" "CHAPgsasl"
28562 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28563 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28564 .cindex "authentication" "GNU SASL"
28565 .cindex "authentication" "SASL"
28566 .cindex "authentication" "EXTERNAL"
28567 .cindex "authentication" "ANONYMOUS"
28568 .cindex "authentication" "PLAIN"
28569 .cindex "authentication" "LOGIN"
28570 .cindex "authentication" "DIGEST-MD5"
28571 .cindex "authentication" "CRAM-MD5"
28572 .cindex "authentication" "SCRAM family"
28573 The &(gsasl)& authenticator provides integration for the GNU SASL
28574 library and the mechanisms it provides.  This is new as of the 4.80 release
28575 and there are a few areas where the library does not let Exim smoothly
28576 scale to handle future authentication mechanisms, so no guarantee can be
28577 made that any particular new authentication mechanism will be supported
28578 without code changes in Exim.
28579
28580 The library is expected to add support in an upcoming
28581 realease for the SCRAM-SHA-256 method.
28582 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28583 when this happens.
28584
28585 To see the list of mechanisms supported by the library run Exim with "auth" debug
28586 enabled and look for a line containing "GNU SASL supports".
28587 Note however that some may not have been tested from Exim.
28588
28589
28590 .option client_authz gsasl string&!! unset
28591 This option can be used to supply an &'authorization id'&
28592 which is different to the &'authentication_id'& provided
28593 by &%client_username%& option.
28594 If unset or (after expansion) empty it is not used,
28595 which is the common case.
28596
28597 .option client_channelbinding gsasl boolean false
28598 See &%server_channelbinding%& below.
28599
28600 .option client_password gsasl string&!! unset
28601 This option is exapanded before use, and should result in
28602 the password to be used, in clear.
28603
28604 .option client_username gsasl string&!! unset
28605 This option is exapanded before use, and should result in
28606 the account name to be used.
28607
28608
28609 .option client_spassword gsasl string&!! unset
28610 This option is only supported for library versions 1.9.1 and greater.
28611 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28612
28613 If a SCRAM mechanism is being used and this option is set
28614 and correctly sized
28615 it is used in preference to &%client_password%&.
28616 The value after expansion should be
28617 a 40 (for SHA-1) or 64 (for SHA-256) character string
28618 with the PBKDF2-prepared password, hex-encoded.
28619
28620 Note that this value will depend on the salt and iteration-count
28621 supplied by the server.
28622 The option is expanded before use.
28623 During the expansion &$auth1$& is set with the client username,
28624 &$auth2$& with the iteration count, and
28625 &$auth3$& with the salt.
28626
28627 The intent of this option
28628 is to support clients that can cache thes salted password
28629 to save on recalculation costs.
28630 The cache lookup should return an unusable value
28631 (eg. an empty string)
28632 if the salt or iteration count has changed
28633
28634 If the authentication succeeds then the above variables are set,
28635 .vindex "&$auth4$&"
28636 plus the calculated salted password value value in &$auth4$&,
28637 during the expansion of the &%client_set_id%& option.
28638 A side-effect of this expansion can be used to prime the cache.
28639
28640
28641 .option server_channelbinding gsasl boolean false
28642 Some authentication mechanisms are able to use external context at both ends
28643 of the session to bind the authentication to that context, and fail the
28644 authentication process if that context differs.  Specifically, some TLS
28645 ciphersuites can provide identifying information about the cryptographic
28646 context.
28647
28648 This should have meant that certificate identity and verification becomes a
28649 non-issue, as a man-in-the-middle attack will cause the correct client and
28650 server to see different identifiers and authentication will fail.
28651
28652 This is
28653 only usable by mechanisms which support "channel binding"; at time of
28654 writing, that's the SCRAM family.
28655 When using this feature the "-PLUS" variants of the method names need to be used.
28656
28657 This defaults off to ensure smooth upgrade across Exim releases, in case
28658 this option causes some clients to start failing.  Some future release
28659 of Exim might have switched the default to be true.
28660
28661 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28662 . Do not plan to rely upon this feature for security, ever, without consulting
28663 . with a subject matter expert (a cryptographic engineer).
28664
28665 This option was deprecated in previous releases due to doubts over
28666 the "Triple Handshake" vulnerability.
28667 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28668 Session Resumption was used) for safety.
28669
28670
28671 .option server_hostname gsasl string&!! "see below"
28672 This option selects the hostname that is used when communicating with the
28673 library. The default value is &`$primary_hostname`&.
28674 Some mechanisms will use this data.
28675
28676
28677 .option server_mech gsasl string "see below"
28678 This option selects the authentication mechanism this driver should use. The
28679 default is the value of the generic &%public_name%& option. This option allows
28680 you to use a different underlying mechanism from the advertised name. For
28681 example:
28682 .code
28683 sasl:
28684   driver = gsasl
28685   public_name = X-ANYTHING
28686   server_mech = CRAM-MD5
28687   server_set_id = $auth1
28688 .endd
28689
28690
28691 .option server_password gsasl string&!! unset
28692 Various mechanisms need access to the cleartext password on the server, so
28693 that proof-of-possession can be demonstrated on the wire, without sending
28694 the password itself.
28695
28696 The data available for lookup varies per mechanism.
28697 In all cases, &$auth1$& is set to the &'authentication id'&.
28698 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28699 if available, else the empty string.
28700 The &$auth3$& variable will always be the &'realm'& if available,
28701 else the empty string.
28702
28703 A forced failure will cause authentication to defer.
28704
28705 If using this option, it may make sense to set the &%server_condition%&
28706 option to be simply "true".
28707
28708
28709 .option server_realm gsasl string&!! unset
28710 This specifies the SASL realm that the server claims to be in.
28711 Some mechanisms will use this data.
28712
28713
28714 .option server_scram_iter gsasl string&!! 4096
28715 This option provides data for the SCRAM family of mechanisms.
28716 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28717 when this option is expanded.
28718
28719 The result of expansion should be a decimal number,
28720 and represents both a lower-bound on the security, and
28721 a compute cost factor imposed on the client
28722 (if it does not cache results, or the server changes
28723 either the iteration count or the salt).
28724 A minimum value of 4096 is required by the standards
28725 for all current SCRAM mechanism variants.
28726
28727 .option server_scram_salt gsasl string&!! unset
28728 This option provides data for the SCRAM family of mechanisms.
28729 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28730 when this option is expanded.
28731 The value should be a base64-encoded string,
28732 of random data typically 4-to-16 bytes long.
28733 If unset or empty after expansion the library will provides a value for the
28734 protocol conversation.
28735
28736
28737 .option server_key gsasl string&!! unset
28738 .option server_skey gsasl string&!! unset
28739 These options can be used for the SCRAM family of mechanisms
28740 to provide stored information related to a password,
28741 the storage of which is preferable to plaintext.
28742
28743 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28744 &%server_skey%& is StoredKey.
28745
28746 They are only available for version 1.9.0 (or later) of the gsasl library.
28747 When this is so, the macros
28748 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28749 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28750 will be defined.
28751
28752 The &$authN$& variables are available when these options are expanded.
28753
28754 If set, the results of expansion should for each
28755 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28756 of base64-coded data, and will be used in preference to the
28757 &%server_password%& option.
28758 If unset or not of the right length, &%server_password%& will be used.
28759
28760 The libgsasl library release includes a utility &'gsasl'& which can be used
28761 to generate these values.
28762
28763
28764 .option server_service gsasl string &`smtp`&
28765 This is the SASL service that the server claims to implement.
28766 Some mechanisms will use this data.
28767
28768
28769 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28770 .vindex "&$auth1$&, &$auth2$&, etc"
28771 These may be set when evaluating specific options, as detailed above.
28772 They will also be set when evaluating &%server_condition%&.
28773
28774 Unless otherwise stated below, the &(gsasl)& integration will use the following
28775 meanings for these variables:
28776
28777 .ilist
28778 .vindex "&$auth1$&"
28779 &$auth1$&: the &'authentication id'&
28780 .next
28781 .vindex "&$auth2$&"
28782 &$auth2$&: the &'authorization id'&
28783 .next
28784 .vindex "&$auth3$&"
28785 &$auth3$&: the &'realm'&
28786 .endlist
28787
28788 On a per-mechanism basis:
28789
28790 .ilist
28791 .cindex "authentication" "EXTERNAL"
28792 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28793 the &%server_condition%& option must be present.
28794 .next
28795 .cindex "authentication" "ANONYMOUS"
28796 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28797 the &%server_condition%& option must be present.
28798 .next
28799 .cindex "authentication" "GSSAPI"
28800 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28801 &$auth2$& will be set to the &'authorization id'&,
28802 the &%server_condition%& option must be present.
28803 .endlist
28804
28805 An &'anonymous token'& is something passed along as an unauthenticated
28806 identifier; this is analogous to FTP anonymous authentication passing an
28807 email address, or software-identifier@, as the "password".
28808
28809
28810 An example showing the password having the realm specified in the callback
28811 and demonstrating a Cyrus SASL to GSASL migration approach is:
28812 .code
28813 gsasl_cyrusless_crammd5:
28814   driver = gsasl
28815   public_name = CRAM-MD5
28816   server_realm = imap.example.org
28817   server_password = ${lookup{$auth1:$auth3:userPassword}\
28818                     dbmjz{/etc/sasldb2}{$value}fail}
28819   server_set_id = ${quote:$auth1}
28820   server_condition = yes
28821 .endd
28822
28823
28824 . ////////////////////////////////////////////////////////////////////////////
28825 . ////////////////////////////////////////////////////////////////////////////
28826
28827 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28828 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28829 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28830 .cindex "authentication" "GSSAPI"
28831 .cindex "authentication" "Kerberos"
28832 The &(heimdal_gssapi)& authenticator provides server integration for the
28833 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28834 reliably.
28835
28836 .option server_hostname heimdal_gssapi string&!! "see below"
28837 This option selects the hostname that is used, with &%server_service%&,
28838 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28839 identifier.  The default value is &`$primary_hostname`&.
28840
28841 .option server_keytab heimdal_gssapi string&!! unset
28842 If set, then Heimdal will not use the system default keytab (typically
28843 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28844 The value should be a pathname, with no &"file:"& prefix.
28845
28846 .option server_service heimdal_gssapi string&!! "smtp"
28847 This option specifies the service identifier used, in conjunction with
28848 &%server_hostname%&, for building the identifier for finding credentials
28849 from the keytab.
28850
28851
28852 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28853 Beware that these variables will typically include a realm, thus will appear
28854 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28855 not verified, so a malicious client can set it to anything.
28856
28857 The &$auth1$& field should be safely trustable as a value from the Key
28858 Distribution Center.  Note that these are not quite email addresses.
28859 Each identifier is for a role, and so the left-hand-side may include a
28860 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28861
28862 .vindex "&$auth1$&, &$auth2$&, etc"
28863 .ilist
28864 .vindex "&$auth1$&"
28865 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28866 .next
28867 .vindex "&$auth2$&"
28868 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28869 authentication.  If that was empty, this will also be set to the
28870 GSS Display Name.
28871 .endlist
28872
28873
28874 . ////////////////////////////////////////////////////////////////////////////
28875 . ////////////////////////////////////////////////////////////////////////////
28876
28877 .chapter "The spa authenticator" "CHAPspa"
28878 .scindex IIDspaauth1 "&(spa)& authenticator"
28879 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28880 .cindex "authentication" "Microsoft Secure Password"
28881 .cindex "authentication" "NTLM"
28882 .cindex "Microsoft Secure Password Authentication"
28883 .cindex "NTLM authentication"
28884 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28885 Password Authentication'& mechanism,
28886 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28887 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28888 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28889 server side was subsequently contributed by Tom Kistner. The mechanism works as
28890 follows:
28891
28892 .ilist
28893 After the AUTH command has been accepted, the client sends an SPA
28894 authentication request based on the user name and optional domain.
28895 .next
28896 The server sends back a challenge.
28897 .next
28898 The client builds a challenge response which makes use of the user's password
28899 and sends it to the server, which then accepts or rejects it.
28900 .endlist
28901
28902 Encryption is used to protect the password in transit.
28903
28904
28905
28906 .section "Using spa as a server" "SECID179"
28907 .cindex "options" "&(spa)& authenticator (server)"
28908 The &(spa)& authenticator has just one server option:
28909
28910 .option server_password spa string&!! unset
28911 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28912 This option is expanded, and the result must be the cleartext password for the
28913 authenticating user, whose name is at this point in &$auth1$&. For
28914 compatibility with previous releases of Exim, the user name is also placed in
28915 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28916 it can lead to confusion in string expansions that also use numeric variables
28917 for other things. For example:
28918 .code
28919 spa:
28920   driver = spa
28921   public_name = NTLM
28922   server_password = \
28923     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28924 .endd
28925 If the expansion is forced to fail, authentication fails. Any other expansion
28926 failure causes a temporary error code to be returned.
28927
28928
28929
28930
28931
28932 .section "Using spa as a client" "SECID180"
28933 .cindex "options" "&(spa)& authenticator (client)"
28934 The &(spa)& authenticator has the following client options:
28935
28936
28937
28938 .option client_domain spa string&!! unset
28939 This option specifies an optional domain for the authentication.
28940
28941
28942 .option client_password spa string&!! unset
28943 This option specifies the user's password, and must be set.
28944
28945
28946 .option client_username spa string&!! unset
28947 This option specifies the user name, and must be set. Here is an example of a
28948 configuration of this authenticator for use with the mail servers at
28949 &'msn.com'&:
28950 .code
28951 msn:
28952   driver = spa
28953   public_name = MSN
28954   client_username = msn/msn_username
28955   client_password = msn_plaintext_password
28956   client_domain = DOMAIN_OR_UNSET
28957 .endd
28958 .ecindex IIDspaauth1
28959 .ecindex IIDspaauth2
28960
28961
28962
28963
28964
28965 . ////////////////////////////////////////////////////////////////////////////
28966 . ////////////////////////////////////////////////////////////////////////////
28967
28968 .chapter "The external authenticator" "CHAPexternauth"
28969 .scindex IIDexternauth1 "&(external)& authenticator"
28970 .scindex IIDexternauth2 "authenticators" "&(external)&"
28971 .cindex "authentication" "Client Certificate"
28972 .cindex "authentication" "X509"
28973 .cindex "Certificate-based authentication"
28974 The &(external)& authenticator provides support for
28975 authentication based on non-SMTP information.
28976 The specification is in RFC 4422 Appendix A
28977 (&url(https://tools.ietf.org/html/rfc4422)).
28978 It is only a transport and negotiation mechanism;
28979 the process of authentication is entirely controlled
28980 by the server configuration.
28981
28982 The client presents an identity in-clear.
28983 It is probably wise for a server to only advertise,
28984 and for clients to only attempt,
28985 this authentication method on a secure (eg. under TLS) connection.
28986
28987 One possible use, compatible with the
28988 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28989 is for using X509 client certificates.
28990
28991 It thus overlaps in function with the TLS authenticator
28992 (see &<<CHAPtlsauth>>&)
28993 but is a full SMTP SASL authenticator
28994 rather than being implicit for TLS-connection carried
28995 client certificates only.
28996
28997 The examples and discussion in this chapter assume that
28998 client-certificate authentication is being done.
28999
29000 The client must present a certificate,
29001 for which it must have been requested via the
29002 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29003 (see &<<CHAPTLS>>&).
29004 For authentication to be effective the certificate should be
29005 verifiable against a trust-anchor certificate known to the server.
29006
29007 .section "External options" "SECTexternsoptions"
29008 .cindex "options" "&(external)& authenticator (server)"
29009 The &(external)& authenticator has two server options:
29010
29011 .option server_param2 external string&!! unset
29012 .option server_param3 external string&!! unset
29013 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
29014 These options are expanded before the &%server_condition%& option
29015 and the result are placed in &$auth2$& and &$auth3$& resectively.
29016 If the expansion is forced to fail, authentication fails. Any other expansion
29017 failure causes a temporary error code to be returned.
29018
29019 They can be used to clarify the coding of a complex &%server_condition%&.
29020
29021 .section "Using external in a server" "SECTexternserver"
29022 .cindex "AUTH" "in &(external)& authenticator"
29023 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
29024         "in &(external)& authenticator"
29025 .vindex "&$auth1$&, &$auth2$&, etc"
29026 .cindex "base64 encoding" "in &(external)& authenticator"
29027
29028 When running as a server, &(external)& performs the authentication test by
29029 expanding a string. The data sent by the client with the AUTH command, or in
29030 response to subsequent prompts, is base64 encoded, and so may contain any byte
29031 values when decoded. The decoded value is treated as
29032 an identity for authentication and
29033 placed in the expansion variable &$auth1$&.
29034
29035 For compatibility with previous releases of Exim, the value is also placed in
29036 the expansion variable &$1$&. However, the use of this
29037 variable for this purpose is now deprecated, as it can lead to confusion in
29038 string expansions that also use them for other things.
29039
29040 .vindex "&$authenticated_id$&"
29041 Once an identity has been received,
29042 &%server_condition%& is expanded. If the expansion is forced to fail,
29043 authentication fails. Any other expansion failure causes a temporary error code
29044 to be returned. If the result of a successful expansion is an empty string,
29045 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
29046 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
29047 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
29048 For any other result, a temporary error code is returned, with the expanded
29049 string as the error text.
29050
29051 Example:
29052 .code
29053 ext_ccert_san_mail:
29054   driver =            external
29055   public_name =       EXTERNAL
29056
29057   server_advertise_condition = $tls_in_certificate_verified
29058   server_param2 =     ${certextract {subj_altname,mail,>:} \
29059                                     {$tls_in_peercert}}
29060   server_condition =  ${if forany {$auth2} \
29061                             {eq {$item}{$auth1}}}
29062   server_set_id =     $auth1
29063 .endd
29064 This accepts a client certificate that is verifiable against any
29065 of your configured trust-anchors
29066 (which usually means the full set of public CAs)
29067 and which has a mail-SAN matching the claimed identity sent by the client.
29068
29069 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
29070 The account name is therefore guessable by an opponent.
29071 TLS 1.3 protects both server and client certificates, and is not vulnerable
29072 in this way.
29073
29074
29075 .section "Using external in a client" "SECTexternclient"
29076 .cindex "options" "&(external)& authenticator (client)"
29077 The &(external)& authenticator has one client option:
29078
29079 .option client_send external string&!! unset
29080 This option is expanded and sent with the AUTH command as the
29081 identity being asserted.
29082
29083 Example:
29084 .code
29085 ext_ccert:
29086   driver =      external
29087   public_name = EXTERNAL
29088
29089   client_condition = ${if !eq{$tls_out_cipher}{}}
29090   client_send = myaccount@smarthost.example.net
29091 .endd
29092
29093
29094 .ecindex IIDexternauth1
29095 .ecindex IIDexternauth2
29096
29097
29098
29099
29100
29101 . ////////////////////////////////////////////////////////////////////////////
29102 . ////////////////////////////////////////////////////////////////////////////
29103
29104 .chapter "The tls authenticator" "CHAPtlsauth"
29105 .scindex IIDtlsauth1 "&(tls)& authenticator"
29106 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
29107 .cindex "authentication" "Client Certificate"
29108 .cindex "authentication" "X509"
29109 .cindex "Certificate-based authentication"
29110 The &(tls)& authenticator provides server support for
29111 authentication based on client certificates.
29112
29113 It is not an SMTP authentication mechanism and is not
29114 advertised by the server as part of the SMTP EHLO response.
29115 It is an Exim authenticator in the sense that it affects
29116 the protocol element of the log line, can be tested for
29117 by the &%authenticated%& ACL condition, and can set
29118 the &$authenticated_id$& variable.
29119
29120 The client must present a verifiable certificate,
29121 for which it must have been requested via the
29122 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29123 (see &<<CHAPTLS>>&).
29124
29125 If an authenticator of this type is configured it is
29126 run immediately after a TLS connection being negotiated
29127 (due to either STARTTLS or TLS-on-connect)
29128 and can authenticate the connection.
29129 If it does, SMTP authentication is not subsequently offered.
29130
29131 A maximum of one authenticator of this type may be present.
29132
29133
29134 .cindex "options" "&(tls)& authenticator (server)"
29135 The &(tls)& authenticator has three server options:
29136
29137 .option server_param1 tls string&!! unset
29138 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29139 This option is expanded after the TLS negotiation and
29140 the result is placed in &$auth1$&.
29141 If the expansion is forced to fail, authentication fails. Any other expansion
29142 failure causes a temporary error code to be returned.
29143
29144 .option server_param2 tls string&!! unset
29145 .option server_param3 tls string&!! unset
29146 As above, for &$auth2$& and &$auth3$&.
29147
29148 &%server_param1%& may also be spelled &%server_param%&.
29149
29150
29151 Example:
29152 .code
29153 tls:
29154   driver = tls
29155   server_param1 =     ${certextract {subj_altname,mail,>:} \
29156                                     {$tls_in_peercert}}
29157   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29158                                  {forany {$auth1} \
29159                             {!= {0} \
29160                                 {${lookup ldap{ldap:///\
29161                          mailname=${quote_ldap_dn:${lc:$item}},\
29162                          ou=users,LDAP_DC?mailid} {$value}{0} \
29163                        }    }  } }}}
29164   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29165 .endd
29166 This accepts a client certificate that is verifiable against any
29167 of your configured trust-anchors
29168 (which usually means the full set of public CAs)
29169 and which has a SAN with a good account name.
29170
29171 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29172 The account name is therefore guessable by an opponent.
29173 TLS 1.3 protects both server and client certificates, and is not vulnerable
29174 in this way.
29175 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29176
29177 . An alternative might use
29178 . .code
29179 .   server_param1 = ${sha256:$tls_in_peercert}
29180 . .endd
29181 . to require one of a set of specific certs that define a given account
29182 . (the verification is still required, but mostly irrelevant).
29183 . This would help for per-device use.
29184 .
29185 . However, for the future we really need support for checking a
29186 . user cert in LDAP - which probably wants a base-64 DER.
29187
29188 .ecindex IIDtlsauth1
29189 .ecindex IIDtlsauth2
29190
29191
29192 Note that because authentication is traditionally an SMTP operation,
29193 the &%authenticated%& ACL condition cannot be used in
29194 a connect- or helo-ACL.
29195
29196
29197
29198 . ////////////////////////////////////////////////////////////////////////////
29199 . ////////////////////////////////////////////////////////////////////////////
29200
29201 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29202          "Encrypted SMTP connections"
29203 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29204 .scindex IIDencsmtp2 "SMTP" "encryption"
29205 .cindex "TLS" "on SMTP connection"
29206 .cindex "OpenSSL"
29207 .cindex "GnuTLS"
29208 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29209 Sockets Layer), is implemented by making use of the OpenSSL library or the
29210 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29211 cryptographic code in the Exim distribution itself for implementing TLS. In
29212 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29213 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29214 You also need to understand the basic concepts of encryption at a managerial
29215 level, and in particular, the way that public keys, private keys, and
29216 certificates are used.
29217
29218 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29219 connection is established, the client issues a STARTTLS command. If the
29220 server accepts this, the client and the server negotiate an encryption
29221 mechanism. If the negotiation succeeds, the data that subsequently passes
29222 between them is encrypted.
29223
29224 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29225 and if so, what cipher suite is in use, whether the client supplied a
29226 certificate, and whether or not that certificate was verified. This makes it
29227 possible for an Exim server to deny or accept certain commands based on the
29228 encryption state.
29229
29230 &*Warning*&: Certain types of firewall and certain anti-virus products can
29231 disrupt TLS connections. You need to turn off SMTP scanning for these products
29232 in order to get TLS to work.
29233
29234
29235
29236 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29237          "SECID284"
29238 .cindex "submissions protocol"
29239 .cindex "ssmtp protocol"
29240 .cindex "smtps protocol"
29241 .cindex "SMTP" "submissions protocol"
29242 .cindex "SMTP" "ssmtp protocol"
29243 .cindex "SMTP" "smtps protocol"
29244 The history of port numbers for TLS in SMTP is a little messy and has been
29245 contentious.  As of RFC 8314, the common practice of using the historically
29246 allocated port 465 for "email submission but with TLS immediately upon connect
29247 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29248 by them in preference to STARTTLS.
29249
29250 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29251 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29252 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29253
29254 This approach was, for a while, officially abandoned when encrypted SMTP was
29255 standardized, but many clients kept using it, even as the TCP port number was
29256 reassigned for other use.
29257 Thus you may encounter guidance claiming that you shouldn't enable use of
29258 this port.
29259 In practice, a number of mail-clients have only ever supported submissions,
29260 not submission with STARTTLS upgrade.
29261 Ideally, offer both submission (587) and submissions (465) service.
29262
29263 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29264 global option. Its value must be a list of port numbers;
29265 the most common use is expected to be:
29266 .code
29267 tls_on_connect_ports = 465
29268 .endd
29269 The port numbers specified by this option apply to all SMTP connections, both
29270 via the daemon and via &'inetd'&. You still need to specify all the ports that
29271 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29272 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29273 an extra port &-- rather, it specifies different behaviour on a port that is
29274 defined elsewhere.
29275
29276 There is also a &%-tls-on-connect%& command line option. This overrides
29277 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29278
29279
29280
29281
29282
29283
29284 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29285 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29286 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29287 To build Exim to use OpenSSL you need to set
29288 .code
29289 USE_OPENSSL=yes
29290 .endd
29291 in Local/Makefile.
29292
29293 To build Exim to use GnuTLS, you need to set
29294 .code
29295 USE_GNUTLS=yes
29296 .endd
29297 in Local/Makefile.
29298
29299 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29300 include files and libraries for GnuTLS can be found.
29301
29302 There are some differences in usage when using GnuTLS instead of OpenSSL:
29303
29304 .ilist
29305 The &%tls_verify_certificates%& option
29306 cannot be the path of a directory
29307 for GnuTLS versions before 3.3.6
29308 (for later versions, or OpenSSL, it can be either).
29309 .next
29310 The default value for &%tls_dhparam%& differs for historical reasons.
29311 .next
29312 .vindex "&$tls_in_peerdn$&"
29313 .vindex "&$tls_out_peerdn$&"
29314 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29315 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29316 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29317 .next
29318 OpenSSL identifies cipher suites using hyphens as separators, for example:
29319 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29320 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29321 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29322 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29323 to handle its own older variants) when processing lists of cipher suites in the
29324 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29325 option).
29326 .next
29327 The &%tls_require_ciphers%& options operate differently, as described in the
29328 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29329 .next
29330 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29331 When using OpenSSL, this option is ignored.
29332 (If an API is found to let OpenSSL be configured in this way,
29333 let the Exim Maintainers know and we'll likely use it).
29334 .next
29335 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option,
29336 it must be ordered to match the &%tls_certificate%& list.
29337 .next
29338 Some other recently added features may only be available in one or the other.
29339 This should be documented with the feature.  If the documentation does not
29340 explicitly state that the feature is infeasible in the other TLS
29341 implementation, then patches are welcome.
29342 .next
29343 The output from "exim -bV" will show which (if any) support was included
29344 in the build.
29345 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29346 .endlist
29347
29348
29349 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29350 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29351 an explicit path; if the latter, then the text about generation still applies,
29352 but not the chosen filename.
29353 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29354 See the documentation of &%tls_dhparam%& for more information.
29355
29356 GnuTLS uses D-H parameters that may take a substantial amount of time
29357 to compute. It is unreasonable to re-compute them for every TLS session.
29358 Therefore, Exim keeps this data in a file in its spool directory, called
29359 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29360 of bits requested.
29361 The file is owned by the Exim user and is readable only by
29362 its owner. Every Exim process that start up GnuTLS reads the D-H
29363 parameters from this file. If the file does not exist, the first Exim process
29364 that needs it computes the data and writes it to a temporary file which is
29365 renamed once it is complete. It does not matter if several Exim processes do
29366 this simultaneously (apart from wasting a few resources). Once a file is in
29367 place, new Exim processes immediately start using it.
29368
29369 For maximum security, the parameters that are stored in this file should be
29370 recalculated periodically, the frequency depending on your paranoia level.
29371 If you are avoiding using the fixed D-H primes published in RFCs, then you
29372 are concerned about some advanced attacks and will wish to do this; if you do
29373 not regenerate then you might as well stick to the standard primes.
29374
29375 Arranging this is easy in principle; just delete the file when you want new
29376 values to be computed. However, there may be a problem. The calculation of new
29377 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29378 If the system is not very active, &_/dev/random_& may delay returning data
29379 until enough randomness (entropy) is available. This may cause Exim to hang for
29380 a substantial amount of time, causing timeouts on incoming connections.
29381
29382 The solution is to generate the parameters externally to Exim. They are stored
29383 in &_gnutls-params-N_& in PEM format, which means that they can be
29384 generated externally using the &(certtool)& command that is part of GnuTLS.
29385
29386 To replace the parameters with new ones, instead of deleting the file
29387 and letting Exim re-create it, you can generate new parameters using
29388 &(certtool)& and, when this has been done, replace Exim's cache file by
29389 renaming. The relevant commands are something like this:
29390 .code
29391 # ls
29392 [ look for file; assume gnutls-params-2236 is the most recent ]
29393 # rm -f new-params
29394 # touch new-params
29395 # chown exim:exim new-params
29396 # chmod 0600 new-params
29397 # certtool --generate-dh-params --bits 2236 >>new-params
29398 # openssl dhparam -noout -text -in new-params | head
29399 [ check the first line, make sure it's not more than 2236;
29400   if it is, then go back to the start ("rm") and repeat
29401   until the size generated is at most the size requested ]
29402 # chmod 0400 new-params
29403 # mv new-params gnutls-params-2236
29404 .endd
29405 If Exim never has to generate the parameters itself, the possibility of
29406 stalling is removed.
29407
29408 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29409 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29410 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29411 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29412 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29413 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29414 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29415 which applies to all D-H usage, client or server.  If the value returned by
29416 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29417 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29418 limit, which is still much higher than Exim historically used.
29419
29420 The filename and bits used will change as the GnuTLS maintainers change the
29421 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29422 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29423 2432 bits, while NSS is limited to 2236 bits.
29424
29425 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29426 increase the chance of the generated prime actually being within acceptable
29427 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29428 procedure above.  There is no sane procedure available to Exim to double-check
29429 the size of the generated prime, so it might still be too large.
29430
29431
29432 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29433 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29434 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29435 There is a function in the OpenSSL library that can be passed a list of cipher
29436 suites before the cipher negotiation takes place. This specifies which ciphers
29437 are acceptable for TLS versions prior to 1.3.
29438 The list is colon separated and may contain names like
29439 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29440 directly to this function call.
29441 Many systems will install the OpenSSL manual-pages, so you may have
29442 &'ciphers(1)'& available to you.
29443 The following quotation from the OpenSSL
29444 documentation specifies what forms of item are allowed in the cipher string:
29445
29446 .ilist
29447 It can consist of a single cipher suite such as RC4-SHA.
29448 .next
29449 It can represent a list of cipher suites containing a certain algorithm,
29450 or cipher suites of a certain type. For example SHA1 represents all
29451 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29452 SSL v3 algorithms.
29453 .next
29454 Lists of cipher suites can be combined in a single cipher string using
29455 the + character. This is used as a logical and operation. For example
29456 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29457 algorithms.
29458 .endlist
29459
29460 Each cipher string can be optionally preceded by one of the characters &`!`&,
29461 &`-`& or &`+`&.
29462 .ilist
29463 If &`!`& is used, the ciphers are permanently deleted from the list. The
29464 ciphers deleted can never reappear in the list even if they are explicitly
29465 stated.
29466 .next
29467 If &`-`& is used, the ciphers are deleted from the list, but some or all
29468 of the ciphers can be added again by later options.
29469 .next
29470 If &`+`& is used, the ciphers are moved to the end of the list. This
29471 option does not add any new ciphers; it just moves matching existing ones.
29472 .endlist
29473
29474 If none of these characters is present, the string is interpreted as
29475 a list of ciphers to be appended to the current preference list. If the list
29476 includes any ciphers already present they will be ignored: that is, they will
29477 not be moved to the end of the list.
29478 .endlist
29479
29480 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29481 string:
29482 .code
29483 # note single-quotes to get ! past any shell history expansion
29484 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29485 .endd
29486
29487 This example will let the library defaults be permitted on the MX port, where
29488 there's probably no identity verification anyway, but ups the ante on the
29489 submission ports where the administrator might have some influence on the
29490 choice of clients used:
29491 .code
29492 # OpenSSL variant; see man ciphers(1)
29493 tls_require_ciphers = ${if =={$received_port}{25}\
29494                            {DEFAULT}\
29495                            {HIGH:!MD5:!SHA1}}
29496 .endd
29497
29498 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29499 .code
29500 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29501 .endd
29502
29503 For TLS version 1.3 the control available is less fine-grained
29504 and Exim does not provide access to it at present.
29505 The value of the &%tls_require_ciphers%& option is ignored when
29506 TLS version 1.3 is negotiated.
29507
29508 As of writing the library default cipher suite list for TLSv1.3 is
29509 .code
29510 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29511 .endd
29512
29513
29514 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29515          "SECTreqciphgnu"
29516 .cindex "GnuTLS" "specifying parameters for"
29517 .cindex "TLS" "specifying ciphers (GnuTLS)"
29518 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29519 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29520 .cindex "TLS" "specifying protocols (GnuTLS)"
29521 .cindex "TLS" "specifying priority string (GnuTLS)"
29522 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29523 The GnuTLS library allows the caller to provide a "priority string", documented
29524 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29525 ciphersuite specification in OpenSSL.
29526
29527 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29528 and controls both protocols and ciphers.
29529
29530 The &%tls_require_ciphers%& option is available both as an global option,
29531 controlling how Exim behaves as a server, and also as an option of the
29532 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29533 the value is string expanded.  The resulting string is not an Exim list and
29534 the string is given to the GnuTLS library, so that Exim does not need to be
29535 aware of future feature enhancements of GnuTLS.
29536
29537 Documentation of the strings accepted may be found in the GnuTLS manual, under
29538 "Priority strings".  This is online as
29539 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29540 but beware that this relates to GnuTLS 3, which may be newer than the version
29541 installed on your system.  If you are using GnuTLS 3,
29542 then the example code
29543 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29544 on that site can be used to test a given string.
29545
29546 For example:
29547 .code
29548 # Disable older versions of protocols
29549 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29550 .endd
29551
29552 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29553 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29554 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29555
29556 This example will let the library defaults be permitted on the MX port, where
29557 there's probably no identity verification anyway, and lowers security further
29558 by increasing compatibility; but this ups the ante on the submission ports
29559 where the administrator might have some influence on the choice of clients
29560 used:
29561 .code
29562 # GnuTLS variant
29563 tls_require_ciphers = ${if =={$received_port}{25}\
29564                            {NORMAL:%COMPAT}\
29565                            {SECURE128}}
29566 .endd
29567
29568
29569 .section "Configuring an Exim server to use TLS" "SECID182"
29570 .cindex "TLS" "configuring an Exim server"
29571 .cindex "ESMTP extensions" STARTTLS
29572 When Exim has been built with TLS support, it advertises the availability of
29573 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29574 but not to any others. The default value of this option is *, which means
29575 that STARTTLS is always advertised.  Set it to blank to never advertise;
29576 this is reasonable for systems that want to use TLS only as a client.
29577
29578 If STARTTLS is to be used you
29579 need to set some other options in order to make TLS available.
29580
29581 If a client issues a STARTTLS command and there is some configuration
29582 problem in the server, the command is rejected with a 454 error. If the client
29583 persists in trying to issue SMTP commands, all except QUIT are rejected
29584 with the error
29585 .code
29586 554 Security failure
29587 .endd
29588 If a STARTTLS command is issued within an existing TLS session, it is
29589 rejected with a 554 error code.
29590
29591 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29592 must be set to match some hosts. The default is * which matches all hosts.
29593
29594 If this is all you do, TLS encryption will be enabled but not authentication -
29595 meaning that the peer has no assurance it is actually you he is talking to.
29596 You gain protection from a passive sniffer listening on the wire but not
29597 from someone able to intercept the communication.
29598
29599 Further protection requires some further configuration at the server end.
29600
29601 To make TLS work you need to set, in the server,
29602 .code
29603 tls_certificate = /some/file/name
29604 tls_privatekey = /some/file/name
29605 .endd
29606 These options are, in fact, expanded strings, so you can make them depend on
29607 the identity of the client that is connected if you wish. The first file
29608 contains the server's X509 certificate, and the second contains the private key
29609 that goes with it. These files need to be
29610 PEM format and readable by the Exim user, and must
29611 always be given as full path names.
29612 The key must not be password-protected.
29613 They can be the same file if both the
29614 certificate and the key are contained within it. If &%tls_privatekey%& is not
29615 set, or if its expansion is forced to fail or results in an empty string, this
29616 is assumed to be the case. The certificate file may also contain intermediate
29617 certificates that need to be sent to the client to enable it to authenticate
29618 the server's certificate.
29619
29620 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29621 colon-separated lists of file paths.  Ciphers using given authentication
29622 algorithms require the presence of a suitable certificate to supply the
29623 public-key.  The server selects among the certificates to present to the
29624 client depending on the selected cipher, hence the priority ordering for
29625 ciphers will affect which certificate is used.
29626
29627 If you do not understand about certificates and keys, please try to find a
29628 source of this background information, which is not Exim-specific. (There are a
29629 few comments below in section &<<SECTcerandall>>&.)
29630
29631 &*Note*&: These options do not apply when Exim is operating as a client &--
29632 they apply only in the case of a server. If you need to use a certificate in an
29633 Exim client, you must set the options of the same names in an &(smtp)&
29634 transport.
29635
29636 With just these options, an Exim server will be able to use TLS. It does not
29637 require the client to have a certificate (but see below for how to insist on
29638 this). There is one other option that may be needed in other situations. If
29639 .code
29640 tls_dhparam = /some/file/name
29641 .endd
29642 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29643 with the parameters contained in the file.
29644 Set this to &`none`& to disable use of DH entirely, by making no prime
29645 available:
29646 .code
29647 tls_dhparam = none
29648 .endd
29649 This may also be set to a string identifying a standard prime to be used for
29650 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29651 used is &`ike23`&.  There are a few standard primes available, see the
29652 documentation for &%tls_dhparam%& for the complete list.
29653
29654 See the command
29655 .code
29656 openssl dhparam
29657 .endd
29658 for a way of generating file data.
29659
29660 The strings supplied for these three options are expanded every time a client
29661 host connects. It is therefore possible to use different certificates and keys
29662 for different hosts, if you so wish, by making use of the client's IP address
29663 in &$sender_host_address$& to control the expansion. If a string expansion is
29664 forced to fail, Exim behaves as if the option is not set.
29665
29666 .cindex "cipher" "logging"
29667 .cindex "log" "TLS cipher"
29668 .vindex "&$tls_in_cipher$&"
29669 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29670 an incoming TLS connection. It is included in the &'Received:'& header of an
29671 incoming message (by default &-- you can, of course, change this), and it is
29672 also included in the log line that records a message's arrival, keyed by
29673 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29674 condition can be used to test for specific cipher suites in ACLs.
29675
29676 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29677 can check the name of the cipher suite and vary their actions accordingly. The
29678 cipher suite names vary, depending on which TLS library is being used. For
29679 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29680 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29681 documentation for more details.
29682
29683 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29684 (again depending on the &%tls_cipher%& log selector).
29685
29686
29687 .subsection "Requesting and verifying client certificates"
29688 .cindex "certificate" "verification of client"
29689 .cindex "TLS" "client certificate verification"
29690 If you want an Exim server to request a certificate when negotiating a TLS
29691 session with a client, you must set either &%tls_verify_hosts%& or
29692 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29693 apply to all TLS connections. For any host that matches one of these options,
29694 Exim requests a certificate as part of the setup of the TLS session. The
29695 contents of the certificate are verified by comparing it with a list of
29696 expected trust-anchors or certificates.
29697 These may be the system default set (depending on library version),
29698 an explicit file or,
29699 depending on library version, a directory, identified by
29700 &%tls_verify_certificates%&.
29701
29702 A file can contain multiple certificates, concatenated end to end. If a
29703 directory is used
29704 (OpenSSL only),
29705 each certificate must be in a separate file, with a name (or a symbolic link)
29706 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29707 certificate. You can compute the relevant hash by running the command
29708 .code
29709 openssl x509 -hash -noout -in /cert/file
29710 .endd
29711 where &_/cert/file_& contains a single certificate.
29712
29713 There is no checking of names of the client against the certificate
29714 Subject Name or Subject Alternate Names.
29715
29716 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29717 what happens if the client does not supply a certificate, or if the certificate
29718 does not match any of the certificates in the collection named by
29719 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29720 attempt to set up a TLS session is aborted, and the incoming connection is
29721 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29722 session continues. ACLs that run for subsequent SMTP commands can detect the
29723 fact that no certificate was verified, and vary their actions accordingly. For
29724 example, you can insist on a certificate before accepting a message for
29725 relaying, but not when the message is destined for local delivery.
29726
29727 .vindex "&$tls_in_peerdn$&"
29728 When a client supplies a certificate (whether it verifies or not), the value of
29729 the Distinguished Name of the certificate is made available in the variable
29730 &$tls_in_peerdn$& during subsequent processing of the message.
29731
29732 .cindex "log" "distinguished name"
29733 Because it is often a long text string, it is not included in the log line or
29734 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29735 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29736 &%received_header_text%& to change the &'Received:'& header. When no
29737 certificate is supplied, &$tls_in_peerdn$& is empty.
29738
29739
29740 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29741 .cindex certificate caching
29742 .cindex privatekey caching
29743 .cindex crl caching
29744 .cindex ocsp caching
29745 .cindex ciphers caching
29746 .cindex "CA bundle" caching
29747 .cindex "certificate authorities" caching
29748 .cindex tls_certificate caching
29749 .cindex tls_privatekey caching
29750 .cindex tls_crl caching
29751 .cindex tls_ocsp_file caching
29752 .cindex tls_require_ciphers caching
29753 .cindex tls_verify_certificate caching
29754 .cindex caching certificate
29755 .cindex caching privatekey
29756 .cindex caching crl
29757 .cindex caching ocsp
29758 .cindex caching ciphers
29759 .cindex caching "certificate authorities
29760 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29761 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29762 expandable elements,
29763 then the associated information is loaded at daemon startup.
29764 It is made available
29765 to child processes forked for handling received SMTP connections.
29766
29767 This caching is currently only supported under Linux and FreeBSD.
29768
29769 If caching is not possible, for example if an item has to be dependent
29770 on the peer host so contains a &$sender_host_name$& expansion, the load
29771 of the associated information is done at the startup of the TLS connection.
29772
29773 The cache is invalidated and reloaded after any changes to the directories
29774 containing files specified by these options.
29775
29776 The information specified by the main option &%tls_verify_certificates%&
29777 is similarly cached so long as it specifies files explicitly
29778 or (under GnuTLS) is the string &"system,cache"&.
29779 The latter case is not automatically invalidated;
29780 it is the operator's responsibility to arrange for a daemon restart
29781 any time the system certificate authority bundle is updated.
29782 A HUP signal is sufficient for this.
29783 The value &"system"& results in no caching under GnuTLS.
29784
29785 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29786 is acceptable in configurations for the Exim executable.
29787
29788 Caching of the system Certificate Authorities bundle can
29789 save significant time and processing on every TLS connection
29790 accepted by Exim.
29791
29792
29793
29794
29795 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29796 .cindex "cipher" "logging"
29797 .cindex "log" "TLS cipher"
29798 .cindex "log" "distinguished name"
29799 .cindex "TLS" "configuring an Exim client"
29800 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29801 deliveries as well as to incoming, the latter one causing logging of the
29802 server certificate's DN. The remaining client configuration for TLS is all
29803 within the &(smtp)& transport.
29804
29805 .cindex "ESMTP extensions" STARTTLS
29806 It is not necessary to set any options to have TLS work in the &(smtp)&
29807 transport. If Exim is built with TLS support, and TLS is advertised by a
29808 server, the &(smtp)& transport always tries to start a TLS session. However,
29809 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29810 transport) to a list of server hosts for which TLS should not be used.
29811
29812 If you do not want Exim to attempt to send messages unencrypted when an attempt
29813 to set up an encrypted connection fails in any way, you can set
29814 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29815 those hosts, delivery is always deferred if an encrypted connection cannot be
29816 set up. If there are any other hosts for the address, they are tried in the
29817 usual way.
29818
29819 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29820 the message unencrypted. It always does this if the response to STARTTLS is
29821 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29822 session after a success response code, what happens is controlled by the
29823 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29824 delivery to this host is deferred, and other hosts (if available) are tried. If
29825 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29826 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29827 negotiation fails, Exim closes the current connection (because it is in an
29828 unknown state), opens a new one to the same host, and then tries the delivery
29829 unencrypted.
29830
29831 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29832 transport provide the client with a certificate, which is passed to the server
29833 if it requests it.
29834 This is an optional thing for TLS connections, although either end
29835 may insist on it.
29836 If the server is Exim, it will request a certificate only if
29837 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29838
29839 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29840 for client use (they are usable for server use).
29841 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29842 in failed connections.
29843
29844 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29845 specifies a collection of expected server certificates.
29846 These may be
29847 the system default set (depending on library version),
29848 a file,
29849 or (depending on library version) a directory.
29850 The client verifies the server's certificate
29851 against this collection, taking into account any revoked certificates that are
29852 in the list defined by &%tls_crl%&.
29853 Failure to verify fails the TLS connection unless either of the
29854 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29855
29856 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29857 certificate verification to the listed servers.  Verification either must
29858 or need not succeed respectively.
29859
29860 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29861 name checks are made on the server certificate.
29862 The match against this list is, as per other Exim usage, the
29863 IP for the host.  That is most closely associated with the
29864 name on the DNS A (or AAAA) record for the host.
29865 However, the name that needs to be in the certificate
29866 is the one at the head of any CNAME chain leading to the A record.
29867 The option defaults to always checking.
29868
29869 The &(smtp)& transport has two OCSP-related options:
29870 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29871 is requested and required for the connection to proceed.  The default
29872 value is empty.
29873 &%hosts_request_ocsp%&; a host-list for which (additionally)
29874 a Certificate Status is requested (but not necessarily verified).  The default
29875 value is "*" meaning that requests are made unless configured
29876 otherwise.
29877
29878 The host(s) should also be in &%hosts_require_tls%&, and
29879 &%tls_verify_certificates%& configured for the transport,
29880 for OCSP to be relevant.
29881
29882 If
29883 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29884 list of permitted cipher suites. If either of these checks fails, delivery to
29885 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29886 alternative hosts, if any.
29887
29888  &*Note*&:
29889 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29890 is operating as a client. Exim does not assume that a server certificate (set
29891 by the global options of the same name) should also be used when operating as a
29892 client.
29893
29894 .vindex "&$host$&"
29895 .vindex "&$host_address$&"
29896 All the TLS options in the &(smtp)& transport are expanded before use, with
29897 &$host$& and &$host_address$& containing the name and address of the server to
29898 which the client is connected. Forced failure of an expansion causes Exim to
29899 behave as if the relevant option were unset.
29900
29901 .vindex &$tls_out_bits$&
29902 .vindex &$tls_out_cipher$&
29903 .vindex &$tls_out_peerdn$&
29904 .vindex &$tls_out_sni$&
29905 Before an SMTP connection is established, the
29906 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29907 variables are emptied. (Until the first connection, they contain the values
29908 that were set when the message was received.) If STARTTLS is subsequently
29909 successfully obeyed, these variables are set to the relevant values for the
29910 outgoing connection.
29911
29912
29913
29914 .subsection "Caching of static client configuration items" SECTclientTLScache
29915 .cindex certificate caching
29916 .cindex privatekey caching
29917 .cindex crl caching
29918 .cindex ciphers caching
29919 .cindex "CA bundle" caching
29920 .cindex "certificate authorities" caching
29921 .cindex tls_certificate caching
29922 .cindex tls_privatekey caching
29923 .cindex tls_crl caching
29924 .cindex tls_require_ciphers caching
29925 .cindex tls_verify_certificate caching
29926 .cindex caching certificate
29927 .cindex caching privatekey
29928 .cindex caching crl
29929 .cindex caching ciphers
29930 .cindex caching "certificate authorities
29931 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29932 and &%tls_crl%& have values with no
29933 expandable elements,
29934 then the associated information is loaded per smtp transport
29935 at daemon startup, at the start of a queue run, or on a
29936 command-line specified message delivery.
29937 It is made available
29938 to child processes forked for handling making SMTP connections.
29939
29940 This caching is currently only supported under Linux.
29941
29942 If caching is not possible, the load
29943 of the associated information is done at the startup of the TLS connection.
29944
29945 The cache is invalidated in the daemon
29946 and reloaded after any changes to the directories
29947 containing files specified by these options.
29948
29949 The information specified by the main option &%tls_verify_certificates%&
29950 is similarly cached so long as it specifies files explicitly
29951 or (under GnuTLS) is the string &"system,cache"&.
29952 The latter case is not automatically invaludated;
29953 it is the operator's responsibility to arrange for a daemon restart
29954 any time the system certificate authority bundle is updated.
29955 A HUP signal is sufficient for this.
29956 The value &"system"& results in no caching under GnuTLS.
29957
29958 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29959 is acceptable in configurations for the Exim executable.
29960
29961 Caching of the system Certificate Authorities bundle can
29962 save significant time and processing on every TLS connection
29963 initiated by Exim.
29964
29965
29966
29967
29968 .section "Use of TLS Server Name Indication" "SECTtlssni"
29969 .cindex "TLS" "Server Name Indication"
29970 .cindex "TLS" SNI
29971 .cindex SNI
29972 .vindex "&$tls_in_sni$&"
29973 .oindex "&%tls_in_sni%&"
29974 With TLS1.0 or above, there is an extension mechanism by which extra
29975 information can be included at various points in the protocol.  One of these
29976 extensions, documented in RFC 6066 (and before that RFC 4366) is
29977 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29978 client in the initial handshake, so that the server can examine the servername
29979 within and possibly choose to use different certificates and keys (and more)
29980 for this session.
29981
29982 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29983 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29984 address.
29985
29986 With SMTP to MX, there are the same problems here as in choosing the identity
29987 against which to validate a certificate: you can't rely on insecure DNS to
29988 provide the identity which you then cryptographically verify.  So this will
29989 be of limited use in that environment.
29990
29991 With SMTP to Submission, there is a well-defined hostname which clients are
29992 connecting to and can validate certificates against.  Thus clients &*can*&
29993 choose to include this information in the TLS negotiation.  If this becomes
29994 wide-spread, then hosters can choose to present different certificates to
29995 different clients.  Or even negotiate different cipher suites.
29996
29997 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29998 if not empty, will be sent on a TLS session as part of the handshake.  There's
29999 nothing more to it.  Choosing a sensible value not derived insecurely is the
30000 only point of caution.  The &$tls_out_sni$& variable will be set to this string
30001 for the lifetime of the client connection (including during authentication).
30002
30003 If DANE validated the connection attempt then the value of the &%tls_sni%& option
30004 is forced to the name of the destination host, after any MX- or CNAME-following.
30005
30006 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
30007 received from a client.
30008 It can be logged with the &%log_selector%& item &`+tls_sni`&.
30009
30010 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
30011 option (prior to expansion) then the following options will be re-expanded
30012 during TLS session handshake, to permit alternative values to be chosen:
30013
30014 .ilist
30015 &%tls_certificate%&
30016 .next
30017 &%tls_crl%&
30018 .next
30019 &%tls_privatekey%&
30020 .next
30021 &%tls_verify_certificates%&
30022 .next
30023 &%tls_ocsp_file%&
30024 .endlist
30025
30026 Great care should be taken to deal with matters of case, various injection
30027 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
30028 can always be referenced; it is important to remember that &$tls_in_sni$& is
30029 arbitrary unverified data provided prior to authentication.
30030 Further, the initial certificate is loaded before SNI has arrived, so
30031 an expansion for &%tls_certificate%& must have a default which is used
30032 when &$tls_in_sni$& is empty.
30033
30034 The Exim developers are proceeding cautiously and so far no other TLS options
30035 are re-expanded.
30036
30037 When Exim is built against OpenSSL, OpenSSL must have been built with support
30038 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
30039 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
30040 see &`-servername`& in the output, then OpenSSL has support.
30041
30042 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
30043 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
30044 built, then you have SNI support).
30045
30046 .subsection ALPN
30047 .cindex TLS ALPN
30048 .cindex ALPN "general information"
30049 .cindex TLS "Application Layer Protocol Names"
30050 There is a TLS feature related to SNI
30051 called Application Layer Protocol Name (ALPN).
30052 This is intended to declare, or select, what protocol layer will be using a TLS
30053 connection.
30054 The client for the connection proposes a set of protocol names, and
30055 the server responds with a selected one.
30056 It is not, as of 2021, commonly used for SMTP connections.
30057 However, to guard against misdirected or malicious use of web clients
30058 (which often do use ALPN) against MTA ports, Exim by default check that
30059 there is no incompatible ALPN specified by a client for a TLS connection.
30060 If there is, the connection is rejected.
30061
30062 As a client Exim does not supply ALPN by default.
30063 The behaviour of both client and server can be configured using the options
30064 &%tls_alpn%& and &%hosts_require_alpn%&.
30065 There are no variables providing observability.
30066 Some feature-specific logging may appear on denied connections, but this
30067 depends on the behaviour of the peer
30068 (not all peers can send a feature-specific TLS Alert).
30069
30070 This feature is available when Exim is built with
30071 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
30072 the macro _HAVE_TLS_ALPN will be defined when this is so.
30073
30074
30075
30076 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
30077          "SECTmulmessam"
30078 .cindex "multiple SMTP deliveries with TLS"
30079 .cindex "TLS" "multiple message deliveries"
30080 Exim sends multiple messages down the same TCP/IP connection by starting up
30081 an entirely new delivery process for each message, passing the socket from
30082 one process to the next. This implementation does not fit well with the use
30083 of TLS, because there is quite a lot of state information associated with a TLS
30084 connection, not just a socket identification. Passing all the state information
30085 to a new process is not feasible. Consequently, for sending using TLS Exim
30086 starts an additional proxy process for handling the encryption, piping the
30087 unencrypted data stream from and to the delivery processes.
30088
30089 An older mode of operation can be enabled on a per-host basis by the
30090 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
30091 this list the proxy process described above is not used; instead Exim
30092 shuts down an existing TLS session being run by the delivery process
30093 before passing the socket to a new process. The new process may then
30094 try to start a new TLS session, and if successful, may try to re-authenticate
30095 if AUTH is in use, before sending the next message.
30096
30097 The RFC is not clear as to whether or not an SMTP session continues in clear
30098 after TLS has been shut down, or whether TLS may be restarted again later, as
30099 just described. However, if the server is Exim, this shutdown and
30100 reinitialization works. It is not known which (if any) other servers operate
30101 successfully if the client closes a TLS session and continues with unencrypted
30102 SMTP, but there are certainly some that do not work. For such servers, Exim
30103 should not pass the socket to another process, because the failure of the
30104 subsequent attempt to use it would cause Exim to record a temporary host error,
30105 and delay other deliveries to that host.
30106
30107 To test for this case, Exim sends an EHLO command to the server after
30108 closing down the TLS session. If this fails in any way, the connection is
30109 closed instead of being passed to a new delivery process, but no retry
30110 information is recorded.
30111
30112 There is also a manual override; you can set &%hosts_nopass_tls%& on the
30113 &(smtp)& transport to match those hosts for which Exim should not pass
30114 connections to new processes if TLS has been used.
30115
30116
30117
30118
30119 .section "Certificates and all that" "SECTcerandall"
30120 .cindex "certificate" "references to discussion"
30121 In order to understand fully how TLS works, you need to know about
30122 certificates, certificate signing, and certificate authorities.
30123 This is a large topic and an introductory guide is unsuitable for the Exim
30124 reference manual, so instead we provide pointers to existing documentation.
30125
30126 The Apache web-server was for a long time the canonical guide, so their
30127 documentation is a good place to start; their SSL module's Introduction
30128 document is currently at
30129 .display
30130 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30131 .endd
30132 and their FAQ is at
30133 .display
30134 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30135 .endd
30136
30137 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30138 0-201-61598-3) in 2001, contains both introductory and more in-depth
30139 descriptions.
30140 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30141 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30142 Ivan is the author of the popular TLS testing tools at
30143 &url(https://www.ssllabs.com/).
30144
30145
30146 .subsection "Certificate chains" SECID186
30147 A file named by &%tls_certificate%& may contain more than one
30148 certificate. This is useful in the case where the certificate that is being
30149 sent is validated by an intermediate certificate which the other end does
30150 not have. Multiple certificates must be in the correct order in the file.
30151 First the host's certificate itself, then the first intermediate
30152 certificate to validate the issuer of the host certificate, then the next
30153 intermediate certificate to validate the issuer of the first intermediate
30154 certificate, and so on, until finally (optionally) the root certificate.
30155 The root certificate must already be trusted by the recipient for
30156 validation to succeed, of course, but if it's not preinstalled, sending the
30157 root certificate along with the rest makes it available for the user to
30158 install if the receiving end is a client MUA that can interact with a user.
30159
30160 Note that certificates using MD5 are unlikely to work on today's Internet;
30161 even if your libraries allow loading them for use in Exim when acting as a
30162 server, increasingly clients will not accept such certificates.  The error
30163 diagnostics in such a case can be frustratingly vague.
30164
30165
30166
30167 .subsection "Self-signed certificates" SECID187
30168 .cindex "certificate" "self-signed"
30169 You can create a self-signed certificate using the &'req'& command provided
30170 with OpenSSL, like this:
30171 . ==== Do not shorten the duration here without reading and considering
30172 . ==== the text below.  Please leave it at 9999 days.
30173 .code
30174 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30175             -days 9999 -nodes
30176 .endd
30177 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30178 delimited and so can be identified independently. The &%-days%& option
30179 specifies a period for which the certificate is valid. The &%-nodes%& option is
30180 important: if you do not set it, the key is encrypted with a passphrase
30181 that you are prompted for, and any use that is made of the key causes more
30182 prompting for the passphrase. This is not helpful if you are going to use
30183 this certificate and key in an MTA, where prompting is not possible.
30184
30185 . ==== I expect to still be working 26 years from now.  The less technical
30186 . ==== debt I create, in terms of storing up trouble for my later years, the
30187 . ==== happier I will be then.  We really have reached the point where we
30188 . ==== should start, at the very least, provoking thought and making folks
30189 . ==== pause before proceeding, instead of leaving all the fixes until two
30190 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30191 . ==== -pdp, 2012
30192 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30193 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30194 the above command might produce a date in the past.  Think carefully about
30195 the lifetime of the systems you're deploying, and either reduce the duration
30196 of the certificate or reconsider your platform deployment.  (At time of
30197 writing, reducing the duration is the most likely choice, but the inexorable
30198 progression of time takes us steadily towards an era where this will not
30199 be a sensible resolution).
30200
30201 A self-signed certificate made in this way is sufficient for testing, and
30202 may be adequate for all your requirements if you are mainly interested in
30203 encrypting transfers, and not in secure identification.
30204
30205 However, many clients require that the certificate presented by the server be a
30206 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30207 certificate. In this situation, the self-signed certificate described above
30208 must be installed on the client host as a trusted root &'certification
30209 authority'& (CA), and the certificate used by Exim must be a user certificate
30210 signed with that self-signed certificate.
30211
30212 For information on creating self-signed CA certificates and using them to sign
30213 user certificates, see the &'General implementation overview'& chapter of the
30214 Open-source PKI book, available online at
30215 &url(https://sourceforge.net/projects/ospkibook/).
30216
30217
30218 .subsection "Revoked certificates"
30219 .cindex "TLS" "revoked certificates"
30220 .cindex "revocation list"
30221 .cindex "certificate" "revocation list"
30222 .cindex "OCSP" "stapling"
30223 There are three ways for a certificate to be made unusable
30224 before its expiry.
30225
30226 .ilist
30227 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30228 certificates are revoked. If you have such a list, you can pass it to an Exim
30229 server using the global option called &%tls_crl%& and to an Exim client using
30230 an identically named option for the &(smtp)& transport. In each case, the value
30231 of the option is expanded and must then be the name of a file that contains a
30232 CRL in PEM format.
30233 The downside is that clients have to periodically re-download a potentially huge
30234 file from every certificate authority they know of.
30235
30236 .next
30237 The way with most moving parts at query time is Online Certificate
30238 Status Protocol (OCSP), where the client verifies the certificate
30239 against an OCSP server run by the CA.  This lets the CA track all
30240 usage of the certs.  It requires running software with access to the
30241 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30242 is based on HTTP and can be proxied accordingly.
30243
30244 The only widespread OCSP server implementation (known to this writer)
30245 comes as part of OpenSSL and aborts on an invalid request, such as
30246 connecting to the port and then disconnecting.  This requires
30247 re-entering the passphrase each time some random client does this.
30248
30249 .next
30250 The third way is OCSP Stapling; in this, the server using a certificate
30251 issued by the CA periodically requests an OCSP proof of validity from
30252 the OCSP server, then serves it up inline as part of the TLS
30253 negotiation.   This approach adds no extra round trips, does not let the
30254 CA track users, scales well with number of certs issued by the CA and is
30255 resilient to temporary OCSP server failures, as long as the server
30256 starts retrying to fetch an OCSP proof some time before its current
30257 proof expires.  The downside is that it requires server support.
30258
30259 Unless Exim is built with the support disabled,
30260 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30261 support for OCSP stapling is included.
30262
30263 There is a global option called &%tls_ocsp_file%&.
30264 The file specified therein is expected to be in DER format, and contain
30265 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30266 option will be re-expanded for SNI, if the &%tls_certificate%& option
30267 contains &`tls_in_sni`&, as per other TLS options.
30268
30269 Exim does not at this time implement any support for fetching a new OCSP
30270 proof.  The burden is on the administrator to handle this, outside of
30271 Exim.  The file specified should be replaced atomically, so that the
30272 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30273 on each connection, so a new file will be handled transparently on the
30274 next connection.
30275
30276 When built with OpenSSL Exim will check for a valid next update timestamp
30277 in the OCSP proof; if not present, or if the proof has expired, it will be
30278 ignored.
30279
30280 For the client to be able to verify the stapled OCSP the server must
30281 also supply, in its stapled information, any intermediate
30282 certificates for the chain leading to the OCSP proof from the signer
30283 of the server certificate.  There may be zero or one such. These
30284 intermediate certificates should be added to the server OCSP stapling
30285 file named by &%tls_ocsp_file%&.
30286
30287 Note that the proof only covers the terminal server certificate,
30288 not any of the chain from CA to it.
30289
30290 There is no current way to staple a proof for a client certificate.
30291
30292 .code
30293   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30294   OCSP server is supplied.  The server URL may be included in the
30295   server certificate, if the CA is helpful.
30296
30297   One failure mode seen was the OCSP Signer cert expiring before the end
30298   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30299   noted this as invalid overall, but the re-fetch script did not.
30300 .endd
30301 .endlist
30302
30303
30304 .ecindex IIDencsmtp1
30305 .ecindex IIDencsmtp2
30306
30307
30308 .section "TLS Resumption" "SECTresumption"
30309 .cindex TLS resumption
30310 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30311 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30312 (or later).
30313
30314 Session resumption (this is the "stateless" variant) involves the server sending
30315 a "session ticket" to the client on one connection, which can be stored by the
30316 client and used for a later session.  The ticket contains sufficient state for
30317 the server to reconstruct the TLS session, avoiding some expensive crypto
30318 calculation and (on TLS1.2) one full packet roundtrip time.
30319
30320 .ilist
30321 Operational cost/benefit:
30322
30323  The extra data being transmitted costs a minor amount, and the client has
30324  extra costs in storing and retrieving the data.
30325
30326  In the Exim/Gnutls implementation the extra cost on an initial connection
30327  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30328  The saved cost on a subsequent connection is about 4ms; three or more
30329  connections become a net win.  On longer network paths, two or more
30330  connections will have an average lower startup time thanks to the one
30331  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30332  packet roundtrips.
30333
30334 .cindex "hints database" tls
30335  Since a new hints DB is used on the TLS client,
30336  the hints DB maintenance should be updated to additionally handle "tls".
30337
30338 .next
30339 Security aspects:
30340
30341  The session ticket is encrypted, but is obviously an additional security
30342  vulnarability surface.  An attacker able to decrypt it would have access
30343  all connections using the resumed session.
30344  The session ticket encryption key is not committed to storage by the server
30345  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30346  overlap; GnuTLS 6hr but does not specify any overlap).
30347  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30348  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30349
30350  There is a question-mark over the security of the Diffie-Helman parameters
30351  used for session negotiation.
30352
30353 .next
30354 Observability:
30355
30356  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30357  element.
30358
30359  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30360  have bits 0-4 indicating respectively
30361  support built, client requested ticket, client offered session,
30362  server issued ticket, resume used.  A suitable decode list is provided
30363  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30364
30365 .next
30366 Control:
30367
30368 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30369 exim, operating as a server, will offer resumption to clients.
30370 Current best practice is to not offer the feature to MUA connection.
30371 Commonly this can be done like this:
30372 .code
30373 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30374 .endd
30375 If the peer host matches the list after expansion then resumption
30376 is offered and/or accepted.
30377
30378 The &%tls_resumption_hosts%& smtp transport option performs the
30379 equivalent function for operation as a client.
30380 If the peer host matches the list after expansion then resumption
30381 is attempted (if a stored session is available) or the information
30382 stored (if supplied by the peer).
30383
30384
30385 .next
30386 Issues:
30387
30388  In a resumed session:
30389 .ilist
30390   The variables &$tls_{in,out}_cipher$& will have values different
30391  to the original (under GnuTLS).
30392 .next
30393   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30394  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30395 . XXX need to do something with that hosts_require_ocsp
30396 .endlist
30397
30398 .endlist
30399
30400
30401 .section DANE "SECDANE"
30402 .cindex DANE
30403 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30404 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30405 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30406 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30407 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30408 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30409
30410 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30411 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30412 by (a) is thought to be smaller than that of the set of root CAs.
30413
30414 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30415 fail to pass on a server's STARTTLS.
30416
30417 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30418 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30419 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30420
30421 DANE requires a server operator to do three things:
30422 .olist
30423 Run DNSSEC.  This provides assurance to clients
30424 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30425 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30426 DNSSEC.
30427 .next
30428 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30429 .next
30430 Offer a server certificate, or certificate chain, in TLS connections which is anchored by one of the TLSA records.
30431 .endlist
30432
30433 There are no changes to Exim specific to server-side operation of DANE.
30434 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30435 in &_Local/Makefile_&.
30436 If it has been included, the macro "_HAVE_DANE" will be defined.
30437
30438 .subsection "DNS records"
30439 A TLSA record consist of 4 fields, the "Certificate Usage", the
30440 "Selector", the "Matching type", and the "Certificate Association Data".
30441 For a detailed description of the TLSA record see
30442 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30443
30444 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30445 These are the "Trust Anchor" and "End Entity" variants.
30446 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30447 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30448 this is appropriate for a single system, using a self-signed certificate.
30449 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30450 well-known one.
30451 A private CA at simplest is just a self-signed certificate (with certain
30452 attributes) which is used to sign server certificates, but running one securely
30453 does require careful arrangement.
30454 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30455 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30456 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30457 all of which point to a single TLSA record.
30458 DANE-TA and DANE-EE can both be used together.
30459
30460 Our recommendation is to use DANE with a certificate from a public CA,
30461 because this enables a variety of strategies for remote clients to verify
30462 your certificate.
30463 You can then publish information both via DANE and another technology,
30464 "MTA-STS", described below.
30465
30466 When you use DANE-TA to publish trust anchor information, you ask entities
30467 outside your administrative control to trust the Certificate Authority for
30468 connections to you.
30469 If using a private CA then you should expect others to still apply the
30470 technical criteria they'd use for a public CA to your certificates.
30471 In particular, you should probably try to follow current best practices for CA
30472 operation around hash algorithms and key sizes.
30473 Do not expect other organizations to lower their security expectations just
30474 because a particular profile might be reasonable for your own internal use.
30475
30476 When this text was last updated, this in practice means to avoid use of SHA-1
30477 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30478 than 4096, for interoperability); to use keyUsage fields correctly; to use
30479 random serial numbers.
30480 The list of requirements is subject to change as best practices evolve.
30481 If you're not already using a private CA, or it doesn't meet these
30482 requirements, then we encourage you to avoid all these issues and use a public
30483 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30484
30485 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30486 a "Matching Type" (3rd) field of SHA2-512(2).
30487
30488 For the "Certificate Authority Data" (4th) field, commands like
30489
30490 .code
30491   openssl x509 -pubkey -noout <certificate.pem \
30492   | openssl rsa -outform der -pubin 2>/dev/null \
30493   | openssl sha512 \
30494   | awk '{print $2}'
30495 .endd
30496
30497 are workable to create a hash of the certificate's public key.
30498
30499 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30500
30501 .code
30502   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30503 .endd
30504
30505 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30506 is useful for quickly generating TLSA records.
30507
30508
30509 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30510
30511 The Certificate issued by the CA published in the DANE-TA model should be
30512 issued using a strong hash algorithm.
30513 Exim, and importantly various other MTAs sending to you, will not
30514 re-enable hash algorithms which have been disabled by default in TLS
30515 libraries.
30516 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30517 interoperability (and probably the maximum too, in 2018).
30518
30519 .subsection "Interaction with OCSP"
30520 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30521 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30522 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30523
30524 .code
30525   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30526                                  {= {4}{$tls_out_tlsa_usage}} } \
30527                          {*}{}}
30528 .endd
30529
30530 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30531 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30532 found. If the definition of &%hosts_request_ocsp%& includes the
30533 string "tls_out_tlsa_usage", they are re-expanded in time to
30534 control the OCSP request.
30535
30536 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30537 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30538
30539
30540 .subsection "Client configuration"
30541 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30542 and &%dane_require_tls_ciphers%&.
30543 The &"require"& variant will result in failure if the target host is not
30544 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30545 the &%dnssec_request_domains%& router or transport option.
30546
30547 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30548
30549 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30550 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30551 will be required for the host.  If it does not, the host will not
30552 be used; there is no fallback to non-DANE or non-TLS.
30553
30554 If DANE is requested and usable, then the TLS cipher list configuration
30555 prefers to use the option &%dane_require_tls_ciphers%& and falls
30556 back to &%tls_require_ciphers%& only if that is unset.
30557 This lets you configure "decent crypto" for DANE and "better than nothing
30558 crypto" as the default.  Note though that while GnuTLS lets the string control
30559 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30560 limited to ciphersuite constraints.
30561
30562 If DANE is requested and useable (see above) the following transport options are ignored:
30563 .code
30564   hosts_require_tls
30565   tls_verify_hosts
30566   tls_try_verify_hosts
30567   tls_verify_certificates
30568   tls_crl
30569   tls_verify_cert_hostnames
30570   tls_sni
30571 .endd
30572
30573 If DANE is not usable, whether requested or not, and CA-anchored
30574 verification evaluation is wanted, the above variables should be set appropriately.
30575
30576 The router and transport option &%dnssec_request_domains%& must not be
30577 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30578
30579 .subsection Observability
30580 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30581
30582 There is a new variable &$tls_out_dane$& which will have "yes" if
30583 verification succeeded using DANE and "no" otherwise (only useful
30584 in combination with events; see &<<CHAPevents>>&),
30585 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30586
30587 .cindex DANE reporting
30588 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30589 to achieve DANE-verified connection, if one was either requested and offered, or
30590 required.  This is intended to support TLS-reporting as defined in
30591 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30592 The &$event_data$& will be one of the Result Types defined in
30593 Section 4.3 of that document.
30594
30595 .subsection General
30596 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30597
30598 DANE is specified in RFC 6698. It decouples certificate authority trust
30599 selection from a "race to the bottom" of "you must trust everything for mail
30600 to get through".
30601 It does retain the need to trust the assurances provided by the DNSSEC tree.
30602
30603 There is an alternative technology called MTA-STS (RFC 8461), which
30604 instead publishes MX trust anchor information on an HTTPS website.
30605 The discovery of the address for that website does not (per standard)
30606 require DNSSEC, and could be regarded as being less secure than DANE
30607 as a result.
30608
30609 Exim has no support for MTA-STS as a client, but Exim mail server operators
30610 can choose to publish information describing their TLS configuration using
30611 MTA-STS to let those clients who do use that protocol derive trust
30612 information.
30613
30614 The MTA-STS design requires a certificate from a public Certificate Authority
30615 which is recognized by clients sending to you.
30616 That selection of which CAs are trusted by others is outside your control.
30617
30618 The most interoperable course of action is probably to use
30619 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30620 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30621 records for DANE clients (such as Exim and Postfix) and to publish anchor
30622 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30623 domain itself (with caveats around occasionally broken MTA-STS because of
30624 incompatible specification changes prior to reaching RFC status).
30625
30626
30627
30628 . ////////////////////////////////////////////////////////////////////////////
30629 . ////////////////////////////////////////////////////////////////////////////
30630
30631 .chapter "Access control lists" "CHAPACL"
30632 .scindex IIDacl "&ACL;" "description"
30633 .cindex "control of incoming mail"
30634 .cindex "message" "controlling incoming"
30635 .cindex "policy control" "access control lists"
30636 Access Control Lists (ACLs) are defined in a separate section of the runtime
30637 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30638 name, terminated by a colon. Here is a complete ACL section that contains just
30639 one very small ACL:
30640 .code
30641 begin acl
30642 small_acl:
30643   accept   hosts = one.host.only
30644 .endd
30645 You can have as many lists as you like in the ACL section, and the order in
30646 which they appear does not matter. The lists are self-terminating.
30647
30648 The majority of ACLs are used to control Exim's behaviour when it receives
30649 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30650 when a local process submits a message using SMTP by specifying the &%-bs%&
30651 option. The most common use is for controlling which recipients are accepted
30652 in incoming messages. In addition, you can define an ACL that is used to check
30653 local non-SMTP messages. The default configuration file contains an example of
30654 a realistic ACL for checking RCPT commands. This is discussed in chapter
30655 &<<CHAPdefconfil>>&.
30656
30657
30658 .section "Testing ACLs" "SECID188"
30659 The &%-bh%& command line option provides a way of testing your ACL
30660 configuration locally by running a fake SMTP session with which you interact.
30661
30662
30663 .section "Specifying when ACLs are used" "SECID189"
30664 .cindex "&ACL;" "options for specifying"
30665 In order to cause an ACL to be used, you have to name it in one of the relevant
30666 options in the main part of the configuration. These options are:
30667 .cindex "AUTH" "ACL for"
30668 .cindex "DATA" "ACLs for"
30669 .cindex "ETRN" "ACL for"
30670 .cindex "EXPN" "ACL for"
30671 .cindex "HELO" "ACL for"
30672 .cindex "EHLO" "ACL for"
30673 .cindex "DKIM" "ACL for"
30674 .cindex "MAIL" "ACL for"
30675 .cindex "QUIT, ACL for"
30676 .cindex "RCPT" "ACL for"
30677 .cindex "STARTTLS, ACL for"
30678 .cindex "VRFY" "ACL for"
30679 .cindex "WELLKNOWN" "ACL for"
30680 .cindex "SMTP" "connection, ACL for"
30681 .cindex "non-SMTP messages" "ACLs for"
30682 .cindex "MIME content scanning" "ACL for"
30683 .cindex "PRDR" "ACL for"
30684
30685 .table2 140pt
30686 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30687 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30688 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30689 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30690 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30691 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30692 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30693 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30694 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30695 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30696 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30697 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30698 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30699 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30700 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30701 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30702 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30703 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30704 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30705 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30706 .irow &%acl_smtp_wellknown%&   "ACL for WELLKNOWN"
30707 .endtable
30708
30709 For example, if you set
30710 .code
30711 acl_smtp_rcpt = small_acl
30712 .endd
30713 the little ACL defined above is used whenever Exim receives a RCPT command
30714 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30715 done when RCPT commands arrive. A rejection of RCPT should cause the
30716 sending MTA to give up on the recipient address contained in the RCPT
30717 command, whereas rejection at other times may cause the client MTA to keep on
30718 trying to deliver the message. It is therefore recommended that you do as much
30719 testing as possible at RCPT time.
30720
30721
30722 .subsection "The non-SMTP ACLs" SECnonSMTP
30723 .cindex "non-SMTP messages" "ACLs for"
30724 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30725 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30726 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30727 the state of the SMTP connection such as encryption and authentication) are not
30728 relevant and are forbidden in these ACLs. However, the sender and recipients
30729 are known, so the &%senders%& and &%sender_domains%& conditions and the
30730 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30731 &$authenticated_sender$& are also available. You can specify added header lines
30732 in any of these ACLs.
30733
30734 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30735 non-SMTP message, before any of the message has been read. (This is the
30736 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30737 batched SMTP input, it runs after the DATA command has been reached. The
30738 result of this ACL is ignored; it cannot be used to reject a message. If you
30739 really need to, you could set a value in an ACL variable here and reject based
30740 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30741 controls, and in particular, it can be used to set
30742 .code
30743 control = suppress_local_fixups
30744 .endd
30745 This cannot be used in the other non-SMTP ACLs because by the time they are
30746 run, it is too late.
30747
30748 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30749 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30750
30751 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30752 kind of rejection is treated as permanent, because there is no way of sending a
30753 temporary error for these kinds of message.
30754
30755
30756 .subsection "The SMTP connect ACL" SECconnectACL
30757 .cindex "SMTP" "connection, ACL for"
30758 .oindex &%smtp_banner%&
30759 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30760 session, after the test specified by &%host_reject_connection%& (which is now
30761 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30762 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30763 the message override the banner message that is otherwise specified by the
30764 &%smtp_banner%& option.
30765
30766 For tls-on-connect connections, the ACL is run before the TLS connection
30767 is accepted; if the ACL does not accept then the TCP connection is dropped without
30768 any TLS startup attempt and without any SMTP response being transmitted.
30769
30770
30771 .subsection "The EHLO/HELO ACL" SECheloACL
30772 .cindex "EHLO" "ACL for"
30773 .cindex "HELO" "ACL for"
30774 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30775 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30776 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30777 Note that a client may issue more than one EHLO or HELO command in an SMTP
30778 session, and indeed is required to issue a new EHLO or HELO after successfully
30779 setting up encryption following a STARTTLS command.
30780
30781 Note also that a deny neither forces the client to go away nor means that
30782 mail will be refused on the connection.  Consider checking for
30783 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30784
30785 If the command is accepted by an &%accept%& verb that has a &%message%&
30786 modifier, the message may not contain more than one line (it will be truncated
30787 at the first newline and a panic logged if it does). Such a message cannot
30788 affect the EHLO options that are listed on the second and subsequent lines of
30789 an EHLO response.
30790
30791
30792 .subsection "The DATA ACLs" SECdataACLS
30793 .cindex "DATA" "ACLs for"
30794 Two ACLs are associated with the DATA command, because it is two-stage
30795 command, with two responses being sent to the client.
30796 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30797 is obeyed. This gives you control after all the RCPT commands, but before
30798 the message itself is received. It offers the opportunity to give a negative
30799 response to the DATA command before the data is transmitted. Header lines
30800 added by MAIL or RCPT ACLs are not visible at this time, but any that
30801 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30802
30803 You cannot test the contents of the message, for example, to verify addresses
30804 in the headers, at RCPT time or when the DATA command is received. Such
30805 tests have to appear in the ACL that is run after the message itself has been
30806 received, before the final response to the DATA command is sent. This is
30807 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30808 associated with the DATA command.
30809
30810 .cindex CHUNKING "BDAT command"
30811 .cindex BDAT "SMTP command"
30812 .cindex "RFC 3030" CHUNKING
30813 If CHUNKING was advertised and a BDAT command sequence is received,
30814 the &%acl_smtp_predata%& ACL is not run.
30815 . XXX why not?  It should be possible, for the first BDAT.
30816 The &%acl_smtp_data%& is run after the last BDAT command and all of
30817 the data specified is received.
30818
30819 For both of these ACLs, it is not possible to reject individual recipients. An
30820 error response rejects the entire message. Unfortunately, it is known that some
30821 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30822 before or after the data) correctly &-- they keep the message on their queues
30823 and try again later, but that is their problem, though it does waste some of
30824 your resources.
30825
30826 The &%acl_smtp_data%& ACL is run after
30827 the &%acl_smtp_data_prdr%&,
30828 the &%acl_smtp_dkim%&
30829 and the &%acl_smtp_mime%& ACLs.
30830
30831 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30832 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30833 enabled (which is the default).
30834
30835 If, for a specific message, an ACL control
30836 &*dkim_disable_verify*&
30837 has been set, this &%acl_smtp_dkim%& ACL is not called.
30838
30839 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30840 received, and is executed for each DKIM signature found in a message.  If not
30841 otherwise specified, the default action is to accept.
30842
30843 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30844
30845 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30846
30847
30848 .subsection "The SMTP MIME ACL" SECID194
30849 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30850 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30851
30852 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30853
30854
30855 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30856 .cindex "PRDR" "ACL for"
30857 .oindex "&%prdr_enable%&"
30858 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30859 with PRDR support enabled (which is the default).
30860 It becomes active only when the PRDR feature is negotiated between
30861 client and server for a message, and more than one recipient
30862 has been accepted.
30863
30864 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30865 has been received, and is executed once for each recipient of the message
30866 with &$local_part$& and &$domain$& valid.
30867 The test may accept, defer or deny for individual recipients.
30868 The &%acl_smtp_data%& will still be called after this ACL and
30869 can reject the message overall, even if this ACL has accepted it
30870 for some or all recipients.
30871
30872 PRDR may be used to support per-user content filtering.  Without it
30873 one must defer any recipient after the first that has a different
30874 content-filter configuration.  With PRDR, the RCPT-time check
30875 .cindex "PRDR" "variable for"
30876 for this can be disabled when the variable &$prdr_requested$&
30877 is &"yes"&.
30878 Any required difference in behaviour of the main DATA-time
30879 ACL should however depend on the PRDR-time ACL having run, as Exim
30880 will avoid doing so in some situations (e.g. single-recipient mails).
30881
30882 See also the &%prdr_enable%& global option
30883 and the &%hosts_try_prdr%& smtp transport option.
30884
30885 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30886 If the ACL is not defined, processing completes as if
30887 the feature was not requested by the client.
30888
30889 .subsection "The SMTP WELLKNOWN ACL" SECTWELLKNOWNACL
30890 .cindex "WELLKNOWN" "ACL for"
30891 .oindex "&%acl_smtp_wellknown%&"
30892 The &%acl_smtp_wellknown%& ACL is available only when Exim is compiled
30893 with WELLKNOWN support enabled.
30894
30895 The ACL determines the response to an SMTP WELLKNOWN command, using the normal
30896 accept/defer/deny verbs for the response code,
30897 and a new &"control=wellknown"& modifier.
30898 This modifier takes a single option, separated by a '/'
30899 character, which must be the name of a file containing the response
30900 cleartext.  The modifier is expanded before use in the usual way before
30901 it is used.  The configuration is responsible for picking a suitable file
30902 to return and, most importantly, not returning any unexpected file.
30903 The argument for the SMTP verb will be available in the &$smtp_command_argument$&
30904 variable and can be used for building the file path.
30905 If the file path given in the modifier is empty or inacessible, the control will
30906 fail.
30907
30908 For example:
30909 .code
30910  check_wellknown:
30911   accept control = wellknown/\
30912                     ${lookup {${xtextd:$smtp_command_argument}} \
30913                         dsearch,key=path,filter=file,ret=full \
30914                         {$spooldir/wellknown.d}}
30915 .endd
30916 File content will be encoded in &"xtext"& form, and line-wrapping
30917 for line-length limitation will be done before transmission.
30918 A response summary line will be prepended, with the (pre-encoding) file size.
30919
30920 The above example uses the expansion operator ${xtextd:<coded-string>}
30921 which is needed to decode the xtext-encoded key from the SMTP verb.
30922
30923 Under the util directory there is a "mailtest" utility which can be used
30924 to test/retrieve WELLKNOWN items. Syntax is
30925 .code
30926   mailtest -h host.example.com -w security.txt
30927 .endd
30928
30929 WELLKNOWN is a ESMTP extension providing access to extended
30930 information about the server.  It is modelled on the webserver
30931 facilities documented in RFC 8615 and can be used for a security.txt
30932 file and could be used for ACME handshaking (RFC 8555).
30933
30934 Exim will advertise WELLKNOWN support in the EHLO response
30935 .oindex &%wellknown_advertise_hosts%&
30936 (conditional on a new option &%wellknown_advertise_hosts%&)
30937 and service WELLKNOWN smtp verbs having a single parameter
30938 giving a key for an item of "site-wide metadata".
30939 The verb and key are separated by whitespace,
30940 and the key is xtext-encoded (per RFC 3461 section 4).
30941
30942
30943 .subsection "The QUIT ACL" SECTQUITACL
30944 .cindex "QUIT, ACL for"
30945 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30946 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30947 does not in fact control any access.
30948 For this reason, it may only accept
30949 or warn as its final result.
30950
30951 This ACL can be used for tasks such as custom logging at the end of an SMTP
30952 session. For example, you can use ACL variables in other ACLs to count
30953 messages, recipients, etc., and log the totals at QUIT time using one or
30954 more &%logwrite%& modifiers on a &%warn%& verb.
30955
30956 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30957 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30958
30959 You do not need to have a final &%accept%&, but if you do, you can use a
30960 &%message%& modifier to specify custom text that is sent as part of the 221
30961 response to QUIT.
30962
30963 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30964 failure (for example, failure to open a log file, or when Exim is bombing out
30965 because it has detected an unrecoverable error), all SMTP commands from the
30966 client are given temporary error responses until QUIT is received or the
30967 connection is closed. In these special cases, the QUIT ACL does not run.
30968
30969
30970 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30971 .vindex &$acl_smtp_notquit$&
30972 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30973 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30974 trouble, such as being unable to write to its log files, this ACL is not run,
30975 because it might try to do things (such as write to log files) that make the
30976 situation even worse.
30977
30978 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30979 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30980 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30981 and &%warn%&.
30982
30983 .vindex &$smtp_notquit_reason$&
30984 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30985 to a string that indicates the reason for the termination of the SMTP
30986 connection. The possible values are:
30987 .table2
30988 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30989 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30990 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30991 .irow &`connection-lost`&          "The SMTP connection has been lost"
30992 .irow &`data-timeout`&             "Timeout while reading message data"
30993 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30994 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30995 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30996 .irow &`synchronization-error`&    "SMTP synchronization error"
30997 .irow &`tls-failed`&               "TLS failed to start"
30998 .endtable
30999 In most cases when an SMTP connection is closed without having received QUIT,
31000 Exim sends an SMTP response message before actually closing the connection.
31001 With the exception of the &`acl-drop`& case, the default message can be
31002 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
31003 &%drop%& verb in another ACL, it is the message from the other ACL that is
31004 used.
31005
31006
31007 .section "Finding an ACL to use" "SECID195"
31008 .cindex "&ACL;" "finding which to use"
31009 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
31010 you can use different ACLs in different circumstances. For example,
31011 .code
31012 acl_smtp_rcpt = ${if ={25}{$interface_port} \
31013                      {acl_check_rcpt} {acl_check_rcpt_submit} }
31014 .endd
31015 In the default configuration file there are some example settings for
31016 providing an RFC 4409 message &"submission"& service on port 587 and
31017 an RFC 8314 &"submissions"& service on port 465. You can use a string
31018 expansion like this to choose an ACL for MUAs on these ports which is
31019 more appropriate for this purpose than the default ACL on port 25.
31020
31021 The expanded string does not have to be the name of an ACL in the
31022 configuration file; there are other possibilities. Having expanded the
31023 string, Exim searches for an ACL as follows:
31024
31025 .ilist
31026 If the string begins with a slash, Exim uses it as a filename, and reads its
31027 contents as an ACL. The lines are processed in the same way as lines in the
31028 Exim configuration file. In particular, continuation lines are supported, blank
31029 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
31030 If the file does not exist or cannot be read, an error occurs (typically
31031 causing a temporary failure of whatever caused the ACL to be run). For example:
31032 .code
31033 acl_smtp_data = /etc/acls/\
31034   ${lookup{$sender_host_address}lsearch\
31035   {/etc/acllist}{$value}{default}}
31036 .endd
31037 This looks up an ACL file to use on the basis of the host's IP address, falling
31038 back to a default if the lookup fails. If an ACL is successfully read from a
31039 file, it is retained in memory for the duration of the Exim process, so that it
31040 can be re-used without having to re-read the file.
31041 .next
31042 If the string does not start with a slash, and does not contain any spaces,
31043 Exim searches the ACL section of the configuration for an ACL whose name
31044 matches the string.
31045 .next
31046 If no named ACL is found, or if the string contains spaces, Exim parses
31047 the string as an inline ACL. This can save typing in cases where you just
31048 want to have something like
31049 .code
31050 acl_smtp_vrfy = accept
31051 .endd
31052 in order to allow free use of the VRFY command. Such a string may contain
31053 newlines; it is processed in the same way as an ACL that is read from a file.
31054 .endlist
31055
31056
31057
31058
31059 .section "ACL return codes" "SECID196"
31060 .cindex "&ACL;" "return codes"
31061 Except for the QUIT ACL, which does not affect the SMTP return code (see
31062 section &<<SECTQUITACL>>& above), the result of running an ACL is either
31063 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
31064 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
31065 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
31066 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
31067 This also causes a 4&'xx'& return code.
31068
31069 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
31070 &"deny"&, because there is no mechanism for passing temporary errors to the
31071 submitters of non-SMTP messages.
31072
31073
31074 ACLs that are relevant to message reception may also return &"discard"&. This
31075 has the effect of &"accept"&, but causes either the entire message or an
31076 individual recipient address to be discarded. In other words, it is a
31077 blackholing facility. Use it with care.
31078
31079 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
31080 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
31081 RCPT ACL is to discard just the one recipient address. If there are no
31082 recipients left when the message's data is received, the DATA ACL is not
31083 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
31084 remaining recipients. The &"discard"& return is not permitted for the
31085 &%acl_smtp_predata%& ACL.
31086
31087 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
31088 is done on the address and the result determines the SMTP response.
31089
31090
31091 .cindex "&[local_scan()]& function" "when all recipients discarded"
31092 The &[local_scan()]& function is always run, even if there are no remaining
31093 recipients; it may create new recipients.
31094
31095
31096
31097 .section "Unset ACL options" "SECID197"
31098 .cindex "&ACL;" "unset options"
31099 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
31100 all the same. &*Note*&: These defaults apply only when the relevant ACL is
31101 not defined at all. For any defined ACL, the default action when control
31102 reaches the end of the ACL statements is &"deny"&.
31103
31104 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
31105 these two are ACLs that are used only for their side effects. They cannot be
31106 used to accept or reject anything.
31107
31108 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
31109 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
31110 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
31111 when the ACL is not defined is &"accept"&.
31112
31113 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&,
31114 &%acl_smtp_vrfy%&
31115 and &%acl_smtp_wellknown%&),
31116 the action when the ACL
31117 is not defined is &"deny"&.  This means that &%acl_smtp_rcpt%& must be
31118 defined in order to receive any messages over an SMTP connection.
31119 For an example, see the ACL in the default configuration file.
31120
31121
31122
31123 .section "Data for message ACLs" "SECID198"
31124 .cindex "&ACL;" "data for message ACL"
31125 .vindex &$domain$&
31126 .vindex &$local_part$&
31127 .vindex &$sender_address$&
31128 .vindex &$sender_host_address$&
31129 .vindex &$smtp_command$&
31130 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
31131 that contain information about the host and the message's sender (for example,
31132 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
31133 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
31134 &$local_part$& are set from the argument address. The entire SMTP command
31135 is available in &$smtp_command$&.
31136
31137 When an ACL for the AUTH parameter of MAIL is running, the variables that
31138 contain information about the host are set, but &$sender_address$& is not yet
31139 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
31140 how it is used.
31141
31142 .vindex "&$message_size$&"
31143 The &$message_size$& variable is set to the value of the SIZE parameter on
31144 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
31145 that parameter is not given. The value is updated to the true message size by
31146 the time the final DATA ACL is run (after the message data has been
31147 received).
31148
31149 .vindex "&$rcpt_count$&"
31150 .vindex "&$recipients_count$&"
31151 The &$rcpt_count$& variable increases by one for each RCPT command received.
31152 The &$recipients_count$& variable increases by one each time a RCPT command is
31153 accepted, so while an ACL for RCPT is being processed, it contains the number
31154 of previously accepted recipients. At DATA time (for both the DATA ACLs),
31155 &$rcpt_count$& contains the total number of RCPT commands, and
31156 &$recipients_count$& contains the total number of accepted recipients.
31157
31158
31159
31160
31161
31162 .section "Data for non-message ACLs" "SECTdatfornon"
31163 .cindex "&ACL;" "data for non-message ACL"
31164 .vindex &$smtp_command_argument$&
31165 .vindex &$smtp_command$&
31166 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
31167 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
31168 and the entire SMTP command is available in &$smtp_command$&.
31169 These variables can be tested using a &%condition%& condition. For example,
31170 here is an ACL for use with AUTH, which insists that either the session is
31171 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
31172 does not permit authentication methods that use cleartext passwords on
31173 unencrypted connections.
31174 .code
31175 acl_check_auth:
31176   accept encrypted = *
31177   accept condition = ${if eq{${uc:$smtp_command_argument}}\
31178                      {CRAM-MD5}}
31179   deny   message   = TLS encryption or CRAM-MD5 required
31180 .endd
31181 (Another way of applying this restriction is to arrange for the authenticators
31182 that use cleartext passwords not to be advertised when the connection is not
31183 encrypted. You can use the generic &%server_advertise_condition%& authenticator
31184 option to do this.)
31185
31186
31187
31188 .section "Format of an ACL" "SECID199"
31189 .cindex "&ACL;" "format of"
31190 .cindex "&ACL;" "verbs, definition of"
31191 An individual ACL definition consists of a number of statements.
31192 Each statement starts
31193 with a verb, optionally followed by a number of conditions and &"modifiers"&.
31194 Modifiers can change the way the verb operates, define error and log messages,
31195 set variables, insert delays, and vary the processing of accepted messages.
31196
31197 If all the conditions are met, the verb is obeyed. The same condition may be
31198 used (with different arguments) more than once in the same statement. This
31199 provides a means of specifying an &"and"& conjunction between conditions. For
31200 example:
31201 .code
31202 deny  dnslists = list1.example
31203       dnslists = list2.example
31204 .endd
31205 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31206 the conditions and modifiers when it reaches a condition that fails. What
31207 happens then depends on the verb (and in one case, on a special modifier). Not
31208 all the conditions make sense at every testing point. For example, you cannot
31209 test a sender address in the ACL that is run for a VRFY command.
31210
31211 The definition of an ACL ends where another starts,
31212 or a different configuration section starts.
31213
31214
31215 .section "ACL verbs" "SECID200"
31216 The ACL verbs are as follows:
31217
31218 .ilist
31219 .cindex "&%accept%& ACL verb"
31220 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31221 of the conditions are not met, what happens depends on whether &%endpass%&
31222 appears among the conditions (for syntax see below). If the failing condition
31223 is before &%endpass%&, control is passed to the next ACL statement; if it is
31224 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31225 check a RCPT command:
31226 .code
31227 accept domains = +local_domains
31228        endpass
31229        verify = recipient
31230 .endd
31231 If the recipient domain does not match the &%domains%& condition, control
31232 passes to the next statement. If it does match, the recipient is verified, and
31233 the command is accepted if verification succeeds. However, if verification
31234 fails, the ACL yields &"deny"&, because the failing condition is after
31235 &%endpass%&.
31236
31237 The &%endpass%& feature has turned out to be confusing to many people, so its
31238 use is not recommended nowadays. It is always possible to rewrite an ACL so
31239 that &%endpass%& is not needed, and it is no longer used in the default
31240 configuration.
31241
31242 .cindex "&%message%& ACL modifier" "with &%accept%&"
31243 If a &%message%& modifier appears on an &%accept%& statement, its action
31244 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31245 (when an &%accept%& verb either accepts or passes control to the next
31246 statement), &%message%& can be used to vary the message that is sent when an
31247 SMTP command is accepted. For example, in a RCPT ACL you could have:
31248 .display
31249 &`accept  `&<&'some conditions'&>
31250 &`        message = OK, I will allow you through today`&
31251 .endd
31252 You can specify an SMTP response code, optionally followed by an &"extended
31253 response code"& at the start of the message, but the first digit must be the
31254 same as would be sent by default, which is 2 for an &%accept%& verb.
31255
31256 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31257 an error message that is used when access is denied. This behaviour is retained
31258 for backward compatibility, but current &"best practice"& is to avoid the use
31259 of &%endpass%&.
31260
31261
31262 .next
31263 .cindex "&%defer%& ACL verb"
31264 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31265 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31266 &%defer%& is the same as &%deny%&, because there is no way of sending a
31267 temporary error. For a RCPT command, &%defer%& is much the same as using a
31268 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31269 be used in any ACL, and even for a recipient it might be a simpler approach.
31270
31271
31272 .next
31273 .cindex "&%deny%& ACL verb"
31274 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31275 the conditions are not met, control is passed to the next ACL statement. For
31276 example,
31277 .code
31278 deny dnslists = blackholes.mail-abuse.org
31279 .endd
31280 rejects commands from hosts that are on a DNS black list.
31281
31282
31283 .next
31284 .cindex "&%discard%& ACL verb"
31285 &%discard%&: This verb behaves like &%accept%&, except that it returns
31286 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31287 that are concerned with receiving messages. When all the conditions are true,
31288 the sending entity receives a &"success"& response. However, &%discard%& causes
31289 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31290 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31291 message's recipients are discarded. Recipients that are discarded before DATA
31292 do not appear in the log line when the &%received_recipients%& log selector is set.
31293
31294 If the &%log_message%& modifier is set when &%discard%& operates,
31295 its contents are added to the line that is automatically written to the log.
31296 The &%message%& modifier operates exactly as it does for &%accept%&.
31297
31298
31299 .next
31300 .cindex "&%drop%& ACL verb"
31301 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31302 forcibly closed after the 5&'xx'& error message has been sent. For example:
31303 .code
31304 drop   condition = ${if > {$rcpt_count}{20}}
31305        message   = I don't take more than 20 RCPTs
31306 .endd
31307 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31308 The connection is always dropped after sending a 550 response.
31309
31310 .next
31311 .cindex "&%require%& ACL verb"
31312 &%require%&: If all the conditions are met, control is passed to the next ACL
31313 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31314 example, when checking a RCPT command,
31315 .code
31316 require message = Sender did not verify
31317         verify  = sender
31318 .endd
31319 passes control to subsequent statements only if the message's sender can be
31320 verified. Otherwise, it rejects the command. Note the positioning of the
31321 &%message%& modifier, before the &%verify%& condition. The reason for this is
31322 discussed in section &<<SECTcondmodproc>>&.
31323
31324 .next
31325 .cindex "&%warn%& ACL verb"
31326 &%warn%&: If all the conditions are true, a line specified by the
31327 &%log_message%& modifier is written to Exim's main log. Control always passes
31328 to the next ACL statement. If any condition is false, the log line is not
31329 written. If an identical log line is requested several times in the same
31330 message, only one copy is actually written to the log. If you want to force
31331 duplicates to be written, use the &%logwrite%& modifier instead.
31332
31333 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31334 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31335 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31336 first failing condition. There is more about adding header lines in section
31337 &<<SECTaddheadacl>>&.
31338
31339 If any condition on a &%warn%& statement cannot be completed (that is, there is
31340 some sort of defer), the log line specified by &%log_message%& is not written.
31341 This does not include the case of a forced failure from a lookup, which
31342 is considered to be a successful completion. After a defer, no further
31343 conditions or modifiers in the &%warn%& statement are processed. The incident
31344 is logged, and the ACL continues to be processed, from the next statement
31345 onwards.
31346
31347
31348 .vindex "&$acl_verify_message$&"
31349 When one of the &%warn%& conditions is an address verification that fails, the
31350 text of the verification failure message is in &$acl_verify_message$&. If you
31351 want this logged, you must set it up explicitly. For example:
31352 .code
31353 warn   !verify = sender
31354        log_message = sender verify failed: $acl_verify_message
31355 .endd
31356 .endlist
31357
31358 At the end of each ACL there is an implicit unconditional &%deny%&.
31359
31360 As you can see from the examples above, the conditions and modifiers are
31361 written one to a line, with the first one on the same line as the verb, and
31362 subsequent ones on following lines. If you have a very long condition, you can
31363 continue it onto several physical lines by the usual backslash continuation
31364 mechanism. It is conventional to align the conditions vertically.
31365
31366
31367
31368 .section "ACL variables" "SECTaclvariables"
31369 .cindex "&ACL;" "variables"
31370 There are some special variables that can be set during ACL processing. They
31371 can be used to pass information between different ACLs, different invocations
31372 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31373 transports, and filters that are used to deliver a message. The names of these
31374 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31375 an underscore, but the remainder of the name can be any sequence of
31376 alphanumeric characters and underscores that you choose. There is no limit on
31377 the number of ACL variables. The two sets act as follows:
31378 .ilist
31379 The values of those variables whose names begin with &$acl_c$& persist
31380 throughout an SMTP connection. They are never reset. Thus, a value that is set
31381 while receiving one message is still available when receiving the next message
31382 on the same SMTP connection.
31383 .next
31384 The values of those variables whose names begin with &$acl_m$& persist only
31385 while a message is being received. They are reset afterwards. They are also
31386 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31387 .endlist
31388
31389 When a message is accepted, the current values of all the ACL variables are
31390 preserved with the message and are subsequently made available at delivery
31391 time. The ACL variables are set by a modifier called &%set%&. For example:
31392 .code
31393 accept hosts = whatever
31394        set acl_m4 = some value
31395 accept authenticated = *
31396        set acl_c_auth = yes
31397 .endd
31398 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31399 be set. If you want to set a variable without taking any action, you can use a
31400 &%warn%& verb without any other modifiers or conditions.
31401
31402 .oindex &%strict_acl_vars%&
31403 What happens if a syntactically valid but undefined ACL variable is
31404 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31405 false (the default), an empty string is substituted; if it is true, an
31406 error is generated.
31407
31408 Versions of Exim before 4.64 have a limited set of numbered variables, but
31409 their names are compatible, so there is no problem with upgrading.
31410
31411
31412 .section "Condition and modifier processing" "SECTcondmodproc"
31413 .cindex "&ACL;" "conditions; processing"
31414 .cindex "&ACL;" "modifiers; processing"
31415 An exclamation mark preceding a condition negates its result. For example:
31416 .code
31417 deny   domains = *.dom.example
31418       !verify  = recipient
31419 .endd
31420 causes the ACL to return &"deny"& if the recipient domain ends in
31421 &'dom.example'& and the recipient address cannot be verified. Sometimes
31422 negation can be used on the right-hand side of a condition. For example, these
31423 two statements are equivalent:
31424 .code
31425 deny  hosts = !192.168.3.4
31426 deny !hosts =  192.168.3.4
31427 .endd
31428 However, for many conditions (&%verify%& being a good example), only left-hand
31429 side negation of the whole condition is possible.
31430
31431 The arguments of conditions and modifiers are expanded. A forced failure
31432 of an expansion causes a condition to be ignored, that is, it behaves as if the
31433 condition is true. Consider these two statements:
31434 .code
31435 accept  senders = ${lookup{$host_name}lsearch\
31436                   {/some/file}{$value}fail}
31437 accept  senders = ${lookup{$host_name}lsearch\
31438                   {/some/file}{$value}{}}
31439 .endd
31440 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31441 the returned list is searched, but if the lookup fails the behaviour is
31442 different in the two cases. The &%fail%& in the first statement causes the
31443 condition to be ignored, leaving no further conditions. The &%accept%& verb
31444 therefore succeeds. The second statement, however, generates an empty list when
31445 the lookup fails. No sender can match an empty list, so the condition fails,
31446 and therefore the &%accept%& also fails.
31447
31448 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31449 specify actions that are taken as the conditions for a statement are checked;
31450 others specify text for messages that are used when access is denied or a
31451 warning is generated. The &%control%& modifier affects the way an incoming
31452 message is handled.
31453
31454 The positioning of the modifiers in an ACL statement is important, because the
31455 processing of a verb ceases as soon as its outcome is known. Only those
31456 modifiers that have already been encountered will take effect. For example,
31457 consider this use of the &%message%& modifier:
31458 .code
31459 require message = Can't verify sender
31460         verify  = sender
31461         message = Can't verify recipient
31462         verify  = recipient
31463         message = This message cannot be used
31464 .endd
31465 If sender verification fails, Exim knows that the result of the statement is
31466 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31467 so its text is used as the error message. If sender verification succeeds, but
31468 recipient verification fails, the second message is used. If recipient
31469 verification succeeds, the third message becomes &"current"&, but is never used
31470 because there are no more conditions to cause failure.
31471
31472 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31473 modifier that is used, because all the conditions must be true for rejection to
31474 happen. Specifying more than one &%message%& modifier does not make sense, and
31475 the message can even be specified after all the conditions. For example:
31476 .code
31477 deny   hosts = ...
31478       !senders = *@my.domain.example
31479        message = Invalid sender from client host
31480 .endd
31481 The &"deny"& result does not happen until the end of the statement is reached,
31482 by which time Exim has set up the message.
31483
31484
31485
31486 .section "ACL modifiers" "SECTACLmodi"
31487 .cindex "&ACL;" "modifiers; list of"
31488 The ACL modifiers are as follows:
31489
31490 .vlist
31491 .vitem &*add_header*&&~=&~<&'text'&>
31492 This modifier specifies one or more header lines that are to be added to an
31493 incoming message, assuming, of course, that the message is ultimately
31494 accepted. For details, see section &<<SECTaddheadacl>>&.
31495
31496 .vitem &*continue*&&~=&~<&'text'&>
31497 .cindex "&%continue%& ACL modifier"
31498 .cindex "database" "updating in ACL"
31499 This modifier does nothing of itself, and processing of the ACL always
31500 continues with the next condition or modifier. The value of &%continue%& is in
31501 the side effects of expanding its argument. Typically this could be used to
31502 update a database. It is really just a syntactic tidiness, to avoid having to
31503 write rather ugly lines like this:
31504 .display
31505 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31506 .endd
31507 Instead, all you need is
31508 .display
31509 &`continue = `&<&'some expansion'&>
31510 .endd
31511
31512 .vitem &*control*&&~=&~<&'text'&>
31513 .cindex "&%control%& ACL modifier"
31514 This modifier affects the subsequent processing of the SMTP connection or of an
31515 incoming message that is accepted. The effect of the first type of control
31516 lasts for the duration of the connection, whereas the effect of the second type
31517 lasts only until the current message has been received. The message-specific
31518 controls always apply to the whole message, not to individual recipients,
31519 even if the &%control%& modifier appears in a RCPT ACL.
31520
31521 As there are now quite a few controls that can be applied, they are described
31522 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31523 in several different ways. For example:
31524
31525 . ==== As this is a nested list, any displays it contains must be indented
31526 . ==== as otherwise they are too far to the left. That comment applies only
31527 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31528 . ==== way.
31529
31530 .ilist
31531 It can be at the end of an &%accept%& statement:
31532 .code
31533     accept  ...some conditions
31534             control = queue
31535 .endd
31536 In this case, the control is applied when this statement yields &"accept"&, in
31537 other words, when the conditions are all true.
31538
31539 .next
31540 It can be in the middle of an &%accept%& statement:
31541 .code
31542     accept  ...some conditions...
31543             control = queue
31544             ...some more conditions...
31545 .endd
31546 If the first set of conditions are true, the control is applied, even if the
31547 statement does not accept because one of the second set of conditions is false.
31548 In this case, some subsequent statement must yield &"accept"& for the control
31549 to be relevant.
31550
31551 .next
31552 It can be used with &%warn%& to apply the control, leaving the
31553 decision about accepting or denying to a subsequent verb. For
31554 example:
31555 .code
31556     warn    ...some conditions...
31557             control = freeze
31558     accept  ...
31559 .endd
31560 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31561 &%logwrite%&, so it does not add anything to the message and does not write a
31562 log entry.
31563
31564 .next
31565 If you want to apply a control unconditionally, you can use it with a
31566 &%require%& verb. For example:
31567 .code
31568     require  control = no_multiline_responses
31569 .endd
31570 .endlist
31571
31572 .vitem &*delay*&&~=&~<&'time'&>
31573 .cindex "&%delay%& ACL modifier"
31574 .oindex "&%-bh%&"
31575 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31576 the time interval before proceeding. However, when testing Exim using the
31577 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31578 output instead). The time is given in the usual Exim notation, and the delay
31579 happens as soon as the modifier is processed. In an SMTP session, pending
31580 output is flushed before the delay is imposed.
31581
31582 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31583 example:
31584 .code
31585 deny    ...some conditions...
31586         delay = 30s
31587 .endd
31588 The delay happens if all the conditions are true, before the statement returns
31589 &"deny"&. Compare this with:
31590 .code
31591 deny    delay = 30s
31592         ...some conditions...
31593 .endd
31594 which waits for 30s before processing the conditions. The &%delay%& modifier
31595 can also be used with &%warn%& and together with &%control%&:
31596 .code
31597 warn    ...some conditions...
31598         delay = 2m
31599         control = freeze
31600 accept  ...
31601 .endd
31602
31603 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31604 responses to several commands are no longer buffered and sent in one packet (as
31605 they would normally be) because all output is flushed before imposing the
31606 delay. This optimization is disabled so that a number of small delays do not
31607 appear to the client as one large aggregated delay that might provoke an
31608 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31609 using a &%control%& modifier to set &%no_delay_flush%&.
31610
31611
31612 .vitem &*endpass*&
31613 .cindex "&%endpass%& ACL modifier"
31614 This modifier, which has no argument, is recognized only in &%accept%& and
31615 &%discard%& statements. It marks the boundary between the conditions whose
31616 failure causes control to pass to the next statement, and the conditions whose
31617 failure causes the ACL to return &"deny"&. This concept has proved to be
31618 confusing to some people, so the use of &%endpass%& is no longer recommended as
31619 &"best practice"&. See the description of &%accept%& above for more details.
31620
31621
31622 .vitem &*log_message*&&~=&~<&'text'&>
31623 .cindex "&%log_message%& ACL modifier"
31624 This modifier sets up a message that is used as part of the log message if the
31625 ACL denies access or a &%warn%& statement's conditions are true. For example:
31626 .code
31627 require log_message = wrong cipher suite $tls_in_cipher
31628         encrypted   = DES-CBC3-SHA
31629 .endd
31630 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31631 example:
31632 .display
31633 &`discard `&<&'some conditions'&>
31634 &`        log_message = Discarded $local_part@$domain because...`&
31635 .endd
31636 When access is denied, &%log_message%& adds to any underlying error message
31637 that may exist because of a condition failure. For example, while verifying a
31638 recipient address, a &':fail:'& redirection might have already set up a
31639 message.
31640
31641 The message may be defined before the conditions to which it applies, because
31642 the string expansion does not happen until Exim decides that access is to be
31643 denied. This means that any variables that are set by the condition are
31644 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31645 variables are set after a DNS black list lookup succeeds. If the expansion of
31646 &%log_message%& fails, or if the result is an empty string, the modifier is
31647 ignored.
31648
31649 .vindex "&$acl_verify_message$&"
31650 If you want to use a &%warn%& statement to log the result of an address
31651 verification, you can use &$acl_verify_message$& to include the verification
31652 error message.
31653
31654 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31655 the start of the logged message. If the same warning log message is requested
31656 more than once while receiving  a single email message, only one copy is
31657 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31658 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31659 is logged for a successful &%warn%& statement.
31660
31661 If &%log_message%& is not present and there is no underlying error message (for
31662 example, from the failure of address verification), but &%message%& is present,
31663 the &%message%& text is used for logging rejections. However, if any text for
31664 logging contains newlines, only the first line is logged. In the absence of
31665 both &%log_message%& and &%message%&, a default built-in message is used for
31666 logging rejections.
31667
31668
31669 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31670 .cindex "&%log_reject_target%& ACL modifier"
31671 .cindex "logging in ACL" "specifying which log"
31672 This modifier makes it possible to specify which logs are used for messages
31673 about ACL rejections. Its argument is a colon-separated list of words that can
31674 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31675 may be empty, in which case a rejection is not logged at all. For example, this
31676 ACL fragment writes no logging information when access is denied:
31677 .display
31678 &`deny `&<&'some conditions'&>
31679 &`     log_reject_target =`&
31680 .endd
31681 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31682 permanent and temporary rejections. Its effect lasts for the rest of the
31683 current ACL.
31684
31685
31686 .vitem &*logwrite*&&~=&~<&'text'&>
31687 .cindex "&%logwrite%& ACL modifier"
31688 .cindex "logging in ACL" "immediate"
31689 This modifier writes a message to a log file as soon as it is encountered when
31690 processing an ACL. (Compare &%log_message%&, which, except in the case of
31691 &%warn%& and &%discard%&, is used only if the ACL statement denies
31692 access.) The &%logwrite%& modifier can be used to log special incidents in
31693 ACLs. For example:
31694 .display
31695 &`accept `&<&'some special conditions'&>
31696 &`       control  = freeze`&
31697 &`       logwrite = froze message because ...`&
31698 .endd
31699 By default, the message is written to the main log. However, it may begin
31700 with a colon, followed by a comma-separated list of log names, and then
31701 another colon, to specify exactly which logs are to be written. For
31702 example:
31703 .code
31704 logwrite = :main,reject: text for main and reject logs
31705 logwrite = :panic: text for panic log only
31706 .endd
31707
31708
31709 .vitem &*message*&&~=&~<&'text'&>
31710 .cindex "&%message%& ACL modifier"
31711 This modifier sets up a text string that is expanded and used as a response
31712 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31713 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31714 there is some complication if &%endpass%& is involved; see the description of
31715 &%accept%& for details.)
31716
31717 The expansion of the message happens at the time Exim decides that the ACL is
31718 to end, not at the time it processes &%message%&. If the expansion fails, or
31719 generates an empty string, the modifier is ignored. Here is an example where
31720 &%message%& must be specified first, because the ACL ends with a rejection if
31721 the &%hosts%& condition fails:
31722 .code
31723 require  message = Host not recognized
31724          hosts = 10.0.0.0/8
31725 .endd
31726 (Once a condition has failed, no further conditions or modifiers are
31727 processed.)
31728
31729 .cindex "SMTP" "error codes"
31730 .oindex "&%smtp_banner%&
31731 For ACLs that are triggered by SMTP commands, the message is returned as part
31732 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31733 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31734 is accepted. In the case of the connect ACL, accepting with a message modifier
31735 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31736 accept message may not contain more than one line (otherwise it will be
31737 truncated at the first newline and a panic logged), and it cannot affect the
31738 EHLO options.
31739
31740 When SMTP is involved, the message may begin with an overriding response code,
31741 consisting of three digits optionally followed by an &"extended response code"&
31742 of the form &'n.n.n'&, each code being followed by a space. For example:
31743 .code
31744 deny  message = 599 1.2.3 Host not welcome
31745       hosts = 192.168.34.0/24
31746 .endd
31747 The first digit of the supplied response code must be the same as would be sent
31748 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31749 access, but for the predata ACL, note that the default success code is 354, not
31750 2&'xx'&.
31751
31752 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31753 the message modifier cannot override the 221 response code.
31754
31755 The text in a &%message%& modifier is literal; any quotes are taken as
31756 literals, but because the string is expanded, backslash escapes are processed
31757 anyway.
31758 If the message contains newlines, this gives rise to a multi-line SMTP
31759 response.
31760 A long message line will also be split into multi-line SMTP responses,
31761 on word boundaries if possible.
31762
31763 .vindex "&$acl_verify_message$&"
31764 While the text is being expanded, the &$acl_verify_message$& variable
31765 contains any message previously set.
31766 Afterwards, &$acl_verify_message$& is cleared.
31767
31768 If &%message%& is used on a statement that verifies an address, the message
31769 specified overrides any message that is generated by the verification process.
31770 However, the original message is available in the variable
31771 &$acl_verify_message$&, so you can incorporate it into your message if you
31772 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31773 routers to be passed back as part of the SMTP response, you should either not
31774 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31775
31776 For compatibility with previous releases of Exim, a &%message%& modifier that
31777 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31778 modifier, but this usage is now deprecated. However, &%message%& acts only when
31779 all the conditions are true, wherever it appears in an ACL command, whereas
31780 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31781 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31782 effect.
31783
31784
31785 .vitem &*queue*&&~=&~<&'text'&>
31786 .cindex "&%queue%& ACL modifier"
31787 .cindex "named queues" "selecting in ACL"
31788 This modifier specifies the use of a named queue for spool files
31789 for the message.
31790 It can only be used before the message is received (i.e. not in
31791 the DATA ACL).
31792 This could be used, for example, for known high-volume burst sources
31793 of traffic, or for quarantine of messages.
31794 Separate queue-runner processes will be needed for named queues.
31795 If the text after expansion is empty, the default queue is used.
31796
31797
31798 .vitem &*remove_header*&&~=&~<&'text'&>
31799 This modifier specifies one or more header names in a colon-separated list
31800  that are to be removed from an incoming message, assuming, of course, that
31801 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31802
31803
31804 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31805 .cindex "&%set%& ACL modifier"
31806 This modifier puts a value into one of the ACL variables (see section
31807 &<<SECTaclvariables>>&).
31808
31809
31810 .vitem &*udpsend*&&~=&~<&'parameters'&>
31811 .cindex "UDP communications"
31812 This modifier sends a UDP packet, for purposes such as statistics
31813 collection or behaviour monitoring. The parameters are expanded, and
31814 the result of the expansion must be a colon-separated list consisting
31815 of a destination server, port number, and the packet contents. The
31816 server can be specified as a host name or IPv4 or IPv6 address. The
31817 separator can be changed with the usual angle bracket syntax. For
31818 example, you might want to collect information on which hosts connect
31819 when:
31820 .code
31821 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31822              $tod_zulu $sender_host_address
31823 .endd
31824 .endlist
31825
31826
31827
31828
31829 .section "Use of the control modifier" "SECTcontrols"
31830 .cindex "&%control%& ACL modifier"
31831 The &%control%& modifier supports the following settings:
31832
31833 .vlist
31834 .vitem &*control&~=&~allow_auth_unadvertised*&
31835 This modifier allows a client host to use the SMTP AUTH command even when it
31836 has not been advertised in response to EHLO. Furthermore, because there are
31837 apparently some really broken clients that do this, Exim will accept AUTH after
31838 HELO (rather than EHLO) when this control is set. It should be used only if you
31839 really need it, and you should limit its use to those broken clients that do
31840 not work without it. For example:
31841 .code
31842 warn hosts   = 192.168.34.25
31843      control = allow_auth_unadvertised
31844 .endd
31845 Normally, when an Exim server receives an AUTH command, it checks the name of
31846 the authentication mechanism that is given in the command to ensure that it
31847 matches an advertised mechanism. When this control is set, the check that a
31848 mechanism has been advertised is bypassed. Any configured mechanism can be used
31849 by the client. This control is permitted only in the connection and HELO ACLs.
31850
31851
31852 .vitem &*control&~=&~caseful_local_part*& &&&
31853        &*control&~=&~caselower_local_part*&
31854 .cindex "&ACL;" "case of local part in"
31855 .cindex "case of local parts"
31856 .vindex "&$local_part$&"
31857 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31858 (that is, during RCPT processing). By default, the contents of &$local_part$&
31859 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31860 any uppercase letters in the original local part are restored in &$local_part$&
31861 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31862 is encountered.
31863
31864 These controls affect only the current recipient. Moreover, they apply only to
31865 local part handling that takes place directly in the ACL (for example, as a key
31866 in lookups). If a test to verify the recipient is obeyed, the case-related
31867 handling of the local part during the verification is controlled by the router
31868 configuration (see the &%caseful_local_part%& generic router option).
31869
31870 This facility could be used, for example, to add a spam score to local parts
31871 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31872 spam score:
31873 .code
31874 warn  control = caseful_local_part
31875       set acl_m4 = ${eval:\
31876                      $acl_m4 + \
31877                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31878                     }
31879       control = caselower_local_part
31880 .endd
31881 Notice that we put back the lower cased version afterwards, assuming that
31882 is what is wanted for subsequent tests.
31883
31884
31885 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31886 .cindex "&ACL;" "cutthrough routing"
31887 .cindex "cutthrough" "requesting"
31888 This option requests delivery be attempted while the item is being received.
31889
31890 The option is usable in the RCPT ACL.
31891 If enabled for a message received via smtp and routed to an smtp transport,
31892 and only one transport, interface, destination host and port combination
31893 is used for all recipients of the message,
31894 then the delivery connection is made while the receiving connection is open
31895 and data is copied from one to the other.
31896
31897 An attempt to set this option for any recipient but the first
31898 for a mail will be quietly ignored.
31899 If a recipient-verify callout
31900 (with use_sender)
31901 connection is subsequently
31902 requested in the same ACL it is held open and used for
31903 any subsequent recipients and the data,
31904 otherwise one is made after the initial RCPT ACL completes.
31905
31906 Note that routers are used in verify mode,
31907 and cannot depend on content of received headers.
31908 Note also that headers cannot be
31909 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31910 Headers may be modified by routers (subject to the above) and transports.
31911 The &'Received-By:'& header is generated as soon as the body reception starts,
31912 rather than the traditional time after the full message is received;
31913 this will affect the timestamp.
31914
31915 All the usual ACLs are called; if one results in the message being
31916 rejected, all effort spent in delivery (including the costs on
31917 the ultimate destination) will be wasted.
31918 Note that in the case of data-time ACLs this includes the entire
31919 message body.
31920
31921 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31922 of outgoing messages is done, because it sends data to the ultimate destination
31923 before the entire message has been received from the source.
31924 It is not supported for messages received with the SMTP PRDR
31925 or CHUNKING
31926 options in use.
31927
31928 Should the ultimate destination system positively accept or reject the mail,
31929 a corresponding indication is given to the source system and nothing is queued.
31930 If the item is successfully delivered in cutthrough mode
31931 the delivery log lines are tagged with ">>" rather than "=>" and appear
31932 before the acceptance "<=" line.
31933
31934 If there is a temporary error the item is queued for later delivery in the
31935 usual fashion.
31936 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31937 to the control; the default value is &"spool"& and the alternate value
31938 &"pass"& copies an SMTP defer response from the target back to the initiator
31939 and does not queue the message.
31940 Note that this is independent of any recipient verify conditions in the ACL.
31941
31942 Delivery in this mode avoids the generation of a bounce mail to a
31943 (possibly faked)
31944 sender when the destination system is doing content-scan based rejection.
31945
31946
31947 .vitem &*control&~=&~debug/*&<&'options'&>
31948 .cindex "&ACL;" "enabling debug logging"
31949 .cindex "debugging" "enabling from an ACL"
31950 This control turns on debug logging, almost as though Exim had been invoked
31951 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31952 by default called &'debuglog'&.
31953
31954 Logging set up by the control will be maintained across spool residency.
31955
31956 Options are a slash-separated list.
31957 If an option takes an argument, the option name and argument are separated by
31958 an equals character.
31959 Several options are supported:
31960 .display
31961 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31962                      The argument, which may access any variables already defined,
31963                      is appended to the default name.
31964
31965 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31966                      using the same values as the &`-d`& command-line option.
31967
31968 stop                 Logging started with this control may be
31969                      stopped by using this option.
31970
31971 kill                 Logging started with this control may be
31972                      stopped by using this option.
31973                      Additionally the debug file will be removed,
31974                      providing one means for speculative debug tracing.
31975
31976 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31977                      for pre-trigger debug capture.
31978                      Debug lines are recorded in the buffer until
31979                      and if) a trigger occurs; at which time they are
31980                      dumped to the debug file.  Newer lines displace the
31981                      oldest if the buffer is full.  After a trigger,
31982                      immediate writes to file are done as normal.
31983
31984 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31985                      see above) to be copied to file.  A reason of &*now*&
31986                      take effect immediately; one of &*paniclog*& triggers
31987                      on a write to the panic log.
31988 .endd
31989
31990 Some examples (which depend on variables that don't exist in all
31991 contexts):
31992 .code
31993       control = debug
31994       control = debug/tag=.$sender_host_address
31995       control = debug/opts=+expand+acl
31996       control = debug/tag=.$message_exim_id/opts=+expand
31997       control = debug/kill
31998       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31999       control = debug/trigger=now
32000 .endd
32001
32002
32003 .vitem &*control&~=&~dkim_disable_verify*&
32004 .cindex "disable DKIM verify"
32005 .cindex "DKIM" "disable verify"
32006 This control turns off DKIM verification processing entirely.  For details on
32007 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
32008
32009
32010 .vitem &*control&~=&~dmarc_disable_verify*&
32011 .cindex "disable DMARC verify"
32012 .cindex "DMARC" "disable verify"
32013 This control turns off DMARC verification processing entirely.  For details on
32014 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
32015
32016
32017 .vitem &*control&~=&~dscp/*&<&'value'&>
32018 .cindex "&ACL;" "setting DSCP value"
32019 .cindex "DSCP" "inbound"
32020 This option causes the DSCP value associated with the socket for the inbound
32021 connection to be adjusted to a given value, given as one of a number of fixed
32022 strings or to numeric value.
32023 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
32024 Common values include &`throughput`&, &`mincost`&, and on newer systems
32025 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
32026
32027 The outbound packets from Exim will be marked with this value in the header
32028 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
32029 that these values will have any effect, not be stripped by networking
32030 equipment, or do much of anything without cooperation with your Network
32031 Engineer and those of all network operators between the source and destination.
32032
32033
32034 .vitem &*control&~=&~enforce_sync*& &&&
32035        &*control&~=&~no_enforce_sync*&
32036 .cindex "SMTP" "synchronization checking"
32037 .cindex "synchronization checking in SMTP"
32038 These controls make it possible to be selective about when SMTP synchronization
32039 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
32040 state of the switch (it is true by default). See the description of this option
32041 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
32042
32043 The effect of these two controls lasts for the remainder of the SMTP
32044 connection. They can appear in any ACL except the one for the non-SMTP
32045 messages. The most straightforward place to put them is in the ACL defined by
32046 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
32047 before the first synchronization check. The expected use is to turn off the
32048 synchronization checks for badly-behaved hosts that you nevertheless need to
32049 work with.
32050
32051
32052 .vitem &*control&~=&~fakedefer/*&<&'message'&>
32053 .cindex "fake defer"
32054 .cindex "defer, fake"
32055 .cindex fakedefer
32056 This control works in exactly the same way as &%fakereject%& (described below)
32057 except that it causes an SMTP 450 response after the message data instead of a
32058 550 response. You must take care when using &%fakedefer%& because it causes the
32059 messages to be duplicated when the sender retries. Therefore, you should not
32060 use &%fakedefer%& if the message is to be delivered normally.
32061
32062 .vitem &*control&~=&~fakereject/*&<&'message'&>
32063 .cindex "fake rejection"
32064 .cindex "rejection, fake"
32065 .cindex fakereject
32066 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
32067 words, only when an SMTP message is being received. If Exim accepts the
32068 message, instead the final 250 response, a 550 rejection message is sent.
32069 However, Exim proceeds to deliver the message as normal. The control applies
32070 only to the current message, not to any subsequent ones that may be received in
32071 the same SMTP connection.
32072
32073 The text for the 550 response is taken from the &%control%& modifier. If no
32074 message is supplied, the following is used:
32075 .code
32076 550-Your message has been rejected but is being
32077 550-kept for evaluation.
32078 550-If it was a legitimate message, it may still be
32079 550 delivered to the target recipient(s).
32080 .endd
32081 This facility should be used with extreme caution.
32082
32083 .vitem &*control&~=&~freeze*&
32084 .cindex "frozen messages" "forcing in ACL"
32085 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
32086 other words, only when a message is being received. If the message is accepted,
32087 it is placed on Exim's queue and frozen. The control applies only to the
32088 current message, not to any subsequent ones that may be received in the same
32089 SMTP connection.
32090
32091 This modifier can optionally be followed by &`/no_tell`&. If the global option
32092 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
32093 is told about the freezing), provided all the &*control=freeze*& modifiers that
32094 are obeyed for the current message have the &`/no_tell`& option.
32095
32096 .vitem &*control&~=&~no_delay_flush*&
32097 .cindex "SMTP" "output flushing, disabling for delay"
32098 Exim normally flushes SMTP output before implementing a delay in an ACL, to
32099 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
32100 use. This control, as long as it is encountered before the &%delay%& modifier,
32101 disables such output flushing.
32102
32103 .vitem &*control&~=&~no_callout_flush*&
32104 .cindex "SMTP" "output flushing, disabling for callout"
32105 Exim normally flushes SMTP output before performing a callout in an ACL, to
32106 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
32107 use. This control, as long as it is encountered before the &%verify%& condition
32108 that causes the callout, disables such output flushing.
32109
32110 .vitem &*control&~=&~no_mbox_unspool*&
32111 This control is available when Exim is compiled with the content scanning
32112 extension. Content scanning may require a copy of the current message, or parts
32113 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
32114 or spam scanner. Normally, such copies are deleted when they are no longer
32115 needed. If this control is set, the copies are not deleted. The control applies
32116 only to the current message, not to any subsequent ones that may be received in
32117 the same SMTP connection. It is provided for debugging purposes and is unlikely
32118 to be useful in production.
32119
32120 .vitem &*control&~=&~no_multiline_responses*&
32121 .cindex "multiline responses, suppressing"
32122 This control is permitted for any ACL except the one for non-SMTP messages.
32123 It seems that there are broken clients in use that cannot handle multiline
32124 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
32125
32126 If this control is set, multiline SMTP responses from ACL rejections are
32127 suppressed. One way of doing this would have been to put out these responses as
32128 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
32129 (&"use multiline responses for more"& it says &-- ha!), and some of the
32130 responses might get close to that. So this facility, which is after all only a
32131 sop to broken clients, is implemented by doing two very easy things:
32132
32133 .ilist
32134 Extra information that is normally output as part of a rejection caused by
32135 sender verification failure is omitted. Only the final line (typically &"sender
32136 verification failed"&) is sent.
32137 .next
32138 If a &%message%& modifier supplies a multiline response, only the first
32139 line is output.
32140 .endlist
32141
32142 The setting of the switch can, of course, be made conditional on the
32143 calling host. Its effect lasts until the end of the SMTP connection.
32144
32145 .vitem &*control&~=&~no_pipelining*&
32146 .cindex "PIPELINING" "suppressing advertising"
32147 .cindex "ESMTP extensions" PIPELINING
32148 This control turns off the advertising of the PIPELINING extension to SMTP in
32149 the current session. To be useful, it must be obeyed before Exim sends its
32150 response to an EHLO command. Therefore, it should normally appear in an ACL
32151 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
32152 &%pipelining_advertise_hosts%&.
32153
32154 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
32155        &*control&~=&~queue_only*&
32156 .oindex "&%queue%&"
32157 .oindex "&%queue_only%&"
32158 .cindex "queueing incoming messages"
32159 .cindex queueing "forcing in ACL"
32160 .cindex "first pass routing"
32161 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
32162 other words, only when a message is being received. If the message is accepted,
32163 it is placed on Exim's queue and left there for delivery by a subsequent queue
32164 runner.
32165 If used with no options set,
32166 no immediate delivery process is started. In other words, it has the
32167 effect as the &%queue_only%& global option or &'-odq'& command-line option.
32168
32169 If the &'first_pass_route'& option is given then
32170 the behaviour is like the command-line &'-oqds'& option;
32171 a delivery process is started which stops short of making
32172 any SMTP delivery.  The benefit is that the hints database will be updated for
32173 the message being waiting for a specific host, and a later queue run will be
32174 able to send all such messages on a single connection.
32175
32176 The control only applies to the current message, not to any subsequent ones that
32177  may be received in the same SMTP connection.
32178
32179 .vitem &*control&~=&~submission/*&<&'options'&>
32180 .cindex "message" "submission"
32181 .cindex "submission mode"
32182 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
32183 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
32184 the current message is a submission from a local MUA. In this case, Exim
32185 operates in &"submission mode"&, and applies certain fixups to the message if
32186 necessary. For example, it adds a &'Date:'& header line if one is not present.
32187 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
32188 late (the message has already been created).
32189
32190 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
32191 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
32192 submission mode; the available options for this control are described there.
32193 The control applies only to the current message, not to any subsequent ones
32194 that may be received in the same SMTP connection.
32195
32196 .vitem &*control&~=&~suppress_local_fixups*&
32197 .cindex "submission fixups, suppressing"
32198 This control applies to locally submitted (non TCP/IP) messages, and is the
32199 complement of &`control = submission`&. It disables the fixups that are
32200 normally applied to locally-submitted messages. Specifically:
32201
32202 .ilist
32203 Any &'Sender:'& header line is left alone (in this respect, it is a
32204 dynamic version of &%local_sender_retain%&).
32205 .next
32206 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32207 .next
32208 There is no check that &'From:'& corresponds to the actual sender.
32209 .endlist ilist
32210
32211 This control may be useful when a remotely-originated message is accepted,
32212 passed to some scanning program, and then re-submitted for delivery. It can be
32213 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32214 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32215 data is read.
32216
32217 &*Note:*& This control applies only to the current message, not to any others
32218 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32219
32220 .vitem &*control&~=&~utf8_downconvert*&
32221 This control enables conversion of UTF-8 in message envelope addresses
32222 to a-label form.
32223 For details see section &<<SECTi18nMTA>>&.
32224
32225 .vitem &*control&~=&~wellknown*&
32226 This control sets up a response data file for a WELLKNOWN SMTP command.
32227 It may only be used in an ACL servicing that command.
32228 For details see section &<<SECTWELLKNOWNACL>>&.
32229 .endlist vlist
32230
32231
32232 .section "Summary of message fixup control" "SECTsummesfix"
32233 All four possibilities for message fixups can be specified:
32234
32235 .ilist
32236 Locally submitted, fixups applied: the default.
32237 .next
32238 Locally submitted, no fixups applied: use
32239 &`control = suppress_local_fixups`&.
32240 .next
32241 Remotely submitted, no fixups applied: the default.
32242 .next
32243 Remotely submitted, fixups applied: use &`control = submission`&.
32244 .endlist
32245
32246
32247
32248 .section "Adding header lines in ACLs" "SECTaddheadacl"
32249 .cindex "header lines" "adding in an ACL"
32250 .cindex "header lines" "position of added lines"
32251 .cindex "&%add_header%& ACL modifier"
32252 The &%add_header%& modifier can be used to add one or more extra header lines
32253 to an incoming message, as in this example:
32254 .code
32255 warn dnslists = sbl.spamhaus.org : \
32256                 dialup.mail-abuse.org
32257      add_header = X-blacklisted-at: $dnslist_domain
32258 .endd
32259 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32260 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32261 receiving a message). The message must ultimately be accepted for
32262 &%add_header%& to have any significant effect. You can use &%add_header%& with
32263 any ACL verb, including &%deny%& (though this is potentially useful only in a
32264 RCPT ACL).
32265
32266 Headers will not be added to the message if the modifier is used in
32267 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32268
32269 Leading and trailing newlines are removed from
32270 the data for the &%add_header%& modifier; if it then
32271 contains one or more newlines that
32272 are not followed by a space or a tab, it is assumed to contain multiple header
32273 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32274 front of any line that is not a valid header line.
32275
32276 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32277 They are added to the message before processing the DATA and MIME ACLs.
32278 However, if an identical header line is requested more than once, only one copy
32279 is actually added to the message. Further header lines may be accumulated
32280 during the DATA and MIME ACLs, after which they are added to the message, again
32281 with duplicates suppressed. Thus, it is possible to add two identical header
32282 lines to an SMTP message, but only if one is added before DATA and one after.
32283 In the case of non-SMTP messages, new headers are accumulated during the
32284 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32285 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32286 are included in the entry that is written to the reject log.
32287
32288 .cindex "header lines" "added; visibility of"
32289 Header lines are not visible in string expansions
32290 of message headers
32291 until they are added to the
32292 message. It follows that header lines defined in the MAIL, RCPT, and predata
32293 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32294 header lines that are added by the DATA or MIME ACLs are not visible in those
32295 ACLs. Because of this restriction, you cannot use header lines as a way of
32296 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32297 this, you can use ACL variables, as described in section
32298 &<<SECTaclvariables>>&.
32299
32300 The list of headers yet to be added is given by the &%$headers_added%& variable.
32301
32302 The &%add_header%& modifier acts immediately as it is encountered during the
32303 processing of an ACL. Notice the difference between these two cases:
32304 .display
32305 &`accept add_header = ADDED: some text`&
32306 &`       `&<&'some condition'&>
32307
32308 &`accept `&<&'some condition'&>
32309 &`       add_header = ADDED: some text`&
32310 .endd
32311 In the first case, the header line is always added, whether or not the
32312 condition is true. In the second case, the header line is added only if the
32313 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32314 ACL statement. All those that are encountered before a condition fails are
32315 honoured.
32316
32317 .cindex "&%warn%& ACL verb"
32318 For compatibility with previous versions of Exim, a &%message%& modifier for a
32319 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32320 effect only if all the conditions are true, even if it appears before some of
32321 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32322 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32323 are present on a &%warn%& verb, both are processed according to their
32324 specifications.
32325
32326 By default, new header lines are added to a message at the end of the existing
32327 header lines. However, you can specify that any particular header line should
32328 be added right at the start (before all the &'Received:'& lines), immediately
32329 after the first block of &'Received:'& lines, or immediately before any line
32330 that is not a &'Received:'& or &'Resent-something:'& header.
32331
32332 This is done by specifying &":at_start:"&, &":after_received:"&, or
32333 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32334 header line, respectively. (Header text cannot start with a colon, as there has
32335 to be a header name first.) For example:
32336 .code
32337 warn add_header = \
32338        :after_received:X-My-Header: something or other...
32339 .endd
32340 If more than one header line is supplied in a single &%add_header%& modifier,
32341 each one is treated independently and can therefore be placed differently. If
32342 you add more than one line at the start, or after the Received: block, they end
32343 up in reverse order.
32344
32345 &*Warning*&: This facility currently applies only to header lines that are
32346 added in an ACL. It does NOT work for header lines that are added in a
32347 system filter or in a router or transport.
32348
32349
32350
32351 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32352 .cindex "header lines" "removing in an ACL"
32353 .cindex "header lines" "position of removed lines"
32354 .cindex "&%remove_header%& ACL modifier"
32355 The &%remove_header%& modifier can be used to remove one or more header lines
32356 from an incoming message, as in this example:
32357 .code
32358 warn   message        = Remove internal headers
32359        remove_header  = x-route-mail1 : x-route-mail2
32360 .endd
32361 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32362 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32363 receiving a message). The message must ultimately be accepted for
32364 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32365 with any ACL verb, including &%deny%&, though this is really not useful for
32366 any verb that doesn't result in a delivered message.
32367
32368 Headers will not be removed from the message if the modifier is used in
32369 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32370
32371 More than one header can be removed at the same time by using a colon separated
32372 list of header specifiers.
32373 If a specifier does not start with a circumflex (^)
32374 then it is treated as a header name.
32375 The header name matching is case insensitive.
32376 If it does, then it is treated as a (front-anchored)
32377 regular expression applied to the whole header.
32378
32379 &*Note*&: The colon terminating a header name will need to be doubled
32380 if used in an RE, and there can legitimately be whitepace before it.
32381
32382 Example:
32383 .code
32384 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32385 .endd
32386
32387 List expansion is not performed, so you cannot use hostlists to
32388 create a list of headers, however both connection and message variable expansion
32389 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32390 .code
32391 warn   hosts           = +internal_hosts
32392        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32393 warn   message         = Remove internal headers
32394        remove_header   = $acl_c_ihdrs
32395 .endd
32396 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32397 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32398 If multiple header lines match, all are removed.
32399 There is no harm in attempting to remove the same header twice nor in removing
32400 a non-existent header. Further header specifiers for removal may be accumulated
32401 during the DATA and MIME ACLs, after which matching headers are removed
32402 if present. In the case of non-SMTP messages, remove specifiers are
32403 accumulated during the non-SMTP ACLs, and are acted on after
32404 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32405 ACL, there really is no effect because there is no logging of what headers
32406 would have been removed.
32407
32408 .cindex "header lines" "removed; visibility of"
32409 Header lines are not visible in string expansions until the DATA phase when it
32410 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32411 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32412 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32413 this restriction, you cannot use header lines as a way of controlling data
32414 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32415 you should instead use ACL variables, as described in section
32416 &<<SECTaclvariables>>&.
32417
32418 The &%remove_header%& modifier acts immediately as it is encountered during the
32419 processing of an ACL. Notice the difference between these two cases:
32420 .display
32421 &`accept remove_header = X-Internal`&
32422 &`       `&<&'some condition'&>
32423
32424 &`accept `&<&'some condition'&>
32425 &`       remove_header = X-Internal`&
32426 .endd
32427 In the first case, the header line is always removed, whether or not the
32428 condition is true. In the second case, the header line is removed only if the
32429 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32430 same ACL statement. All those that are encountered before a condition fails
32431 are honoured.
32432
32433 &*Warning*&: This facility currently applies only to header lines that are
32434 present during ACL processing. It does NOT remove header lines that are added
32435 in a system filter or in a router or transport.
32436
32437
32438
32439
32440 .section "ACL conditions" "SECTaclconditions"
32441 .cindex "&ACL;" "conditions; list of"
32442 Some of the conditions listed in this section are available only when Exim is
32443 compiled with the content-scanning extension. They are included here briefly
32444 for completeness. More detailed descriptions can be found in the discussion on
32445 content scanning in chapter &<<CHAPexiscan>>&.
32446
32447 Not all conditions are relevant in all circumstances. For example, testing
32448 senders and recipients does not make sense in an ACL that is being run as the
32449 result of the arrival of an ETRN command, and checks on message headers can be
32450 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32451 can use the same condition (with different parameters) more than once in the
32452 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32453 The conditions are as follows:
32454
32455
32456 .vlist
32457 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32458 .cindex "&ACL;" "nested"
32459 .cindex "&ACL;" "indirect"
32460 .cindex "&ACL;" "arguments"
32461 .cindex "&%acl%& ACL condition"
32462 The possible values of the argument are the same as for the
32463 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32464 &"accept"& the condition is true; if it returns &"deny"& the condition is
32465 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32466 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32467 condition false. This means that further processing of the &%warn%& verb
32468 ceases, but processing of the ACL continues.
32469
32470 If the argument is a named ACL, up to nine space-separated optional values
32471 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32472 and $acl_narg is set to the count of values.
32473 Previous values of these variables are restored after the call returns.
32474 The name and values are expanded separately.
32475 Note that spaces in complex expansions which are used as arguments
32476 will act as argument separators.
32477
32478 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32479 the connection is dropped. If it returns &"discard"&, the verb must be
32480 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32481 conditions are tested.
32482
32483 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32484 loops. This condition allows you to use different ACLs in different
32485 circumstances. For example, different ACLs can be used to handle RCPT commands
32486 for different local users or different local domains.
32487
32488 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32489 .cindex "&%authenticated%& ACL condition"
32490 .cindex "authentication" "ACL checking"
32491 .cindex "&ACL;" "testing for authentication"
32492 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32493 the name of the authenticator is tested against the list. To test for
32494 authentication by any authenticator, you can set
32495 .code
32496 authenticated = *
32497 .endd
32498
32499 .vitem &*condition&~=&~*&<&'string'&>
32500 .cindex "&%condition%& ACL condition"
32501 .cindex "customizing" "ACL condition"
32502 .cindex "&ACL;" "customized test"
32503 .cindex "&ACL;" "testing, customized"
32504 This feature allows you to make up custom conditions. If the result of
32505 expanding the string is an empty string, the number zero, or one of the strings
32506 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32507 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32508 any other value, some error is assumed to have occurred, and the ACL returns
32509 &"defer"&. However, if the expansion is forced to fail, the condition is
32510 ignored. The effect is to treat it as true, whether it is positive or
32511 negative.
32512
32513 .vitem &*decode&~=&~*&<&'location'&>
32514 .cindex "&%decode%& ACL condition"
32515 This condition is available only when Exim is compiled with the
32516 content-scanning extension, and it is allowed only in the ACL defined by
32517 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32518 If all goes well, the condition is true. It is false only if there are
32519 problems such as a syntax error or a memory shortage. For more details, see
32520 chapter &<<CHAPexiscan>>&.
32521
32522 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32523 .cindex "&%dnslists%& ACL condition"
32524 .cindex "DNS list" "in ACL"
32525 .cindex "black list (DNS)"
32526 .cindex "&ACL;" "testing a DNS list"
32527 This condition checks for entries in DNS black lists. These are also known as
32528 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32529 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32530 different variants of this condition to describe briefly here. See sections
32531 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32532
32533 .vitem &*domains&~=&~*&<&'domain&~list'&>
32534 .cindex "&%domains%& ACL condition"
32535 .cindex "domain" "ACL checking"
32536 .cindex "&ACL;" "testing a recipient domain"
32537 .vindex "&$domain_data$&"
32538 This condition is relevant only in a RCPT ACL. It checks that the domain
32539 of the recipient address is in the domain list. If percent-hack processing is
32540 enabled, it is done before this test is done. If the check succeeds with a
32541 lookup, the result of the lookup is placed in &$domain_data$& until the next
32542 &%domains%& test.
32543
32544 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32545 use &%domains%& in a DATA ACL.
32546
32547
32548 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32549 .cindex "&%encrypted%& ACL condition"
32550 .cindex "encryption" "checking in an ACL"
32551 .cindex "&ACL;" "testing for encryption"
32552 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32553 name of the cipher suite in use is tested against the list. To test for
32554 encryption without testing for any specific cipher suite(s), set
32555 .code
32556 encrypted = *
32557 .endd
32558
32559
32560 .vitem &*hosts&~=&~*&<&'host&~list'&>
32561 .cindex "&%hosts%& ACL condition"
32562 .cindex "host" "ACL checking"
32563 .cindex "&ACL;" "testing the client host"
32564 This condition tests that the calling host matches the host list. If you have
32565 name lookups or wildcarded host names and IP addresses in the same host list,
32566 you should normally put the IP addresses first. For example, you could have:
32567 .code
32568 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32569 .endd
32570 The lookup in this example uses the host name for its key. This is implied by
32571 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32572 and it wouldn't matter which way round you had these two items.)
32573
32574 The reason for the problem with host names lies in the left-to-right way that
32575 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32576 but when it reaches an item that requires a host name, it fails if it cannot
32577 find a host name to compare with the pattern. If the above list is given in the
32578 opposite order, the &%accept%& statement fails for a host whose name cannot be
32579 found, even if its IP address is 10.9.8.7.
32580
32581 If you really do want to do the name check first, and still recognize the IP
32582 address even if the name lookup fails, you can rewrite the ACL like this:
32583 .code
32584 accept hosts = dbm;/etc/friendly/hosts
32585 accept hosts = 10.9.8.7
32586 .endd
32587 The default action on failing to find the host name is to assume that the host
32588 is not in the list, so the first &%accept%& statement fails. The second
32589 statement can then check the IP address.
32590
32591 .vindex "&$host_data$&"
32592 If a &%hosts%& condition is satisfied by means of a lookup, the result
32593 of the lookup is made available in the &$host_data$& variable. This
32594 allows you, for example, to set up a statement like this:
32595 .code
32596 deny  hosts = net-lsearch;/some/file
32597       message = $host_data
32598 .endd
32599 which gives a custom error message for each denied host.
32600
32601 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32602 .cindex "&%local_parts%& ACL condition"
32603 .cindex "local part" "ACL checking"
32604 .cindex "&ACL;" "testing a local part"
32605 .vindex "&$local_part_data$&"
32606 This condition is relevant only in a RCPT ACL. It checks that the local
32607 part of the recipient address is in the list. If percent-hack processing is
32608 enabled, it is done before this test. If the check succeeds with a lookup, the
32609 result of the lookup is placed in &$local_part_data$&, which remains set until
32610 the next &%local_parts%& test.
32611
32612 .vitem &*malware&~=&~*&<&'option'&>
32613 .cindex "&%malware%& ACL condition"
32614 .cindex "&ACL;" "virus scanning"
32615 .cindex "&ACL;" "scanning for viruses"
32616 This condition is available only when Exim is compiled with the
32617 content-scanning extension
32618 and only after a DATA command.
32619 It causes the incoming message to be scanned for
32620 viruses. For details, see chapter &<<CHAPexiscan>>&.
32621
32622 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32623 .cindex "&%mime_regex%& ACL condition"
32624 .cindex "&ACL;" "testing by regex matching"
32625 This condition is available only when Exim is compiled with the
32626 content-scanning extension, and it is allowed only in the ACL defined by
32627 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32628 with any of the regular expressions. For details, see chapter
32629 &<<CHAPexiscan>>&.
32630
32631 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32632 .cindex "rate limiting"
32633 This condition can be used to limit the rate at which a user or host submits
32634 messages. Details are given in section &<<SECTratelimiting>>&.
32635
32636 .vitem &*recipients&~=&~*&<&'address&~list'&>
32637 .cindex "&%recipients%& ACL condition"
32638 .cindex "recipient" "ACL checking"
32639 .cindex "&ACL;" "testing a recipient"
32640 This condition is relevant only in a RCPT ACL. It checks the entire
32641 recipient address against a list of recipients.
32642
32643 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32644 .cindex "&%regex%& ACL condition"
32645 .cindex "&ACL;" "testing by regex matching"
32646 This condition is available only when Exim is compiled with the
32647 content-scanning extension, and is available only in the DATA, MIME, and
32648 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32649 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32650
32651 .vitem &*seen&~=&~*&<&'parameters'&>
32652 .cindex "&%seen%& ACL condition"
32653 This condition can be used to test if a situation has been previously met,
32654 for example for greylisting.
32655 Details are given in section &<<SECTseen>>&.
32656
32657 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32658 .cindex "&%sender_domains%& ACL condition"
32659 .cindex "sender" "ACL checking"
32660 .cindex "&ACL;" "testing a sender domain"
32661 .vindex "&$domain$&"
32662 .vindex "&$sender_address_domain$&"
32663 This condition tests the domain of the sender of the message against the given
32664 domain list. &*Note*&: The domain of the sender address is in
32665 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32666 of this condition. This is an exception to the general rule for testing domain
32667 lists. It is done this way so that, if this condition is used in an ACL for a
32668 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32669 influence the sender checking.
32670
32671 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32672 relaying, because sender addresses are easily, and commonly, forged.
32673
32674 .vitem &*senders&~=&~*&<&'address&~list'&>
32675 .cindex "&%senders%& ACL condition"
32676 .cindex "sender" "ACL checking"
32677 .cindex "&ACL;" "testing a sender"
32678 This condition tests the sender of the message against the given list. To test
32679 for a bounce message, which has an empty sender, set
32680 .code
32681 senders = :
32682 .endd
32683 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32684 relaying, because sender addresses are easily, and commonly, forged.
32685
32686 .vitem &*spam&~=&~*&<&'username'&>
32687 .cindex "&%spam%& ACL condition"
32688 .cindex "&ACL;" "scanning for spam"
32689 This condition is available only when Exim is compiled with the
32690 content-scanning extension. It causes the incoming message to be scanned by
32691 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32692
32693 .vitem &*verify&~=&~certificate*&
32694 .cindex "&%verify%& ACL condition"
32695 .cindex "TLS" "client certificate verification"
32696 .cindex "certificate" "verification of client"
32697 .cindex "&ACL;" "certificate verification"
32698 .cindex "&ACL;" "testing a TLS certificate"
32699 This condition is true in an SMTP session if the session is encrypted, and a
32700 certificate was received from the client, and the certificate was verified. The
32701 server requests a certificate only if the client matches &%tls_verify_hosts%&
32702 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32703
32704 .vitem &*verify&~=&~csa*&
32705 .cindex "CSA verification"
32706 This condition checks whether the sending host (the client) is authorized to
32707 send email. Details of how this works are given in section
32708 &<<SECTverifyCSA>>&.
32709
32710 .vitem &*verify&~=&~header_names_ascii*&
32711 .cindex "&%verify%& ACL condition"
32712 .cindex "&ACL;" "verifying header names only ASCII"
32713 .cindex "header lines" "verifying header names only ASCII"
32714 .cindex "verifying" "header names only ASCII"
32715 This condition is relevant only in an ACL that is run after a message has been
32716 received.
32717 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32718 It checks all header names (not the content) to make sure
32719 there are no non-ASCII characters, also excluding control characters.  The
32720 allowable characters are decimal ASCII values 33 through 126.
32721
32722 Exim itself will handle headers with non-ASCII characters, but it can cause
32723 problems for downstream applications, so this option will allow their
32724 detection and rejection in the DATA ACL's.
32725
32726 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32727 .cindex "&%verify%& ACL condition"
32728 .cindex "&ACL;" "verifying sender in the header"
32729 .cindex "header lines" "verifying the sender in"
32730 .cindex "sender" "verifying in header"
32731 .cindex "verifying" "sender in header"
32732 This condition is relevant only in an ACL that is run after a message has been
32733 received, that is, in an ACL specified by &%acl_smtp_data%& or
32734 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32735 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32736 is loosely thought of as a &"sender"& address (hence the name of the test).
32737 However, an address that appears in one of these headers need not be an address
32738 that accepts bounce messages; only sender addresses in envelopes are required
32739 to accept bounces. Therefore, if you use the callout option on this check, you
32740 might want to arrange for a non-empty address in the MAIL command.
32741
32742 Details of address verification and the options are given later, starting at
32743 section &<<SECTaddressverification>>& (callouts are described in section
32744 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32745 condition to restrict it to bounce messages only:
32746 .code
32747 deny    senders = :
32748        !verify  = header_sender
32749         message = A valid sender header is required for bounces
32750 .endd
32751
32752 .vitem &*verify&~=&~header_syntax*&
32753 .cindex "&%verify%& ACL condition"
32754 .cindex "&ACL;" "verifying header syntax"
32755 .cindex "header lines" "verifying syntax"
32756 .cindex "verifying" "header syntax"
32757 This condition is relevant only in an ACL that is run after a message has been
32758 received, that is, in an ACL specified by &%acl_smtp_data%& or
32759 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32760 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32761 and &'Bcc:'&), returning true if there are no problems.
32762 Unqualified addresses (local parts without domains) are
32763 permitted only in locally generated messages and from hosts that match
32764 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32765 appropriate.
32766
32767 Note that this condition is a syntax check only. However, a common spamming
32768 ploy used to be to send syntactically invalid headers such as
32769 .code
32770 To: @
32771 .endd
32772 and this condition can be used to reject such messages, though they are not as
32773 common as they used to be.
32774
32775 .vitem &*verify&~=&~helo*&
32776 .cindex "&%verify%& ACL condition"
32777 .cindex "&ACL;" "verifying HELO/EHLO"
32778 .cindex "HELO" "verifying"
32779 .cindex "EHLO" "verifying"
32780 .cindex "verifying" "EHLO"
32781 .cindex "verifying" "HELO"
32782 This condition is true if a HELO or EHLO command has been received from the
32783 client host, and its contents have been verified. If there has been no previous
32784 attempt to verify the HELO/EHLO contents, it is carried out when this
32785 condition is encountered. See the description of the &%helo_verify_hosts%& and
32786 &%helo_try_verify_hosts%& options for details of how to request verification
32787 independently of this condition, and for detail of the verification.
32788
32789 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32790 option), this condition is always true.
32791
32792
32793 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32794 .cindex "verifying" "not blind"
32795 .cindex "bcc recipients, verifying none"
32796 This condition checks that there are no blind (bcc) recipients in the message.
32797 Every envelope recipient must appear either in a &'To:'& header line or in a
32798 &'Cc:'& header line for this condition to be true. Local parts are checked
32799 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32800 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32801 used only in a DATA or non-SMTP ACL.
32802
32803 There is one possible option, &`case_insensitive`&.  If this is present then
32804 local parts are checked case-insensitively.
32805
32806 There are, of course, many legitimate messages that make use of blind (bcc)
32807 recipients. This check should not be used on its own for blocking messages.
32808
32809
32810 .vitem &*verify&~=&~recipient/*&<&'options'&>
32811 .cindex "&%verify%& ACL condition"
32812 .cindex "&ACL;" "verifying recipient"
32813 .cindex "recipient" "verifying"
32814 .cindex "verifying" "recipient"
32815 .vindex "&$address_data$&"
32816 This condition is relevant only after a RCPT command. It verifies the current
32817 recipient. Details of address verification are given later, starting at section
32818 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32819 of &$address_data$& is the last value that was set while routing the address.
32820 This applies even if the verification fails. When an address that is being
32821 verified is redirected to a single address, verification continues with the new
32822 address, and in that case, the subsequent value of &$address_data$& is the
32823 value for the child address.
32824
32825 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32826 .cindex "&%verify%& ACL condition"
32827 .cindex "&ACL;" "verifying host reverse lookup"
32828 .cindex "host" "verifying reverse lookup"
32829 This condition ensures that a verified host name has been looked up from the IP
32830 address of the client host. (This may have happened already if the host name
32831 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32832 Verification ensures that the host name obtained from a reverse DNS lookup, or
32833 one of its aliases, does, when it is itself looked up in the DNS, yield the
32834 original IP address.
32835
32836 There is one possible option, &`defer_ok`&.  If this is present and a
32837 DNS operation returns a temporary error, the verify condition succeeds.
32838
32839 If this condition is used for a locally generated message (that is, when there
32840 is no client host involved), it always succeeds.
32841
32842 .vitem &*verify&~=&~sender/*&<&'options'&>
32843 .cindex "&%verify%& ACL condition"
32844 .cindex "&ACL;" "verifying sender"
32845 .cindex "sender" "verifying"
32846 .cindex "verifying" "sender"
32847 This condition is relevant only after a MAIL or RCPT command, or after a
32848 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32849 the message's sender is empty (that is, this is a bounce message), the
32850 condition is true. Otherwise, the sender address is verified.
32851
32852 .vindex "&$address_data$&"
32853 .vindex "&$sender_address_data$&"
32854 If there is data in the &$address_data$& variable at the end of routing, its
32855 value is placed in &$sender_address_data$& at the end of verification. This
32856 value can be used in subsequent conditions and modifiers in the same ACL
32857 statement. It does not persist after the end of the current statement. If you
32858 want to preserve the value for longer, you can save it in an ACL variable.
32859
32860 Details of verification are given later, starting at section
32861 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32862 to avoid doing it more than once per message.
32863
32864 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32865 .cindex "&%verify%& ACL condition"
32866 This is a variation of the previous option, in which a modified address is
32867 verified as a sender.
32868
32869 Note that '/' is legal in local-parts; if the address may have such
32870 (eg. is generated from the received message)
32871 they must be protected from the options parsing by doubling:
32872 .code
32873 verify = sender=${listquote{/}{${address:$h_sender:}}}
32874 .endd
32875 .endlist
32876
32877
32878
32879 .section "Using DNS lists" "SECTmorednslists"
32880 .cindex "DNS list" "in ACL"
32881 .cindex "black list (DNS)"
32882 .cindex "&ACL;" "testing a DNS list"
32883 In its simplest form, the &%dnslists%& condition tests whether the calling host
32884 is on at least one of a number of DNS lists by looking up the inverted IP
32885 address in one or more DNS domains. (Note that DNS list domains are not mail
32886 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32887 special options instead.) For example, if the calling host's IP
32888 address is 192.168.62.43, and the ACL statement is
32889 .code
32890 deny dnslists = blackholes.mail-abuse.org : \
32891                 dialups.mail-abuse.org
32892 .endd
32893 the following records are looked up:
32894 .code
32895 43.62.168.192.blackholes.mail-abuse.org
32896 43.62.168.192.dialups.mail-abuse.org
32897 .endd
32898 As soon as Exim finds an existing DNS record, processing of the list stops.
32899 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32900 to test that a host is on more than one list (an &"and"& conjunction), you can
32901 use two separate conditions:
32902 .code
32903 deny dnslists = blackholes.mail-abuse.org
32904      dnslists = dialups.mail-abuse.org
32905 .endd
32906 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32907 behaves as if the host does not match the list item, that is, as if the DNS
32908 record does not exist. If there are further items in the DNS list, they are
32909 processed.
32910
32911 This is usually the required action when &%dnslists%& is used with &%deny%&
32912 (which is the most common usage), because it prevents a DNS failure from
32913 blocking mail. However, you can change this behaviour by putting one of the
32914 following special items in the list:
32915 .itable none 0 0 2 25* left 75* left
32916 .irow "+include_unknown"   "behave as if the item is on the list"
32917 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32918 .irow "+defer_unknown  "   "give a temporary error"
32919 .endtable
32920 .cindex "&`+include_unknown`&"
32921 .cindex "&`+exclude_unknown`&"
32922 .cindex "&`+defer_unknown`&"
32923 Each of these applies to any subsequent items on the list. For example:
32924 .code
32925 deny dnslists = +defer_unknown : foo.bar.example
32926 .endd
32927 Testing the list of domains stops as soon as a match is found. If you want to
32928 warn for one list and block for another, you can use two different statements:
32929 .code
32930 deny  dnslists = blackholes.mail-abuse.org
32931 warn  dnslists = dialups.mail-abuse.org
32932       message  = X-Warn: sending host is on dialups list
32933 .endd
32934 .cindex caching "of dns lookup"
32935 .cindex DNS TTL
32936 DNS list lookups are cached by Exim for the duration of the SMTP session
32937 (but limited by the DNS return TTL value),
32938 so a lookup based on the IP address is done at most once for any incoming
32939 connection (assuming long-enough TTL).
32940 Exim does not share information between multiple incoming
32941 connections (but your local name server cache should be active).
32942
32943 There are a number of DNS lists to choose from, some commercial, some free,
32944 or free for small deployments.  An overview can be found at
32945 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32946
32947
32948
32949 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32950 .cindex "DNS list" "keyed by explicit IP address"
32951 By default, the IP address that is used in a DNS list lookup is the IP address
32952 of the calling host. However, you can specify another IP address by listing it
32953 after the domain name, introduced by a slash. For example:
32954 .code
32955 deny dnslists = black.list.tld/192.168.1.2
32956 .endd
32957 This feature is not very helpful with explicit IP addresses; it is intended for
32958 use with IP addresses that are looked up, for example, the IP addresses of the
32959 MX hosts or nameservers of an email sender address. For an example, see section
32960 &<<SECTmulkeyfor>>& below.
32961
32962
32963
32964
32965 .subsection "DNS lists keyed on domain names" SECID202
32966 .cindex "DNS list" "keyed by domain name"
32967 There are some lists that are keyed on domain names rather than inverted IP
32968 addresses (see, e.g., the &'domain based zones'& link at
32969 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32970 with these lists. You can change the name that is looked up in a DNS list by
32971 listing it after the domain name, introduced by a slash. For example,
32972 .code
32973 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32974       message  = Sender's domain is listed at $dnslist_domain
32975 .endd
32976 This particular example is useful only in ACLs that are obeyed after the
32977 RCPT or DATA commands, when a sender address is available. If (for
32978 example) the message's sender is &'user@tld.example'& the name that is looked
32979 up by this example is
32980 .code
32981 tld.example.dsn.rfc-ignorant.org
32982 .endd
32983 A single &%dnslists%& condition can contain entries for both names and IP
32984 addresses. For example:
32985 .code
32986 deny dnslists = sbl.spamhaus.org : \
32987                 dsn.rfc-ignorant.org/$sender_address_domain
32988 .endd
32989 The first item checks the sending host's IP address; the second checks a domain
32990 name. The whole condition is true if either of the DNS lookups succeeds.
32991
32992
32993
32994
32995 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32996 .cindex "DNS list" "multiple keys for"
32997 The syntax described above for looking up explicitly-defined values (either
32998 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32999 name for the DNS list, what follows the slash can in fact be a list of items.
33000 As with all lists in Exim, the default separator is a colon. However, because
33001 this is a sublist within the list of DNS blacklist domains, it is necessary
33002 either to double the separators like this:
33003 .code
33004 dnslists = black.list.tld/name.1::name.2
33005 .endd
33006 or to change the separator character, like this:
33007 .code
33008 dnslists = black.list.tld/<;name.1;name.2
33009 .endd
33010 If an item in the list is an IP address, it is inverted before the DNS
33011 blacklist domain is appended. If it is not an IP address, no inversion
33012 occurs. Consider this condition:
33013 .code
33014 dnslists = black.list.tld/<;192.168.1.2;a.domain
33015 .endd
33016 The DNS lookups that occur are:
33017 .code
33018 2.1.168.192.black.list.tld
33019 a.domain.black.list.tld
33020 .endd
33021 Once a DNS record has been found (that matches a specific IP return
33022 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
33023 are done. If there is a temporary DNS error, the rest of the sublist of domains
33024 or IP addresses is tried. A temporary error for the whole dnslists item occurs
33025 only if no other DNS lookup in this sublist succeeds. In other words, a
33026 successful lookup for any of the items in the sublist overrides a temporary
33027 error for a previous item.
33028
33029 The ability to supply a list of items after the slash is in some sense just a
33030 syntactic convenience. These two examples have the same effect:
33031 .code
33032 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
33033 dnslists = black.list.tld/a.domain::b.domain
33034 .endd
33035 However, when the data for the list is obtained from a lookup, the second form
33036 is usually much more convenient. Consider this example:
33037 .code
33038 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
33039                                    ${lookup dnsdb {>|mxh=\
33040                                    $sender_address_domain} }} }
33041      message  = The mail servers for the domain \
33042                 $sender_address_domain \
33043                 are listed at $dnslist_domain ($dnslist_value); \
33044                 see $dnslist_text.
33045 .endd
33046 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
33047 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
33048 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
33049 of expanding the condition might be something like this:
33050 .code
33051 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
33052 .endd
33053 Thus, this example checks whether or not the IP addresses of the sender
33054 domain's mail servers are on the Spamhaus black list.
33055
33056 The key that was used for a successful DNS list lookup is put into the variable
33057 &$dnslist_matched$& (see section &<<SECID204>>&).
33058
33059
33060
33061
33062 .subsection "Data returned by DNS lists" SECID203
33063 .cindex "DNS list" "data returned from"
33064 DNS lists are constructed using address records in the DNS. The original RBL
33065 just used the address 127.0.0.1 on the right hand side of each record, but the
33066 RBL+ list and some other lists use a number of values with different meanings.
33067 The values used on the RBL+ list are:
33068 .itable none 0 0 2 20* left 80* left
33069 .irow 127.1.0.1  "RBL"
33070 .irow 127.1.0.2  "DUL"
33071 .irow 127.1.0.3  "DUL and RBL"
33072 .irow 127.1.0.4  "RSS"
33073 .irow 127.1.0.5  "RSS and RBL"
33074 .irow 127.1.0.6  "RSS and DUL"
33075 .irow 127.1.0.7  "RSS and DUL and RBL"
33076 .endtable
33077 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
33078 different values. Some DNS lists may return more than one address record;
33079 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
33080
33081 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
33082 range. If a DNSBL operator loses control of the domain, lookups on it
33083 may start returning other addresses.  Because of this, Exim now ignores
33084 returned values outside the 127/8 region.
33085
33086
33087 .subsection "Variables set from DNS lists" SECID204
33088 .cindex "expansion" "variables, set from DNS list"
33089 .cindex "DNS list" "variables set from"
33090 .vindex "&$dnslist_domain$&"
33091 .vindex "&$dnslist_matched$&"
33092 .vindex "&$dnslist_text$&"
33093 .vindex "&$dnslist_value$&"
33094 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
33095 the name of the overall domain that matched (for example,
33096 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
33097 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
33098 the DNS record. When the key is an IP address, it is not reversed in
33099 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
33100 cases, for example:
33101 .code
33102 deny dnslists = spamhaus.example
33103 .endd
33104 the key is also available in another variable (in this case,
33105 &$sender_host_address$&). In more complicated cases, however, this is not true.
33106 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
33107 might generate a dnslists lookup like this:
33108 .code
33109 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
33110 .endd
33111 If this condition succeeds, the value in &$dnslist_matched$& might be
33112 &`192.168.6.7`& (for example).
33113
33114 If more than one address record is returned by the DNS lookup, all the IP
33115 addresses are included in &$dnslist_value$&, separated by commas and spaces.
33116 The variable &$dnslist_text$& contains the contents of any associated TXT
33117 record. For lists such as RBL+ the TXT record for a merged entry is often not
33118 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
33119 information.
33120
33121 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
33122 &-- even if these appear before the condition in the ACL, they are not
33123 expanded until after it has failed. For example:
33124 .code
33125 deny    hosts = !+local_networks
33126         message = $sender_host_address is listed \
33127                   at $dnslist_domain
33128         dnslists = rbl-plus.mail-abuse.example
33129 .endd
33130
33131
33132
33133 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
33134 .cindex "DNS list" "matching specific returned data"
33135 You can add an equals sign and an IP address after a &%dnslists%& domain name
33136 in order to restrict its action to DNS records with a matching right hand side.
33137 For example,
33138 .code
33139 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
33140 .endd
33141 rejects only those hosts that yield 127.0.0.2. Without this additional data,
33142 any address record is considered to be a match. For the moment, we assume
33143 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
33144 describes how multiple records are handled.
33145
33146 More than one IP address may be given for checking, using a comma as a
33147 separator. These are alternatives &-- if any one of them matches, the
33148 &%dnslists%& condition is true. For example:
33149 .code
33150 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
33151 .endd
33152 If you want to specify a constraining address list and also specify names or IP
33153 addresses to be looked up, the constraining address list must be specified
33154 first. For example:
33155 .code
33156 deny dnslists = dsn.rfc-ignorant.org\
33157                 =127.0.0.2/$sender_address_domain
33158 .endd
33159
33160 If the character &`&&`& is used instead of &`=`&, the comparison for each
33161 listed IP address is done by a bitwise &"and"& instead of by an equality test.
33162 In other words, the listed addresses are used as bit masks. The comparison is
33163 true if all the bits in the mask are present in the address that is being
33164 tested. For example:
33165 .code
33166 dnslists = a.b.c&0.0.0.3
33167 .endd
33168 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
33169 want to test whether one bit or another bit is present (as opposed to both
33170 being present), you must use multiple values. For example:
33171 .code
33172 dnslists = a.b.c&0.0.0.1,0.0.0.2
33173 .endd
33174 matches if the final component of the address is an odd number or two times
33175 an odd number.
33176
33177
33178
33179 .subsection "Negated DNS matching conditions" SECID205
33180 You can supply a negative list of IP addresses as part of a &%dnslists%&
33181 condition. Whereas
33182 .code
33183 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
33184 .endd
33185 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33186 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
33187 .code
33188 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
33189 .endd
33190 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33191 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
33192 words, the result of the test is inverted if an exclamation mark appears before
33193 the &`=`& (or the &`&&`&) sign.
33194
33195 &*Note*&: This kind of negation is not the same as negation in a domain,
33196 host, or address list (which is why the syntax is different).
33197
33198 If you are using just one list, the negation syntax does not gain you much. The
33199 previous example is precisely equivalent to
33200 .code
33201 deny  dnslists = a.b.c
33202      !dnslists = a.b.c=127.0.0.2,127.0.0.3
33203 .endd
33204 However, if you are using multiple lists, the negation syntax is clearer.
33205 Consider this example:
33206 .code
33207 deny  dnslists = sbl.spamhaus.org : \
33208                  list.dsbl.org : \
33209                  dnsbl.njabl.org!=127.0.0.3 : \
33210                  relays.ordb.org
33211 .endd
33212 Using only positive lists, this would have to be:
33213 .code
33214 deny  dnslists = sbl.spamhaus.org : \
33215                  list.dsbl.org
33216 deny  dnslists = dnsbl.njabl.org
33217      !dnslists = dnsbl.njabl.org=127.0.0.3
33218 deny  dnslists = relays.ordb.org
33219 .endd
33220 which is less clear, and harder to maintain.
33221
33222 Negation can also be used with a bitwise-and restriction.
33223 The dnslists condition with only be trus if a result is returned
33224 by the lookup which, anded with the restriction, is all zeroes.
33225 For example:
33226 .code
33227 deny dnslists = zen.spamhaus.org!&0.255.255.0
33228 .endd
33229
33230
33231
33232
33233 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33234 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33235 thereby providing more than one IP address. When an item in a &%dnslists%& list
33236 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33237 the match to specific results from the DNS lookup, there are two ways in which
33238 the checking can be handled. For example, consider the condition:
33239 .code
33240 dnslists = a.b.c=127.0.0.1
33241 .endd
33242 What happens if the DNS lookup for the incoming IP address yields both
33243 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33244 condition true because at least one given value was found, or is it false
33245 because at least one of the found values was not listed? And how does this
33246 affect negated conditions? Both possibilities are provided for with the help of
33247 additional separators &`==`& and &`=&&`&.
33248
33249 .ilist
33250 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33251 IP addresses matches one of the listed addresses. For the example above, the
33252 condition is true because 127.0.0.1 matches.
33253 .next
33254 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33255 looked up IP addresses matches one of the listed addresses. If the condition is
33256 changed to:
33257 .code
33258 dnslists = a.b.c==127.0.0.1
33259 .endd
33260 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33261 false because 127.0.0.2 is not listed. You would need to have:
33262 .code
33263 dnslists = a.b.c==127.0.0.1,127.0.0.2
33264 .endd
33265 for the condition to be true.
33266 .endlist
33267
33268 When &`!`& is used to negate IP address matching, it inverts the result, giving
33269 the precise opposite of the behaviour above. Thus:
33270 .ilist
33271 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33272 addresses matches one of the listed addresses. Consider:
33273 .code
33274 dnslists = a.b.c!&0.0.0.1
33275 .endd
33276 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33277 false because 127.0.0.1 matches.
33278 .next
33279 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33280 looked up IP address that does not match. Consider:
33281 .code
33282 dnslists = a.b.c!=&0.0.0.1
33283 .endd
33284 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33285 true, because 127.0.0.2 does not match. You would need to have:
33286 .code
33287 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33288 .endd
33289 for the condition to be false.
33290 .endlist
33291 When the DNS lookup yields only a single IP address, there is no difference
33292 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33293
33294
33295
33296
33297 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33298 .cindex "DNS list" "information from merged"
33299 When the facility for restricting the matching IP values in a DNS list is used,
33300 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33301 the true reason for rejection. This happens when lists are merged and the IP
33302 address in the A record is used to distinguish them; unfortunately there is
33303 only one TXT record. One way round this is not to use merged lists, but that
33304 can be inefficient because it requires multiple DNS lookups where one would do
33305 in the vast majority of cases when the host of interest is not on any of the
33306 lists.
33307
33308 A less inefficient way of solving this problem is available. If
33309 two domain names, comma-separated, are given, the second is used first to
33310 do an initial check, making use of any IP value restrictions that are set.
33311 If there is a match, the first domain is used, without any IP value
33312 restrictions, to get the TXT record. As a byproduct of this, there is also
33313 a check that the IP being tested is indeed on the first list. The first
33314 domain is the one that is put in &$dnslist_domain$&. For example:
33315 .code
33316 deny   dnslists = \
33317          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33318          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33319        message  = \
33320          rejected because $sender_host_address is blacklisted \
33321          at $dnslist_domain\n$dnslist_text
33322 .endd
33323 For the first blacklist item, this starts by doing a lookup in
33324 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33325 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33326 value, and as long as something is found, it looks for the corresponding TXT
33327 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33328 The second blacklist item is processed similarly.
33329
33330 If you are interested in more than one merged list, the same list must be
33331 given several times, but because the results of the DNS lookups are cached,
33332 the DNS calls themselves are not repeated. For example:
33333 .code
33334 deny dnslists = \
33335          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33336          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33337          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33338          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33339 .endd
33340 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33341 values matches (or if no record is found), this is the only lookup that is
33342 done. Only if there is a match is one of the more specific lists consulted.
33343
33344
33345
33346 .subsection "DNS lists and IPv6" SECTmorednslistslast
33347 .cindex "IPv6" "DNS black lists"
33348 .cindex "DNS list" "IPv6 usage"
33349 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33350 nibble by nibble. For example, if the calling host's IP address is
33351 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33352 .code
33353 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33354   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33355 .endd
33356 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33357 lists contain wildcard records, intended for IPv4, that interact badly with
33358 IPv6. For example, the DNS entry
33359 .code
33360 *.3.some.list.example.    A    127.0.0.1
33361 .endd
33362 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33363 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33364
33365 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33366 &%condition%& condition, as in this example:
33367 .code
33368 deny   condition = ${if isip4{$sender_host_address}}
33369        dnslists  = some.list.example
33370 .endd
33371
33372 If an explicit key is being used for a DNS lookup and it may be an IPv6
33373 address you should specify alternate list separators for both the outer
33374 (DNS list name) list and inner (lookup keys) list:
33375 .code
33376        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33377 .endd
33378
33379
33380 .section "Previously seen user and hosts" "SECTseen"
33381 .cindex "&%seen%& ACL condition"
33382 .cindex greylisting
33383 The &%seen%& ACL condition can be used to test whether a
33384 situation has been previously met.
33385 It uses a hints database to record a timestamp against a key.
33386 The syntax of the condition is:
33387 .display
33388 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33389 .endd
33390
33391 For example,
33392 .code
33393 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33394 .endd
33395 in a RCPT ACL will implement simple greylisting.
33396
33397 The parameters for the condition are
33398 a possible minus sign,
33399 then an interval,
33400 then, slash-separated, a list of options.
33401 The interval is taken as an offset before the current time,
33402 and used for the test.
33403 If the interval is preceded by a minus sign then the condition returns
33404 whether a record is found which is before the test time.
33405 Otherwise, the condition returns whether one is found which is since the
33406 test time.
33407
33408 Options are read in order with later ones overriding earlier ones.
33409
33410 The default key is &$sender_host_address$&.
33411 An explicit key can be set using a &%key=value%& option.
33412
33413 If a &%readonly%& option is given then
33414 no record create or update is done.
33415 If a &%write%& option is given then
33416 a record create or update is always done.
33417 An update is done if the test is for &"since"&.
33418 If none of those hold and there was no existing record,
33419 a record is created.
33420
33421 Creates and updates are marked with the current time.
33422
33423 Finally, a &"before"& test which succeeds, and for which the record
33424 is old enough, will be refreshed with a timestamp of the test time.
33425 This can prevent tidying of the database from removing the entry.
33426 The interval for this is, by default, 10 days.
33427 An explicit interval can be set using a
33428 &%refresh=value%& option.
33429
33430 Note that &"seen"& should be added to the list of hints databases
33431 for maintenance if this ACL condition is used.
33432
33433
33434 .section "Rate limiting incoming messages" "SECTratelimiting"
33435 .cindex "rate limiting" "client sending"
33436 .cindex "limiting client sending rates"
33437 .oindex "&%smtp_ratelimit_*%&"
33438 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33439 which clients can send email. This is more powerful than the
33440 &%smtp_ratelimit_*%& options, because those options control the rate of
33441 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33442 works across all connections (concurrent and sequential) from the same client
33443 host. The syntax of the &%ratelimit%& condition is:
33444 .display
33445 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33446 .endd
33447 If the average client sending rate is less than &'m'& messages per time
33448 period &'p'& then the condition is false; otherwise it is true.
33449
33450 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33451 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33452 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33453 of &'p'&.
33454
33455 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33456 time interval, for example, &`8h`& for eight hours. A larger time constant
33457 means that it takes Exim longer to forget a client's past behaviour. The
33458 parameter &'m'& is the maximum number of messages that a client is permitted to
33459 send in each time interval. It also specifies the number of messages permitted
33460 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33461 constant, you can allow a client to send more messages in a burst without
33462 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33463 both small, messages must be sent at an even rate.
33464
33465 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33466 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33467 when deploying the &%ratelimit%& ACL condition. The script prints usage
33468 instructions when it is run with no arguments.
33469
33470 The key is used to look up the data for calculating the client's average
33471 sending rate. This data is stored in Exim's spool directory, alongside the
33472 retry and other hints databases. The default key is &$sender_host_address$&,
33473 which means Exim computes the sending rate of each client host IP address.
33474 By changing the key you can change how Exim identifies clients for the purpose
33475 of ratelimiting. For example, to limit the sending rate of each authenticated
33476 user, independent of the computer they are sending from, set the key to
33477 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33478 example, &$authenticated_id$& is only meaningful if the client has
33479 authenticated (which you can check with the &%authenticated%& ACL condition).
33480
33481 The lookup key does not have to identify clients: If you want to limit the
33482 rate at which a recipient receives messages, you can use the key
33483 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33484 ACL.
33485
33486 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33487 specifies what Exim measures the rate of, for example, messages or recipients
33488 or bytes. You can adjust the measurement using the &%unique=%& and/or
33489 &%count=%& options. You can also control when Exim updates the recorded rate
33490 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33491 separated by a slash, like the other parameters. They may appear in any order.
33492
33493 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33494 any options that alter the meaning of the stored data. The limit &'m'& is not
33495 stored, so you can alter the configured maximum rate and Exim will still
33496 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33497 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33498 behaviour. The lookup key is not affected by changes to the update mode and
33499 the &%count=%& option.
33500
33501
33502 .subsection "Ratelimit options for what is being measured" ratoptmea
33503 .cindex "rate limiting" "per_* options"
33504 .vlist
33505 .vitem per_conn
33506 .cindex "rate limiting" per_conn
33507 This option limits the client's connection rate. It is not
33508 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33509 &%acl_not_smtp_start%& ACLs.
33510
33511 .vitem per_mail
33512 .cindex "rate limiting" per_conn
33513 This option limits the client's rate of sending messages. This is
33514 the default if none of the &%per_*%& options is specified. It can be used in
33515 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33516 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33517
33518 .vitem per_byte
33519 .cindex "rate limiting" per_conn
33520 This option limits the sender's email bandwidth. It can be used in
33521 the same ACLs as the &%per_mail%& option, though it is best to use this option
33522 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33523 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33524 in its MAIL command, which may be inaccurate or completely missing. You can
33525 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33526 in kilobytes, megabytes, or gigabytes, respectively.
33527
33528 .vitem per_rcpt
33529 .cindex "rate limiting" per_rcpt
33530 This option causes Exim to limit the rate at which recipients are
33531 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33532 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33533 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33534 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33535 in either case the rate limiting engine will see a message with many
33536 recipients as a large high-speed burst.
33537
33538 .vitem per_addr
33539 .cindex "rate limiting" per_addr
33540 This option is like the &%per_rcpt%& option, except it counts the
33541 number of different recipients that the client has sent messages to in the
33542 last time period. That is, if the client repeatedly sends messages to the same
33543 recipient, its measured rate is not increased. This option can only be used in
33544 &%acl_smtp_rcpt%&.
33545
33546 .vitem per_cmd
33547 .cindex "rate limiting" per_cmd
33548 This option causes Exim to recompute the rate every time the
33549 condition is processed. This can be used to limit the rate of any SMTP
33550 command. If it is used in multiple ACLs it can limit the aggregate rate of
33551 multiple different commands.
33552
33553 .vitem count
33554 .cindex "rate limiting" count
33555 This option can be used to alter how much Exim adds to the client's
33556 measured rate.
33557 A value is required, after an equals sign.
33558 For example, the &%per_byte%& option is equivalent to
33559 &`per_mail/count=$message_size`&.
33560 If there is no &%count=%& option, Exim
33561 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33562 other than &%acl_smtp_rcpt%&).
33563 The count does not have to be an integer.
33564
33565 .vitem unique
33566 .cindex "rate limiting" unique
33567 This option is described in section &<<ratoptuniq>>& below.
33568 .endlist
33569
33570
33571 .subsection "Ratelimit update modes" ratoptupd
33572 .cindex "rate limiting" "reading data without updating"
33573 You can specify one of three options with the &%ratelimit%& condition to
33574 control when its database is updated. This section describes the &%readonly%&
33575 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33576
33577 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33578 previously-computed rate to check against the limit.
33579
33580 For example, you can test the client's sending rate and deny it access (when
33581 it is too fast) in the connect ACL. If the client passes this check then it
33582 can go on to send a message, in which case its recorded rate will be updated
33583 in the MAIL ACL. Subsequent connections from the same client will check this
33584 new rate.
33585 .code
33586 acl_check_connect:
33587  deny ratelimit = 100 / 5m / readonly
33588       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33589                   (max $sender_rate_limit)
33590 # ...
33591 acl_check_mail:
33592  warn ratelimit = 100 / 5m / strict
33593       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33594                   (max $sender_rate_limit)
33595 .endd
33596
33597 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33598 processing a message then it may increase the client's measured rate more than
33599 it should. For example, this will happen if you check the &%per_rcpt%& option
33600 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33601 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33602 multiple update problems by using the &%readonly%& option on later ratelimit
33603 checks.
33604
33605 The &%per_*%& options described above do not make sense in some ACLs. If you
33606 use a &%per_*%& option in an ACL where it is not normally permitted then the
33607 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33608 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33609 next section) so you must specify the &%readonly%& option explicitly.
33610
33611
33612 .subsection "Ratelimit options for handling fast clients" ratoptfast
33613 .cindex "rate limiting" "strict and leaky modes"
33614 If a client's average rate is greater than the maximum, the rate limiting
33615 engine can react in two possible ways, depending on the presence of the
33616 &%strict%& or &%leaky%& update modes. This is independent of the other
33617 counter-measures (such as rejecting the message) that may be specified by the
33618 rest of the ACL.
33619
33620 The &%leaky%& (default) option means that the client's recorded rate is not
33621 updated if it is above the limit. The effect of this is that Exim measures the
33622 client's average rate of successfully sent email,
33623 up to the given limit.
33624 This is appropriate if the countermeasure when the condition is true
33625 consists of refusing the message, and
33626 is generally the better choice if you have clients that retry automatically.
33627 If the action when true is anything more complex then this option is
33628 likely not what is wanted.
33629
33630 The &%strict%& option means that the client's recorded rate is always
33631 updated. The effect of this is that Exim measures the client's average rate
33632 of attempts to send email, which can be much higher than the maximum it is
33633 actually allowed. If the client is over the limit it may be subjected to
33634 counter-measures by the ACL. It must slow down and allow sufficient time to
33635 pass that its computed rate falls below the maximum before it can send email
33636 again. The time (the number of smoothing periods) it must wait and not
33637 attempt to send mail can be calculated with this formula:
33638 .code
33639         ln(peakrate/maxrate)
33640 .endd
33641
33642
33643 .subsection "Limiting the rate of different events" ratoptuniq
33644 .cindex "rate limiting" "counting unique events"
33645 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33646 rate of different events. For example, the &%per_addr%& option uses this
33647 mechanism to count the number of different recipients that the client has
33648 sent messages to in the last time period; it is equivalent to
33649 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33650 measure the rate that a client uses different sender addresses with the
33651 options &`per_mail/unique=$sender_address`&.
33652
33653 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33654 has seen for that key. The whole set is thrown away when it is older than the
33655 rate smoothing period &'p'&, so each different event is counted at most once
33656 per period. In the &%leaky%& update mode, an event that causes the client to
33657 go over the limit is not added to the set, in the same way that the client's
33658 recorded rate is not updated in the same situation.
33659
33660 When you combine the &%unique=%& and &%readonly%& options, the specific
33661 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33662 rate.
33663
33664 The &%unique=%& mechanism needs more space in the ratelimit database than the
33665 other &%ratelimit%& options in order to store the event set. The number of
33666 unique values is potentially as large as the rate limit, so the extra space
33667 required increases with larger limits.
33668
33669 The uniqueification is not perfect: there is a small probability that Exim
33670 will think a new event has happened before. If the sender's rate is less than
33671 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33672 the measured rate can go above the limit, in which case Exim may under-count
33673 events by a significant margin. Fortunately, if the rate is high enough (2.7
33674 times the limit) that the false positive rate goes above 9%, then Exim will
33675 throw away the over-full event set before the measured rate falls below the
33676 limit. Therefore the only harm should be that exceptionally high sending rates
33677 are logged incorrectly; any countermeasures you configure will be as effective
33678 as intended.
33679
33680
33681 .subsection "Using rate limiting" useratlim
33682 Exim's other ACL facilities are used to define what counter-measures are taken
33683 when the rate limit is exceeded. This might be anything from logging a warning
33684 (for example, while measuring existing sending rates in order to define
33685 policy), through time delays to slow down fast senders, up to rejecting the
33686 message. For example:
33687 .code
33688 # Log all senders' rates
33689 warn ratelimit = 0 / 1h / strict
33690      log_message = Sender rate $sender_rate / $sender_rate_period
33691
33692 # Slow down fast senders; note the need to truncate $sender_rate
33693 # at the decimal point.
33694 warn ratelimit = 100 / 1h / per_rcpt / strict
33695      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33696                    $sender_rate_limit }s
33697
33698 # Keep authenticated users under control
33699 deny authenticated = *
33700      ratelimit = 100 / 1d / strict / $authenticated_id
33701
33702 # System-wide rate limit
33703 defer ratelimit = 10 / 1s / $primary_hostname
33704       message = Sorry, too busy. Try again later.
33705
33706 # Restrict incoming rate from each host, with a default
33707 # set using a macro and special cases looked up in a table.
33708 defer ratelimit = ${lookup {$sender_host_address} \
33709                    cdb {DB/ratelimits.cdb} \
33710                    {$value} {RATELIMIT} }
33711       message = Sender rate exceeds $sender_rate_limit \
33712                messages per $sender_rate_period
33713 .endd
33714 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33715 especially with the &%per_rcpt%& option, you may suffer from a performance
33716 bottleneck caused by locking on the ratelimit hints database. Apart from
33717 making your ACLs less complicated, you can reduce the problem by using a
33718 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33719 this means that Exim will lose its hints data after a reboot (including retry
33720 hints, the callout cache, and ratelimit data).
33721
33722
33723
33724 .section "Address verification" "SECTaddressverification"
33725 .cindex "verifying address" "options for"
33726 .cindex "policy control" "address verification"
33727 Several of the &%verify%& conditions described in section
33728 &<<SECTaclconditions>>& cause addresses to be verified. Section
33729 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33730 The verification conditions can be followed by options that modify the
33731 verification process. The options are separated from the keyword and from each
33732 other by slashes, and some of them contain parameters. For example:
33733 .code
33734 verify = sender/callout
33735 verify = recipient/defer_ok/callout=10s,defer_ok
33736 .endd
33737 The first stage of address verification, which always happens, is to run the
33738 address through the routers, in &"verify mode"&. Routers can detect the
33739 difference between verification and routing for delivery, and their actions can
33740 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33741 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33742 The available options are as follows:
33743
33744 .ilist
33745 If the &%callout%& option is specified, successful routing to one or more
33746 remote hosts is followed by a &"callout"& to those hosts as an additional
33747 check. Callouts and their sub-options are discussed in the next section.
33748 .next
33749 If there is a defer error while doing verification routing, the ACL
33750 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33751 options, the condition is forced to be true instead. Note that this is a main
33752 verification option as well as a suboption for callouts.
33753 .next
33754 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33755 discusses the reporting of sender address verification failures.
33756 .next
33757 The &%success_on_redirect%& option causes verification always to succeed
33758 immediately after a successful redirection. By default, if a redirection
33759 generates just one address, that address is also verified. See further
33760 discussion in section &<<SECTredirwhilveri>>&.
33761 .next
33762 If the &%quota%& option is specified for recipient verify,
33763 successful routing to an appendfile transport is followed by a call into
33764 the transport to evaluate the quota status for the recipient.
33765 No actual delivery is done, but verification will succeed if the quota
33766 is sufficient for the message (if the sender gave a message size) or
33767 not already exceeded (otherwise).
33768 .endlist
33769
33770 .cindex "verifying address" "differentiating failures"
33771 .vindex "&$recipient_verify_failure$&"
33772 .vindex "&$sender_verify_failure$&"
33773 .vindex "&$acl_verify_message$&"
33774 After an address verification failure, &$acl_verify_message$& contains the
33775 error message that is associated with the failure. It can be preserved by
33776 coding like this:
33777 .code
33778 warn  !verify = sender
33779        set acl_m0 = $acl_verify_message
33780 .endd
33781 If you are writing your own custom rejection message or log message when
33782 denying access, you can use this variable to include information about the
33783 verification failure.
33784 This variable is cleared at the end of processing the ACL verb.
33785
33786 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33787 appropriate) contains one of the following words:
33788
33789 .ilist
33790 &%qualify%&: The address was unqualified (no domain), and the message
33791 was neither local nor came from an exempted host.
33792 .next
33793 &%route%&: Routing failed.
33794 .next
33795 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33796 occurred at or before the MAIL command (that is, on initial
33797 connection, HELO, or MAIL).
33798 .next
33799 &%recipient%&: The RCPT command in a callout was rejected.
33800 .next
33801 &%postmaster%&: The postmaster check in a callout was rejected.
33802 .next
33803 &%quota%&: The quota check for a local recipient did non pass.
33804 .endlist
33805
33806 The main use of these variables is expected to be to distinguish between
33807 rejections of MAIL and rejections of RCPT in callouts.
33808
33809 The above variables may also be set after a &*successful*&
33810 address verification to:
33811
33812 .ilist
33813 &%random%&: A random local-part callout succeeded
33814 .endlist
33815
33816
33817
33818
33819 .section "Callout verification" "SECTcallver"
33820 .cindex "verifying address" "by callout"
33821 .cindex "callout" "verification"
33822 .cindex "SMTP" "callout verification"
33823 For non-local addresses, routing verifies the domain, but is unable to do any
33824 checking of the local part. There are situations where some means of verifying
33825 the local part is desirable. One way this can be done is to make an SMTP
33826 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33827 a subsequent host for a recipient address, to see if the host accepts the
33828 address. We use the term &'callout'& to cover both cases. Note that for a
33829 sender address, the callback is not to the client host that is trying to
33830 deliver the message, but to one of the hosts that accepts incoming mail for the
33831 sender's domain.
33832
33833 Exim does not do callouts by default. If you want them to happen, you must
33834 request them by setting appropriate options on the &%verify%& condition, as
33835 described below. This facility should be used with care, because it can add a
33836 lot of resource usage to the cost of verifying an address. However, Exim does
33837 cache the results of callouts, which helps to reduce the cost. Details of
33838 caching are in section &<<SECTcallvercache>>&.
33839
33840 Recipient callouts are usually used only between hosts that are controlled by
33841 the same administration. For example, a corporate gateway host could use
33842 callouts to check for valid recipients on an internal mailserver. A successful
33843 callout does not guarantee that a real delivery to the address would succeed;
33844 on the other hand, a failing callout does guarantee that a delivery would fail.
33845
33846 If the &%callout%& option is present on a condition that verifies an address, a
33847 second stage of verification occurs if the address is successfully routed to
33848 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33849 &(manualroute)& router, where the router specifies the hosts. However, if a
33850 router that does not set up hosts routes to an &(smtp)& transport with a
33851 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33852 &%hosts_override%& set, its hosts are always used, whether or not the router
33853 supplies a host list.
33854 Callouts are only supported on &(smtp)& transports.
33855
33856 The port that is used is taken from the transport, if it is specified and is a
33857 remote transport. (For routers that do verification only, no transport need be
33858 specified.) Otherwise, the default SMTP port is used. If a remote transport
33859 specifies an outgoing interface, this is used; otherwise the interface is not
33860 specified. Likewise, the text that is used for the HELO command is taken from
33861 the transport's &%helo_data%& option; if there is no transport, the value of
33862 &$smtp_active_hostname$& is used.
33863
33864 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33865 test whether a bounce message could be delivered to the sender address. The
33866 following SMTP commands are sent:
33867 .display
33868 &`HELO `&<&'local host name'&>
33869 &`MAIL FROM:<>`&
33870 &`RCPT TO:`&<&'the address to be tested'&>
33871 &`QUIT`&
33872 .endd
33873 LHLO is used instead of HELO if the transport's &%protocol%& option is
33874 set to &"lmtp"&.
33875
33876 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33877 settings.
33878
33879 A recipient callout check is similar. By default, it also uses an empty address
33880 for the sender. This default is chosen because most hosts do not make use of
33881 the sender address when verifying a recipient. Using the same address means
33882 that a single cache entry can be used for each recipient. Some sites, however,
33883 do make use of the sender address when verifying. These are catered for by the
33884 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33885
33886 If the response to the RCPT command is a 2&'xx'& code, the verification
33887 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33888 Exim tries the next host, if any. If there is a problem with all the remote
33889 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33890 &%callout%& option is given, in which case the condition is forced to succeed.
33891
33892 .cindex "SMTP" "output flushing, disabling for callout"
33893 A callout may take a little time. For this reason, Exim normally flushes SMTP
33894 output before performing a callout in an ACL, to avoid unexpected timeouts in
33895 clients when the SMTP PIPELINING extension is in use. The flushing can be
33896 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33897
33898 .cindex "tainted data" "de-tainting"
33899 .cindex "de-tainting" "using recipient verify"
33900 A recipient callout which gets a 2&'xx'& code
33901 will assign untainted values to the
33902 &$domain_data$& and &$local_part_data$& variables,
33903 corresponding to the domain and local parts of the recipient address.
33904
33905
33906
33907
33908 .subsection "Additional parameters for callouts" CALLaddparcall
33909 .cindex "callout" "additional parameters for"
33910 The &%callout%& option can be followed by an equals sign and a number of
33911 optional parameters, separated by commas. For example:
33912 .code
33913 verify = recipient/callout=10s,defer_ok
33914 .endd
33915 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33916 separate verify options, is retained for backwards compatibility, but is now
33917 deprecated. The additional parameters for &%callout%& are as follows:
33918
33919
33920 .vlist
33921 .vitem <&'a&~time&~interval'&>
33922 .cindex "callout" "timeout, specifying"
33923 This specifies the timeout that applies for the callout attempt to each host.
33924 For example:
33925 .code
33926 verify = sender/callout=5s
33927 .endd
33928 The default is 30 seconds. The timeout is used for each response from the
33929 remote host. It is also used for the initial connection, unless overridden by
33930 the &%connect%& parameter.
33931
33932
33933 .vitem &*connect&~=&~*&<&'time&~interval'&>
33934 .cindex "callout" "connection timeout, specifying"
33935 This parameter makes it possible to set a different (usually smaller) timeout
33936 for making the SMTP connection. For example:
33937 .code
33938 verify = sender/callout=5s,connect=1s
33939 .endd
33940 If not specified, this timeout defaults to the general timeout value.
33941
33942 .vitem &*defer_ok*&
33943 .cindex "callout" "defer, action on"
33944 When this parameter is present, failure to contact any host, or any other kind
33945 of temporary error, is treated as success by the ACL. However, the cache is not
33946 updated in this circumstance.
33947
33948 .vitem &*fullpostmaster*&
33949 .cindex "callout" "full postmaster check"
33950 This operates like the &%postmaster%& option (see below), but if the check for
33951 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33952 accordance with the specification in RFC 2821. The RFC states that the
33953 unqualified address &'postmaster'& should be accepted.
33954
33955
33956 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33957 .cindex "callout" "sender when verifying header"
33958 When verifying addresses in header lines using the &%header_sender%&
33959 verification option, Exim behaves by default as if the addresses are envelope
33960 sender addresses from a message. Callout verification therefore tests to see
33961 whether a bounce message could be delivered, by using an empty address in the
33962 MAIL command. However, it is arguable that these addresses might never be used
33963 as envelope senders, and could therefore justifiably reject bounce messages
33964 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33965 address to use in the MAIL command. For example:
33966 .code
33967 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33968 .endd
33969 This parameter is available only for the &%header_sender%& verification option.
33970
33971
33972 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33973 .cindex "callout" "overall timeout, specifying"
33974 This parameter sets an overall timeout for performing a callout verification.
33975 For example:
33976 .code
33977 verify = sender/callout=5s,maxwait=30s
33978 .endd
33979 This timeout defaults to four times the callout timeout for individual SMTP
33980 commands. The overall timeout applies when there is more than one host that can
33981 be tried. The timeout is checked before trying the next host. This prevents
33982 very long delays if there are a large number of hosts and all are timing out
33983 (for example, when network connections are timing out).
33984
33985
33986 .vitem &*no_cache*&
33987 .cindex "callout" "cache, suppressing"
33988 .cindex "caching callout, suppressing"
33989 When this parameter is given, the callout cache is neither read nor updated.
33990
33991 .vitem &*postmaster*&
33992 .cindex "callout" "postmaster; checking"
33993 When this parameter is set, a successful callout check is followed by a similar
33994 check for the local part &'postmaster'& at the same domain. If this address is
33995 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33996 the postmaster check is recorded in a cache record; if it is a failure, this is
33997 used to fail subsequent callouts for the domain without a connection being
33998 made, until the cache record expires.
33999
34000 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
34001 The postmaster check uses an empty sender in the MAIL command by default.
34002 You can use this parameter to do a postmaster check using a different address.
34003 For example:
34004 .code
34005 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
34006 .endd
34007 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
34008 one overrides. The &%postmaster%& parameter is equivalent to this example:
34009 .code
34010 require  verify = sender/callout=postmaster_mailfrom=
34011 .endd
34012 &*Warning*&: The caching arrangements for postmaster checking do not take
34013 account of the sender address. It is assumed that either the empty address or
34014 a fixed non-empty address will be used. All that Exim remembers is that the
34015 postmaster check for the domain succeeded or failed.
34016
34017
34018 .vitem &*random*&
34019 .cindex "callout" "&""random""& check"
34020 When this parameter is set, before doing the normal callout check, Exim does a
34021 check for a &"random"& local part at the same domain. The local part is not
34022 really random &-- it is defined by the expansion of the option
34023 &%callout_random_local_part%&, which defaults to
34024 .code
34025 $primary_hostname-$tod_epoch-testing
34026 .endd
34027 The idea here is to try to determine whether the remote host accepts all local
34028 parts without checking. If it does, there is no point in doing callouts for
34029 specific local parts. If the &"random"& check succeeds, the result is saved in
34030 a cache record, and used to force the current and subsequent callout checks to
34031 succeed without a connection being made, until the cache record expires.
34032
34033 .vitem &*use_postmaster*&
34034 .cindex "callout" "sender for recipient check"
34035 This parameter applies to recipient callouts only. For example:
34036 .code
34037 deny  !verify = recipient/callout=use_postmaster
34038 .endd
34039 .vindex "&$qualify_domain$&"
34040 It causes a non-empty postmaster address to be used in the MAIL command when
34041 performing the callout for the recipient, and also for a &"random"& check if
34042 that is configured. The local part of the address is &`postmaster`& and the
34043 domain is the contents of &$qualify_domain$&.
34044
34045 .vitem &*use_sender*&
34046 This option applies to recipient callouts only. For example:
34047 .code
34048 require  verify = recipient/callout=use_sender
34049 .endd
34050 It causes the message's actual sender address to be used in the MAIL
34051 command when performing the callout, instead of an empty address. There is no
34052 need to use this option unless you know that the called hosts make use of the
34053 sender when checking recipients. If used indiscriminately, it reduces the
34054 usefulness of callout caching.
34055
34056 .vitem &*hold*&
34057 This option applies to recipient callouts only. For example:
34058 .code
34059 require  verify = recipient/callout=use_sender,hold
34060 .endd
34061 It causes the connection to be held open and used for any further recipients
34062 and for eventual delivery (should that be done quickly).
34063 Doing this saves on TCP and SMTP startup costs, and TLS costs also
34064 when that is used for the connections.
34065 The advantage is only gained if there are no callout cache hits
34066 (which could be enforced by the no_cache option),
34067 if the use_sender option is used,
34068 if neither the random nor the use_postmaster option is used,
34069 and if no other callouts intervene.
34070 .endlist
34071
34072 If you use any of the parameters that set a non-empty sender for the MAIL
34073 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
34074 &%use_sender%&), you should think about possible loops. Recipient checking is
34075 usually done between two hosts that are under the same management, and the host
34076 that receives the callouts is not normally configured to do callouts itself.
34077 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
34078 these circumstances.
34079
34080 However, if you use a non-empty sender address for a callout to an arbitrary
34081 host, there is the likelihood that the remote host will itself initiate a
34082 callout check back to your host. As it is checking what appears to be a message
34083 sender, it is likely to use an empty address in MAIL, thus avoiding a
34084 callout loop. However, to be on the safe side it would be best to set up your
34085 own ACLs so that they do not do sender verification checks when the recipient
34086 is the address you use for header sender or postmaster callout checking.
34087
34088 Another issue to think about when using non-empty senders for callouts is
34089 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
34090 by the sender/recipient combination; thus, for any given recipient, many more
34091 actual callouts are performed than when an empty sender or postmaster is used.
34092
34093
34094
34095
34096 .subsection "Callout caching" SECTcallvercache
34097 .cindex "hints database" "callout cache"
34098 .cindex "callout" "cache, description of"
34099 .cindex "caching" "callout"
34100 Exim caches the results of callouts in order to reduce the amount of resources
34101 used, unless you specify the &%no_cache%& parameter with the &%callout%&
34102 option. A hints database called &"callout"& is used for the cache. Two
34103 different record types are used: one records the result of a callout check for
34104 a specific address, and the other records information that applies to the
34105 entire domain (for example, that it accepts the local part &'postmaster'&).
34106
34107 When an original callout fails, a detailed SMTP error message is given about
34108 the failure. However, for subsequent failures that use the cache data, this message
34109 is not available.
34110
34111 The expiry times for negative and positive address cache records are
34112 independent, and can be set by the global options &%callout_negative_expire%&
34113 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
34114
34115 If a host gives a negative response to an SMTP connection, or rejects any
34116 commands up to and including
34117 .code
34118 MAIL FROM:<>
34119 .endd
34120 (but not including the MAIL command with a non-empty address),
34121 any callout attempt is bound to fail. Exim remembers such failures in a
34122 domain cache record, which it uses to fail callouts for the domain without
34123 making new connections, until the domain record times out. There are two
34124 separate expiry times for domain cache records:
34125 &%callout_domain_negative_expire%& (default 3h) and
34126 &%callout_domain_positive_expire%& (default 7d).
34127
34128 Domain records expire when the negative expiry time is reached if callouts
34129 cannot be made for the domain, or if the postmaster check failed.
34130 Otherwise, they expire when the positive expiry time is reached. This
34131 ensures that, for example, a host that stops accepting &"random"& local parts
34132 will eventually be noticed.
34133
34134 The callout caching mechanism is based on the domain of the address that is
34135 being tested. If the domain routes to several hosts, it is assumed that their
34136 behaviour will be the same.
34137
34138
34139
34140 .section "Quota caching" "SECTquotacache"
34141 .cindex "hints database" "quota cache"
34142 .cindex "quota" "cache, description of"
34143 .cindex "caching" "quota"
34144 Exim caches the results of quota verification
34145 in order to reduce the amount of resources used.
34146 The &"callout"& hints database is used.
34147
34148 The default cache periods are five minutes for a positive (good) result
34149 and one hour for a negative result.
34150 To change the periods the &%quota%& option can be followed by an equals sign
34151 and a number of optional paramemters, separated by commas.
34152 For example:
34153 .code
34154 verify = recipient/quota=cachepos=1h,cacheneg=1d
34155 .endd
34156 Possible parameters are:
34157 .vlist
34158 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
34159 .cindex "quota cache" "positive entry expiry, specifying"
34160 Set the lifetime for a positive cache entry.
34161 A value of zero seconds is legitimate.
34162
34163 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
34164 .cindex "quota cache" "negative entry expiry, specifying"
34165 As above, for a negative entry.
34166
34167 .vitem &*no_cache*&
34168 Set both positive and negative lifetimes to zero.
34169
34170 .section "Sender address verification reporting" "SECTsenaddver"
34171 .cindex "verifying" "suppressing error details"
34172 See section &<<SECTaddressverification>>& for a general discussion of
34173 verification. When sender verification fails in an ACL, the details of the
34174 failure are given as additional output lines before the 550 response to the
34175 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
34176 you might see:
34177 .code
34178 MAIL FROM:<xyz@abc.example>
34179 250 OK
34180 RCPT TO:<pqr@def.example>
34181 550-Verification failed for <xyz@abc.example>
34182 550-Called:   192.168.34.43
34183 550-Sent:     RCPT TO:<xyz@abc.example>
34184 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
34185 550 Sender verification failed
34186 .endd
34187 If more than one RCPT command fails in the same way, the details are given
34188 only for the first of them. However, some administrators do not want to send
34189 out this much information. You can suppress the details by adding
34190 &`/no_details`& to the ACL statement that requests sender verification. For
34191 example:
34192 .code
34193 verify = sender/no_details
34194 .endd
34195
34196 .section "Redirection while verifying" "SECTredirwhilveri"
34197 .cindex "verifying" "redirection while"
34198 .cindex "address redirection" "while verifying"
34199 A dilemma arises when a local address is redirected by aliasing or forwarding
34200 during verification: should the generated addresses themselves be verified,
34201 or should the successful expansion of the original address be enough to verify
34202 it? By default, Exim takes the following pragmatic approach:
34203
34204 .ilist
34205 When an incoming address is redirected to just one child address, verification
34206 continues with the child address, and if that fails to verify, the original
34207 verification also fails.
34208 .next
34209 When an incoming address is redirected to more than one child address,
34210 verification does not continue. A success result is returned.
34211 .endlist
34212
34213 This seems the most reasonable behaviour for the common use of aliasing as a
34214 way of redirecting different local parts to the same mailbox. It means, for
34215 example, that a pair of alias entries of the form
34216 .code
34217 A.Wol:   aw123
34218 aw123:   :fail: Gone away, no forwarding address
34219 .endd
34220 work as expected, with both local parts causing verification failure. When a
34221 redirection generates more than one address, the behaviour is more like a
34222 mailing list, where the existence of the alias itself is sufficient for
34223 verification to succeed.
34224
34225 It is possible, however, to change the default behaviour so that all successful
34226 redirections count as successful verifications, however many new addresses are
34227 generated. This is specified by the &%success_on_redirect%& verification
34228 option. For example:
34229 .code
34230 require verify = recipient/success_on_redirect/callout=10s
34231 .endd
34232 In this example, verification succeeds if a router generates a new address, and
34233 the callout does not occur, because no address was routed to a remote host.
34234
34235 When verification is being tested via the &%-bv%& option, the treatment of
34236 redirections is as just described, unless the &%-v%& or any debugging option is
34237 also specified. In that case, full verification is done for every generated
34238 address and a report is output for each of them.
34239
34240
34241
34242 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34243 .cindex "CSA" "verifying"
34244 Client SMTP Authorization is a system that allows a site to advertise
34245 which machines are and are not permitted to send email. This is done by placing
34246 special SRV records in the DNS; these are looked up using the client's HELO
34247 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34248 Authorization checks in Exim are performed by the ACL condition:
34249 .code
34250 verify = csa
34251 .endd
34252 This fails if the client is not authorized. If there is a DNS problem, or if no
34253 valid CSA SRV record is found, or if the client is authorized, the condition
34254 succeeds. These three cases can be distinguished using the expansion variable
34255 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34256 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34257 be likely to cause problems for legitimate email.
34258
34259 The error messages produced by the CSA code include slightly more
34260 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34261 looking up the CSA SRV record, or problems looking up the CSA target
34262 address record. There are four reasons for &$csa_status$& being &"fail"&:
34263
34264 .ilist
34265 The client's host name is explicitly not authorized.
34266 .next
34267 The client's IP address does not match any of the CSA target IP addresses.
34268 .next
34269 The client's host name is authorized but it has no valid target IP addresses
34270 (for example, the target's addresses are IPv6 and the client is using IPv4).
34271 .next
34272 The client's host name has no CSA SRV record but a parent domain has asserted
34273 that all subdomains must be explicitly authorized.
34274 .endlist
34275
34276 The &%csa%& verification condition can take an argument which is the domain to
34277 use for the DNS query. The default is:
34278 .code
34279 verify = csa/$sender_helo_name
34280 .endd
34281 This implementation includes an extension to CSA. If the query domain
34282 is an address literal such as [192.0.2.95], or if it is a bare IP
34283 address, Exim searches for CSA SRV records in the reverse DNS as if
34284 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34285 meaningful to say:
34286 .code
34287 verify = csa/$sender_host_address
34288 .endd
34289 In fact, this is the check that Exim performs if the client does not say HELO.
34290 This extension can be turned off by setting the main configuration option
34291 &%dns_csa_use_reverse%& to be false.
34292
34293 If a CSA SRV record is not found for the domain itself, a search
34294 is performed through its parent domains for a record which might be
34295 making assertions about subdomains. The maximum depth of this search is limited
34296 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34297 default. Exim does not look for CSA SRV records in a top level domain, so the
34298 default settings handle HELO domains as long as seven
34299 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34300 of legitimate HELO domains.
34301
34302 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34303 direct SRV lookups, this is not sufficient because of the extra parent domain
34304 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34305 addresses into lookups in the reverse DNS space. The result of a successful
34306 lookup such as:
34307 .code
34308 ${lookup dnsdb {csa=$sender_helo_name}}
34309 .endd
34310 has two space-separated fields: an authorization code and a target host name.
34311 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34312 authorization required but absent, or &"?"& for unknown.
34313
34314
34315
34316
34317 .section "Bounce address tag validation" "SECTverifyPRVS"
34318 .cindex "BATV, verifying"
34319 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34320 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34321 Genuine incoming bounce messages should therefore always be addressed to
34322 recipients that have a valid tag. This scheme is a way of detecting unwanted
34323 bounce messages caused by sender address forgeries (often called &"collateral
34324 spam"&), because the recipients of such messages do not include valid tags.
34325
34326 There are two expansion items to help with the implementation of the BATV
34327 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34328 the original envelope sender address by using a simple key to add a hash of the
34329 address and some time-based randomizing information. The &%prvs%& expansion
34330 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34331 The syntax of these expansion items is described in section
34332 &<<SECTexpansionitems>>&.
34333 The validity period on signed addresses is seven days.
34334
34335 As an example, suppose the secret per-address keys are stored in an MySQL
34336 database. A query to look up the key for an address could be defined as a macro
34337 like this:
34338 .code
34339 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34340                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34341                 }{$value}}
34342 .endd
34343 Suppose also that the senders who make use of BATV are defined by an address
34344 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34345 use this:
34346 .code
34347 # Bounces: drop unsigned addresses for BATV senders
34348 deny senders = :
34349      recipients = +batv_senders
34350      message = This address does not send an unsigned reverse path
34351
34352 # Bounces: In case of prvs-signed address, check signature.
34353 deny senders = :
34354      condition  = ${prvscheck {$local_part@$domain}\
34355                   {PRVSCHECK_SQL}{1}}
34356      !condition = $prvscheck_result
34357      message = Invalid reverse path signature.
34358 .endd
34359 The first statement rejects recipients for bounce messages that are addressed
34360 to plain BATV sender addresses, because it is known that BATV senders do not
34361 send out messages with plain sender addresses. The second statement rejects
34362 recipients that are prvs-signed, but with invalid signatures (either because
34363 the key is wrong, or the signature has timed out).
34364
34365 A non-prvs-signed address is not rejected by the second statement, because the
34366 &%prvscheck%& expansion yields an empty string if its first argument is not a
34367 prvs-signed address, thus causing the &%condition%& condition to be false. If
34368 the first argument is a syntactically valid prvs-signed address, the yield is
34369 the third string (in this case &"1"&), whether or not the cryptographic and
34370 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34371 of the checks (empty for failure, &"1"& for success).
34372
34373 There is one more issue you must consider when implementing prvs-signing:
34374 you have to ensure that the routers accept prvs-signed addresses and
34375 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34376 router to remove the signature with a configuration along these lines:
34377 .code
34378 batv_redirect:
34379   driver = redirect
34380   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34381 .endd
34382 This works because, if the third argument of &%prvscheck%& is empty, the result
34383 of the expansion of a prvs-signed address is the decoded value of the original
34384 address. This router should probably be the first of your routers that handles
34385 local addresses.
34386
34387 To create BATV-signed addresses in the first place, a transport of this form
34388 can be used:
34389 .code
34390 external_smtp_batv:
34391   driver = smtp
34392   return_path = ${prvs {$return_path} \
34393                        {${lookup mysql{SELECT \
34394                        secret FROM batv_prvs WHERE \
34395                        sender='${quote_mysql:$sender_address}'} \
34396                        {$value}fail}}}
34397 .endd
34398 If no key can be found for the existing return path, no signing takes place.
34399
34400
34401
34402 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34403 .cindex "&ACL;" "relay control"
34404 .cindex "relaying" "control by ACL"
34405 .cindex "policy control" "relay control"
34406 An MTA is said to &'relay'& a message if it receives it from some host and
34407 delivers it directly to another host as a result of a remote address contained
34408 within it. Redirecting a local address via an alias or forward file and then
34409 passing the message on to another host is not relaying,
34410 .cindex "&""percent hack""&"
34411 but a redirection as a result of the &"percent hack"& is.
34412
34413 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34414 A host which is acting as a gateway or an MX backup is concerned with incoming
34415 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34416 a host which is acting as a smart host for a number of clients is concerned
34417 with outgoing relaying from those clients to the Internet at large. Often the
34418 same host is fulfilling both functions,
34419 . ///
34420 . as illustrated in the diagram below,
34421 . ///
34422 but in principle these two kinds of relaying are entirely independent. What is
34423 not wanted is the transmission of mail from arbitrary remote hosts through your
34424 system to arbitrary domains.
34425
34426
34427 You can implement relay control by means of suitable statements in the ACL that
34428 runs for each RCPT command. For convenience, it is often easiest to use
34429 Exim's named list facility to define the domains and hosts involved. For
34430 example, suppose you want to do the following:
34431
34432 .ilist
34433 Deliver a number of domains to mailboxes on the local host (or process them
34434 locally in some other way). Let's say these are &'my.dom1.example'& and
34435 &'my.dom2.example'&.
34436 .next
34437 Relay mail for a number of other domains for which you are the secondary MX.
34438 These might be &'friend1.example'& and &'friend2.example'&.
34439 .next
34440 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34441 Suppose your LAN is 192.168.45.0/24.
34442 .endlist
34443
34444
34445 In the main part of the configuration, you put the following definitions:
34446 .code
34447 domainlist local_domains    = my.dom1.example : my.dom2.example
34448 domainlist relay_to_domains = friend1.example : friend2.example
34449 hostlist   relay_from_hosts = 192.168.45.0/24
34450 .endd
34451 Now you can use these definitions in the ACL that is run for every RCPT
34452 command:
34453 .code
34454 acl_check_rcpt:
34455   accept domains = +local_domains : +relay_to_domains
34456   accept hosts   = +relay_from_hosts
34457 .endd
34458 The first statement accepts any RCPT command that contains an address in
34459 the local or relay domains. For any other domain, control passes to the second
34460 statement, which accepts the command only if it comes from one of the relay
34461 hosts. In practice, you will probably want to make your ACL more sophisticated
34462 than this, for example, by including sender and recipient verification. The
34463 default configuration includes a more comprehensive example, which is described
34464 in chapter &<<CHAPdefconfil>>&.
34465
34466
34467
34468 .section "Checking a relay configuration" "SECTcheralcon"
34469 .cindex "relaying" "checking control of"
34470 You can check the relay characteristics of your configuration in the same way
34471 that you can test any ACL behaviour for an incoming SMTP connection, by using
34472 the &%-bh%& option to run a fake SMTP session with which you interact.
34473 .ecindex IIDacl
34474
34475
34476
34477 . ////////////////////////////////////////////////////////////////////////////
34478 . ////////////////////////////////////////////////////////////////////////////
34479
34480 .chapter "Content scanning at ACL time" "CHAPexiscan"
34481 .scindex IIDcosca "content scanning" "at ACL time"
34482 The extension of Exim to include content scanning at ACL time, formerly known
34483 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34484 was integrated into the main source for Exim release 4.50, and Tom continues to
34485 maintain it. Most of the wording of this chapter is taken from Tom's
34486 specification.
34487
34488 It is also possible to scan the content of messages at other times. The
34489 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34490 scanning after all the ACLs have run. A transport filter can be used to scan
34491 messages at delivery time (see the &%transport_filter%& option, described in
34492 chapter &<<CHAPtransportgeneric>>&).
34493
34494 If you want to include the ACL-time content-scanning features when you compile
34495 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34496 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34497
34498 .ilist
34499 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34500 for all MIME parts for SMTP and non-SMTP messages, respectively.
34501 .next
34502 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34503 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34504 run at the end of message reception (the &%acl_smtp_data%& ACL).
34505 .next
34506 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34507 of messages, or parts of messages, for debugging purposes.
34508 .next
34509 Additional expansion variables that are set in the new ACL and by the new
34510 conditions.
34511 .next
34512 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34513 .endlist
34514
34515 Content-scanning is continually evolving, and new features are still being
34516 added. While such features are still unstable and liable to incompatible
34517 changes, they are made available in Exim by setting options whose names begin
34518 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34519 this manual. You can find out about them by reading the file called
34520 &_doc/experimental.txt_&.
34521
34522 All the content-scanning facilities work on a MBOX copy of the message that is
34523 temporarily created in a file called:
34524 .display
34525 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34526 .endd
34527 The &_.eml_& extension is a friendly hint to virus scanners that they can
34528 expect an MBOX-like structure inside that file. The file is created when the
34529 first content scanning facility is called. Subsequent calls to content
34530 scanning conditions open the same file again. The directory is recursively
34531 removed when the &%acl_smtp_data%& ACL has finished running, unless
34532 .code
34533 control = no_mbox_unspool
34534 .endd
34535 has been encountered. When the MIME ACL decodes files, they are put into the
34536 same directory by default.
34537
34538
34539
34540 .section "Scanning for viruses" "SECTscanvirus"
34541 .cindex "virus scanning"
34542 .cindex "content scanning" "for viruses"
34543 .cindex "content scanning" "the &%malware%& condition"
34544 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34545 It supports a &"generic"& interface to scanners called via the shell, and
34546 specialized interfaces for &"daemon"& type virus scanners, which are resident
34547 in memory and thus are much faster.
34548
34549 Since message data needs to have arrived,
34550 the condition may be only called in ACL defined by
34551 &%acl_smtp_data%&,
34552 &%acl_smtp_data_prdr%&,
34553 &%acl_smtp_mime%& or
34554 &%acl_smtp_dkim%&
34555
34556 A timeout of 2 minutes is applied to a scanner call (by default);
34557 if it expires then a defer action is taken.
34558
34559 .oindex "&%av_scanner%&"
34560 You can set the &%av_scanner%& option in the main part of the configuration
34561 to specify which scanner to use, together with any additional options that
34562 are needed. The basic syntax is as follows:
34563 .display
34564 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34565 .endd
34566 If you do not set &%av_scanner%&, it defaults to
34567 .code
34568 av_scanner = sophie:/var/run/sophie
34569 .endd
34570 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34571 before use.
34572 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34573 The following scanner types are supported in this release,
34574 though individual ones can be included or not at build time:
34575
34576 .vlist
34577 .vitem &%avast%&
34578 .cindex "virus scanners" "avast"
34579 This is the scanner daemon of Avast. It has been tested with Avast Core
34580 Security (currently at version 2.2.0).
34581 You can get a trial version at &url(https://www.avast.com) or for Linux
34582 at &url(https://www.avast.com/linux-server-antivirus).
34583 This scanner type takes one option,
34584 which can be either a full path to a UNIX socket,
34585 or host and port specifiers separated by white space.
34586 The host may be a name or an IP address; the port is either a
34587 single number or a pair of numbers with a dash between.
34588 A list of options may follow. These options are interpreted on the
34589 Exim's side of the malware scanner, or are given on separate lines to
34590 the daemon as options before the main scan command.
34591
34592 .cindex &`pass_unscanned`& "avast"
34593 If &`pass_unscanned`&
34594 is set, any files the Avast scanner can't scan (e.g.
34595 decompression bombs, or invalid archives) are considered clean. Use with
34596 care.
34597
34598 For example:
34599 .code
34600 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34601 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34602 av_scanner = avast:192.168.2.22 5036
34603 .endd
34604 If you omit the argument, the default path
34605 &_/var/run/avast/scan.sock_&
34606 is used.
34607 If you use a remote host,
34608 you need to make Exim's spool directory available to it,
34609 as the scanner is passed a file path, not file contents.
34610 For information about available commands and their options you may use
34611 .code
34612 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34613     FLAGS
34614     SENSITIVITY
34615     PACK
34616 .endd
34617
34618 If the scanner returns a temporary failure (e.g. license issues, or
34619 permission problems), the message is deferred and a paniclog entry is
34620 written.  The usual &`defer_ok`& option is available.
34621
34622 .vitem &%aveserver%&
34623 .cindex "virus scanners" "Kaspersky"
34624 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34625 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34626 which is the path to the daemon's UNIX socket. The default is shown in this
34627 example:
34628 .code
34629 av_scanner = aveserver:/var/run/aveserver
34630 .endd
34631
34632
34633 .vitem &%clamd%&
34634 .cindex "virus scanners" "clamd"
34635 This daemon-type scanner is GPL and free. You can get it at
34636 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34637 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34638 in the MIME ACL. This is no longer believed to be necessary.
34639
34640 The options are a list of server specifiers, which may be
34641 a UNIX socket specification,
34642 a TCP socket specification,
34643 or a (global) option.
34644
34645 A socket specification consists of a space-separated list.
34646 For a Unix socket the first element is a full path for the socket,
34647 for a TCP socket the first element is the IP address
34648 and the second a port number,
34649 Any further elements are per-server (non-global) options.
34650 These per-server options are supported:
34651 .code
34652 retry=<timespec>        Retry on connect fail
34653 .endd
34654
34655 The &`retry`& option specifies a time after which a single retry for
34656 a failed connect is made.  The default is to not retry.
34657
34658 If a Unix socket file is specified, only one server is supported.
34659
34660 Examples:
34661 .code
34662 av_scanner = clamd:/opt/clamd/socket
34663 av_scanner = clamd:192.0.2.3 1234
34664 av_scanner = clamd:192.0.2.3 1234:local
34665 av_scanner = clamd:192.0.2.3 1234 retry=10s
34666 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34667 .endd
34668 If the value of av_scanner points to a UNIX socket file or contains the
34669 &`local`&
34670 option, then the ClamAV interface will pass a filename containing the data
34671 to be scanned, which should normally result in less I/O happening and be
34672 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34673 Exim does not assume that there is a common filesystem with the remote host.
34674
34675 The final example shows that multiple TCP targets can be specified.  Exim will
34676 randomly use one for each incoming email (i.e. it load balances them).  Note
34677 that only TCP targets may be used if specifying a list of scanners; a UNIX
34678 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34679 unavailable, Exim will try the remaining one(s) until it finds one that works.
34680 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34681 not keep track of scanner state between multiple messages, and the scanner
34682 selection is random, so the message will get logged in the mainlog for each
34683 email that the down scanner gets chosen first (message wrapped to be readable):
34684 .code
34685 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34686    clamd: connection to localhost, port 3310 failed
34687    (Connection refused)
34688 .endd
34689
34690 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34691 contributing the code for this scanner.
34692
34693 .vitem &%cmdline%&
34694 .cindex "virus scanners" "command line interface"
34695 This is the keyword for the generic command line scanner interface. It can be
34696 used to attach virus scanners that are invoked from the shell. This scanner
34697 type takes 3 mandatory options:
34698
34699 .olist
34700 The full path and name of the scanner binary, with all command line options,
34701 and a placeholder (&`%s`&) for the directory to scan.
34702
34703 .next
34704 A regular expression to match against the STDOUT and STDERR output of the
34705 virus scanner. If the expression matches, a virus was found. You must make
34706 absolutely sure that this expression matches on &"virus found"&. This is called
34707 the &"trigger"& expression.
34708
34709 .next
34710 Another regular expression, containing exactly one pair of parentheses, to
34711 match the name of the virus found in the scanners output. This is called the
34712 &"name"& expression.
34713 .endlist olist
34714
34715 For example, Sophos Sweep reports a virus on a line like this:
34716 .code
34717 Virus 'W32/Magistr-B' found in file ./those.bat
34718 .endd
34719 For the trigger expression, we can match the phrase &"found in file"&. For the
34720 name expression, we want to extract the W32/Magistr-B string, so we can match
34721 for the single quotes left and right of it. Altogether, this makes the
34722 configuration setting:
34723 .code
34724 av_scanner = cmdline:\
34725              /path/to/sweep -ss -all -rec -archive %s:\
34726              found in file:'(.+)'
34727 .endd
34728 .vitem &%drweb%&
34729 .cindex "virus scanners" "DrWeb"
34730 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34731 takes one option,
34732 either a full path to a UNIX socket,
34733 or host and port specifiers separated by white space.
34734 The host may be a name or an IP address; the port is either a
34735 single number or a pair of numbers with a dash between.
34736 For example:
34737 .code
34738 av_scanner = drweb:/var/run/drwebd.sock
34739 av_scanner = drweb:192.168.2.20 31337
34740 .endd
34741 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34742 is used. Thanks to Alex Miller for contributing the code for this scanner.
34743
34744 .vitem &%f-protd%&
34745 .cindex "virus scanners" "f-protd"
34746 The f-protd scanner is accessed via HTTP over TCP.
34747 One argument is taken, being a space-separated hostname and port number
34748 (or port-range).
34749 For example:
34750 .code
34751 av_scanner = f-protd:localhost 10200-10204
34752 .endd
34753 If you omit the argument, the default values shown above are used.
34754
34755 .vitem &%f-prot6d%&
34756 .cindex "virus scanners" "f-prot6d"
34757 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34758 One argument is taken, being a space-separated hostname and port number.
34759 For example:
34760 .code
34761 av_scanner = f-prot6d:localhost 10200
34762 .endd
34763 If you omit the argument, the default values show above are used.
34764
34765 .vitem &%fsecure%&
34766 .cindex "virus scanners" "F-Secure"
34767 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34768 argument which is the path to a UNIX socket. For example:
34769 .code
34770 av_scanner = fsecure:/path/to/.fsav
34771 .endd
34772 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34773 Thelmen for contributing the code for this scanner.
34774
34775 .vitem &%kavdaemon%&
34776 .cindex "virus scanners" "Kaspersky"
34777 This is the scanner daemon of Kaspersky Version 4. This version of the
34778 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34779 scanner type takes one option, which is the path to the daemon's UNIX socket.
34780 For example:
34781 .code
34782 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34783 .endd
34784 The default path is &_/var/run/AvpCtl_&.
34785
34786 .vitem &%mksd%&
34787 .cindex "virus scanners" "mksd"
34788 This was a daemon type scanner that is aimed mainly at Polish users,
34789 though some documentation was available in English.
34790 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34791 and this appears to be a candidate for removal from Exim, unless
34792 we are informed of other virus scanners which use the same protocol
34793 to integrate.
34794 The only option for this scanner type is
34795 the maximum number of processes used simultaneously to scan the attachments,
34796 provided that mksd has
34797 been run with at least the same number of child processes. For example:
34798 .code
34799 av_scanner = mksd:2
34800 .endd
34801 You can safely omit this option (the default value is 1).
34802
34803 .vitem &%sock%&
34804 .cindex "virus scanners" "simple socket-connected"
34805 This is a general-purpose way of talking to simple scanner daemons
34806 running on the local machine.
34807 There are four options:
34808 an address (which may be an IP address and port, or the path of a Unix socket),
34809 a commandline to send (may include a single %s which will be replaced with
34810 the path to the mail file to be scanned),
34811 an RE to trigger on from the returned data,
34812 and an RE to extract malware_name from the returned data.
34813 For example:
34814 .code
34815 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34816 .endd
34817 Note that surrounding whitespace is stripped from each option, meaning
34818 there is no way to specify a trailing newline.
34819 The socket specifier and both regular-expressions are required.
34820 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34821 specify an empty element to get this.
34822
34823 .vitem &%sophie%&
34824 .cindex "virus scanners" "Sophos and Sophie"
34825 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34826 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34827 for this scanner type is the path to the UNIX socket that Sophie uses for
34828 client communication. For example:
34829 .code
34830 av_scanner = sophie:/tmp/sophie
34831 .endd
34832 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34833 the option.
34834 .endlist
34835
34836 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34837 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34838 ACL.
34839
34840 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34841 makes it possible to use different scanners. See further below for an example.
34842 The &%malware%& condition caches its results, so when you use it multiple times
34843 for the same message, the actual scanning process is only carried out once.
34844 However, using expandable items in &%av_scanner%& disables this caching, in
34845 which case each use of the &%malware%& condition causes a new scan of the
34846 message.
34847
34848 The &%malware%& condition takes a right-hand argument that is expanded before
34849 use and taken as a list, slash-separated by default.
34850 The first element can then be one of
34851
34852 .ilist
34853 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34854 The condition succeeds if a virus was found, and fail otherwise. This is the
34855 recommended usage.
34856 .next
34857 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34858 the condition fails immediately.
34859 .next
34860 A regular expression, in which case the message is scanned for viruses. The
34861 condition succeeds if a virus is found and its name matches the regular
34862 expression. This allows you to take special actions on certain types of virus.
34863 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34864 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34865 .endlist
34866
34867 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34868 messages even if there is a problem with the virus scanner.
34869 Otherwise, such a problem causes the ACL to defer.
34870
34871 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34872 specify a non-default timeout.  The default is two minutes.
34873 For example:
34874 .code
34875 malware = * / defer_ok / tmo=10s
34876 .endd
34877 A timeout causes the ACL to defer.
34878
34879 .vindex "&$callout_address$&"
34880 When a connection is made to the scanner the expansion variable &$callout_address$&
34881 is set to record the actual address used.
34882
34883 .vindex "&$malware_name$&"
34884 When a virus is found, the condition sets up an expansion variable called
34885 &$malware_name$& that contains the name of the virus. You can use it in a
34886 &%message%& modifier that specifies the error returned to the sender, and/or in
34887 logging data.
34888
34889 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34890 imposed by your anti-virus scanner.
34891
34892 Here is a very simple scanning example:
34893 .code
34894 deny malware = *
34895      message = This message contains malware ($malware_name)
34896 .endd
34897 The next example accepts messages when there is a problem with the scanner:
34898 .code
34899 deny malware = */defer_ok
34900      message = This message contains malware ($malware_name)
34901 .endd
34902 The next example shows how to use an ACL variable to scan with both sophie and
34903 aveserver. It assumes you have set:
34904 .code
34905 av_scanner = $acl_m0
34906 .endd
34907 in the main Exim configuration.
34908 .code
34909 deny set acl_m0 = sophie
34910      malware = *
34911      message = This message contains malware ($malware_name)
34912
34913 deny set acl_m0 = aveserver
34914      malware = *
34915      message = This message contains malware ($malware_name)
34916 .endd
34917
34918
34919 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34920 .cindex "content scanning" "for spam"
34921 .cindex "spam scanning"
34922 .cindex "SpamAssassin"
34923 .cindex "Rspamd"
34924 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34925 score and a report for the message.
34926 Support is also provided for Rspamd.
34927
34928 For more information about installation and configuration of SpamAssassin or
34929 Rspamd refer to their respective websites at
34930 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34931
34932 SpamAssassin can be installed with CPAN by running:
34933 .code
34934 perl -MCPAN -e 'install Mail::SpamAssassin'
34935 .endd
34936 SpamAssassin has its own set of configuration files. Please review its
34937 documentation to see how you can tweak it. The default installation should work
34938 nicely, however.
34939
34940 .oindex "&%spamd_address%&"
34941 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34942 intend to use an instance running on the local host you do not need to set
34943 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34944 you must set the &%spamd_address%& option in the global part of the Exim
34945 configuration as follows (example):
34946 .code
34947 spamd_address = 192.168.99.45 783
34948 .endd
34949 The SpamAssassin protocol relies on a TCP half-close from the client.
34950 If your SpamAssassin client side is running a Linux system with an
34951 iptables firewall, consider setting
34952 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34953 timeout, Exim uses when waiting for a response from the SpamAssassin
34954 server (currently defaulting to 120s).  With a lower value the Linux
34955 connection tracking may consider your half-closed connection as dead too
34956 soon.
34957
34958
34959 To use Rspamd (which by default listens on all local addresses
34960 on TCP port 11333)
34961 you should add &%variant=rspamd%& after the address/port pair, for example:
34962 .code
34963 spamd_address = 127.0.0.1 11333 variant=rspamd
34964 .endd
34965
34966 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34967 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34968 filename instead of an address/port pair:
34969 .code
34970 spamd_address = /var/run/spamd_socket
34971 .endd
34972 You can have multiple &%spamd%& servers to improve scalability. These can
34973 reside on other hardware reachable over the network. To specify multiple
34974 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34975 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34976 .code
34977 spamd_address = 192.168.2.10 783 : \
34978                 192.168.2.11 783 : \
34979                 192.168.2.12 783
34980 .endd
34981 Up to 32 &%spamd%& servers are supported.
34982 When a server fails to respond to the connection attempt, all other
34983 servers are tried until one succeeds. If no server responds, the &%spam%&
34984 condition defers.
34985
34986 Unix and TCP socket specifications may be mixed in any order.
34987 Each element of the list is a list itself, space-separated by default
34988 and changeable in the usual way (&<<SECTlistsepchange>>&);
34989 take care to not double the separator.
34990
34991 For TCP socket specifications a host name or IP (v4 or v6, but
34992 subject to list-separator quoting rules) address can be used,
34993 and the port can be one or a dash-separated pair.
34994 In the latter case, the range is tried in strict order.
34995
34996 Elements after the first for Unix sockets, or second for TCP socket,
34997 are options.
34998 The supported options are:
34999 .code
35000 pri=<priority>      Selection priority
35001 weight=<value>      Selection bias
35002 time=<start>-<end>  Use only between these times of day
35003 retry=<timespec>    Retry on connect fail
35004 tmo=<timespec>      Connection time limit
35005 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
35006 .endd
35007
35008 The &`pri`& option specifies a priority for the server within the list,
35009 higher values being tried first.
35010 The default priority is 1.
35011
35012 The &`weight`& option specifies a selection bias.
35013 Within a priority set
35014 servers are queried in a random fashion, weighted by this value.
35015 The default value for selection bias is 1.
35016
35017 Time specifications for the &`time`& option are <hour>.<minute>.<second>
35018 in the local time zone; each element being one or more digits.
35019 Either the seconds or both minutes and seconds, plus the leading &`.`&
35020 characters, may be omitted and will be taken as zero.
35021
35022 Timeout specifications for the &`retry`& and &`tmo`& options
35023 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
35024
35025 The &`tmo`& option specifies an overall timeout for communication.
35026 The default value is two minutes.
35027
35028 The &`retry`& option specifies a time after which a single retry for
35029 a failed connect is made.
35030 The default is to not retry.
35031
35032 The &%spamd_address%& variable is expanded before use if it starts with
35033 a dollar sign. In this case, the expansion may return a string that is
35034 used as the list so that multiple spamd servers can be the result of an
35035 expansion.
35036
35037 .vindex "&$callout_address$&"
35038 When a connection is made to the server the expansion variable &$callout_address$&
35039 is set to record the actual address used.
35040
35041 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
35042 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
35043 .code
35044 deny spam = joe
35045      message = This message was classified as SPAM
35046 .endd
35047 The right-hand side of the &%spam%& condition specifies a name. This is
35048 relevant if you have set up multiple SpamAssassin profiles. If you do not want
35049 to scan using a specific profile, but rather use the SpamAssassin system-wide
35050 default profile, you can scan for an unknown name, or simply use &"nobody"&.
35051 Rspamd does not use this setting. However, you must put something on the
35052 right-hand side.
35053
35054 The name allows you to use per-domain or per-user antispam profiles in
35055 principle, but this is not straightforward in practice, because a message may
35056 have multiple recipients, not necessarily all in the same domain. Because the
35057 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
35058 read the contents of the message, the variables &$local_part$& and &$domain$&
35059 are not set.
35060 Careful enforcement of single-recipient messages
35061 (e.g. by responding with defer in the recipient ACL for all recipients
35062 after the first),
35063 or the use of PRDR,
35064 .cindex "PRDR" "use for per-user SpamAssassin profiles"
35065 are needed to use this feature.
35066
35067 The right-hand side of the &%spam%& condition is expanded before being used, so
35068 you can put lookups or conditions there. When the right-hand side evaluates to
35069 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
35070
35071
35072 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
35073 large ones may cause significant performance degradation. As most spam messages
35074 are quite small, it is recommended that you do not scan the big ones. For
35075 example:
35076 .code
35077 deny condition = ${if < {$message_size}{10K}}
35078      spam = nobody
35079      message = This message was classified as SPAM
35080 .endd
35081
35082 The &%spam%& condition returns true if the threshold specified in the user's
35083 SpamAssassin profile has been matched or exceeded. If you want to use the
35084 &%spam%& condition for its side effects (see the variables below), you can make
35085 it always return &"true"& by appending &`:true`& to the username.
35086
35087 .cindex "spam scanning" "returned variables"
35088 When the &%spam%& condition is run, it sets up a number of expansion
35089 variables.
35090 Except for &$spam_report$&,
35091 these variables are saved with the received message so are
35092 available for use at delivery time.
35093
35094 .vlist
35095 .vitem &$spam_score$&
35096 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
35097 for inclusion in log or reject messages.
35098
35099 .vitem &$spam_score_int$&
35100 The spam score of the message, multiplied by ten, as an integer value. For
35101 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
35102 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
35103 The integer value is useful for numeric comparisons in conditions.
35104
35105 .vitem &$spam_bar$&
35106 A string consisting of a number of &"+"& or &"-"& characters, representing the
35107 integer part of the spam score value. A spam score of 4.4 would have a
35108 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
35109 headers, since MUAs can match on such strings. The maximum length of the
35110 spam bar is 50 characters.
35111
35112 .vitem &$spam_report$&
35113 A multiline text table, containing the full SpamAssassin report for the
35114 message. Useful for inclusion in headers or reject messages.
35115 This variable is only usable in a DATA-time ACL.
35116 Beware that SpamAssassin may return non-ASCII characters, especially
35117 when running in country-specific locales, which are not legal
35118 unencoded in headers.
35119
35120 .vitem &$spam_action$&
35121 For SpamAssassin either 'reject' or 'no action' depending on the
35122 spam score versus threshold.
35123 For Rspamd, the recommended action.
35124
35125 .endlist
35126
35127 The &%spam%& condition caches its results unless expansion in
35128 spamd_address was used. If you call it again with the same user name, it
35129 does not scan again, but rather returns the same values as before.
35130
35131 The &%spam%& condition returns DEFER if there is any error while running
35132 the message through SpamAssassin or if the expansion of spamd_address
35133 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
35134 statement block), append &`/defer_ok`& to the right-hand side of the
35135 spam condition, like this:
35136 .code
35137 deny spam    = joe/defer_ok
35138      message = This message was classified as SPAM
35139 .endd
35140 This causes messages to be accepted even if there is a problem with &%spamd%&.
35141
35142 Here is a longer, commented example of the use of the &%spam%&
35143 condition:
35144 .code
35145 # put headers in all messages (no matter if spam or not)
35146 warn  spam = nobody:true
35147       add_header = X-Spam-Score: $spam_score ($spam_bar)
35148       add_header = X-Spam-Report: $spam_report
35149
35150 # add second subject line with *SPAM* marker when message
35151 # is over threshold
35152 warn  spam = nobody
35153       add_header = Subject: *SPAM* $h_Subject:
35154
35155 # reject spam at high scores (> 12)
35156 deny  spam = nobody:true
35157       condition = ${if >{$spam_score_int}{120}{1}{0}}
35158       message = This message scored $spam_score spam points.
35159 .endd
35160
35161
35162
35163 .section "Scanning MIME parts" "SECTscanmimepart"
35164 .cindex "content scanning" "MIME parts"
35165 .cindex "MIME content scanning"
35166 .oindex "&%acl_smtp_mime%&"
35167 .oindex "&%acl_not_smtp_mime%&"
35168 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
35169 each MIME part of an SMTP message, including multipart types, in the sequence
35170 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
35171 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
35172 options may both refer to the same ACL if you want the same processing in both
35173 cases.
35174
35175 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
35176 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
35177 the case of a non-SMTP message. However, a MIME ACL is called only if the
35178 message contains a &'Content-Type:'& header line. When a call to a MIME
35179 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
35180 result code is sent to the client. In the case of an SMTP message, the
35181 &%acl_smtp_data%& ACL is not called when this happens.
35182
35183 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
35184 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
35185 condition to match against the raw MIME part. You can also use the
35186 &%mime_regex%& condition to match against the decoded MIME part (see section
35187 &<<SECTscanregex>>&).
35188
35189 At the start of a MIME ACL, a number of variables are set from the header
35190 information for the relevant MIME part. These are described below. The contents
35191 of the MIME part are not by default decoded into a disk file except for MIME
35192 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
35193 part into a disk file, you can use the &%decode%& condition. The general
35194 syntax is:
35195 .display
35196 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
35197 .endd
35198 The right hand side is expanded before use. After expansion,
35199 the value can be:
35200
35201 .olist
35202 &"0"& or &"false"&, in which case no decoding is done.
35203 .next
35204 The string &"default"&. In that case, the file is put in the temporary
35205 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35206 a sequential filename consisting of the message id and a sequence number. The
35207 full path and name is available in &$mime_decoded_filename$& after decoding.
35208 .next
35209 A full path name starting with a slash. If the full name is an existing
35210 directory, it is used as a replacement for the default directory. The filename
35211 is then sequentially assigned. If the path does not exist, it is used as
35212 the full path and filename.
35213 .next
35214 If the string does not start with a slash, it is used as the
35215 filename, and the default path is then used.
35216 .endlist
35217 The &%decode%& condition normally succeeds. It is only false for syntax
35218 errors or unusual circumstances such as memory shortages.
35219 The variable &$mime_filename$& will have the suggested name for the file.
35220 Note however that this might contain anything, and is very difficult
35221 to safely use as all or even part of the filename.
35222 If you place files outside of the default path, they are not
35223 automatically unlinked.
35224
35225 For RFC822 attachments (these are messages attached to messages, with a
35226 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35227 as for the primary message, only that the &$mime_is_rfc822$& expansion
35228 variable is set (see below). Attached messages are always decoded to disk
35229 before being checked, and the files are unlinked once the check is done.
35230
35231 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35232 used to match regular expressions against raw and decoded MIME parts,
35233 respectively. They are described in section &<<SECTscanregex>>&.
35234
35235 .cindex "MIME content scanning" "returned variables"
35236 The following list describes all expansion variables that are
35237 available in the MIME ACL:
35238
35239 .vlist
35240 .vitem &$mime_anomaly_level$& &&&
35241        &$mime_anomaly_text$&
35242 .vindex &$mime_anomaly_level$&
35243 .vindex &$mime_anomaly_text$&
35244 If there are problems decoding, these variables contain information on
35245 the detected issue.
35246
35247 .vitem &$mime_boundary$&
35248 .vindex &$mime_boundary$&
35249 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35250 have a boundary string, which is stored in this variable. If the current part
35251 has no boundary parameter in the &'Content-Type:'& header, this variable
35252 contains the empty string.
35253
35254 .vitem &$mime_charset$&
35255 .vindex &$mime_charset$&
35256 This variable contains the character set identifier, if one was found in the
35257 &'Content-Type:'& header. Examples for charset identifiers are:
35258 .code
35259 us-ascii
35260 gb2312 (Chinese)
35261 iso-8859-1
35262 .endd
35263 Please note that this value is not normalized, so you should do matches
35264 case-insensitively.
35265
35266 .vitem &$mime_content_description$&
35267 .vindex &$mime_content_description$&
35268 This variable contains the normalized content of the &'Content-Description:'&
35269 header. It can contain a human-readable description of the parts content. Some
35270 implementations repeat the filename for attachments here, but they are usually
35271 only used for display purposes.
35272
35273 .vitem &$mime_content_disposition$&
35274 .vindex &$mime_content_disposition$&
35275 This variable contains the normalized content of the &'Content-Disposition:'&
35276 header. You can expect strings like &"attachment"& or &"inline"& here.
35277
35278 .vitem &$mime_content_id$&
35279 .vindex &$mime_content_id$&
35280 This variable contains the normalized content of the &'Content-ID:'& header.
35281 This is a unique ID that can be used to reference a part from another part.
35282
35283 .vitem &$mime_content_size$&
35284 .vindex &$mime_content_size$&
35285 This variable is set only after the &%decode%& modifier (see above) has been
35286 successfully run. It contains the size of the decoded part in kilobytes. The
35287 size is always rounded up to full kilobytes, so only a completely empty part
35288 has a &$mime_content_size$& of zero.
35289
35290 .vitem &$mime_content_transfer_encoding$&
35291 .vindex &$mime_content_transfer_encoding$&
35292 This variable contains the normalized content of the
35293 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35294 type. Typical values are &"base64"& and &"quoted-printable"&.
35295
35296 .vitem &$mime_content_type$&
35297 .vindex &$mime_content_type$&
35298 If the MIME part has a &'Content-Type:'& header, this variable contains its
35299 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35300 are some examples of popular MIME types, as they may appear in this variable:
35301 .code
35302 text/plain
35303 text/html
35304 application/octet-stream
35305 image/jpeg
35306 audio/midi
35307 .endd
35308 If the MIME part has no &'Content-Type:'& header, this variable contains the
35309 empty string.
35310
35311 .vitem &$mime_decoded_filename$&
35312 .vindex &$mime_decoded_filename$&
35313 This variable is set only after the &%decode%& modifier (see above) has been
35314 successfully run. It contains the full path and filename of the file
35315 containing the decoded data.
35316 .endlist
35317
35318 .cindex "RFC 2047"
35319 .vlist
35320 .vitem &$mime_filename$&
35321 .vindex &$mime_filename$&
35322 This is perhaps the most important of the MIME variables. It contains a
35323 proposed filename for an attachment, if one was found in either the
35324 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35325 RFC2047
35326 or RFC2231
35327 decoded, but no additional sanity checks are done.
35328  If no filename was
35329 found, this variable contains the empty string.
35330
35331 .vitem &$mime_is_coverletter$&
35332 .vindex &$mime_is_coverletter$&
35333 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35334 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35335 content in the cover letter, while not restricting attachments at all.
35336
35337 The variable contains 1 (true) for a MIME part believed to be part of the
35338 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35339 follows:
35340
35341 .olist
35342 The outermost MIME part of a message is always a cover letter.
35343
35344 .next
35345 If a multipart/alternative or multipart/related MIME part is a cover letter,
35346 so are all MIME subparts within that multipart.
35347
35348 .next
35349 If any other multipart is a cover letter, the first subpart is a cover letter,
35350 and the rest are attachments.
35351
35352 .next
35353 All parts contained within an attachment multipart are attachments.
35354 .endlist olist
35355
35356 As an example, the following will ban &"HTML mail"& (including that sent with
35357 alternative plain text), while allowing HTML files to be attached. HTML
35358 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35359 .code
35360 deny !condition = $mime_is_rfc822
35361      condition = $mime_is_coverletter
35362      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35363      message = HTML mail is not accepted here
35364 .endd
35365
35366 .vitem &$mime_is_multipart$&
35367 .vindex &$mime_is_multipart$&
35368 This variable has the value 1 (true) when the current part has the main type
35369 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35370 Since multipart entities only serve as containers for other parts, you may not
35371 want to carry out specific actions on them.
35372
35373 .vitem &$mime_is_rfc822$&
35374 .vindex &$mime_is_rfc822$&
35375 This variable has the value 1 (true) if the current part is not a part of the
35376 checked message itself, but part of an attached message. Attached message
35377 decoding is fully recursive.
35378
35379 .vitem &$mime_part_count$&
35380 .vindex &$mime_part_count$&
35381 This variable is a counter that is raised for each processed MIME part. It
35382 starts at zero for the very first part (which is usually a multipart). The
35383 counter is per-message, so it is reset when processing RFC822 attachments (see
35384 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35385 complete, so you can use it in the DATA ACL to determine the number of MIME
35386 parts of a message. For non-MIME messages, this variable contains the value -1.
35387 .endlist
35388
35389
35390
35391 .section "Scanning with regular expressions" "SECTscanregex"
35392 .cindex "content scanning" "with regular expressions"
35393 .cindex "regular expressions" "content scanning with"
35394 You can specify your own custom regular expression matches on the full body of
35395 the message, or on individual MIME parts.
35396
35397 The &%regex%& condition takes one or more regular expressions as arguments and
35398 matches them against the full message (when called in the DATA ACL) or a raw
35399 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35400 linewise, with a maximum line length of 32K characters. That means you cannot
35401 have multiline matches with the &%regex%& condition.
35402
35403 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35404 to 32K of decoded content (the whole content at once, not linewise). If the
35405 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35406 is decoded automatically when &%mime_regex%& is executed (using default path
35407 and filename values). If the decoded data is larger than  32K, only the first
35408 32K characters are checked.
35409
35410 The regular expressions are passed as a colon-separated list. To include a
35411 literal colon, you must double it. Since the whole right-hand side string is
35412 expanded before being used, you must also escape dollar signs and backslashes
35413 with more backslashes, or use the &`\N`& facility to disable expansion.
35414 Here is a simple example that contains two regular expressions:
35415 .code
35416 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35417      message = contains blacklisted regex ($regex_match_string)
35418 .endd
35419 The conditions returns true if any one of the regular expressions matches. The
35420 &$regex_match_string$& expansion variable is then set up and contains the
35421 matching regular expression.
35422 The expansion variables &$regex1$& &$regex2$& etc
35423 are set to any substrings captured by the regular expression.
35424
35425 &*Warning*&: With large messages, these conditions can be fairly
35426 CPU-intensive.
35427
35428 .ecindex IIDcosca
35429
35430
35431
35432
35433 . ////////////////////////////////////////////////////////////////////////////
35434 . ////////////////////////////////////////////////////////////////////////////
35435
35436 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35437          "Local scan function"
35438 .scindex IIDlosca "&[local_scan()]& function" "description of"
35439 .cindex "customizing" "input scan using C function"
35440 .cindex "policy control" "by local scan function"
35441 In these days of email worms, viruses, and ever-increasing spam, some sites
35442 want to apply a lot of checking to messages before accepting them.
35443
35444 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35445 passing messages to external virus and spam scanning software. You can also do
35446 a certain amount in Exim itself through string expansions and the &%condition%&
35447 condition in the ACL that runs after the SMTP DATA command or the ACL for
35448 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35449
35450 To allow for further customization to a site's own requirements, there is the
35451 possibility of linking Exim with a private message scanning function, written
35452 in C. If you want to run code that is written in something other than C, you
35453 can of course use a little C stub to call it.
35454
35455 The local scan function is run once for every incoming message, at the point
35456 when Exim is just about to accept the message.
35457 It can therefore be used to control non-SMTP messages from local processes as
35458 well as messages arriving via SMTP.
35459
35460 Exim applies a timeout to calls of the local scan function, and there is an
35461 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35462 Zero means &"no timeout"&.
35463 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35464 before calling the local scan function, so that the most common types of crash
35465 are caught. If the timeout is exceeded or one of those signals is caught, the
35466 incoming message is rejected with a temporary error if it is an SMTP message.
35467 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35468 code. The incident is logged on the main and reject logs.
35469
35470
35471
35472 .section "Building Exim to use a local scan function" "SECID207"
35473 .cindex "&[local_scan()]& function" "building Exim to use"
35474 To make use of the local scan function feature, you must tell Exim where your
35475 function is before building Exim, by setting
35476 both HAVE_LOCAL_SCAN and
35477 LOCAL_SCAN_SOURCE in your
35478 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35479 directory, so you might set
35480 .code
35481 HAVE_LOCAL_SCAN=yes
35482 LOCAL_SCAN_SOURCE=Local/local_scan.c
35483 .endd
35484 for example. The function must be called &[local_scan()]&;
35485 the source file(s) for it should first #define LOCAL_SCAN
35486 and then #include "local_scan.h".
35487 It is called by
35488 Exim after it has received a message, when the success return code is about to
35489 be sent. This is after all the ACLs have been run. The return code from your
35490 function controls whether the message is actually accepted or not. There is a
35491 commented template function (that just accepts the message) in the file
35492 _src/local_scan.c_.
35493
35494 If you want to make use of Exim's runtime configuration file to set options
35495 for your &[local_scan()]& function, you must also set
35496 .code
35497 LOCAL_SCAN_HAS_OPTIONS=yes
35498 .endd
35499 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35500
35501
35502
35503
35504 .section "API for local_scan()" "SECTapiforloc"
35505 .cindex "&[local_scan()]& function" "API description"
35506 .cindex &%dlfunc%& "API description"
35507 You must include this line near the start of your code:
35508 .code
35509 #define LOCAL_SCAN
35510 #include "local_scan.h"
35511 .endd
35512 This header file defines a number of variables and other values, and the
35513 prototype for the function itself. Exim is coded to use unsigned char values
35514 almost exclusively, and one of the things this header defines is a shorthand
35515 for &`unsigned char`& called &`uschar`&.
35516 It also makes available the following macro definitions, to simplify casting character
35517 strings and pointers to character strings:
35518 .code
35519 #define CS   (char *)
35520 #define CCS  (const char *)
35521 #define CSS  (char **)
35522 #define US   (unsigned char *)
35523 #define CUS  (const unsigned char *)
35524 #define USS  (unsigned char **)
35525 .endd
35526 The function prototype for &[local_scan()]& is:
35527 .code
35528 extern int local_scan(int fd, uschar **return_text);
35529 .endd
35530 The arguments are as follows:
35531
35532 .ilist
35533 &%fd%& is a file descriptor for the file that contains the body of the message
35534 (the -D file). The file is open for reading and writing, but updating it is not
35535 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35536
35537 The descriptor is positioned at character 26 of the file, which is the first
35538 character of the body itself, because the first 26 characters (19 characters
35539 before Exim  4.97) are the message id followed by &`-D`& and a newline.
35540 If you rewind the file, you should use the
35541 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35542 case this changes in some future version.
35543 .next
35544 &%return_text%& is an address which you can use to return a pointer to a text
35545 string at the end of the function. The value it points to on entry is NULL.
35546 .endlist
35547
35548 The function must return an &%int%& value which is one of the following macros:
35549
35550 .vlist
35551 .vitem &`LOCAL_SCAN_ACCEPT`&
35552 .vindex "&$local_scan_data$&"
35553 The message is accepted. If you pass back a string of text, it is saved with
35554 the message, and made available in the variable &$local_scan_data$&. No
35555 newlines are permitted (if there are any, they are turned into spaces) and the
35556 maximum length of text is 1000 characters.
35557
35558 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35559 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35560 queued without immediate delivery, and is frozen.
35561
35562 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35563 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35564 queued without immediate delivery.
35565
35566 .vitem &`LOCAL_SCAN_REJECT`&
35567 The message is rejected; the returned text is used as an error message which is
35568 passed back to the sender and which is also logged. Newlines are permitted &--
35569 they cause a multiline response for SMTP rejections, but are converted to
35570 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35571 used.
35572
35573 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35574 The message is temporarily rejected; the returned text is used as an error
35575 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35576 problem"& is used.
35577
35578 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35579 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35580 message is not written to the reject log. It has the effect of unsetting the
35581 &%rejected_header%& log selector for just this rejection. If
35582 &%rejected_header%& is already unset (see the discussion of the
35583 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35584 same as LOCAL_SCAN_REJECT.
35585
35586 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35587 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35588 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35589 .endlist
35590
35591 If the message is not being received by interactive SMTP, rejections are
35592 reported by writing to &%stderr%& or by sending an email, as configured by the
35593 &%-oe%& command line options.
35594
35595
35596
35597 .section "Configuration options for local_scan()" "SECTconoptloc"
35598 .cindex "&[local_scan()]& function" "configuration options"
35599 It is possible to have option settings in the main configuration file
35600 that set values in static variables in the &[local_scan()]& module. If you
35601 want to do this, you must have the line
35602 .code
35603 LOCAL_SCAN_HAS_OPTIONS=yes
35604 .endd
35605 in your &_Local/Makefile_& when you build Exim. (This line is in
35606 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35607 file, you must define static variables to hold the option values, and a table
35608 to define them.
35609
35610 The table must be a vector called &%local_scan_options%&, of type
35611 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35612 and a pointer to the variable that holds the value. The entries must appear in
35613 alphabetical order. Following &%local_scan_options%& you must also define a
35614 variable called &%local_scan_options_count%& that contains the number of
35615 entries in the table. Here is a short example, showing two kinds of option:
35616 .code
35617 static int my_integer_option = 42;
35618 static uschar *my_string_option = US"a default string";
35619
35620 optionlist local_scan_options[] = {
35621   { "my_integer", opt_int,       &my_integer_option },
35622   { "my_string",  opt_stringptr, &my_string_option }
35623 };
35624
35625 int local_scan_options_count =
35626   sizeof(local_scan_options)/sizeof(optionlist);
35627 .endd
35628 The values of the variables can now be changed from Exim's runtime
35629 configuration file by including a local scan section as in this example:
35630 .code
35631 begin local_scan
35632 my_integer = 99
35633 my_string = some string of text...
35634 .endd
35635 The available types of option data are as follows:
35636
35637 .vlist
35638 .vitem &*opt_bool*&
35639 This specifies a boolean (true/false) option. The address should point to a
35640 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35641 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35642 whether such a variable has been set at all, you can initialize it to
35643 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35644 values.)
35645
35646 .vitem &*opt_fixed*&
35647 This specifies a fixed point number, such as is used for load averages.
35648 The address should point to a variable of type &`int`&. The value is stored
35649 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35650
35651 .vitem &*opt_int*&
35652 This specifies an integer; the address should point to a variable of type
35653 &`int`&. The value may be specified in any of the integer formats accepted by
35654 Exim.
35655
35656 .vitem &*opt_mkint*&
35657 This is the same as &%opt_int%&, except that when such a value is output in a
35658 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35659 printed with the suffix K or M.
35660
35661 .vitem &*opt_octint*&
35662 This also specifies an integer, but the value is always interpreted as an
35663 octal integer, whether or not it starts with the digit zero, and it is
35664 always output in octal.
35665
35666 .vitem &*opt_stringptr*&
35667 This specifies a string value; the address must be a pointer to a
35668 variable that points to a string (for example, of type &`uschar *`&).
35669
35670 .vitem &*opt_time*&
35671 This specifies a time interval value. The address must point to a variable of
35672 type &`int`&. The value that is placed there is a number of seconds.
35673 .endlist
35674
35675 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35676 out the values of all the &[local_scan()]& options.
35677
35678
35679
35680 .section "Available Exim variables" "SECID208"
35681 .cindex "&[local_scan()]& function" "available Exim variables"
35682 The header &_local_scan.h_& gives you access to a number of C variables. These
35683 are the only ones that are guaranteed to be maintained from release to release.
35684 Note, however, that you can obtain the value of any Exim expansion variable,
35685 including &$recipients$&, by calling &'expand_string()'&. The exported
35686 C variables are as follows:
35687
35688 .vlist
35689 .vitem &*int&~body_linecount*&
35690 This variable contains the number of lines in the message's body.
35691 It is not valid if the &%spool_wireformat%& option is used.
35692
35693 .vitem &*int&~body_zerocount*&
35694 This variable contains the number of binary zero bytes in the message's body.
35695 It is not valid if the &%spool_wireformat%& option is used.
35696
35697 .vitem &*unsigned&~int&~debug_selector*&
35698 This variable is set to zero when no debugging is taking place. Otherwise, it
35699 is a bitmap of debugging selectors. Two bits are identified for use in
35700 &[local_scan()]&; they are defined as macros:
35701
35702 .ilist
35703 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35704 testing option that is not privileged &-- any caller may set it. All the
35705 other selector bits can be set only by admin users.
35706
35707 .next
35708 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35709 by the &`+local_scan`& debug selector. It is not included in the default set
35710 of debugging bits.
35711 .endlist ilist
35712
35713 Thus, to write to the debugging output only when &`+local_scan`& has been
35714 selected, you should use code like this:
35715 .code
35716 if ((debug_selector & D_local_scan) != 0)
35717   debug_printf("xxx", ...);
35718 .endd
35719 .vitem &*uschar&~*expand_string_message*&
35720 After a failing call to &'expand_string()'& (returned value NULL), the
35721 variable &%expand_string_message%& contains the error message, zero-terminated.
35722
35723 .vitem &*header_line&~*header_list*&
35724 A pointer to a chain of header lines. The &%header_line%& structure is
35725 discussed below.
35726
35727 .vitem &*header_line&~*header_last*&
35728 A pointer to the last of the header lines.
35729
35730 .vitem &*const&~uschar&~*headers_charset*&
35731 The value of the &%headers_charset%& configuration option.
35732
35733 .vitem &*BOOL&~host_checking*&
35734 This variable is TRUE during a host checking session that is initiated by the
35735 &%-bh%& command line option.
35736
35737 .vitem &*uschar&~*interface_address*&
35738 The IP address of the interface that received the message, as a string. This
35739 is NULL for locally submitted messages.
35740
35741 .vitem &*int&~interface_port*&
35742 The port on which this message was received. When testing with the &%-bh%&
35743 command line option, the value of this variable is -1 unless a port has been
35744 specified via the &%-oMi%& option.
35745
35746 .vitem &*uschar&~*message_id*&
35747 This variable contains Exim's message id for the incoming message (the value of
35748 &$message_exim_id$&) as a zero-terminated string.
35749
35750 .vitem &*uschar&~*received_protocol*&
35751 The name of the protocol by which the message was received.
35752
35753 .vitem &*int&~recipients_count*&
35754 The number of accepted recipients.
35755
35756 .vitem &*recipient_item&~*recipients_list*&
35757 .cindex "recipient" "adding in local scan"
35758 .cindex "recipient" "removing in local scan"
35759 The list of accepted recipients, held in a vector of length
35760 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35761 can add additional recipients by calling &'receive_add_recipient()'& (see
35762 below). You can delete recipients by removing them from the vector and
35763 adjusting the value in &%recipients_count%&. In particular, by setting
35764 &%recipients_count%& to zero you remove all recipients. If you then return the
35765 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35766 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35767 and then call &'receive_add_recipient()'& as often as needed.
35768
35769 .vitem &*uschar&~*sender_address*&
35770 The envelope sender address. For bounce messages this is the empty string.
35771
35772 .vitem &*uschar&~*sender_host_address*&
35773 The IP address of the sending host, as a string. This is NULL for
35774 locally-submitted messages.
35775
35776 .vitem &*uschar&~*sender_host_authenticated*&
35777 The name of the authentication mechanism that was used, or NULL if the message
35778 was not received over an authenticated SMTP connection.
35779
35780 .vitem &*uschar&~*sender_host_name*&
35781 The name of the sending host, if known.
35782
35783 .vitem &*int&~sender_host_port*&
35784 The port on the sending host.
35785
35786 .vitem &*BOOL&~smtp_input*&
35787 This variable is TRUE for all SMTP input, including BSMTP.
35788
35789 .vitem &*BOOL&~smtp_batched_input*&
35790 This variable is TRUE for BSMTP input.
35791
35792 .vitem &*int&~store_pool*&
35793 The contents of this variable control which pool of memory is used for new
35794 requests. See section &<<SECTmemhanloc>>& for details.
35795 .endlist
35796
35797
35798 .section "Structure of header lines" "SECID209"
35799 The &%header_line%& structure contains the members listed below.
35800 You can add additional header lines by calling the &'header_add()'& function
35801 (see below). You can cause header lines to be ignored (deleted) by setting
35802 their type to *.
35803
35804
35805 .vlist
35806 .vitem &*struct&~header_line&~*next*&
35807 A pointer to the next header line, or NULL for the last line.
35808
35809 .vitem &*int&~type*&
35810 A code identifying certain headers that Exim recognizes. The codes are printing
35811 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35812 Notice in particular that any header line whose type is * is not transmitted
35813 with the message. This flagging is used for header lines that have been
35814 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35815 lines.) Effectively, * means &"deleted"&.
35816
35817 .vitem &*int&~slen*&
35818 The number of characters in the header line, including the terminating and any
35819 internal newlines.
35820
35821 .vitem &*uschar&~*text*&
35822 A pointer to the text of the header. It always ends with a newline, followed by
35823 a zero byte. Internal newlines are preserved.
35824 .endlist
35825
35826
35827
35828 .section "Structure of recipient items" "SECID210"
35829 The &%recipient_item%& structure contains these members:
35830
35831 .vlist
35832 .vitem &*uschar&~*address*&
35833 This is a pointer to the recipient address as it was received.
35834
35835 .vitem &*int&~pno*&
35836 This is used in later Exim processing when top level addresses are created by
35837 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35838 and must always contain -1 at this stage.
35839
35840 .vitem &*uschar&~*errors_to*&
35841 If this value is not NULL, bounce messages caused by failing to deliver to the
35842 recipient are sent to the address it contains. In other words, it overrides the
35843 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35844 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35845 an unqualified address, Exim qualifies it using the domain from
35846 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35847 is NULL for all recipients.
35848 .endlist
35849
35850
35851
35852 .section "Available Exim functions" "SECID211"
35853 .cindex "&[local_scan()]& function" "available Exim functions"
35854 The header &_local_scan.h_& gives you access to a number of Exim functions.
35855 These are the only ones that are guaranteed to be maintained from release to
35856 release:
35857
35858 .vlist
35859 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35860        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35861
35862 This function creates a child process that runs the command specified by
35863 &%argv%&. The environment for the process is specified by &%envp%&, which can
35864 be NULL if no environment variables are to be passed. A new umask is supplied
35865 for the process in &%newumask%&.
35866
35867 Pipes to the standard input and output of the new process are set up
35868 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35869 standard error is cloned to the standard output. If there are any file
35870 descriptors &"in the way"& in the new process, they are closed. If the final
35871 argument is TRUE, the new process is made into a process group leader.
35872
35873 The function returns the pid of the new process, or -1 if things go wrong.
35874
35875 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35876 This function waits for a child process to terminate, or for a timeout (in
35877 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35878 return value is as follows:
35879
35880 .ilist
35881 >= 0
35882
35883 The process terminated by a normal exit and the value is the process
35884 ending status.
35885
35886 .next
35887 < 0 and > &--256
35888
35889 The process was terminated by a signal and the value is the negation of the
35890 signal number.
35891
35892 .next
35893 &--256
35894
35895 The process timed out.
35896 .next
35897 &--257
35898
35899 The was some other error in wait(); &%errno%& is still set.
35900 .endlist
35901
35902 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35903 This function provide you with a means of submitting a new message to
35904 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35905 want, but this packages it all up for you.) The function creates a pipe,
35906 forks a subprocess that is running
35907 .code
35908 exim -t -oem -oi -f <>
35909 .endd
35910 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35911 that is connected to the standard input. The yield of the function is the PID
35912 of the subprocess. You can then write a message to the file descriptor, with
35913 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35914
35915 When you have finished, call &'child_close()'& to wait for the process to
35916 finish and to collect its ending status. A timeout value of zero is usually
35917 fine in this circumstance. Unless you have made a mistake with the recipient
35918 addresses, you should get a return code of zero.
35919
35920
35921 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35922        *sender_authentication)*&
35923 This function is a more sophisticated version of &'child_open()'&. The command
35924 that it runs is:
35925 .display
35926 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35927 .endd
35928 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35929
35930
35931 .vitem &*void&~debug_printf(char&~*,&~...)*&
35932 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35933 output is written to the standard error stream. If no debugging is selected,
35934 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35935 conditional on the &`local_scan`& debug selector by coding like this:
35936 .code
35937 if ((debug_selector & D_local_scan) != 0)
35938   debug_printf("xxx", ...);
35939 .endd
35940
35941 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35942 This is an interface to Exim's string expansion code. The return value is the
35943 expanded string, or NULL if there was an expansion failure.
35944 The C variable &%expand_string_message%& contains an error message after an
35945 expansion failure. If expansion does not change the string, the return value is
35946 the pointer to the input string. Otherwise, the return value points to a new
35947 block of memory that was obtained by a call to &'store_get()'&. See section
35948 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35949
35950 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35951 This function allows you to an add additional header line at the end of the
35952 existing ones. The first argument is the type, and should normally be a space
35953 character. The second argument is a format string and any number of
35954 substitution arguments as for &[sprintf()]&. You may include internal newlines
35955 if you want, and you must ensure that the string ends with a newline.
35956
35957 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35958         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35959 This function adds a new header line at a specified point in the header
35960 chain. The header itself is specified as for &'header_add()'&.
35961
35962 If &%name%& is NULL, the new header is added at the end of the chain if
35963 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35964 NULL, the header lines are searched for the first non-deleted header that
35965 matches the name. If one is found, the new header is added before it if
35966 &%after%& is false. If &%after%& is true, the new header is added after the
35967 found header and any adjacent subsequent ones with the same name (even if
35968 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35969 option controls where the header is added. If it is true, addition is at the
35970 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35971 headers, or at the top if there are no &'Received:'& headers, you could use
35972 .code
35973 header_add_at_position(TRUE, US"Received", TRUE,
35974   ' ', "X-xxx: ...");
35975 .endd
35976 Normally, there is always at least one non-deleted &'Received:'& header, but
35977 there may not be if &%received_header_text%& expands to an empty string.
35978
35979
35980 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35981 This function removes header lines. If &%occurrence%& is zero or negative, all
35982 occurrences of the header are removed. If occurrence is greater than zero, that
35983 particular instance of the header is removed. If no header(s) can be found that
35984 match the specification, the function does nothing.
35985
35986
35987 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35988         int&~length,&~BOOL&~notdel)*&"
35989 This function tests whether the given header has the given name. It is not just
35990 a string comparison, because white space is permitted between the name and the
35991 colon. If the &%notdel%& argument is true, a false return is forced for all
35992 &"deleted"& headers; otherwise they are not treated specially. For example:
35993 .code
35994 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35995 .endd
35996 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35997 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35998 This function base64-encodes a string, which is passed by address and length.
35999 The text may contain bytes of any value, including zero. The result is passed
36000 back in dynamic memory that is obtained by calling &'store_get()'&. It is
36001 zero-terminated.
36002
36003 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
36004 This function decodes a base64-encoded string. Its arguments are a
36005 zero-terminated base64-encoded string and the address of a variable that is set
36006 to point to the result, which is in dynamic memory. The length of the decoded
36007 string is the yield of the function. If the input is invalid base64 data, the
36008 yield is -1. A zero byte is added to the end of the output string to make it
36009 easy to interpret as a C string (assuming it contains no zeros of its own). The
36010 added zero byte is not included in the returned count.
36011
36012 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
36013 This function checks for a match in a domain list. Domains are always
36014 matched caselessly. The return value is one of the following:
36015 .itable none 0 0 2 15* left 85* left
36016 .irow &`OK`&    "match succeeded"
36017 .irow &`FAIL`&  "match failed"
36018 .irow &`DEFER`& "match deferred"
36019 .endtable
36020 DEFER is usually caused by some kind of lookup defer, such as the
36021 inability to contact a database.
36022
36023 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
36024         BOOL&~caseless)*&"
36025 This function checks for a match in a local part list. The third argument
36026 controls case-sensitivity. The return values are as for
36027 &'lss_match_domain()'&.
36028
36029 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
36030         BOOL&~caseless)*&"
36031 This function checks for a match in an address list. The third argument
36032 controls the case-sensitivity of the local part match. The domain is always
36033 matched caselessly. The return values are as for &'lss_match_domain()'&.
36034
36035 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
36036         uschar&~*list)*&"
36037 This function checks for a match in a host list. The most common usage is
36038 expected to be
36039 .code
36040 lss_match_host(sender_host_name, sender_host_address, ...)
36041 .endd
36042 .vindex "&$sender_host_address$&"
36043 An empty address field matches an empty item in the host list. If the host name
36044 is NULL, the name corresponding to &$sender_host_address$& is automatically
36045 looked up if a host name is required to match an item in the list. The return
36046 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
36047 returns ERROR in the case when it had to look up a host name, but the lookup
36048 failed.
36049
36050 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
36051         *format,&~...)*&"
36052 This function writes to Exim's log files. The first argument should be zero (it
36053 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
36054 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
36055 them. It specifies to which log or logs the message is written. The remaining
36056 arguments are a format and relevant insertion arguments. The string should not
36057 contain any newlines, not even at the end.
36058
36059
36060 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
36061 This function adds an additional recipient to the message. The first argument
36062 is the recipient address. If it is unqualified (has no domain), it is qualified
36063 with the &%qualify_recipient%& domain. The second argument must always be -1.
36064
36065 This function does not allow you to specify a private &%errors_to%& address (as
36066 described with the structure of &%recipient_item%& above), because it pre-dates
36067 the addition of that field to the structure. However, it is easy to add such a
36068 value afterwards. For example:
36069 .code
36070  receive_add_recipient(US"monitor@mydom.example", -1);
36071  recipients_list[recipients_count-1].errors_to =
36072    US"postmaster@mydom.example";
36073 .endd
36074
36075 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
36076 This is a convenience function to remove a named recipient from the list of
36077 recipients. It returns true if a recipient was removed, and false if no
36078 matching recipient could be found. The argument must be a complete email
36079 address.
36080 .endlist
36081
36082
36083 .cindex "RFC 2047"
36084 .vlist
36085 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
36086   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
36087 This function decodes strings that are encoded according to RFC 2047. Typically
36088 these are the contents of header lines. First, each &"encoded word"& is decoded
36089 from the Q or B encoding into a byte-string. Then, if provided with the name of
36090 a charset encoding, and if the &[iconv()]& function is available, an attempt is
36091 made  to translate the result to the named character set. If this fails, the
36092 binary string is returned with an error message.
36093
36094 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
36095 maximum MIME word length is enforced. The third argument is the target
36096 encoding, or NULL if no translation is wanted.
36097
36098 .cindex "binary zero" "in RFC 2047 decoding"
36099 .cindex "RFC 2047" "binary zero in"
36100 If a binary zero is encountered in the decoded string, it is replaced by the
36101 contents of the &%zeroval%& argument. For use with Exim headers, the value must
36102 not be 0 because header lines are handled as zero-terminated strings.
36103
36104 The function returns the result of processing the string, zero-terminated; if
36105 &%lenptr%& is not NULL, the length of the result is set in the variable to
36106 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
36107
36108 If an error is encountered, the function returns NULL and uses the &%error%&
36109 argument to return an error message. The variable pointed to by &%error%& is
36110 set to NULL if there is no error; it may be set non-NULL even when the function
36111 returns a non-NULL value if decoding was successful, but there was a problem
36112 with translation.
36113
36114
36115 .vitem &*int&~smtp_fflush(void)*&
36116 This function is used in conjunction with &'smtp_printf()'&, as described
36117 below.
36118
36119 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
36120 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
36121 output stream. You should use this function only when there is an SMTP output
36122 stream, that is, when the incoming message is being received via interactive
36123 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
36124 is FALSE. If you want to test for an incoming message from another host (as
36125 opposed to a local process that used the &%-bs%& command line option), you can
36126 test the value of &%sender_host_address%&, which is non-NULL when a remote host
36127 is involved.
36128
36129 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
36130 output function, so it can be used for all forms of SMTP connection.
36131
36132 The second argument is used to request that the data be buffered
36133 (when TRUE) or flushed (along with any previously buffered, when FALSE).
36134 This is advisory only, but likely to save on system-calls and packets
36135 sent when a sequence of calls to the function are made.
36136
36137 The argument was added in Exim version 4.90 - changing the API/ABI.
36138 Nobody noticed until 4.93 was imminent, at which point the
36139 ABI version number was incremented.
36140
36141 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
36142 must start with an appropriate response code: 550 if you are going to return
36143 LOCAL_SCAN_REJECT, 451 if you are going to return
36144 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
36145 initial lines of a multi-line response, the code must be followed by a hyphen
36146 to indicate that the line is not the final response line. You must also ensure
36147 that the lines you write terminate with CRLF. For example:
36148 .code
36149 smtp_printf("550-this is some extra info\r\n");
36150 return LOCAL_SCAN_REJECT;
36151 .endd
36152 Note that you can also create multi-line responses by including newlines in
36153 the data returned via the &%return_text%& argument. The added value of using
36154 &'smtp_printf()'& is that, for instance, you could introduce delays between
36155 multiple output lines.
36156
36157 The &'smtp_printf()'& function does not return any error indication, because it
36158 does not
36159 guarantee a flush of
36160 pending output, and therefore does not test
36161 the state of the stream. (In the main code of Exim, flushing and error
36162 detection is done when Exim is ready for the next SMTP input command.) If
36163 you want to flush the output and check for an error (for example, the
36164 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
36165 arguments. It flushes the output stream, and returns a non-zero value if there
36166 is an error.
36167
36168 .vitem &*void&~*store_get(int,BOOL)*&
36169 This function accesses Exim's internal store (memory) manager. It gets a new
36170 chunk of memory whose size is given by the first argument.
36171 The second argument should be given as TRUE if the memory will be used for
36172 data possibly coming from an attacker (eg. the message content),
36173 FALSE if it is locally-sourced.
36174 Exim bombs out if it ever
36175 runs out of memory. See the next section for a discussion of memory handling.
36176
36177 .vitem &*void&~*store_get_perm(int,BOOL)*&
36178 This function is like &'store_get()'&, but it always gets memory from the
36179 permanent pool. See the next section for a discussion of memory handling.
36180
36181 .vitem &*uschar&~*string_copy(uschar&~*string)*&
36182 See below.
36183
36184 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
36185 See below.
36186
36187 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
36188 These three functions create strings using Exim's dynamic memory facilities.
36189 The first makes a copy of an entire string. The second copies up to a maximum
36190 number of characters, indicated by the second argument. The third uses a format
36191 and insertion arguments to create a new string. In each case, the result is a
36192 pointer to a new string in the current memory pool. See the next section for
36193 more discussion.
36194 .endlist
36195
36196
36197
36198 .section "More about Exim's memory handling" "SECTmemhanloc"
36199 .cindex "&[local_scan()]& function" "memory handling"
36200 No function is provided for freeing memory, because that is never needed.
36201 The dynamic memory that Exim uses when receiving a message is automatically
36202 recycled if another message is received by the same process (this applies only
36203 to incoming SMTP connections &-- other input methods can supply only one
36204 message at a time). After receiving the last message, a reception process
36205 terminates.
36206
36207 Because it is recycled, the normal dynamic memory cannot be used for holding
36208 data that must be preserved over a number of incoming messages on the same SMTP
36209 connection. However, Exim in fact uses two pools of dynamic memory; the second
36210 one is not recycled, and can be used for this purpose.
36211
36212 If you want to allocate memory that remains available for subsequent messages
36213 in the same SMTP connection, you should set
36214 .code
36215 store_pool = POOL_PERM
36216 .endd
36217 before calling the function that does the allocation. There is no need to
36218 restore the value if you do not need to; however, if you do want to revert to
36219 the normal pool, you can either restore the previous value of &%store_pool%& or
36220 set it explicitly to POOL_MAIN.
36221
36222 The pool setting applies to all functions that get dynamic memory, including
36223 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36224 There is also a convenience function called &'store_get_perm()'& that gets a
36225 block of memory from the permanent pool while preserving the value of
36226 &%store_pool%&.
36227 .ecindex IIDlosca
36228
36229
36230
36231
36232 . ////////////////////////////////////////////////////////////////////////////
36233 . ////////////////////////////////////////////////////////////////////////////
36234
36235 .chapter "System-wide message filtering" "CHAPsystemfilter"
36236 .scindex IIDsysfil1 "filter" "system filter"
36237 .scindex IIDsysfil2 "filtering all mail"
36238 .scindex IIDsysfil3 "system filter"
36239 The previous chapters (on ACLs and the local scan function) describe checks
36240 that can be applied to messages before they are accepted by a host. There is
36241 also a mechanism for checking messages once they have been received, but before
36242 they are delivered. This is called the &'system filter'&.
36243
36244 The system filter operates in a similar manner to users' filter files, but it
36245 is run just once per message (however many recipients the message has).
36246 It should not normally be used as a substitute for routing, because &%deliver%&
36247 commands in a system router provide new envelope recipient addresses.
36248 The system filter must be an Exim filter. It cannot be a Sieve filter.
36249
36250 The system filter is run at the start of a delivery attempt, before any routing
36251 is done. If a message fails to be completely delivered at the first attempt,
36252 the system filter is run again at the start of every retry.
36253 If you want your filter to do something only once per message, you can make use
36254 .cindex retry condition
36255 of the &%first_delivery%& condition in an &%if%& command in the filter to
36256 prevent it happening on retries.
36257
36258 .vindex "&$domain$&"
36259 .vindex "&$local_part$&"
36260 &*Warning*&: Because the system filter runs just once, variables that are
36261 specific to individual recipient addresses, such as &$local_part$& and
36262 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36263 you want to run a centrally-specified filter for each recipient address
36264 independently, you can do so by setting up a suitable &(redirect)& router, as
36265 described in section &<<SECTperaddfil>>& below.
36266
36267
36268 .section "Specifying a system filter" "SECID212"
36269 .cindex "uid (user id)" "system filter"
36270 .cindex "gid (group id)" "system filter"
36271 The name of the file that contains the system filter must be specified by
36272 setting &%system_filter%&. If you want the filter to run under a uid and gid
36273 other than root, you must also set &%system_filter_user%& and
36274 &%system_filter_group%& as appropriate. For example:
36275 .code
36276 system_filter = /etc/mail/exim.filter
36277 system_filter_user = exim
36278 .endd
36279 If a system filter generates any deliveries directly to files or pipes (via the
36280 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36281 specified by setting &%system_filter_file_transport%& and
36282 &%system_filter_pipe_transport%&, respectively. Similarly,
36283 &%system_filter_reply_transport%& must be set to handle any messages generated
36284 by the &%reply%& command.
36285
36286
36287 .section "Testing a system filter" "SECID213"
36288 You can run simple tests of a system filter in the same way as for a user
36289 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36290 are permitted only in system filters are recognized.
36291
36292 If you want to test the combined effect of a system filter and a user filter,
36293 you can use both &%-bF%& and &%-bf%& on the same command line.
36294
36295
36296
36297 .section "Contents of a system filter" "SECID214"
36298 The language used to specify system filters is the same as for users' filter
36299 files. It is described in the separate end-user document &'Exim's interface to
36300 mail filtering'&. However, there are some additional features that are
36301 available only in system filters; these are described in subsequent sections.
36302 If they are encountered in a user's filter file or when testing with &%-bf%&,
36303 they cause errors.
36304
36305 .cindex "frozen messages" "manual thaw; testing in filter"
36306 There are two special conditions which, though available in users' filter
36307 files, are designed for use in system filters. The condition &%first_delivery%&
36308 is true only for the first attempt at delivering a message, and
36309 &%manually_thawed%& is true only if the message has been frozen, and
36310 subsequently thawed by an admin user. An explicit forced delivery counts as a
36311 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36312
36313 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36314 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36315 succeed, it will not be tried again.
36316 If you want Exim to retry an unseen delivery until it succeeds, you should
36317 arrange to set it up every time the filter runs.
36318
36319 When a system filter finishes running, the values of the variables &$n0$& &--
36320 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36321 users' filter files. Thus a system filter can, for example, set up &"scores"&
36322 to which users' filter files can refer.
36323
36324
36325
36326 .section "Additional variable for system filters" "SECID215"
36327 .vindex "&$recipients$&"
36328 The expansion variable &$recipients$&, containing a list of all the recipients
36329 of the message (separated by commas and white space), is available in system
36330 filters. It is not available in users' filters for privacy reasons.
36331
36332
36333
36334 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36335 .cindex "freezing messages"
36336 .cindex "message" "freezing"
36337 .cindex "message" "forced failure"
36338 .cindex "&%fail%&" "in system filter"
36339 .cindex "&%freeze%& in system filter"
36340 .cindex "&%defer%& in system filter"
36341 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36342 always available in system filters, but are not normally enabled in users'
36343 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36344 for the &(redirect)& router.) These commands can optionally be followed by the
36345 word &%text%& and a string containing an error message, for example:
36346 .code
36347 fail text "this message looks like spam to me"
36348 .endd
36349 The keyword &%text%& is optional if the next character is a double quote.
36350
36351 The &%defer%& command defers delivery of the original recipients of the
36352 message. The &%fail%& command causes all the original recipients to be failed,
36353 and a bounce message to be created. The &%freeze%& command suspends all
36354 delivery attempts for the original recipients. In all cases, any new deliveries
36355 that are specified by the filter are attempted as normal after the filter has
36356 run.
36357
36358 The &%freeze%& command is ignored if the message has been manually unfrozen and
36359 not manually frozen since. This means that automatic freezing by a system
36360 filter can be used as a way of checking out suspicious messages. If a message
36361 is found to be all right, manually unfreezing it allows it to be delivered.
36362
36363 .cindex "log" "&%fail%& command log line"
36364 .cindex "&%fail%&" "log line; reducing"
36365 The text given with a fail command is used as part of the bounce message as
36366 well as being written to the log. If the message is quite long, this can fill
36367 up a lot of log space when such failures are common. To reduce the size of the
36368 log message, Exim interprets the text in a special way if it starts with the
36369 two characters &`<<`& and contains &`>>`& later. The text between these two
36370 strings is written to the log, and the rest of the text is used in the bounce
36371 message. For example:
36372 .code
36373 fail "<<filter test 1>>Your message is rejected \
36374      because it contains attachments that we are \
36375      not prepared to receive."
36376 .endd
36377
36378 .cindex "loop" "caused by &%fail%&"
36379 Take great care with the &%fail%& command when basing the decision to fail on
36380 the contents of the message, because the bounce message will of course include
36381 the contents of the original message and will therefore trigger the &%fail%&
36382 command again (causing a mail loop) unless steps are taken to prevent this.
36383 Testing the &%error_message%& condition is one way to prevent this. You could
36384 use, for example
36385 .code
36386 if $message_body contains "this is spam" and not error_message
36387 then fail text "spam is not wanted here" endif
36388 .endd
36389 though of course that might let through unwanted bounce messages. The
36390 alternative is clever checking of the body and/or headers to detect bounces
36391 generated by the filter.
36392
36393 The interpretation of a system filter file ceases after a
36394 &%defer%&,
36395 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36396 set up earlier in the filter file are honoured, so you can use a sequence such
36397 as
36398 .code
36399 mail ...
36400 freeze
36401 .endd
36402 to send a specified message when the system filter is freezing (or deferring or
36403 failing) a message. The normal deliveries for the message do not, of course,
36404 take place.
36405
36406
36407
36408 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36409 .cindex "header lines" "adding; in system filter"
36410 .cindex "header lines" "removing; in system filter"
36411 .cindex "filter" "header lines; adding/removing"
36412 Two filter commands that are available only in system filters are:
36413 .code
36414 headers add <string>
36415 headers remove <string>
36416 .endd
36417 The argument for the &%headers add%& is a string that is expanded and then
36418 added to the end of the message's headers. It is the responsibility of the
36419 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36420 space is ignored, and if the string is otherwise empty, or if the expansion is
36421 forced to fail, the command has no effect.
36422
36423 You can use &"\n"& within the string, followed by white space, to specify
36424 continued header lines. More than one header may be added in one command by
36425 including &"\n"& within the string without any following white space. For
36426 example:
36427 .code
36428 headers add "X-header-1: ....\n  \
36429              continuation of X-header-1 ...\n\
36430              X-header-2: ...."
36431 .endd
36432 Note that the header line continuation white space after the first newline must
36433 be placed before the backslash that continues the input string, because white
36434 space after input continuations is ignored.
36435
36436 The argument for &%headers remove%& is a colon-separated list of header names.
36437 This command applies only to those headers that are stored with the message;
36438 those that are added at delivery time (such as &'Envelope-To:'& and
36439 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36440 header with the same name, they are all removed.
36441
36442 The &%headers%& command in a system filter makes an immediate change to the set
36443 of header lines that was received with the message (with possible additions
36444 from ACL processing). Subsequent commands in the system filter operate on the
36445 modified set, which also forms the basis for subsequent message delivery.
36446 Unless further modified during routing or transporting, this set of headers is
36447 used for all recipients of the message.
36448
36449 During routing and transporting, the variables that refer to the contents of
36450 header lines refer only to those lines that are in this set. Thus, header lines
36451 that are added by a system filter are visible to users' filter files and to all
36452 routers and transports. This contrasts with the manipulation of header lines by
36453 routers and transports, which is not immediate, but which instead is saved up
36454 until the message is actually being written (see section
36455 &<<SECTheadersaddrem>>&).
36456
36457 If the message is not delivered at the first attempt, header lines that were
36458 added by the system filter are stored with the message, and so are still
36459 present at the next delivery attempt. Header lines that were removed are still
36460 present, but marked &"deleted"& so that they are not transported with the
36461 message. For this reason, it is usual to make the &%headers%& command
36462 conditional on &%first_delivery%& so that the set of header lines is not
36463 modified more than once.
36464
36465 Because header modification in a system filter acts immediately, you have to
36466 use an indirect approach if you want to modify the contents of a header line.
36467 For example:
36468 .code
36469 headers add "Old-Subject: $h_subject:"
36470 headers remove "Subject"
36471 headers add "Subject: new subject (was: $h_old-subject:)"
36472 headers remove "Old-Subject"
36473 .endd
36474
36475
36476
36477 .section "Setting an errors address in a system filter" "SECID217"
36478 .cindex "envelope from"
36479 .cindex "envelope sender"
36480 In a system filter, if a &%deliver%& command is followed by
36481 .code
36482 errors_to <some address>
36483 .endd
36484 in order to change the envelope sender (and hence the error reporting) for that
36485 delivery, any address may be specified. (In a user filter, only the current
36486 user's address can be set.) For example, if some mail is being monitored, you
36487 might use
36488 .code
36489 unseen deliver monitor@spying.example errors_to root@local.example
36490 .endd
36491 to take a copy which would not be sent back to the normal error reporting
36492 address if its delivery failed.
36493
36494
36495
36496 .section "Per-address filtering" "SECTperaddfil"
36497 .vindex "&$domain_data$&"
36498 .vindex "&$local_part_data$&"
36499 In contrast to the system filter, which is run just once per message for each
36500 delivery attempt, it is also possible to set up a system-wide filtering
36501 operation that runs once for each recipient address. In this case, variables
36502 such as &$local_part_data$& and &$domain_data$& can be used,
36503 and indeed, the choice of filter file could be made dependent on them.
36504 This is an example of a router which implements such a filter:
36505 .code
36506 central_filter:
36507   check_local_user
36508   driver = redirect
36509   domains = +local_domains
36510   file = /central/filters/$local_part_data
36511   no_verify
36512   allow_filter
36513   allow_freeze
36514 .endd
36515 The filter is run in a separate process under its own uid. Therefore, either
36516 &%check_local_user%& must be set (as above), in which case the filter is run as
36517 the local user, or the &%user%& option must be used to specify which user to
36518 use. If both are set, &%user%& overrides.
36519
36520 Care should be taken to ensure that none of the commands in the filter file
36521 specify a significant delivery if the message is to go on to be delivered to
36522 its intended recipient. The router will not then claim to have dealt with the
36523 address, so it will be passed on to subsequent routers to be delivered in the
36524 normal way.
36525 .ecindex IIDsysfil1
36526 .ecindex IIDsysfil2
36527 .ecindex IIDsysfil3
36528
36529
36530
36531
36532
36533
36534 . ////////////////////////////////////////////////////////////////////////////
36535 . ////////////////////////////////////////////////////////////////////////////
36536
36537 .chapter "Message processing" "CHAPmsgproc"
36538 .scindex IIDmesproc "message" "general processing"
36539 Exim performs various transformations on the sender and recipient addresses of
36540 all messages that it handles, and also on the messages' header lines. Some of
36541 these are optional and configurable, while others always take place. All of
36542 this processing, except rewriting as a result of routing, and the addition or
36543 removal of header lines while delivering, happens when a message is received,
36544 before it is placed on Exim's queue.
36545
36546 Some of the automatic processing takes place by default only for
36547 &"locally-originated"& messages. This adjective is used to describe messages
36548 that are not received over TCP/IP, but instead are passed to an Exim process on
36549 its standard input. This includes the interactive &"local SMTP"& case that is
36550 set up by the &%-bs%& command line option.
36551
36552 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36553 or ::1) are not considered to be locally-originated. Exim does not treat the
36554 loopback interface specially in any way.
36555
36556 If you want the loopback interface to be treated specially, you must ensure
36557 that there are appropriate entries in your ACLs.
36558
36559
36560
36561
36562 .section "Submission mode for non-local messages" "SECTsubmodnon"
36563 .cindex "message" "submission"
36564 .cindex "submission mode"
36565 Processing that happens automatically for locally-originated messages (unless
36566 &%suppress_local_fixups%& is set) can also be requested for messages that are
36567 received over TCP/IP. The term &"submission mode"& is used to describe this
36568 state. Submission mode is set by the modifier
36569 .code
36570 control = submission
36571 .endd
36572 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36573 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36574 a local submission, and is normally used when the source of the message is
36575 known to be an MUA running on a client host (as opposed to an MTA). For
36576 example, to set submission mode for messages originating on the IPv4 loopback
36577 interface, you could include the following in the MAIL ACL:
36578 .code
36579 warn  hosts = 127.0.0.1
36580       control = submission
36581 .endd
36582 .cindex "&%sender_retain%& submission option"
36583 There are some options that can be used when setting submission mode. A slash
36584 is used to separate options. For example:
36585 .code
36586 control = submission/sender_retain
36587 .endd
36588 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36589 true and &%local_from_check%& false for the current incoming message. The first
36590 of these allows an existing &'Sender:'& header in the message to remain, and
36591 the second suppresses the check to ensure that &'From:'& matches the
36592 authenticated sender. With this setting, Exim still fixes up messages by adding
36593 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36594 attempt to check sender authenticity in header lines.
36595
36596 When &%sender_retain%& is not set, a submission mode setting may specify a
36597 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36598 example:
36599 .code
36600 control = submission/domain=some.domain
36601 .endd
36602 The domain may be empty. How this value is used is described in sections
36603 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36604 that allows you to specify the user's full name for inclusion in a created
36605 &'Sender:'& or &'From:'& header line. For example:
36606 .code
36607 accept authenticated = *
36608        control = submission/domain=wonderland.example/\
36609                             name=${lookup {$authenticated_id} \
36610                                    lsearch {/etc/exim/namelist}}
36611 .endd
36612 Because the name may contain any characters, including slashes, the &%name%&
36613 option must be given last. The remainder of the string is used as the name. For
36614 the example above, if &_/etc/exim/namelist_& contains:
36615 .code
36616 bigegg:  Humpty Dumpty
36617 .endd
36618 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36619 line would be:
36620 .code
36621 Sender: Humpty Dumpty <bigegg@wonderland.example>
36622 .endd
36623 .cindex "return path" "in submission mode"
36624 By default, submission mode forces the return path to the same address as is
36625 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36626 specified, the return path is also left unchanged.
36627
36628 &*Note*&: The changes caused by submission mode take effect after the predata
36629 ACL. This means that any sender checks performed before the fix-ups use the
36630 untrusted sender address specified by the user, not the trusted sender address
36631 specified by submission mode. Although this might be slightly unexpected, it
36632 does mean that you can configure ACL checks to spot that a user is trying to
36633 spoof another's address.
36634
36635 .section "Line endings" "SECTlineendings"
36636 .cindex "line endings"
36637 .cindex "carriage return"
36638 .cindex "linefeed"
36639 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36640 linefeed) is the line ending for messages transmitted over the Internet using
36641 SMTP over TCP/IP. However, within individual operating systems, different
36642 conventions are used. For example, Unix-like systems use just LF, but others
36643 use CRLF or just CR.
36644
36645 Exim was designed for Unix-like systems, and internally, it stores messages
36646 using the system's convention of a single LF as a line terminator. When
36647 receiving a message, all line endings are translated to this standard format.
36648 Originally, it was thought that programs that passed messages directly to an
36649 MTA within an operating system would use that system's convention. Experience
36650 has shown that this is not the case; for example, there are Unix applications
36651 that use CRLF in this circumstance. For this reason, and for compatibility with
36652 other MTAs, the way Exim handles line endings for all messages is now as
36653 follows:
36654
36655 .ilist
36656 CR is treated as a line ending; if it is immediately followed by LF, the LF
36657 is ignored.
36658 .next
36659 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36660 nor a local message in the state where a line containing only a dot is a
36661 terminator.
36662 .next
36663 If a bare CR is encountered within a header line, an extra space is added after
36664 the line terminator so as not to end the header line. The reasoning behind this
36665 is that bare CRs in header lines are most likely either to be mistakes, or
36666 people trying to play silly games.
36667 .next
36668 If the first header line received in a message ends with CRLF, a subsequent
36669 bare LF in a header line is treated in the same way as a bare CR in a header
36670 line and a bare LF in a body line is replaced with a space.
36671 .next
36672 If the first header line received in a message does not end with CRLF, a subsequent
36673 LF not preceded by CR is treated as a line ending.
36674 .endlist
36675
36676
36677
36678
36679
36680 .section "Unqualified addresses" "SECID218"
36681 .cindex "unqualified addresses"
36682 .cindex "address" "qualification"
36683 By default, Exim expects every envelope address it receives from an external
36684 host to be fully qualified. Unqualified addresses cause negative responses to
36685 SMTP commands. However, because SMTP is used as a means of transporting
36686 messages from MUAs running on personal workstations, there is sometimes a
36687 requirement to accept unqualified addresses from specific hosts or IP networks.
36688
36689 Exim has two options that separately control which hosts may send unqualified
36690 sender or recipient addresses in SMTP commands, namely
36691 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36692 cases, if an unqualified address is accepted, it is qualified by adding the
36693 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36694
36695 .oindex "&%qualify_domain%&"
36696 .oindex "&%qualify_recipient%&"
36697 Unqualified addresses in header lines are automatically qualified for messages
36698 that are locally originated, unless the &%-bnq%& option is given on the command
36699 line. For messages received over SMTP, unqualified addresses in header lines
36700 are qualified only if unqualified addresses are permitted in SMTP commands. In
36701 other words, such qualification is also controlled by
36702 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36703
36704
36705
36706
36707 .section "The UUCP From line" "SECID219"
36708 .cindex "&""From""& line"
36709 .cindex "UUCP" "&""From""& line"
36710 .cindex "sender" "address"
36711 .oindex "&%uucp_from_pattern%&"
36712 .oindex "&%uucp_from_sender%&"
36713 .cindex "envelope from"
36714 .cindex "envelope sender"
36715 .cindex "Sendmail compatibility" "&""From""& line"
36716 Messages that have come from UUCP (and some other applications) often begin
36717 with a line containing the envelope sender and a timestamp, following the word
36718 &"From"&. Examples of two common formats are:
36719 .code
36720 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36721 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36722 .endd
36723 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36724 Exim recognizes such lines at the start of messages that are submitted to it
36725 via the command line (that is, on the standard input). It does not recognize
36726 such lines in incoming SMTP messages, unless the sending host matches
36727 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36728 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36729 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36730 default value matches the two common cases shown above and puts the address
36731 that follows &"From"& into &$1$&.
36732
36733 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36734 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36735 a trusted user, the message's sender address is constructed by expanding the
36736 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36737 then parsed as an RFC 2822 address. If there is no domain, the local part is
36738 qualified with &%qualify_domain%& unless it is the empty string. However, if
36739 the command line &%-f%& option is used, it overrides the &"From"& line.
36740
36741 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36742 sender address is not changed. This is also the case for incoming SMTP messages
36743 that are permitted to contain &"From"& lines.
36744
36745 Only one &"From"& line is recognized. If there is more than one, the second is
36746 treated as a data line that starts the body of the message, as it is not valid
36747 as a header line. This also happens if a &"From"& line is present in an
36748 incoming SMTP message from a source that is not permitted to send them.
36749
36750
36751
36752 .section "Header lines"
36753 .subsection "Resent- header lines" SECID220
36754 .chindex Resent-
36755 RFC 2822 makes provision for sets of header lines starting with the string
36756 &`Resent-`& to be added to a message when it is resent by the original
36757 recipient to somebody else. These headers are &'Resent-Date:'&,
36758 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36759 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36760
36761 .blockquote
36762 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36763 processing of replies or other such automatic actions on messages.'&
36764 .endblockquote
36765
36766 This leaves things a bit vague as far as other processing actions such as
36767 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36768 follows:
36769
36770 .ilist
36771 A &'Resent-From:'& line that just contains the login id of the submitting user
36772 is automatically rewritten in the same way as &'From:'& (see below).
36773 .next
36774 If there's a rewriting rule for a particular header line, it is also applied to
36775 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36776 &'From:'& also rewrites &'Resent-From:'&.
36777 .next
36778 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36779 also removed.
36780 .next
36781 For a locally-submitted message,
36782 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36783 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36784 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36785 included in log lines in this case.
36786 .next
36787 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36788 &%Resent-%& header lines are present.
36789 .endlist
36790
36791
36792
36793
36794 .subsection Auto-Submitted: SECID221
36795 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36796 includes the header line:
36797 .code
36798 Auto-Submitted: auto-replied
36799 .endd
36800
36801 .subsection Bcc: SECID222
36802 .cindex "&'Bcc:'& header line"
36803 If Exim is called with the &%-t%& option, to take recipient addresses from a
36804 message's header, it removes any &'Bcc:'& header line that may exist (after
36805 extracting its addresses). If &%-t%& is not present on the command line, any
36806 existing &'Bcc:'& is not removed.
36807
36808
36809 .subsection Date: SECID223
36810 .cindex Date:
36811 If a locally-generated or submission-mode message has no &'Date:'& header line,
36812 Exim adds one, using the current date and time, unless the
36813 &%suppress_local_fixups%& control has been specified.
36814
36815 .subsection Delivery-date: SECID224
36816 .cindex "&'Delivery-date:'& header line"
36817 .oindex "&%delivery_date_remove%&"
36818 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36819 set. Exim can be configured to add them to the final delivery of messages. (See
36820 the generic &%delivery_date_add%& transport option.) They should not be present
36821 in messages in transit. If the &%delivery_date_remove%& configuration option is
36822 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36823 messages.
36824
36825
36826 .subsection Envelope-to: SECID225
36827 .chindex Envelope-to:
36828 .oindex "&%envelope_to_remove%&"
36829 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36830 Exim can be configured to add them to the final delivery of messages. (See the
36831 generic &%envelope_to_add%& transport option.) They should not be present in
36832 messages in transit. If the &%envelope_to_remove%& configuration option is set
36833 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36834 messages.
36835
36836
36837 .subsection From: SECTthefrohea
36838 .chindex From:
36839 .cindex "Sendmail compatibility" "&""From""& line"
36840 .cindex "message" "submission"
36841 .cindex "submission mode"
36842 If a submission-mode message does not contain a &'From:'& header line, Exim
36843 adds one if either of the following conditions is true:
36844
36845 .ilist
36846 The envelope sender address is not empty (that is, this is not a bounce
36847 message). The added header line copies the envelope sender address.
36848 .next
36849 .vindex "&$authenticated_id$&"
36850 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36851 .olist
36852 .vindex "&$qualify_domain$&"
36853 If no domain is specified by the submission control, the local part is
36854 &$authenticated_id$& and the domain is &$qualify_domain$&.
36855 .next
36856 If a non-empty domain is specified by the submission control, the local
36857 part is &$authenticated_id$&, and the domain is the specified domain.
36858 .next
36859 If an empty domain is specified by the submission control,
36860 &$authenticated_id$& is assumed to be the complete address.
36861 .endlist
36862 .endlist
36863
36864 A non-empty envelope sender takes precedence.
36865
36866 If a locally-generated incoming message does not contain a &'From:'& header
36867 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36868 containing the sender's address. The calling user's login name and full name
36869 are used to construct the address, as described in section &<<SECTconstr>>&.
36870 They are obtained from the password data by calling &[getpwuid()]& (but see the
36871 &%unknown_login%& configuration option). The address is qualified with
36872 &%qualify_domain%&.
36873
36874 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36875 &'From:'& header line containing just the unqualified login name of the calling
36876 user, this is replaced by an address containing the user's login name and full
36877 name as described in section &<<SECTconstr>>&.
36878
36879
36880 .subsection Message-ID: SECID226
36881 .chindex Message-ID:
36882 .cindex "message" "submission"
36883 .oindex "&%message_id_header_text%&"
36884 If a locally-generated or submission-mode incoming message does not contain a
36885 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36886 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36887 to the message. If there are any &'Resent-:'& headers in the message, it
36888 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36889 message id, preceded by the letter E to ensure it starts with a letter, and
36890 followed by @ and the primary host name. Additional information can be included
36891 in this header line by setting the &%message_id_header_text%& and/or
36892 &%message_id_header_domain%& options.
36893
36894
36895 .subsection Received: SECID227
36896 .chindex Received:
36897 A &'Received:'& header line is added at the start of every message. The
36898 contents are defined by the &%received_header_text%& configuration option, and
36899 Exim automatically adds a semicolon and a timestamp to the configured string.
36900
36901 The &'Received:'& header is generated as soon as the message's header lines
36902 have been received. At this stage, the timestamp in the &'Received:'& header
36903 line is the time that the message started to be received. This is the value
36904 that is seen by the DATA ACL and by the &[local_scan()]& function.
36905
36906 Once a message is accepted, the timestamp in the &'Received:'& header line is
36907 changed to the time of acceptance, which is (apart from a small delay while the
36908 -H spool file is written) the earliest time at which delivery could start.
36909
36910
36911 .subsection References: SECID228
36912 .chindex References:
36913 Messages created by the &(autoreply)& transport include a &'References:'&
36914 header line. This is constructed according to the rules that are described in
36915 section 3.64 of RFC 2822 (which states that replies should contain such a
36916 header line), and section 3.14 of RFC 3834 (which states that automatic
36917 responses are not different in this respect). However, because some mail
36918 processing software does not cope well with very long header lines, no more
36919 than 12 message IDs are copied from the &'References:'& header line in the
36920 incoming message. If there are more than 12, the first one and then the final
36921 11 are copied, before adding the message ID of the incoming message.
36922
36923
36924
36925 .subsection Return-path: SECID229
36926 .chindex Return-path:
36927 .oindex "&%return_path_remove%&"
36928 &'Return-path:'& header lines are defined as something an MTA may insert when
36929 it does the final delivery of messages. (See the generic &%return_path_add%&
36930 transport option.) Therefore, they should not be present in messages in
36931 transit. If the &%return_path_remove%& configuration option is set (the
36932 default), Exim removes &'Return-path:'& header lines from incoming messages.
36933
36934
36935
36936 .subsection Sender: SECTthesenhea
36937 .cindex "&'Sender:'& header line"
36938 .cindex "message" "submission"
36939 .chindex Sender:
36940 For a locally-originated message from an untrusted user, Exim may remove an
36941 existing &'Sender:'& header line, and it may add a new one. You can modify
36942 these actions by setting the &%local_sender_retain%& option true, the
36943 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36944 control setting.
36945
36946 When a local message is received from an untrusted user and
36947 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36948 control has not been set, a check is made to see if the address given in the
36949 &'From:'& header line is the correct (local) sender of the message. The address
36950 that is expected has the login name as the local part and the value of
36951 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36952 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36953 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36954 line is added to the message.
36955
36956 If you set &%local_from_check%& false, this checking does not occur. However,
36957 the removal of an existing &'Sender:'& line still happens, unless you also set
36958 &%local_sender_retain%& to be true. It is not possible to set both of these
36959 options true at the same time.
36960
36961 .cindex "submission mode"
36962 By default, no processing of &'Sender:'& header lines is done for messages
36963 received over TCP/IP or for messages submitted by trusted users. However, when
36964 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36965 not specified on the submission control, the following processing takes place:
36966
36967 .vindex "&$authenticated_id$&"
36968 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36969 authenticated, and &$authenticated_id$& is not empty, a sender address is
36970 created as follows:
36971
36972 .ilist
36973 .vindex "&$qualify_domain$&"
36974 If no domain is specified by the submission control, the local part is
36975 &$authenticated_id$& and the domain is &$qualify_domain$&.
36976 .next
36977 If a non-empty domain is specified by the submission control, the local part
36978 is &$authenticated_id$&, and the domain is the specified domain.
36979 .next
36980 If an empty domain is specified by the submission control,
36981 &$authenticated_id$& is assumed to be the complete address.
36982 .endlist
36983
36984 This address is compared with the address in the &'From:'& header line. If they
36985 are different, a &'Sender:'& header line containing the created address is
36986 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36987 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36988
36989 .cindex "return path" "created from &'Sender:'&"
36990 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36991 the message (the envelope sender address) is changed to be the same address,
36992 except in the case of submission mode when &%sender_retain%& is specified.
36993
36994
36995
36996 .section "Adding and removing header lines in routers and transports" &&&
36997          "SECTheadersaddrem"
36998 .cindex "header lines" "adding; in router or transport"
36999 .cindex "header lines" "removing; in router or transport"
37000 When a message is delivered, the addition and removal of header lines can be
37001 specified in a system filter, or on any of the routers and transports that
37002 process the message. Section &<<SECTaddremheasys>>& contains details about
37003 modifying headers in a system filter. Header lines can also be added in an ACL
37004 as a message is received (see section &<<SECTaddheadacl>>&).
37005
37006 In contrast to what happens in a system filter, header modifications that are
37007 specified on routers and transports apply only to the particular recipient
37008 addresses that are being processed by those routers and transports. These
37009 changes do not actually take place until a copy of the message is being
37010 transported. Therefore, they do not affect the basic set of header lines, and
37011 they do not affect the values of the variables that refer to header lines.
37012
37013 &*Note*&: In particular, this means that any expansions in the configuration of
37014 the transport cannot refer to the modified header lines, because such
37015 expansions all occur before the message is actually transported.
37016
37017 For both routers and transports, the argument of a &%headers_add%&
37018 option must be in the form of one or more RFC 2822 header lines, separated by
37019 newlines (coded as &"\n"&). For example:
37020 .code
37021 headers_add = X-added-header: added by $primary_hostname\n\
37022               X-added-second: another added header line
37023 .endd
37024 Exim does not check the syntax of these added header lines.
37025
37026 Multiple &%headers_add%& options for a single router or transport can be
37027 specified; the values will append to a single list of header lines.
37028 Each header-line is separately expanded.
37029
37030 The argument of a &%headers_remove%& option must consist of a colon-separated
37031 list of header names. This is confusing, because header names themselves are
37032 often terminated by colons. In this case, the colons are the list separators,
37033 not part of the names. For example:
37034 .code
37035 headers_remove = return-receipt-to:acknowledge-to
37036 .endd
37037
37038 Multiple &%headers_remove%& options for a single router or transport can be
37039 specified; the arguments will append to a single header-names list.
37040 Each item is separately expanded.
37041 Note that colons in complex expansions which are used to
37042 form all or part of a &%headers_remove%& list
37043 will act as list separators.
37044
37045 When &%headers_add%& or &%headers_remove%& is specified on a router,
37046 items are expanded at routing time,
37047 and then associated with all addresses that are
37048 accepted by that router, and also with any new addresses that it generates. If
37049 an address passes through several routers as a result of aliasing or
37050 forwarding, the changes are cumulative.
37051
37052 .oindex "&%unseen%&"
37053 However, this does not apply to multiple routers that result from the use of
37054 the &%unseen%& option. Any header modifications that were specified by the
37055 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
37056
37057 Addresses that end up with different &%headers_add%& or &%headers_remove%&
37058 settings cannot be delivered together in a batch, so a transport is always
37059 dealing with a set of addresses that have the same header-processing
37060 requirements.
37061
37062 The transport starts by writing the original set of header lines that arrived
37063 with the message, possibly modified by the system filter. As it writes out
37064 these lines, it consults the list of header names that were attached to the
37065 recipient address(es) by &%headers_remove%& options in routers, and it also
37066 consults the transport's own &%headers_remove%& option. Header lines whose
37067 names are on either of these lists are not written out. If there are multiple
37068 instances of any listed header, they are all skipped.
37069
37070 After the remaining original header lines have been written, new header
37071 lines that were specified by routers' &%headers_add%& options are written, in
37072 the order in which they were attached to the address. These are followed by any
37073 header lines specified by the transport's &%headers_add%& option.
37074
37075 This way of handling header line modifications in routers and transports has
37076 the following consequences:
37077
37078 .ilist
37079 The original set of header lines, possibly modified by the system filter,
37080 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
37081 to it, at all times.
37082 .next
37083 Header lines that are added by a router's
37084 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
37085 expansion syntax in subsequent routers or the transport.
37086 .next
37087 Conversely, header lines that are specified for removal by &%headers_remove%&
37088 in a router remain visible to subsequent routers and the transport.
37089 .next
37090 Headers added to an address by &%headers_add%& in a router cannot be removed by
37091 a later router or by a transport.
37092 .next
37093 An added header can refer to the contents of an original header that is to be
37094 removed, even it has the same name as the added header. For example:
37095 .code
37096 headers_remove = subject
37097 headers_add = Subject: new subject (was: $h_subject:)
37098 .endd
37099 .endlist
37100
37101 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
37102 for a &(redirect)& router that has the &%one_time%& option set.
37103
37104
37105
37106
37107
37108 .section "Constructed addresses" "SECTconstr"
37109 .cindex "address" "constructed"
37110 .cindex "constructed address"
37111 When Exim constructs a sender address for a locally-generated message, it uses
37112 the form
37113 .display
37114 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
37115 .endd
37116 For example:
37117 .code
37118 Zaphod Beeblebrox <zaphod@end.univ.example>
37119 .endd
37120 The user name is obtained from the &%-F%& command line option if set, or
37121 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
37122 &"gecos"& field from the password entry. If the &"gecos"& field contains an
37123 ampersand character, this is replaced by the login name with the first letter
37124 upper cased, as is conventional in a number of operating systems. See the
37125 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
37126 The &%unknown_username%& option can be used to specify user names in cases when
37127 there is no password file entry.
37128
37129 .cindex "RFC 2047"
37130 In all cases, the user name is made to conform to RFC 2822 by quoting all or
37131 parts of it if necessary. In addition, if it contains any non-printing
37132 characters, it is encoded as described in RFC 2047, which defines a way of
37133 including non-ASCII characters in header lines. The value of the
37134 &%headers_charset%& option specifies the name of the encoding that is used (the
37135 characters are assumed to be in this encoding). The setting of
37136 &%print_topbitchars%& controls whether characters with the top bit set (that
37137 is, with codes greater than 127) count as printing characters or not.
37138
37139
37140
37141 .section "Case of local parts" "SECID230"
37142 .cindex "case of local parts"
37143 .cindex "local part" "case of"
37144 RFC 2822 states that the case of letters in the local parts of addresses cannot
37145 be assumed to be non-significant. Exim preserves the case of local parts of
37146 addresses, but by default it uses a lower-cased form when it is routing,
37147 because on most Unix systems, usernames are in lower case and case-insensitive
37148 routing is required. However, any particular router can be made to use the
37149 original case for local parts by setting the &%caseful_local_part%& generic
37150 router option.
37151
37152 .cindex "mixed-case login names"
37153 If you must have mixed-case user names on your system, the best way to proceed,
37154 assuming you want case-independent handling of incoming email, is to set up
37155 your first router to convert incoming local parts in your domains to the
37156 correct case by means of a file lookup. For example:
37157 .code
37158 correct_case:
37159   driver = redirect
37160   domains = +local_domains
37161   data = ${lookup{$local_part}cdb\
37162               {/etc/usercased.cdb}{$value}fail}\
37163               @$domain
37164 .endd
37165 For this router, the local part is forced to lower case by the default action
37166 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
37167 up a new local part in the correct case. If you then set &%caseful_local_part%&
37168 on any subsequent routers which process your domains, they will operate on
37169 local parts with the correct case in a case-sensitive manner.
37170
37171
37172
37173 .section "Dots in local parts" "SECID231"
37174 .cindex "dot" "in local part"
37175 .cindex "local part" "dots in"
37176 RFC 2822 forbids empty components in local parts. That is, an unquoted local
37177 part may not begin or end with a dot, nor have two consecutive dots in the
37178 middle. However, it seems that many MTAs do not enforce this, so Exim permits
37179 empty components for compatibility.
37180
37181
37182
37183 .section "Rewriting addresses" "SECID232"
37184 .cindex "rewriting" "addresses"
37185 Rewriting of sender and recipient addresses, and addresses in headers, can
37186 happen automatically, or as the result of configuration options, as described
37187 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
37188 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
37189
37190 Automatic rewriting includes qualification, as mentioned above. The other case
37191 in which it can happen is when an incomplete non-local domain is given. The
37192 routing process may cause this to be expanded into the full domain name. For
37193 example, a header such as
37194 .code
37195 To: hare@teaparty
37196 .endd
37197 might get rewritten as
37198 .code
37199 To: hare@teaparty.wonderland.fict.example
37200 .endd
37201 Rewriting as a result of routing is the one kind of message processing that
37202 does not happen at input time, as it cannot be done until the address has
37203 been routed.
37204
37205 Strictly, one should not do &'any'& deliveries of a message until all its
37206 addresses have been routed, in case any of the headers get changed as a
37207 result of routing. However, doing this in practice would hold up many
37208 deliveries for unreasonable amounts of time, just because one address could not
37209 immediately be routed. Exim therefore does not delay other deliveries when
37210 routing of one or more addresses is deferred.
37211 .ecindex IIDmesproc
37212
37213
37214
37215 . ////////////////////////////////////////////////////////////////////////////
37216 . ////////////////////////////////////////////////////////////////////////////
37217
37218 .chapter "SMTP processing" "CHAPSMTP"
37219 .scindex IIDsmtpproc1 "SMTP" "processing details"
37220 .scindex IIDsmtpproc2 "LMTP" "processing details"
37221 Exim supports a number of different ways of using the SMTP protocol, and its
37222 LMTP variant, which is an interactive protocol for transferring messages into a
37223 closed mail store application. This chapter contains details of how SMTP is
37224 processed. For incoming mail, the following are available:
37225
37226 .ilist
37227 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37228 .next
37229 SMTP over the standard input and output (the &%-bs%& option);
37230 .next
37231 Batched SMTP on the standard input (the &%-bS%& option).
37232 .endlist
37233
37234 For mail delivery, the following are available:
37235
37236 .ilist
37237 SMTP over TCP/IP (the &(smtp)& transport);
37238 .next
37239 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37240 &"lmtp"&);
37241 .next
37242 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37243 transport);
37244 .next
37245 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37246 the &%use_bsmtp%& option set).
37247 .endlist
37248
37249 &'Batched SMTP'& is the name for a process in which batches of messages are
37250 stored in or read from files (or pipes), in a format in which SMTP commands are
37251 used to contain the envelope information.
37252
37253
37254
37255 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37256 .cindex "SMTP" "outgoing over TCP/IP"
37257 .cindex "outgoing SMTP over TCP/IP"
37258 .cindex "LMTP" "over TCP/IP"
37259 .cindex "outgoing LMTP over TCP/IP"
37260 .cindex "EHLO"
37261 .cindex "HELO"
37262 .cindex "SIZE" "option on MAIL command"
37263 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37264 The &%protocol%& option selects which protocol is to be used, but the actual
37265 processing is the same in both cases.
37266
37267 .cindex "ESMTP extensions" SIZE
37268 If, in response to its EHLO command, Exim is told that the SIZE
37269 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37270 command. The value of <&'n'&> is the message size plus the value of the
37271 &%size_addition%& option (default 1024) to allow for additions to the message
37272 such as per-transport header lines, or changes made in a
37273 .cindex "transport" "filter"
37274 .cindex "filter" "transport filter"
37275 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37276 suppressed.
37277
37278 If the remote server advertises support for PIPELINING, Exim uses the
37279 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37280 required for the transaction.
37281
37282 If the remote server advertises support for the STARTTLS command, and Exim
37283 was built to support TLS encryption, it tries to start a TLS session unless the
37284 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37285 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37286 is called for verification.
37287
37288 If the remote server advertises support for the AUTH command, Exim scans
37289 the authenticators configuration for any suitable client settings, as described
37290 in chapter &<<CHAPSMTPAUTH>>&.
37291
37292 .cindex "carriage return"
37293 .cindex "linefeed"
37294 Responses from the remote host are supposed to be terminated by CR followed by
37295 LF. However, there are known to be hosts that do not send CR characters, so in
37296 order to be able to interwork with such hosts, Exim treats LF on its own as a
37297 line terminator.
37298
37299 If a message contains a number of different addresses, all those with the same
37300 characteristics (for example, the same envelope sender) that resolve to the
37301 same set of hosts, in the same order, are sent in a single SMTP transaction,
37302 even if they are for different domains, unless there are more than the setting
37303 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37304 they are split into groups containing no more than &%max_rcpt%&s addresses
37305 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37306 in parallel sessions. The order of hosts with identical MX values is not
37307 significant when checking whether addresses can be batched in this way.
37308
37309 When the &(smtp)& transport suffers a temporary failure that is not
37310 message-related, Exim updates its transport-specific database, which contains
37311 records indexed by host name that remember which messages are waiting for each
37312 particular host. It also updates the retry database with new retry times.
37313
37314 .cindex "hints database" "retry keys"
37315 Exim's retry hints are based on host name plus IP address, so if one address of
37316 a multi-homed host is broken, it will soon be skipped most of the time.
37317 See the next section for more detail about error handling.
37318
37319 .cindex "SMTP" "passed connection"
37320 .cindex "SMTP" "batching over TCP/IP"
37321 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37322 looks in the hints database for the transport to see if there are any queued
37323 messages waiting for the host to which it is connected. If it finds one, it
37324 creates a new Exim process using the &%-MC%& option (which can only be used by
37325 a process running as root or the Exim user) and passes the TCP/IP socket to it
37326 so that it can deliver another message using the same socket. The new process
37327 does only those deliveries that are routed to the connected host, and may in
37328 turn pass the socket on to a third process, and so on.
37329
37330 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37331 limit the number of messages sent down a single TCP/IP connection.
37332
37333 .cindex "asterisk" "after IP address"
37334 The second and subsequent messages delivered down an existing connection are
37335 identified in the main log by the addition of an asterisk after the closing
37336 square bracket of the IP address.
37337
37338
37339
37340
37341 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37342 .cindex "error" "in outgoing SMTP"
37343 .cindex "SMTP" "errors in outgoing"
37344 .cindex "host" "error"
37345 Three different kinds of error are recognized for outgoing SMTP: host errors,
37346 message errors, and recipient errors.
37347
37348 .vlist
37349 .vitem "&*Host errors*&"
37350 A host error is not associated with a particular message or with a
37351 particular recipient of a message. The host errors are:
37352
37353 .ilist
37354 Connection refused or timed out,
37355 .next
37356 Any error response code on connection,
37357 .next
37358 Any error response code to EHLO or HELO,
37359 .next
37360 Loss of connection at any time, except after &"."&,
37361 .next
37362 I/O errors at any time,
37363 .next
37364 Timeouts during the session, other than in response to MAIL, RCPT or
37365 the &"."& at the end of the data.
37366 .endlist ilist
37367
37368 For a host error, a permanent error response on connection, or in response to
37369 EHLO, causes all addresses routed to the host to be failed. Any other host
37370 error causes all addresses to be deferred, and retry data to be created for the
37371 host. It is not tried again, for any message, until its retry time arrives. If
37372 the current set of addresses are not all delivered in this run (to some
37373 alternative host), the message is added to the list of those waiting for this
37374 host, so if it is still undelivered when a subsequent successful delivery is
37375 made to the host, it will be sent down the same SMTP connection.
37376
37377 .vitem "&*Message errors*&"
37378 .cindex "message" "error"
37379 A message error is associated with a particular message when sent to a
37380 particular host, but not with a particular recipient of the message. The
37381 message errors are:
37382
37383 .ilist
37384 Any error response code to MAIL, DATA, or the &"."& that terminates
37385 the data,
37386 .next
37387 Timeout after MAIL,
37388 .next
37389 Timeout or loss of connection after the &"."& that terminates the data. A
37390 timeout after the DATA command itself is treated as a host error, as is loss of
37391 connection at any other time.
37392 .endlist ilist
37393
37394 For a message error, a permanent error response (5&'xx'&) causes all addresses
37395 to be failed, and a delivery error report to be returned to the sender. A
37396 temporary error response (4&'xx'&), or one of the timeouts, causes all
37397 addresses to be deferred. Retry data is not created for the host, but instead,
37398 a retry record for the combination of host plus message id is created. The
37399 message is not added to the list of those waiting for this host. This ensures
37400 that the failing message will not be sent to this host again until the retry
37401 time arrives. However, other messages that are routed to the host are not
37402 affected, so if it is some property of the message that is causing the error,
37403 it will not stop the delivery of other mail.
37404
37405 If the remote host specified support for the SIZE parameter in its response
37406 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37407 over-large message will cause a message error because the error arrives as a
37408 response to MAIL.
37409
37410 .vitem "&*Recipient errors*&"
37411 .cindex "recipient" "error"
37412 A recipient error is associated with a particular recipient of a message. The
37413 recipient errors are:
37414
37415 .ilist
37416 Any error response to RCPT,
37417 .next
37418 Timeout after RCPT.
37419 .endlist
37420
37421 For a recipient error, a permanent error response (5&'xx'&) causes the
37422 recipient address to be failed, and a bounce message to be returned to the
37423 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37424 address to be deferred, and routing retry data to be created for it. This is
37425 used to delay processing of the address in subsequent queue runs, until its
37426 routing retry time arrives. This applies to all messages, but because it
37427 operates only in queue runs, one attempt will be made to deliver a new message
37428 to the failing address before the delay starts to operate. This ensures that,
37429 if the failure is really related to the message rather than the recipient
37430 (&"message too big for this recipient"& is a possible example), other messages
37431 have a chance of getting delivered. If a delivery to the address does succeed,
37432 the retry information gets cleared, so all stuck messages get tried again, and
37433 the retry clock is reset.
37434
37435 The message is not added to the list of those waiting for this host. Use of the
37436 host for other messages is unaffected, and except in the case of a timeout,
37437 other recipients are processed independently, and may be successfully delivered
37438 in the current SMTP session. After a timeout it is of course impossible to
37439 proceed with the session, so all addresses get deferred. However, those other
37440 than the one that failed do not suffer any subsequent retry delays. Therefore,
37441 if one recipient is causing trouble, the others have a chance of getting
37442 through when a subsequent delivery attempt occurs before the failing
37443 recipient's retry time.
37444 .endlist
37445
37446 In all cases, if there are other hosts (or IP addresses) available for the
37447 current set of addresses (for example, from multiple MX records), they are
37448 tried in this run for any undelivered addresses, subject of course to their
37449 own retry data. In other words, recipient error retry data does not take effect
37450 until the next delivery attempt.
37451
37452 Some hosts have been observed to give temporary error responses to every
37453 MAIL command at certain times (&"insufficient space"& has been seen). It
37454 would be nice if such circumstances could be recognized, and defer data for the
37455 host itself created, but this is not possible within the current Exim design.
37456 What actually happens is that retry data for every (host, message) combination
37457 is created.
37458
37459 The reason that timeouts after MAIL and RCPT are treated specially is that
37460 these can sometimes arise as a result of the remote host's verification
37461 procedures. Exim makes this assumption, and treats them as if a temporary error
37462 response had been received. A timeout after &"."& is treated specially because
37463 it is known that some broken implementations fail to recognize the end of the
37464 message if the last character of the last line is a binary zero. Thus, it is
37465 helpful to treat this case as a message error.
37466
37467 Timeouts at other times are treated as host errors, assuming a problem with the
37468 host, or the connection to it. If a timeout after MAIL, RCPT,
37469 or &"."& is really a connection problem, the assumption is that at the next try
37470 the timeout is likely to occur at some other point in the dialogue, causing it
37471 then to be treated as a host error.
37472
37473 There is experimental evidence that some MTAs drop the connection after the
37474 terminating &"."& if they do not like the contents of the message for some
37475 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37476 should be given. That is why Exim treats this case as a message rather than a
37477 host error, in order not to delay other messages to the same host.
37478
37479
37480
37481
37482 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37483 .cindex "SMTP" "incoming over TCP/IP"
37484 .cindex "incoming SMTP over TCP/IP"
37485 .cindex "inetd"
37486 .cindex "daemon"
37487 Incoming SMTP messages can be accepted in one of two ways: by running a
37488 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37489 &_/etc/inetd.conf_& should be like this:
37490 .code
37491 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37492 .endd
37493 Exim distinguishes between this case and the case of a locally running user
37494 agent using the &%-bs%& option by checking whether or not the standard input is
37495 a socket. When it is, either the port must be privileged (less than 1024), or
37496 the caller must be root or the Exim user. If any other user passes a socket
37497 with an unprivileged port number, Exim prints a message on the standard error
37498 stream and exits with an error code.
37499
37500 By default, Exim does not make a log entry when a remote host connects or
37501 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37502 unexpected. It can be made to write such log entries by setting the
37503 &%smtp_connection%& log selector.
37504
37505 .cindex "carriage return"
37506 .cindex "linefeed"
37507 Commands from the remote host are supposed to be terminated by CR followed by
37508 LF. However, there are known to be hosts that do not send CR characters. In
37509 order to be able to interwork with such hosts, Exim treats LF on its own as a
37510 line terminator.
37511 Furthermore, because common code is used for receiving messages from all
37512 sources, a CR on its own is also interpreted as a line terminator. However, the
37513 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37514
37515 .cindex "EHLO" "invalid data"
37516 .cindex "HELO" "invalid data"
37517 One area that sometimes gives rise to problems concerns the EHLO or
37518 HELO commands. Some clients send syntactically invalid versions of these
37519 commands, which Exim rejects by default. (This is nothing to do with verifying
37520 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37521 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37522 match the broken hosts that send invalid commands.
37523
37524 .cindex "SIZE option on MAIL command"
37525 .cindex "MAIL" "SIZE option"
37526 The amount of disk space available is checked whenever SIZE is received on
37527 a MAIL command, independently of whether &%message_size_limit%& or
37528 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37529 false. A temporary error is given if there is not enough space. If
37530 &%check_spool_space%& is set, the check is for that amount of space plus the
37531 value given with SIZE, that is, it checks that the addition of the incoming
37532 message will not reduce the space below the threshold.
37533
37534 When a message is successfully received, Exim includes the local message id in
37535 its response to the final &"."& that terminates the data. If the remote host
37536 logs this text it can help with tracing what has happened to a message.
37537
37538 The Exim daemon can limit the number of simultaneous incoming connections it is
37539 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37540 number of simultaneous incoming connections from a single remote host (see the
37541 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37542 rejected using the SMTP temporary error code 421.
37543
37544 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37545 subprocess has finished, as this can get lost at busy times. Instead, it looks
37546 for completed subprocesses every time it wakes up. Provided there are other
37547 things happening (new incoming calls, starts of queue runs), completed
37548 processes will be noticed and tidied away. On very quiet systems you may
37549 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37550 it will be noticed when the daemon next wakes up.
37551
37552 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37553 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37554 high system load &-- for details see the &%smtp_accept_reserve%&,
37555 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37556 applies in both the daemon and &'inetd'& cases.
37557
37558 Exim normally starts a delivery process for each message received, though this
37559 can be varied by means of the &%-odq%& command line option and the
37560 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37561 number of simultaneously running delivery processes started in this way from
37562 SMTP input can be limited by the &%smtp_accept_queue%& and
37563 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37564 subsequently received messages are just put on the input queue without starting
37565 a delivery process.
37566
37567 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37568 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37569 started up from the &'inetd'& daemon, because in that case each connection is
37570 handled by an entirely independent Exim process. Control by load average is,
37571 however, available with &'inetd'&.
37572
37573 Exim can be configured to verify addresses in incoming SMTP commands as they
37574 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37575 to rewrite addresses at this time &-- before any syntax checking is done. See
37576 section &<<SSECTrewriteS>>&.
37577
37578 Exim can also be configured to limit the rate at which a client host submits
37579 MAIL and RCPT commands in a single SMTP session. See the
37580 &%smtp_ratelimit_hosts%& option.
37581
37582
37583
37584 .subsection "Unrecognized SMTP commands" SECID234
37585 .cindex "SMTP" "unrecognized commands"
37586 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37587 commands during a single SMTP connection, it drops the connection after sending
37588 the error response to the last command. The default value for
37589 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37590 abuse that subvert web servers into making connections to SMTP ports; in these
37591 circumstances, a number of non-SMTP lines are sent first.
37592
37593
37594 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37595 .cindex "SMTP" "syntax errors"
37596 .cindex "SMTP" "protocol errors"
37597 A syntax error is detected if an SMTP command is recognized, but there is
37598 something syntactically wrong with its data, for example, a malformed email
37599 address in a RCPT command. Protocol errors include invalid command
37600 sequencing such as RCPT before MAIL. If Exim receives more than
37601 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37602 drops the connection after sending the error response to the last command. The
37603 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37604 broken clients that loop sending bad commands (yes, it has been seen).
37605
37606
37607
37608 .subsection "Use of non-mail SMTP commands" SECID236
37609 .cindex "SMTP" "non-mail commands"
37610 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37611 DATA. Exim counts such commands, and drops the connection if there are too
37612 many of them in a single SMTP session. This action catches some
37613 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37614 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37615 defines what &"too many"& means. Its default value is 10.
37616
37617 When a new message is expected, one occurrence of RSET is not counted. This
37618 allows a client to send one RSET between messages (this is not necessary,
37619 but some clients do it). Exim also allows one uncounted occurrence of HELO
37620 or EHLO, and one occurrence of STARTTLS between messages. After
37621 starting up a TLS session, another EHLO is expected, and so it too is not
37622 counted.
37623
37624 The first occurrence of AUTH in a connection, or immediately following
37625 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37626 RCPT, DATA, and QUIT are counted.
37627
37628 You can control which hosts are subject to the limit set by
37629 &%smtp_accept_max_nonmail%& by setting
37630 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37631 the limit apply to all hosts. This option means that you can exclude any
37632 specific badly-behaved hosts that you have to live with.
37633
37634
37635
37636
37637 .subsection "The VRFY and EXPN commands" SECID237
37638 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37639 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37640 appropriate) in order to decide whether the command should be accepted or not.
37641
37642 .cindex "VRFY" "processing"
37643 When no ACL is defined for VRFY, or if it rejects without
37644 setting an explicit response code, the command is accepted
37645 (with a 252 SMTP response code)
37646 in order to support awkward clients that do a VRFY before every RCPT.
37647 When VRFY is accepted, it runs exactly the same code as when Exim is
37648 called with the &%-bv%& option, and returns 250/451/550
37649 SMTP response codes.
37650
37651 .cindex "EXPN" "processing"
37652 If no ACL for EXPN is defined, the command is rejected.
37653 When EXPN is accepted, a single-level expansion of the address is done.
37654 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37655 than a verification (the &%-bv%& option). If an unqualified local part is given
37656 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37657 of VRFY and EXPN commands are logged on the main and reject logs, and
37658 VRFY verification failures are logged in the main log for consistency with
37659 RCPT failures.
37660
37661
37662
37663 .subsection "The ETRN command" SECTETRN
37664 .cindex "ETRN" "processing"
37665 .cindex "ESMTP extensions" ETRN
37666 Most modern installations never need to use this.
37667 It is used for managing messages queued for an intermittently-connecting
37668 destination (eg. one using a dialup connection).
37669
37670 .oindex "&%acl_smtp_etrn%&"
37671 The command is only available if permitted by an ACL
37672 specfied by the main-section &%acl_smtp_etrn%& option.
37673
37674 RFC 1985 describes an ESMTP command called ETRN that is designed to
37675 overcome the security problems of the TURN command (which has fallen into
37676 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37677 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37678 should be accepted or not. If no ACL is defined, the command is rejected.
37679
37680 The ETRN command is concerned with &"releasing"& messages that are awaiting
37681 delivery to certain hosts. As Exim does not organize its message queue by host,
37682 the only form of ETRN that is supported by default is the one where the
37683 text starts with the &"#"& prefix, in which case the remainder of the text is
37684 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37685 the &%-R%& option to happen, with the remainder of the ETRN text as its
37686 argument. For example,
37687 .code
37688 ETRN #brigadoon
37689 .endd
37690 runs the command
37691 .code
37692 exim -R brigadoon
37693 .endd
37694 which causes a delivery attempt on all messages with undelivered addresses
37695 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37696 default), Exim prevents the simultaneous execution of more than one queue run
37697 for the same argument string as a result of an ETRN command. This stops
37698 a misbehaving client from starting more than one queue runner at once.
37699
37700 .cindex "hints database" "ETRN serialization"
37701 Exim implements the serialization by means of a hints database in which a
37702 record is written whenever a process is started by ETRN, and deleted when
37703 the process completes. However, Exim does not keep the SMTP session waiting for
37704 the ETRN process to complete. Once ETRN is accepted, the client is sent
37705 a &"success"& return code. Obviously there is scope for hints records to get
37706 left lying around if there is a system or program crash. To guard against this,
37707 Exim ignores any records that are more than six hours old.
37708
37709 .oindex "&%smtp_etrn_command%&"
37710 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37711 used. This specifies a command that is run whenever ETRN is received,
37712 whatever the form of its argument. For
37713 example:
37714 .code
37715 smtp_etrn_command = /etc/etrn_command $domain \
37716                     $sender_host_address
37717 .endd
37718 .vindex "&$domain$&"
37719 The string is split up into arguments which are independently expanded. The
37720 expansion variable &$domain$& is set to the argument of the ETRN command,
37721 and no syntax checking is done on the contents of this argument. Exim does not
37722 wait for the command to complete, so its status code is not checked. Exim runs
37723 under its own uid and gid when receiving incoming SMTP, so it is not possible
37724 for it to change them before running the command.
37725
37726
37727
37728 .section "Incoming local SMTP" "SECID238"
37729 .cindex "SMTP" "local incoming"
37730 Some user agents use SMTP to pass messages to their local MTA using the
37731 standard input and output, as opposed to passing the envelope on the command
37732 line and writing the message to the standard input. This is supported by the
37733 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37734 messages over TCP/IP (including the use of ACLs), except that the envelope
37735 sender given in a MAIL command is ignored unless the caller is trusted. In
37736 an ACL you can detect this form of SMTP input by testing for an empty host
37737 identification. It is common to have this as the first line in the ACL that
37738 runs for RCPT commands:
37739 .code
37740 accept hosts = :
37741 .endd
37742 This accepts SMTP messages from local processes without doing any other tests.
37743
37744
37745
37746 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37747 .cindex "SMTP" "batched outgoing"
37748 .cindex "batched SMTP output"
37749 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37750 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37751 be output in BSMTP format. No SMTP responses are possible for this form of
37752 delivery. All it is doing is using SMTP commands as a way of transmitting the
37753 envelope along with the message.
37754
37755 The message is written to the file or pipe preceded by the SMTP commands
37756 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37757 the message that start with a dot have an extra dot added. The SMTP command
37758 HELO is not normally used. If it is required, the &%message_prefix%& option
37759 can be used to specify it.
37760
37761 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37762 one recipient address at a time by default. However, you can arrange for them
37763 to handle several addresses at once by setting the &%batch_max%& option. When
37764 this is done for BSMTP, messages may contain multiple RCPT commands. See
37765 chapter &<<CHAPbatching>>& for more details.
37766
37767 .vindex "&$host$&"
37768 When one or more addresses are routed to a BSMTP transport by a router that
37769 sets up a host list, the name of the first host on the list is available to the
37770 transport in the variable &$host$&. Here is an example of such a transport and
37771 router:
37772 .code
37773 begin routers
37774 route_append:
37775   driver = manualroute
37776   transport = smtp_appendfile
37777   route_list = domain.example  batch.host.example
37778
37779 begin transports
37780 smtp_appendfile:
37781   driver = appendfile
37782   directory = /var/bsmtp/$host
37783   batch_max = 1000
37784   use_bsmtp
37785   user = exim
37786 .endd
37787 This causes messages addressed to &'domain.example'& to be written in BSMTP
37788 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37789 message (unless there are more than 1000 recipients).
37790
37791
37792
37793 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37794 .cindex "SMTP" "batched incoming"
37795 .cindex "batched SMTP input"
37796 The &%-bS%& command line option causes Exim to accept one or more messages by
37797 reading SMTP on the standard input, but to generate no responses. If the caller
37798 is trusted, the senders in the MAIL commands are believed; otherwise the
37799 sender is always the caller of Exim. Unqualified senders and receivers are not
37800 rejected (there seems little point) but instead just get qualified. HELO
37801 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37802 as NOOP; QUIT quits.
37803
37804 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37805 ACL is run in the same way as for non-SMTP local input.
37806
37807 If an error is detected while reading a message, including a missing &"."& at
37808 the end, Exim gives up immediately. It writes details of the error to the
37809 standard output in a stylized way that the calling program should be able to
37810 make some use of automatically, for example:
37811 .code
37812 554 Unexpected end of file
37813 Transaction started in line 10
37814 Error detected in line 14
37815 .endd
37816 It writes a more verbose version, for human consumption, to the standard error
37817 file, for example:
37818 .code
37819 An error was detected while processing a file of BSMTP input.
37820 The error message was:
37821
37822 501 '>' missing at end of address
37823
37824 The SMTP transaction started in line 10.
37825 The error was detected in line 12.
37826 The SMTP command at fault was:
37827
37828 rcpt to:<malformed@in.com.plete
37829
37830 1 previous message was successfully processed.
37831 The rest of the batch was abandoned.
37832 .endd
37833 The return code from Exim is zero only if there were no errors. It is 1 if some
37834 messages were accepted before an error was detected, and 2 if no messages were
37835 accepted.
37836 .ecindex IIDsmtpproc1
37837 .ecindex IIDsmtpproc2
37838
37839
37840
37841 . ////////////////////////////////////////////////////////////////////////////
37842 . ////////////////////////////////////////////////////////////////////////////
37843
37844 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37845          "Customizing messages"
37846 When a message fails to be delivered, or remains in the queue for more than a
37847 configured amount of time, Exim sends a message to the original sender, or
37848 to an alternative configured address. The text of these messages is built into
37849 the code of Exim, but it is possible to change it, either by adding a single
37850 string, or by replacing each of the paragraphs by text supplied in a file.
37851
37852 The &'From:'& and &'To:'& header lines are automatically generated; you can
37853 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37854 option. Exim also adds the line
37855 .code
37856 Auto-Submitted: auto-generated
37857 .endd
37858 to all warning and bounce messages,
37859
37860
37861 .section "Customizing bounce messages" "SECID239"
37862 .cindex "customizing" "bounce message"
37863 .cindex "bounce message" "customizing"
37864 If &%bounce_message_text%& is set, its contents are included in the default
37865 message immediately after &"This message was created automatically by mail
37866 delivery software."& The string is not expanded. It is not used if
37867 &%bounce_message_file%& is set.
37868
37869 When &%bounce_message_file%& is set, it must point to a template file for
37870 constructing error messages. The file consists of a series of text items,
37871 separated by lines consisting of exactly four asterisks. If the file cannot be
37872 opened, default text is used and a message is written to the main and panic
37873 logs. If any text item in the file is empty, default text is used for that
37874 item.
37875
37876 .vindex "&$bounce_recipient$&"
37877 .vindex "&$bounce_return_size_limit$&"
37878 Each item of text that is read from the file is expanded, and there are two
37879 expansion variables which can be of use here: &$bounce_recipient$& is set to
37880 the recipient of an error message while it is being created, and
37881 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37882 option, rounded to a whole number.
37883
37884 The items must appear in the file in the following order:
37885
37886 .ilist
37887 The first item is included in the headers, and should include at least a
37888 &'Subject:'& header. Exim does not check the syntax of these headers.
37889 .next
37890 The second item forms the start of the error message. After it, Exim lists the
37891 failing addresses with their error messages.
37892 .next
37893 The third item is used to introduce any text from pipe transports that is to be
37894 returned to the sender. It is omitted if there is no such text.
37895 .next
37896 The fourth, fifth and sixth items will be ignored and may be empty.
37897 The fields exist for back-compatibility
37898 .endlist
37899
37900 The default state (&%bounce_message_file%& unset) is equivalent to the
37901 following file, in which the sixth item is empty. The &'Subject:'& and some
37902 other lines have been split in order to fit them on the page:
37903 .code
37904 Subject: Mail delivery failed
37905   ${if eq{$sender_address}{$bounce_recipient}
37906   {: returning message to sender}}
37907 ****
37908 This message was created automatically by mail delivery software.
37909
37910 A message ${if eq{$sender_address}{$bounce_recipient}
37911   {that you sent }{sent by
37912
37913 <$sender_address>
37914
37915 }}could not be delivered to all of its recipients.
37916 This is a permanent error. The following address(es) failed:
37917 ****
37918 The following text was generated during the delivery attempt(s):
37919 ****
37920 ------ This is a copy of the message, including all the headers.
37921   ------
37922 ****
37923 ------ The body of the message is $message_size characters long;
37924   only the first
37925 ------ $bounce_return_size_limit or so are included here.
37926 ****
37927 .endd
37928 .section "Customizing warning messages" "SECTcustwarn"
37929 .cindex "customizing" "warning message"
37930 .cindex "warning of delay" "customizing the message"
37931 The option &%warn_message_file%& can be pointed at a template file for use when
37932 warnings about message delays are created. In this case there are only three
37933 text sections:
37934
37935 .ilist
37936 The first item is included in the headers, and should include at least a
37937 &'Subject:'& header. Exim does not check the syntax of these headers.
37938 .next
37939 The second item forms the start of the warning message. After it, Exim lists
37940 the delayed addresses.
37941 .next
37942 The third item then ends the message.
37943 .endlist
37944
37945 The default state is equivalent to the following file, except that some lines
37946 have been split here, in order to fit them on the page:
37947 .code
37948 Subject: Warning: message $message_exim_id delayed
37949   $warn_message_delay
37950 ****
37951 This message was created automatically by mail delivery software.
37952
37953 A message ${if eq{$sender_address}{$warn_message_recipients}
37954 {that you sent }{sent by
37955
37956 <$sender_address>
37957
37958 }}has not been delivered to all of its recipients after
37959 more than $warn_message_delay in the queue on $primary_hostname.
37960
37961 The message identifier is:     $message_exim_id
37962 The subject of the message is: $h_subject
37963 The date of the message is:    $h_date
37964
37965 The following address(es) have not yet been delivered:
37966 ****
37967 No action is required on your part. Delivery attempts will
37968 continue for some time, and this warning may be repeated at
37969 intervals if the message remains undelivered. Eventually the
37970 mail delivery software will give up, and when that happens,
37971 the message will be returned to you.
37972 .endd
37973 .vindex "&$warn_message_delay$&"
37974 .vindex "&$warn_message_recipients$&"
37975 However, in the default state the subject and date lines are omitted if no
37976 appropriate headers exist. During the expansion of this file,
37977 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37978 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37979 of recipients for the warning message. There may be more than one if there are
37980 multiple addresses with different &%errors_to%& settings on the routers that
37981 handled them.
37982
37983
37984
37985
37986 . ////////////////////////////////////////////////////////////////////////////
37987 . ////////////////////////////////////////////////////////////////////////////
37988
37989 .chapter "Some common configuration settings" "CHAPcomconreq"
37990 This chapter discusses some configuration settings that seem to be fairly
37991 common. More examples and discussion can be found in the Exim book.
37992
37993
37994
37995 .section "Sending mail to a smart host" "SECID240"
37996 .cindex "smart host" "example router"
37997 If you want to send all mail for non-local domains to a &"smart host"&, you
37998 should replace the default &(dnslookup)& router with a router which does the
37999 routing explicitly:
38000 .code
38001 send_to_smart_host:
38002   driver = manualroute
38003   route_list = !+local_domains smart.host.name
38004   transport = remote_smtp
38005 .endd
38006 You can use the smart host's IP address instead of the name if you wish.
38007 If you are using Exim only to submit messages to a smart host, and not for
38008 receiving incoming messages, you can arrange for it to do the submission
38009 synchronously by setting the &%mua_wrapper%& option (see chapter
38010 &<<CHAPnonqueueing>>&).
38011
38012
38013
38014
38015 .section "Using Exim to handle mailing lists" "SECTmailinglists"
38016 .cindex "mailing lists"
38017 Exim can be used to run simple mailing lists, but for large and/or complicated
38018 requirements, the use of additional specialized mailing list software such as
38019 Majordomo or Mailman is recommended.
38020
38021 The &(redirect)& router can be used to handle mailing lists where each list
38022 is maintained in a separate file, which can therefore be managed by an
38023 independent manager. The &%domains%& router option can be used to run these
38024 lists in a separate domain from normal mail. For example:
38025 .code
38026 lists:
38027   driver = redirect
38028   domains = lists.example
38029   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
38030   forbid_pipe
38031   forbid_file
38032   errors_to = ${quote_local_part:$local_part-request}@lists.example
38033   no_more
38034 .endd
38035 This router is skipped for domains other than &'lists.example'&. For addresses
38036 in that domain, it looks for a file that matches the local part. If there is no
38037 such file, the router declines, but because &%no_more%& is set, no subsequent
38038 routers are tried, and so the whole delivery fails.
38039
38040 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
38041 expanded into a filename or a pipe delivery, which is usually inappropriate in
38042 a mailing list.
38043
38044 .oindex "&%errors_to%&"
38045 The &%errors_to%& option specifies that any delivery errors caused by addresses
38046 taken from a mailing list are to be sent to the given address rather than the
38047 original sender of the message. However, before acting on this, Exim verifies
38048 the error address, and ignores it if verification fails.
38049
38050 For example, using the configuration above, mail sent to
38051 &'dicts@lists.example'& is passed on to those addresses contained in
38052 &_/usr/lists/dicts_&, with error reports directed to
38053 &'dicts-request@lists.example'&, provided that this address can be verified.
38054 There could be a file called &_/usr/lists/dicts-request_& containing
38055 the address(es) of this particular list's manager(s), but other approaches,
38056 such as setting up an earlier router (possibly using the &%local_part_prefix%&
38057 or &%local_part_suffix%& options) to handle addresses of the form
38058 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
38059
38060
38061
38062 .section "Syntax errors in mailing lists" "SECID241"
38063 .cindex "mailing lists" "syntax errors in"
38064 If an entry in redirection data contains a syntax error, Exim normally defers
38065 delivery of the original address. That means that a syntax error in a mailing
38066 list holds up all deliveries to the list. This may not be appropriate when a
38067 list is being maintained automatically from data supplied by users, and the
38068 addresses are not rigorously checked.
38069
38070 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
38071 entries that fail to parse, noting the incident in the log. If in addition
38072 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
38073 whenever a broken address is skipped. It is usually appropriate to set
38074 &%syntax_errors_to%& to the same address as &%errors_to%&.
38075
38076
38077
38078 .section "Re-expansion of mailing lists" "SECID242"
38079 .cindex "mailing lists" "re-expansion of"
38080 Exim remembers every individual address to which a message has been delivered,
38081 in order to avoid duplication, but it normally stores only the original
38082 recipient addresses with a message. If all the deliveries to a mailing list
38083 cannot be done at the first attempt, the mailing list is re-expanded when the
38084 delivery is next tried. This means that alterations to the list are taken into
38085 account at each delivery attempt, so addresses that have been added to
38086 the list since the message arrived will therefore receive a copy of the
38087 message, even though it pre-dates their subscription.
38088
38089 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
38090 on the &(redirect)& router. If this is done, any addresses generated by the
38091 router that fail to deliver at the first attempt are added to the message as
38092 &"top level"& addresses, and the parent address that generated them is marked
38093 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
38094 subsequent delivery attempts. The disadvantage of this is that if any of the
38095 failing addresses are incorrect, correcting them in the file has no effect on
38096 pre-existing messages.
38097
38098 The original top-level address is remembered with each of the generated
38099 addresses, and is output in any log messages. However, any intermediate parent
38100 addresses are not recorded. This makes a difference to the log only if the
38101 &%all_parents%& selector is set, but for mailing lists there is normally only
38102 one level of expansion anyway.
38103
38104
38105
38106 .section "Closed mailing lists" "SECID243"
38107 .cindex "mailing lists" "closed"
38108 The examples so far have assumed open mailing lists, to which anybody may
38109 send mail. It is also possible to set up closed lists, where mail is accepted
38110 from specified senders only. This is done by making use of the generic
38111 &%senders%& option to restrict the router that handles the list.
38112
38113 The following example uses the same file as a list of recipients and as a list
38114 of permitted senders. It requires three routers:
38115 .code
38116 lists_request:
38117   driver = redirect
38118   domains = lists.example
38119   local_part_suffix = -request
38120   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
38121   file = /usr/lists/${local_part_data}-request
38122   no_more
38123
38124 lists_post:
38125   driver = redirect
38126   domains = lists.example
38127   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
38128   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
38129   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
38130   forbid_pipe
38131   forbid_file
38132   errors_to = ${quote_local_part:$local_part-request}@lists.example
38133   no_more
38134
38135 lists_closed:
38136   driver = redirect
38137   domains = lists.example
38138   allow_fail
38139   data = :fail: $local_part@lists.example is a closed mailing list
38140 .endd
38141 All three routers have the same &%domains%& setting, so for any other domains,
38142 they are all skipped. The first router runs only if the local part ends in
38143 &%-request%&. It handles messages to the list manager(s) by means of an open
38144 mailing list.
38145
38146 The second router runs only if the &%senders%& precondition is satisfied. It
38147 checks for the existence of a list that corresponds to the local part, and then
38148 checks that the sender is on the list by means of a linear search. It is
38149 necessary to check for the existence of the file before trying to search it,
38150 because otherwise Exim thinks there is a configuration error. If the file does
38151 not exist, the expansion of &%senders%& is *, which matches all senders. This
38152 means that the router runs, but because there is no list, declines, and
38153 &%no_more%& ensures that no further routers are run. The address fails with an
38154 &"unrouteable address"& error.
38155
38156 The third router runs only if the second router is skipped, which happens when
38157 a mailing list exists, but the sender is not on it. This router forcibly fails
38158 the address, giving a suitable error message.
38159
38160
38161
38162
38163 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
38164 .cindex "VERP"
38165 .cindex "Variable Envelope Return Paths"
38166 .cindex "envelope from"
38167 .cindex "envelope sender"
38168 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
38169 are a way of helping mailing list administrators discover which subscription
38170 address is the cause of a particular delivery failure. The idea is to encode
38171 the original recipient address in the outgoing envelope sender address, so that
38172 if the message is forwarded by another host and then subsequently bounces, the
38173 original recipient can be extracted from the recipient address of the bounce.
38174
38175 .oindex &%errors_to%&
38176 .oindex &%return_path%&
38177 Envelope sender addresses can be modified by Exim using two different
38178 facilities: the &%errors_to%& option on a router (as shown in previous mailing
38179 list examples), or the &%return_path%& option on a transport. The second of
38180 these is effective only if the message is successfully delivered to another
38181 host; it is not used for errors detected on the local host (see the description
38182 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
38183 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
38184 .code
38185 verp_smtp:
38186   driver = smtp
38187   max_rcpt = 1
38188   return_path = \
38189     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38190       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38191 .endd
38192 This has the effect of rewriting the return path (envelope sender) on outgoing
38193 SMTP messages, if the local part of the original return path ends in
38194 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
38195 local part and domain of the recipient into the return path. Suppose, for
38196 example, that a message whose return path has been set to
38197 &'somelist-request@your.dom.example'& is sent to
38198 &'subscriber@other.dom.example'&. In the transport, the return path is
38199 rewritten as
38200 .code
38201 somelist-request+subscriber=other.dom.example@your.dom.example
38202 .endd
38203 .vindex "&$local_part$&"
38204 For this to work, you must tell Exim to send multiple copies of messages that
38205 have more than one recipient, so that each copy has just one recipient. This is
38206 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
38207 might be sent to several different recipients in the same domain, in which case
38208 &$local_part$& is not available in the transport, because it is not unique.
38209
38210 Unless your host is doing nothing but mailing list deliveries, you should
38211 probably use a separate transport for the VERP deliveries, so as not to use
38212 extra resources in making one-per-recipient copies for other deliveries. This
38213 can easily be done by expanding the &%transport%& option in the router:
38214 .code
38215 dnslookup:
38216   driver = dnslookup
38217   domains = ! +local_domains
38218   transport = \
38219     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38220       {verp_smtp}{remote_smtp}}
38221   no_more
38222 .endd
38223 If you want to change the return path using &%errors_to%& in a router instead
38224 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38225 routers that handle mailing list addresses. This will ensure that all delivery
38226 errors, including those detected on the local host, are sent to the VERP
38227 address.
38228
38229 On a host that does no local deliveries and has no manual routing, only the
38230 &(dnslookup)& router needs to be changed. A special transport is not needed for
38231 SMTP deliveries. Every mailing list recipient has its own return path value,
38232 and so Exim must hand them to the transport one at a time. Here is an example
38233 of a &(dnslookup)& router that implements VERP:
38234 .code
38235 verp_dnslookup:
38236   driver = dnslookup
38237   domains = ! +local_domains
38238   transport = remote_smtp
38239   errors_to = \
38240     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38241      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38242   no_more
38243 .endd
38244 Before you start sending out messages with VERPed return paths, you must also
38245 configure Exim to accept the bounce messages that come back to those paths.
38246 Typically this is done by setting a &%local_part_suffix%& option for a
38247 router, and using this to route the messages to wherever you want to handle
38248 them.
38249
38250 The overhead incurred in using VERP depends very much on the size of the
38251 message, the number of recipient addresses that resolve to the same remote
38252 host, and the speed of the connection over which the message is being sent. If
38253 a lot of addresses resolve to the same host and the connection is slow, sending
38254 a separate copy of the message for each address may take substantially longer
38255 than sending a single copy with many recipients (for which VERP cannot be
38256 used).
38257
38258
38259
38260
38261
38262
38263 .section "Virtual domains" "SECTvirtualdomains"
38264 .cindex "virtual domains"
38265 .cindex "domain" "virtual"
38266 The phrase &'virtual domain'& is unfortunately used with two rather different
38267 meanings:
38268
38269 .ilist
38270 A domain for which there are no real mailboxes; all valid local parts are
38271 aliases for other email addresses. Common examples are organizational
38272 top-level domains and &"vanity"& domains.
38273 .next
38274 One of a number of independent domains that are all handled by the same host,
38275 with mailboxes on that host, but where the mailbox owners do not necessarily
38276 have login accounts on that host.
38277 .endlist
38278
38279 The first usage is probably more common, and does seem more &"virtual"& than
38280 the second. This kind of domain can be handled in Exim with a straightforward
38281 aliasing router. One approach is to create a separate alias file for each
38282 virtual domain. Exim can test for the existence of the alias file to determine
38283 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38284 to a router of this form:
38285 .code
38286 virtual:
38287   driver = redirect
38288   domains = dsearch;/etc/mail/virtual
38289   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38290   no_more
38291 .endd
38292 The &%domains%& option specifies that the router is to be skipped, unless there
38293 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38294 domain that is being processed.
38295 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38296 being placed into the &$domain_data$& variable.
38297
38298 When the router runs, it looks up the local
38299 part in the file to find a new address (or list of addresses). The &%no_more%&
38300 setting ensures that if the lookup fails (leading to &%data%& being an empty
38301 string), Exim gives up on the address without trying any subsequent routers.
38302
38303 This one router can handle all the virtual domains because the alias filenames
38304 follow a fixed pattern. Permissions can be arranged so that appropriate people
38305 can edit the different alias files. A successful aliasing operation results in
38306 a new envelope recipient address, which is then routed from scratch.
38307
38308 The other kind of &"virtual"& domain can also be handled in a straightforward
38309 way. One approach is to create a file for each domain containing a list of
38310 valid local parts, and use it in a router like this:
38311 .code
38312 my_domains:
38313   driver = accept
38314   domains = dsearch;/etc/mail/domains
38315   local_parts = lsearch;/etc/mail/domains/$domain
38316   transport = my_mailboxes
38317 .endd
38318 The address is accepted if there is a file for the domain, and the local part
38319 can be found in the file. The &%domains%& option is used to check for the
38320 file's existence because &%domains%& is tested before the &%local_parts%&
38321 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38322 because that option is tested after &%local_parts%&. The transport is as
38323 follows:
38324 .code
38325 my_mailboxes:
38326   driver = appendfile
38327   file = /var/mail/$domain_data/$local_part_data
38328   user = mail
38329 .endd
38330 This uses a directory of mailboxes for each domain. The &%user%& setting is
38331 required, to specify which uid is to be used for writing to the mailboxes.
38332
38333 The configuration shown here is just one example of how you might support this
38334 requirement. There are many other ways this kind of configuration can be set
38335 up, for example, by using a database instead of separate files to hold all the
38336 information about the domains.
38337
38338
38339
38340 .section "Multiple user mailboxes" "SECTmulbox"
38341 .cindex "multiple mailboxes"
38342 .cindex "mailbox" "multiple"
38343 .cindex "local part" "prefix"
38344 .cindex "local part" "suffix"
38345 Heavy email users often want to operate with multiple mailboxes, into which
38346 incoming mail is automatically sorted. A popular way of handling this is to
38347 allow users to use multiple sender addresses, so that replies can easily be
38348 identified. Users are permitted to add prefixes or suffixes to their local
38349 parts for this purpose. The wildcard facility of the generic router options
38350 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38351 example, consider this router:
38352 .code
38353 userforward:
38354   driver = redirect
38355   check_local_user
38356   file = $home/.forward
38357   local_part_suffix = -*
38358   local_part_suffix_optional
38359   allow_filter
38360 .endd
38361 .vindex "&$local_part_suffix$&"
38362 It runs a user's &_.forward_& file for all local parts of the form
38363 &'username-*'&. Within the filter file the user can distinguish different
38364 cases by testing the variable &$local_part_suffix$&. For example:
38365 .code
38366 if $local_part_suffix contains -special then
38367 save /home/$local_part_data/Mail/special
38368 endif
38369 .endd
38370 If the filter file does not exist, or does not deal with such addresses, they
38371 fall through to subsequent routers, and, assuming no subsequent use of the
38372 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38373 control over which suffixes are valid.
38374
38375 Alternatively, a suffix can be used to trigger the use of a different
38376 &_.forward_& file &-- which is the way a similar facility is implemented in
38377 another MTA:
38378 .code
38379 userforward:
38380   driver = redirect
38381   check_local_user
38382   local_part_suffix = -*
38383   local_part_suffix_optional
38384   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38385   allow_filter
38386 .endd
38387 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38388 example, &_.forward-special_& is used. Once again, if the appropriate file
38389 does not exist, or does not deal with the address, it is passed on to
38390 subsequent routers, which could, if required, look for an unqualified
38391 &_.forward_& file to use as a default.
38392
38393
38394
38395 .section "Simplified vacation processing" "SECID244"
38396 .cindex "vacation processing"
38397 The traditional way of running the &'vacation'& program is for a user to set up
38398 a pipe command in a &_.forward_& file
38399 (see section &<<SECTspecitredli>>& for syntax details).
38400 This is prone to error by inexperienced users. There are two features of Exim
38401 that can be used to make this process simpler for users:
38402
38403 .ilist
38404 A local part prefix such as &"vacation-"& can be specified on a router which
38405 can cause the message to be delivered directly to the &'vacation'& program, or
38406 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38407 &_.forward_& file are then much simpler. For example:
38408 .code
38409 spqr, vacation-spqr
38410 .endd
38411 .next
38412 The &%require_files%& generic router option can be used to trigger a
38413 vacation delivery by checking for the existence of a certain file in the
38414 user's home directory. The &%unseen%& generic option should also be used, to
38415 ensure that the original delivery also proceeds. In this case, all the user has
38416 to do is to create a file called, say, &_.vacation_&, containing a vacation
38417 message.
38418 .endlist
38419
38420 Another advantage of both these methods is that they both work even when the
38421 use of arbitrary pipes by users is locked out.
38422
38423
38424
38425 .section "Taking copies of mail" "SECID245"
38426 .cindex "message" "copying every"
38427 Some installations have policies that require archive copies of all messages to
38428 be made. A single copy of each message can easily be taken by an appropriate
38429 command in a system filter, which could, for example, use a different file for
38430 each day's messages.
38431
38432 There is also a shadow transport mechanism that can be used to take copies of
38433 messages that are successfully delivered by local transports, one copy per
38434 delivery. This could be used, &'inter alia'&, to implement automatic
38435 notification of delivery by sites that insist on doing such things.
38436
38437
38438
38439 .section "Intermittently connected hosts" "SECID246"
38440 .cindex "intermittently connected hosts"
38441 It has become quite common (because it is cheaper) for hosts to connect to the
38442 Internet periodically rather than remain connected all the time. The normal
38443 arrangement is that mail for such hosts accumulates on a system that is
38444 permanently connected.
38445
38446 Exim was designed for use on permanently connected hosts, and so it is not
38447 particularly well-suited to use in an intermittently connected environment.
38448 Nevertheless there are some features that can be used.
38449
38450
38451 .section "Exim on the upstream server host" "SECID247"
38452 It is tempting to arrange for incoming mail for the intermittently connected
38453 host to remain in Exim's queue until the client connects. However, this
38454 approach does not scale very well. Two different kinds of waiting message are
38455 being mixed up in the same queue &-- those that cannot be delivered because of
38456 some temporary problem, and those that are waiting for their destination host
38457 to connect. This makes it hard to manage the queue, as well as wasting
38458 resources, because each queue runner scans the entire queue.
38459
38460 A better approach is to separate off those messages that are waiting for an
38461 intermittently connected host. This can be done by delivering these messages
38462 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38463 format, from where they are transmitted by other software when their
38464 destination connects. This makes it easy to collect all the mail for one host
38465 in a single directory, and to apply local timeout rules on a per-message basis
38466 if required.
38467
38468 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38469 you are doing this, you should configure Exim with a long retry period for the
38470 intermittent host. For example:
38471 .code
38472 cheshire.wonderland.fict.example    *   F,5d,24h
38473 .endd
38474 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38475 which messages it has queued up for that host. Once the intermittent host comes
38476 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38477 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38478 causes all the queued up messages to be delivered, often down a single SMTP
38479 connection. While the host remains connected, any new messages get delivered
38480 immediately.
38481
38482 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38483 issued with a different IP address each time it connects, Exim's retry
38484 mechanisms on the holding host get confused, because the IP address is normally
38485 used as part of the key string for holding retry information. This can be
38486 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38487 Since this has disadvantages for permanently connected hosts, it is best to
38488 arrange a separate transport for the intermittently connected ones.
38489
38490
38491
38492 .section "Exim on the intermittently connected client host" "SECID248"
38493 The value of &%smtp_accept_queue_per_connection%& should probably be
38494 increased, or even set to zero (that is, disabled) on the intermittently
38495 connected host, so that all incoming messages down a single connection get
38496 delivered immediately.
38497
38498 .cindex "SMTP" "passed connection"
38499 .cindex "SMTP" "multiple deliveries"
38500 .cindex "multiple SMTP deliveries"
38501 .cindex "first pass routing"
38502 Mail waiting to be sent from an intermittently connected host will probably
38503 not have been routed, because without a connection DNS lookups are not
38504 possible. This means that if a normal queue run is done at connection time,
38505 each message is likely to be sent in a separate SMTP session. This can be
38506 avoided by starting the queue run with a command line option beginning with
38507 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38508 first pass, routing is done but no deliveries take place. The second pass is a
38509 normal queue run; since all the messages have been previously routed, those
38510 destined for the same host are likely to get sent as multiple deliveries in a
38511 single SMTP connection.
38512
38513
38514
38515 . ////////////////////////////////////////////////////////////////////////////
38516 . ////////////////////////////////////////////////////////////////////////////
38517
38518 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38519          "Exim as a non-queueing client"
38520 .cindex "client, non-queueing"
38521 .cindex "smart host" "suppressing queueing"
38522 On a personal computer, it is a common requirement for all
38523 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38524 configured to operate that way, for all the popular operating systems.
38525 However, there are some MUAs for Unix-like systems that cannot be so
38526 configured: they submit messages using the command line interface of
38527 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38528 messages this way.
38529
38530 If the personal computer runs continuously, there is no problem, because it can
38531 run a conventional MTA that handles delivery to the smart host, and deal with
38532 any delays via its queueing mechanism. However, if the computer does not run
38533 continuously or runs different operating systems at different times, queueing
38534 email is not desirable.
38535
38536 There is therefore a requirement for something that can provide the
38537 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38538 any queueing or retrying facilities. Furthermore, the delivery to the smart
38539 host should be synchronous, so that if it fails, the sending MUA is immediately
38540 informed. In other words, we want something that extends an MUA that submits
38541 to a local MTA via the command line so that it behaves like one that submits
38542 to a remote smart host using TCP/SMTP.
38543
38544 There are a number of applications (for example, there is one called &'ssmtp'&)
38545 that do this job. However, people have found them to be lacking in various
38546 ways. For instance, you might want to allow aliasing and forwarding to be done
38547 before sending a message to the smart host.
38548
38549 Exim already had the necessary infrastructure for doing this job. Just a few
38550 tweaks were needed to make it behave as required, though it is somewhat of an
38551 overkill to use a fully-featured MTA for this purpose.
38552
38553 .oindex "&%mua_wrapper%&"
38554 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38555 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38556 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38557 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38558 compatible router and transport configuration. Typically there will be just one
38559 router and one transport, sending everything to a smart host.
38560
38561 When run in MUA wrapping mode, the behaviour of Exim changes in the
38562 following ways:
38563
38564 .ilist
38565 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38566 In other words, the only way to submit messages is via the command line.
38567 .next
38568 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38569 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38570 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38571 does not finish until the delivery attempt is complete. If the delivery is
38572 successful, a zero return code is given.
38573 .next
38574 Address redirection is permitted, but the final routing for all addresses must
38575 be to the same remote transport, and to the same list of hosts. Furthermore,
38576 the return address (envelope sender) must be the same for all recipients, as
38577 must any added or deleted header lines. In other words, it must be possible to
38578 deliver the message in a single SMTP transaction, however many recipients there
38579 are.
38580 .next
38581 If these conditions are not met, or if routing any address results in a
38582 failure or defer status, or if Exim is unable to deliver all the recipients
38583 successfully to one of the smart hosts, delivery of the entire message fails.
38584 .next
38585 Because no queueing is allowed, all failures are treated as permanent; there
38586 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38587 smart host. Furthermore, because only a single yes/no response can be given to
38588 the caller, it is not possible to deliver to some recipients and not others. If
38589 there is an error (temporary or permanent) for any recipient, all are failed.
38590 .next
38591 If more than one smart host is listed, Exim will try another host after a
38592 connection failure or a timeout, in the normal way. However, if this kind of
38593 failure happens for all the hosts, the delivery fails.
38594 .next
38595 When delivery fails, an error message is written to the standard error stream
38596 (as well as to Exim's log), and Exim exits to the caller with a return code
38597 value 1. The message is expunged from Exim's spool files. No bounce messages
38598 are ever generated.
38599 .next
38600 No retry data is maintained, and any retry rules are ignored.
38601 .next
38602 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38603 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38604 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38605 .endlist
38606
38607 The overall effect is that Exim makes a single synchronous attempt to deliver
38608 the message, failing if there is any kind of problem. Because no local
38609 deliveries are done and no daemon can be run, Exim does not need root
38610 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38611 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38612 the advantages and disadvantages of running without root privilege.
38613
38614
38615
38616
38617 . ////////////////////////////////////////////////////////////////////////////
38618 . ////////////////////////////////////////////////////////////////////////////
38619
38620 .chapter "Log files" "CHAPlog"
38621 .scindex IIDloggen "log" "general description"
38622 .cindex "log" "types of"
38623 Exim writes three different logs, referred to as the main log, the reject log,
38624 and the panic log:
38625
38626 .ilist
38627 .cindex "main log"
38628 The main log records the arrival of each message and each delivery in a single
38629 line in each case. The format is as compact as possible, in an attempt to keep
38630 down the size of log files. Two-character flag sequences make it easy to pick
38631 out these lines. A number of other events are recorded in the main log. Some of
38632 them are optional, in which case the &%log_selector%& option controls whether
38633 they are included or not. A Perl script called &'eximstats'&, which does simple
38634 analysis of main log files, is provided in the Exim distribution (see section
38635 &<<SECTmailstat>>&).
38636 .next
38637 .cindex "reject log"
38638 The reject log records information from messages that are rejected as a result
38639 of a configuration option (that is, for policy reasons).
38640 The first line of each rejection is a copy of the line that is also written to
38641 the main log. Then, if the message's header has been read at the time the log
38642 is written, its contents are written to this log. Only the original header
38643 lines are available; header lines added by ACLs are not logged. You can use the
38644 reject log to check that your policy controls are working correctly; on a busy
38645 host this may be easier than scanning the main log for rejection messages. You
38646 can suppress the writing of the reject log by setting &%write_rejectlog%&
38647 false.
38648 .next
38649 .cindex "panic log"
38650 .cindex "system log"
38651 When certain serious errors occur, Exim writes entries to its panic log. If the
38652 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38653 are usually written to the main log as well, but can get lost amid the mass of
38654 other entries. The panic log should be empty under normal circumstances. It is
38655 therefore a good idea to check it (or to have a &'cron'& script check it)
38656 regularly, in order to become aware of any problems. When Exim cannot open its
38657 panic log, it tries as a last resort to write to the system log (syslog). This
38658 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38659 message itself is written at priority LOG_CRIT.
38660 .endlist
38661
38662 Every log line starts with a timestamp, in the format shown in the following
38663 example. Note that many of the examples shown in this chapter are line-wrapped.
38664 In the log file, this would be all on one line:
38665 .code
38666 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38667   by QUIT
38668 .endd
38669 By default, the timestamps are in the local timezone. There are two
38670 ways of changing this:
38671
38672 .ilist
38673 You can set the &%timezone%& option to a different time zone; in particular, if
38674 you set
38675 .code
38676 timezone = UTC
38677 .endd
38678 the timestamps will be in UTC (aka GMT).
38679 .next
38680 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38681 example:
38682 .code
38683 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38684 .endd
38685 .endlist
38686
38687 .cindex "log" "process ids in"
38688 .cindex "pid (process id)" "in log lines"
38689 Exim does not include its process id in log lines by default, but you can
38690 request that it does so by specifying the &`pid`& log selector (see section
38691 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38692 brackets, immediately after the time and date.
38693
38694
38695
38696
38697 .section "Where the logs are written" "SECTwhelogwri"
38698 .cindex "log" "destination"
38699 .cindex "log" "to file"
38700 .cindex "log" "to syslog"
38701 .cindex "syslog"
38702 The logs may be written to local files, or to syslog, or both. However, it
38703 should be noted that many syslog implementations use UDP as a transport, and
38704 are therefore unreliable in the sense that messages are not guaranteed to
38705 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38706 It has also been reported that on large log files (tens of megabytes) you may
38707 need to tweak syslog to prevent it syncing the file with each write &-- on
38708 Linux this has been seen to make syslog take 90% plus of CPU time.
38709
38710 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38711 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38712 configuration. This latter string is expanded, so it can contain, for example,
38713 references to the host name:
38714 .code
38715 log_file_path = /var/log/$primary_hostname/exim_%slog
38716 .endd
38717 It is generally advisable, however, to set the string in &_Local/Makefile_&
38718 rather than at runtime, because then the setting is available right from the
38719 start of Exim's execution. Otherwise, if there's something it wants to log
38720 before it has read the configuration file (for example, an error in the
38721 configuration file) it will not use the path you want, and may not be able to
38722 log at all.
38723
38724 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38725 list, currently limited to at most two items. This is one option where the
38726 facility for changing a list separator may not be used. The list must always be
38727 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38728 otherwise the item must either be an absolute path, containing &`%s`& at the
38729 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38730 implying the use of a default path.
38731
38732 When Exim encounters an empty item in the list, it searches the list defined by
38733 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38734 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38735 mean &"use the path specified at build time"&. If no such item exists, log
38736 files are written in the &_log_& subdirectory of the spool directory. This is
38737 equivalent to the configuration file setting:
38738 .code
38739 log_file_path = $spool_directory/log/%slog
38740 .endd
38741 If you do not specify anything at build time or runtime,
38742 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38743 that is where the logs are written.
38744
38745 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38746 are in use &-- see section &<<SECTdatlogfil>>& below.
38747
38748 Here are some examples of possible Makefile settings:
38749 .display
38750 &`LOG_FILE_PATH=syslog                    `& syslog only
38751 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38752 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38753 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38754 .endd
38755 If there are more than two paths in the list, the first is used and a panic
38756 error is logged.
38757
38758
38759
38760 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38761 .cindex "log" "cycling local files"
38762 .cindex "cycling logs"
38763 .cindex "&'exicyclog'&"
38764 .cindex "log" "local files; writing to"
38765 Some operating systems provide centralized and standardized methods for cycling
38766 log files. For those that do not, a utility script called &'exicyclog'& is
38767 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38768 main and reject logs each time it is called. The maximum number of old logs to
38769 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38770
38771 An Exim delivery process opens the main log when it first needs to write to it,
38772 and it keeps the file open in case subsequent entries are required &-- for
38773 example, if a number of different deliveries are being done for the same
38774 message. However, remote SMTP deliveries can take a long time, and this means
38775 that the file may be kept open long after it is renamed if &'exicyclog'& or
38776 something similar is being used to rename log files on a regular basis. To
38777 ensure that a switch of log files is noticed as soon as possible, Exim calls
38778 &[stat()]& on the main log's name before reusing an open file, and if the file
38779 does not exist, or its inode has changed, the old file is closed and Exim
38780 tries to open the main log from scratch. Thus, an old log file may remain open
38781 for quite some time, but no Exim processes should write to it once it has been
38782 renamed.
38783
38784
38785
38786 .section "Datestamped log files" "SECTdatlogfil"
38787 .cindex "log" "datestamped files"
38788 Instead of cycling the main and reject log files by renaming them
38789 periodically, some sites like to use files whose names contain a datestamp,
38790 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38791 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38792 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38793 point where the datestamp is required. For example:
38794 .code
38795 log_file_path = /var/spool/exim/log/%slog-%D
38796 log_file_path = /var/log/exim-%s-%D.log
38797 log_file_path = /var/spool/exim/log/%D-%slog
38798 log_file_path = /var/log/exim/%s.%M
38799 .endd
38800 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38801 examples of names generated by the above examples:
38802 .code
38803 /var/spool/exim/log/mainlog-20021225
38804 /var/log/exim-reject-20021225.log
38805 /var/spool/exim/log/20021225-mainlog
38806 /var/log/exim/main.200212
38807 .endd
38808 When this form of log file is specified, Exim automatically switches to new
38809 files at midnight. It does not make any attempt to compress old logs; you
38810 will need to write your own script if you require this. You should not
38811 run &'exicyclog'& with this form of logging.
38812
38813 The location of the panic log is also determined by &%log_file_path%&, but it
38814 is not datestamped, because rotation of the panic log does not make sense.
38815 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38816 the string. In addition, if it immediately follows a slash, a following
38817 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38818 character is removed. Thus, the four examples above would give these panic
38819 log names:
38820 .code
38821 /var/spool/exim/log/paniclog
38822 /var/log/exim-panic.log
38823 /var/spool/exim/log/paniclog
38824 /var/log/exim/panic
38825 .endd
38826
38827
38828 .section "Logging to syslog" "SECID249"
38829 .cindex "log" "syslog; writing to"
38830 The use of syslog does not change what Exim logs or the format of its messages,
38831 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38832 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38833 that, the same strings are written to syslog as to log files. The syslog
38834 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38835 by default, but you can change these by setting the &%syslog_facility%& and
38836 &%syslog_processname%& options, respectively. If Exim was compiled with
38837 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38838 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38839 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38840 the time and host name to each line.
38841 The three log streams are mapped onto syslog priorities as follows:
38842
38843 .ilist
38844 &'mainlog'& is mapped to LOG_INFO
38845 .next
38846 &'rejectlog'& is mapped to LOG_NOTICE
38847 .next
38848 &'paniclog'& is mapped to LOG_ALERT
38849 .endlist
38850
38851 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38852 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38853 these are routed by syslog to the same place. You can suppress this duplication
38854 by setting &%syslog_duplication%& false.
38855
38856 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38857 entries contain multiple lines when headers are included. To cope with both
38858 these cases, entries written to syslog are split into separate &[syslog()]&
38859 calls at each internal newline, and also after a maximum of
38860 870 data characters. (This allows for a total syslog line length of 1024, when
38861 additions such as timestamps are added.) If you are running a syslog
38862 replacement that can handle lines longer than the 1024 characters allowed by
38863 RFC 3164, you should set
38864 .code
38865 SYSLOG_LONG_LINES=yes
38866 .endd
38867 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38868 lines, but it still splits at internal newlines in &'reject'& log entries.
38869
38870 To make it easy to re-assemble split lines later, each component of a split
38871 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38872 where <&'n'&> is the component number and <&'m'&> is the total number of
38873 components in the entry. The / delimiter is used when the line was split
38874 because it was too long; if it was split because of an internal newline, the \
38875 delimiter is used. For example, supposing the length limit to be 50 instead of
38876 870, the following would be the result of a typical rejection message to
38877 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38878 name, and pid as added by syslog:
38879 .code
38880 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38881 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38882 [3/5]  when scanning for sender: missing or malformed lo
38883 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38884 [5/5] mple>)
38885 .endd
38886 The same error might cause the following lines to be written to &"rejectlog"&
38887 (LOG_NOTICE):
38888 .code
38889 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38890 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38891 [3/18] er when scanning for sender: missing or malformed
38892 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38893 [5\18] .example>)
38894 [6\18] Recipients: ph10@some.domain.cam.example
38895 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38896 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38897 [9\18]        id 16RdAL-0006pc-00
38898 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38899 [11\18] 09:43 +0100
38900 [12\18] F From: <>
38901 [13\18]   Subject: this is a test header
38902 [18\18]   X-something: this is another header
38903 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38904 [16\18] le>
38905 [17\18] B Bcc:
38906 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38907 .endd
38908 Log lines that are neither too long nor contain newlines are written to syslog
38909 without modification.
38910
38911 If only syslog is being used, the Exim monitor is unable to provide a log tail
38912 display, unless syslog is routing &'mainlog'& to a file on the local host and
38913 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38914 where it is.
38915
38916
38917
38918 .section "Log line flags" "SECID250"
38919 One line is written to the main log for each message received, and for each
38920 successful, unsuccessful, and delayed delivery. These lines can readily be
38921 picked out by the distinctive two-character flags that immediately follow the
38922 timestamp. The flags are:
38923 .itable none 0 0 2 10* left 90* left
38924 .irow &%<=%&     "message arrival"
38925 .irow &%(=%&     "message fakereject"
38926 .irow &%=>%&     "normal message delivery"
38927 .irow &%->%&     "additional address in same delivery"
38928 .irow &%>>%&     "cutthrough message delivery"
38929 .irow &%*>%&     "delivery suppressed by &%-N%&"
38930 .irow &%**%&     "delivery failed; address bounced"
38931 .irow &%==%&     "delivery deferred; temporary problem"
38932 .endtable
38933
38934
38935 .section "Logging message reception" "SECID251"
38936 .cindex "log" "reception line"
38937 The format of the single-line entry in the main log that is written for every
38938 message received is shown in the basic example below, which is split over
38939 several lines in order to fit it on the page:
38940 .code
38941 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38942   H=mailer.fict.example [192.168.123.123] U=exim
38943   P=smtp S=5678 id=<incoming message id>
38944 .endd
38945 The address immediately following &"<="& is the envelope sender address. A
38946 bounce message is shown with the sender address &"<>"&, and if it is locally
38947 generated, this is followed by an item of the form
38948 .code
38949 R=<message id>
38950 .endd
38951 which is a reference to the message that caused the bounce to be sent.
38952
38953 .cindex "HELO"
38954 .cindex "EHLO"
38955 For messages from other hosts, the H and U fields identify the remote host and
38956 record the RFC 1413 identity of the user that sent the message, if one was
38957 received. The number given in square brackets is the IP address of the sending
38958 host. If there is a single, unparenthesized  host name in the H field, as
38959 above, it has been verified to correspond to the IP address (see the
38960 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38961 by the remote host in the SMTP HELO or EHLO command, and has not been
38962 verified. If verification yields a different name to that given for HELO or
38963 EHLO, the verified name appears first, followed by the HELO or EHLO
38964 name in parentheses.
38965
38966 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38967 without brackets, in the HELO or EHLO command, leading to entries in
38968 the log containing text like these examples:
38969 .code
38970 H=(10.21.32.43) [192.168.8.34]
38971 H=([10.21.32.43]) [192.168.8.34]
38972 .endd
38973 This can be confusing. Only the final address in square brackets can be relied
38974 on.
38975
38976 For locally generated messages (that is, messages not received over TCP/IP),
38977 the H field is omitted, and the U field contains the login name of the caller
38978 of Exim.
38979
38980 .cindex "authentication" "logging"
38981 .cindex "AUTH" "logging"
38982 For all messages, the P field specifies the protocol used to receive the
38983 message. This is the value that is stored in &$received_protocol$&. In the case
38984 of incoming SMTP messages, the value indicates whether or not any SMTP
38985 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38986 session was encrypted, there is an additional X field that records the cipher
38987 suite that was used.
38988
38989 .cindex log protocol
38990 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38991 hosts that have authenticated themselves using the SMTP AUTH command. The first
38992 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38993 there is an additional item A= followed by the name of the authenticator that
38994 was used. If an authenticated identification was set up by the authenticator's
38995 &%server_set_id%& option, this is logged too, separated by a colon from the
38996 authenticator name.
38997
38998 .cindex "size" "of message"
38999 The id field records the existing message id, if present. The size of the
39000 received message is given by the S field. When the message is delivered,
39001 headers may be removed or added, so that the size of delivered copies of the
39002 message may not correspond with this value (and indeed may be different to each
39003 other).
39004
39005 The &%log_selector%& option can be used to request the logging of additional
39006 data when a message is received. See section &<<SECTlogselector>>& below.
39007
39008
39009
39010 .section "Logging deliveries" "SECID252"
39011 .cindex "log" "delivery line"
39012 The format of the single-line entry in the main log that is written for every
39013 delivery is shown in one of the examples below, for local and remote
39014 deliveries, respectively. Each example has been split into multiple lines in order
39015 to fit it on the page:
39016 .code
39017 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
39018   <marv@hitch.fict.example> R=localuser T=local_delivery
39019 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
39020   monk@holistic.fict.example R=dnslookup T=remote_smtp
39021   H=holistic.fict.example [192.168.234.234]
39022 .endd
39023 For ordinary local deliveries, the original address is given in angle brackets
39024 after the final delivery address, which might be a pipe or a file. If
39025 intermediate address(es) exist between the original and the final address, the
39026 last of these is given in parentheses after the final address. The R and T
39027 fields record the router and transport that were used to process the address.
39028
39029 If SMTP AUTH was used for the delivery there is an additional item A=
39030 followed by the name of the authenticator that was used.
39031 If an authenticated identification was set up by the authenticator's &%client_set_id%&
39032 option, this is logged too, as a second colon-separated list item.
39033 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
39034
39035 If a shadow transport was run after a successful local delivery, the log line
39036 for the successful delivery has an item added on the end, of the form
39037 .display
39038 &`ST=<`&&'shadow transport name'&&`>`&
39039 .endd
39040 If the shadow transport did not succeed, the error message is put in
39041 parentheses afterwards.
39042
39043 .cindex "asterisk" "after IP address"
39044 When more than one address is included in a single delivery (for example, two
39045 SMTP RCPT commands in one transaction) the second and subsequent addresses are
39046 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
39047 down a single SMTP connection, an asterisk follows the
39048 remote IP address (and port if enabled)
39049 in the log lines for the second and subsequent messages.
39050 When two or more messages are delivered down a single TLS connection, the
39051 DNS and some TLS-related information logged for the first message delivered
39052 will not be present in the log lines for the second and subsequent messages.
39053 TLS cipher information is still available.
39054
39055 .cindex "delivery" "cutthrough; logging"
39056 .cindex "cutthrough" "logging"
39057 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
39058 line precedes the reception line, since cutthrough waits for a possible
39059 rejection from the destination in case it can reject the sourced item.
39060
39061 The generation of a reply message by a filter file gets logged as a
39062 &"delivery"& to the addressee, preceded by &">"&.
39063
39064 The &%log_selector%& option can be used to request the logging of additional
39065 data when a message is delivered. See section &<<SECTlogselector>>& below.
39066
39067
39068 .section "Discarded deliveries" "SECID253"
39069 .cindex "discarded messages"
39070 .cindex "message" "discarded"
39071 .cindex "delivery" "discarded; logging"
39072 When a message is discarded as a result of the command &"seen finish"& being
39073 obeyed in a filter file which generates no deliveries, a log entry of the form
39074 .code
39075 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
39076   <low.club@bridge.example> R=userforward
39077 .endd
39078 is written, to record why no deliveries are logged. When a message is discarded
39079 because it is aliased to &":blackhole:"& the log line is like this:
39080 .code
39081 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
39082   <hole@nowhere.example> R=blackhole_router
39083 .endd
39084
39085
39086 .section "Deferred deliveries" "SECID254"
39087 When a delivery is deferred, a line of the following form is logged:
39088 .code
39089 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
39090   R=dnslookup T=smtp defer (146): Connection refused
39091 .endd
39092 In the case of remote deliveries, the error is the one that was given for the
39093 last IP address that was tried. Details of individual SMTP failures are also
39094 written to the log, so the above line would be preceded by something like
39095 .code
39096 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
39097   mail1.endrest.example [192.168.239.239]: Connection refused
39098 .endd
39099 When a deferred address is skipped because its retry time has not been reached,
39100 a message is written to the log, but this can be suppressed by setting an
39101 appropriate value in &%log_selector%&.
39102
39103
39104
39105 .section "Delivery failures" "SECID255"
39106 .cindex "delivery" "failure; logging"
39107 If a delivery fails because an address cannot be routed, a line of the
39108 following form is logged:
39109 .code
39110 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
39111   <jim@trek99.example>: unknown mail domain
39112 .endd
39113 If a delivery fails at transport time, the router and transport are shown, and
39114 the response from the remote host is included, as in this example:
39115 .code
39116 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
39117   R=dnslookup T=remote_smtp: SMTP error from remote mailer
39118   after pipelined RCPT TO:<ace400@pb.example>: host
39119   pbmail3.py.example [192.168.63.111]: 553 5.3.0
39120   <ace400@pb.example>...Addressee unknown
39121 .endd
39122 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
39123 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
39124 disabling PIPELINING. The log lines for all forms of delivery failure are
39125 flagged with &`**`&.
39126
39127
39128
39129 .section "Fake deliveries" "SECID256"
39130 .cindex "delivery" "fake; logging"
39131 If a delivery does not actually take place because the &%-N%& option has been
39132 used to suppress it, a normal delivery line is written to the log, except that
39133 &"=>"& is replaced by &"*>"&.
39134
39135
39136
39137 .section "Completion" "SECID257"
39138 A line of the form
39139 .code
39140 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
39141 .endd
39142 is written to the main log when a message is about to be removed from the spool
39143 at the end of its processing.
39144
39145
39146
39147
39148 .section "Summary of Fields in Log Lines" "SECID258"
39149 .cindex "log" "summary of fields"
39150 A summary of the field identifiers that are used in log lines is shown in
39151 the following table:
39152 .display
39153 &`A   `&        authenticator name (and optional id and sender)
39154 &`C   `&        SMTP confirmation on delivery
39155 &`Ci  `&        connection identifier
39156 &`    `&        command list for &"no mail in SMTP session"&
39157 &`CV  `&        certificate verification status
39158 &`D   `&        duration of &"no mail in SMTP session"&
39159 &`DKIM`&        domain verified in incoming message
39160 &`DN  `&        distinguished name from peer certificate
39161 &`DS  `&        DNSSEC secured lookups
39162 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
39163 &`F   `&        sender address (on delivery lines)
39164 &`H   `&        host name and IP address
39165 &`I   `&        local interface used
39166 &`id  `&        message id (from header) for incoming message
39167 &`K   `&        CHUNKING extension used
39168 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
39169 &`M8S `&        8BITMIME status for incoming message
39170 &`P   `&        on &`<=`& lines: protocol used
39171 &`    `&        on &`=>`& and &`**`& lines: return path
39172 &`PRDR`&        PRDR extension used
39173 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
39174 &`Q   `&        alternate queue name
39175 &`QT  `&        on &`=>`& lines: time spent on queue so far
39176 &`    `&        on &"Completed"& lines: time spent on queue
39177 &`R   `&        on &`<=`& lines: reference for local bounce
39178 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
39179 &`RT  `&        on &`<=`& lines: time taken for reception
39180 &`S   `&        size of message in bytes
39181 &`SNI `&        server name indication from TLS client hello
39182 &`ST  `&        shadow transport name
39183 &`T   `&        on &`<=`& lines: message subject (topic)
39184 &`TFO `&        connection took advantage of TCP Fast Open
39185 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
39186 &`U   `&        local user or RFC 1413 identity
39187 &`X   `&        TLS cipher suite
39188 .endd
39189
39190
39191 .section "Other log entries" "SECID259"
39192 Various other types of log entry are written from time to time. Most should be
39193 self-explanatory. Among the more common are:
39194
39195 .ilist
39196 .cindex "retry" "time not reached"
39197 &'retry time not reached'&&~&~An address previously suffered a temporary error
39198 during routing or local delivery, and the time to retry has not yet arrived.
39199 This message is not written to an individual message log file unless it happens
39200 during the first delivery attempt.
39201 .next
39202 &'retry time not reached for any host'&&~&~An address previously suffered
39203 temporary errors during remote delivery, and the retry time has not yet arrived
39204 for any of the hosts to which it is routed.
39205 .next
39206 .cindex "spool directory" "file locked"
39207 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
39208 some other Exim process is already working on the message. This can be quite
39209 common if queue running processes are started at frequent intervals. The
39210 &'exiwhat'& utility script can be used to find out what Exim processes are
39211 doing.
39212 .next
39213 .cindex "error" "ignored"
39214 &'error ignored'&&~&~There are several circumstances that give rise to this
39215 message:
39216 .olist
39217 Exim failed to deliver a bounce message whose age was greater than
39218 &%ignore_bounce_errors_after%&. The bounce was discarded.
39219 .next
39220 A filter file set up a delivery using the &"noerror"& option, and the delivery
39221 failed. The delivery was discarded.
39222 .next
39223 A delivery set up by a router configured with
39224 . ==== As this is a nested list, any displays it contains must be indented
39225 . ==== as otherwise they are too far to the left.
39226 .code
39227     errors_to = <>
39228 .endd
39229 failed. The delivery was discarded.
39230 .endlist olist
39231 .next
39232 .cindex DKIM "log line"
39233 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39234 logging and the message has a DKIM signature header.
39235 .endlist ilist
39236
39237
39238
39239
39240
39241 .section "Reducing or increasing what is logged" "SECTlogselector"
39242 .cindex "log" "selectors"
39243 By setting the &%log_selector%& global option, you can disable some of Exim's
39244 default logging to the main log, or you can request additional logging. The value of
39245 &%log_selector%& is made up of names preceded by plus or minus characters. For
39246 example:
39247 .code
39248 log_selector = +arguments -retry_defer
39249 .endd
39250 The list of optional log items is in the following table, with the default
39251 selection marked by asterisks:
39252 .itable none 0 0 3 2.8in left 10pt center 3in left
39253 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39254 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39255 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39256 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39257 .irow &`arguments`&                     &nbsp; "command line arguments"
39258 .irow &`connection_id`&                 &nbsp;  "connection identifier"
39259 .irow &`connection_reject`&             *       "connection rejections"
39260 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39261 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39262 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39263 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39264 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature; DKIM signing"
39265 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39266 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39267 .irow &`etrn`&                          *       "ETRN commands"
39268 .irow &`host_lookup_failed`&            *       "as it says"
39269 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39270 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39271 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39272 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39273 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39274 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39275 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39276 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39277 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39278 .irow &`queue_run`&                     *       "start and end queue runs"
39279 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39280 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39281 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39282 .irow &`pid`&                           &nbsp; "Exim process id"
39283 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39284 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39285 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39286 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39287 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39288 .irow &`rejected_header`&               *       "header contents on reject log"
39289 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39290 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39291 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39292 .irow &`sender_verify_fail`&            *       "sender verification failures"
39293 .irow &`size_reject`&                   *       "rejection because too big"
39294 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39295 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39296 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39297 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39298 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39299 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39300 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39301 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39302 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39303 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39304 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39305 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39306 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39307 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39308 .irow &`unknown_in_list`&               &nbsp; "lookup failed in list match"
39309 .irow &`all`&                           &nbsp; "&*all of the above*&"
39310 .endtable
39311 See also the &%slow_lookup_log%& main configuration option,
39312 section &<<SECID99>>&
39313
39314 More details on each of these items follows:
39315
39316 .ilist
39317 .cindex "8BITMIME"
39318 .cindex "log" "8BITMIME"
39319 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39320 which may help in tracking down interoperability issues with ancient MTAs
39321 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39322 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39323 &`7BIT`& and &`8BITMIME`& respectively.
39324 .next
39325 .cindex "&%warn%& ACL verb" "log when skipping"
39326 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39327 its conditions cannot be evaluated, a log line to this effect is written if
39328 this log selector is set.
39329 .next
39330 .cindex "log" "rewriting"
39331 .cindex "rewriting" "logging"
39332 &%address_rewrite%&: This applies both to global rewrites and per-transport
39333 rewrites, but not to rewrites in filters run as an unprivileged user (because
39334 such users cannot access the log).
39335 .next
39336 .cindex "log" "full parentage"
39337 &%all_parents%&: Normally only the original and final addresses are logged on
39338 delivery lines; with this selector, intermediate parents are given in
39339 parentheses between them.
39340 .next
39341 .cindex "log" "Exim arguments"
39342 .cindex "Exim arguments, logging"
39343 &%arguments%&: This causes Exim to write the arguments with which it was called
39344 to the main log, preceded by the current working directory. This is a debugging
39345 feature, added to make it easier to find out how certain MUAs call
39346 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39347 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39348 that are empty or that contain white space are quoted. Non-printing characters
39349 are shown as escape sequences. This facility cannot log unrecognized arguments,
39350 because the arguments are checked before the configuration file is read. The
39351 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39352 between the caller and Exim.
39353 .next
39354 .cindex "log" "connection identifier"
39355 &%connection_identifier%&: An identifier for the accepted connection is added to
39356 connection start and end lines and to message accept lines.
39357 The identifier is tagged by Ci=.
39358 The value is PID-based, so will reset on reboot and will wrap.
39359 .next
39360 .cindex "log" "connection rejections"
39361 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39362 connection is rejected, for whatever reason.
39363 .next
39364 .cindex "log" "delayed delivery"
39365 .cindex "delayed delivery, logging"
39366 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39367 started for an incoming message because the load is too high or too many
39368 messages were received on one connection. Logging does not occur if no delivery
39369 process is started because &%queue_only%& is set or &%-odq%& was used.
39370 .next
39371 .cindex "log" "delivery duration"
39372 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39373 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39374 If millisecond logging is enabled, short times will be shown with greater
39375 precision, eg. &`DT=0.304s`&.
39376 .next
39377 .cindex "log" "message size on delivery"
39378 .cindex "size" "of message"
39379 &%delivery_size%&: For each delivery, the size of message delivered is added to
39380 the &"=>"& line, tagged with S=.
39381 .next
39382 .cindex log "DKIM verification"
39383 .cindex DKIM "verification logging"
39384 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39385 verifies successfully a tag of DKIM is added, with one of the verified domains.
39386 .next
39387 .cindex log "DKIM verification"
39388 .cindex DKIM "verification logging"
39389 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39390 Also, on message delivery lines signing information (domain and selector)
39391 is added, tagged with DKIM=.
39392 .next
39393 .cindex "log" "dnslist defer"
39394 .cindex "DNS list" "logging defer"
39395 .cindex "black list (DNS)"
39396 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39397 DNS black list suffers a temporary error.
39398 .next
39399 .cindex log dnssec
39400 .cindex dnssec logging
39401 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39402 dns lookups gave secure results a tag of DS is added.
39403 For acceptance this covers the reverse and forward lookups for host name verification.
39404 It does not cover helo-name verification.
39405 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39406 .next
39407 .cindex "log" "ETRN commands"
39408 .cindex "ETRN" "logging"
39409 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39410 is run to determine whether or not it is actually accepted. An invalid ETRN
39411 command, or one received within a message transaction is not logged by this
39412 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39413 .next
39414 .cindex "log" "host lookup failure"
39415 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39416 any addresses, or when a lookup of an IP address fails to find a host name, a
39417 log line is written. This logging does not apply to direct DNS lookups when
39418 routing email addresses, but it does apply to &"byname"& lookups.
39419 .next
39420 .cindex "log" "ident timeout"
39421 .cindex "RFC 1413" "logging timeout"
39422 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39423 client's ident port times out.
39424 .next
39425 .cindex "log" "incoming interface"
39426 .cindex "log" "outgoing interface"
39427 .cindex "log" "local interface"
39428 .cindex "log" "local address and port"
39429 .cindex "TCP/IP" "logging local address and port"
39430 .cindex "interface" "logging"
39431 &%incoming_interface%&: The interface on which a message was received is added
39432 to the &"<="& line as an IP address in square brackets, tagged by I= and
39433 followed by a colon and the port number. The local interface and port are also
39434 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39435 rejection lines, and (despite the name) to outgoing
39436 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39437 The latter can be disabled by turning off the &%outgoing_interface%& option.
39438 .next
39439 .cindex log "incoming proxy address"
39440 .cindex proxy "logging proxy address"
39441 .cindex "TCP/IP" "logging proxy address"
39442 &%proxy%&: The internal (closest to the system running Exim) IP address
39443 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39444 on a proxied connection
39445 or the &"=>"& line for a message delivered on a proxied connection.
39446 See &<<SECTproxyInbound>>& for more information.
39447 .next
39448 .cindex "log" "incoming remote port"
39449 .cindex "port" "logging remote"
39450 .cindex "TCP/IP" "logging incoming remote port"
39451 .vindex "&$sender_fullhost$&"
39452 .vindex "&$sender_rcvhost$&"
39453 &%incoming_port%&: The remote port number from which a message was received is
39454 added to log entries and &'Received:'& header lines, following the IP address
39455 in square brackets, and separated from it by a colon. This is implemented by
39456 changing the value that is put in the &$sender_fullhost$& and
39457 &$sender_rcvhost$& variables. Recording the remote port number has become more
39458 important with the widening use of NAT (see RFC 2505).
39459 .next
39460 .cindex "log" "dropped connection"
39461 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39462 connection is unexpectedly dropped.
39463 .next
39464 .cindex "log" "millisecond timestamps"
39465 .cindex millisecond logging
39466 .cindex timestamps "millisecond, in logs"
39467 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39468 appended to the seconds value.
39469 .next
39470 .cindex "log" "message id"
39471 &%msg_id%&: The value of the Message-ID: header.
39472 .next
39473 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39474 This will be either because the message is a bounce, or was submitted locally
39475 (submission mode) without one.
39476 The field identifier will have an asterix appended: &"id*="&.
39477 .next
39478 .cindex "log" "outgoing interface"
39479 .cindex "log" "local interface"
39480 .cindex "log" "local address and port"
39481 .cindex "TCP/IP" "logging local address and port"
39482 .cindex "interface" "logging"
39483 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39484 interface on which a message was sent is added to delivery lines as an I= tag
39485 followed by IP address in square brackets. You can disable this by turning
39486 off the &%outgoing_interface%& option.
39487 .next
39488 .cindex "log" "outgoing remote port"
39489 .cindex "port" "logging outgoing remote"
39490 .cindex "TCP/IP" "logging outgoing remote port"
39491 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39492 containing => tags) following the IP address.
39493 The local port is also added if &%incoming_interface%& and
39494 &%outgoing_interface%& are both enabled.
39495 This option is not included in the default setting, because for most ordinary
39496 configurations, the remote port number is always 25 (the SMTP port), and the
39497 local port is a random ephemeral port.
39498 .next
39499 .cindex "log" "process ids in"
39500 .cindex "pid (process id)" "in log lines"
39501 &%pid%&: The current process id is added to every log line, in square brackets,
39502 immediately after the time and date.
39503 .next
39504 .cindex log pipelining
39505 .cindex pipelining "logging outgoing"
39506 &%pipelining%&: A field is added to delivery and accept
39507 log lines when the ESMTP PIPELINING extension was used.
39508 The field is a single "L".
39509
39510 On accept lines, where PIPELINING was offered but not used by the client,
39511 the field has a minus appended.
39512
39513 .cindex "pipelining" "early connection"
39514 If Exim is built without the DISABLE_PIPE_CONNECT build option
39515 accept "L" fields have a period appended if the feature was
39516 offered but not used, or an asterisk appended if used.
39517 Delivery "L" fields have an asterisk appended if used.
39518
39519 .next
39520 .cindex "log" "queue run"
39521 .cindex "queue runner" "logging"
39522 &%queue_run%&: The start and end of every queue run are logged.
39523 .next
39524 .cindex "log" "queue time"
39525 &%queue_time%&: The amount of time the message has been in the queue on the
39526 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39527 &`QT=3m45s`&.
39528 If millisecond logging is enabled, short times will be shown with greater
39529 precision, eg. &`QT=1.578s`&.
39530 .next
39531 &%queue_time_overall%&: The amount of time the message has been in the queue on
39532 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39533 example, &`QT=3m45s`&.
39534 .next
39535 .cindex "log" "receive duration"
39536 &%receive_time%&: For each message, the amount of real time it has taken to
39537 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39538 If millisecond logging is enabled, short times will be shown with greater
39539 precision, eg. &`RT=0.204s`&.
39540 .next
39541 .cindex "log" "recipients"
39542 &%received_recipients%&: The recipients of a message are listed in the main log
39543 as soon as the message is received. The list appears at the end of the log line
39544 that is written when a message is received, preceded by the word &"for"&. The
39545 addresses are listed after they have been qualified, but before any rewriting
39546 has taken place.
39547 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39548 in the list.
39549 .next
39550 .cindex "log" "sender reception"
39551 &%received_sender%&: The unrewritten original sender of a message is added to
39552 the end of the log line that records the message's arrival, after the word
39553 &"from"& (before the recipients if &%received_recipients%& is also set).
39554 .next
39555 .cindex "log" "header lines for rejection"
39556 &%rejected_header%&: If a message's header has been received at the time a
39557 rejection is written to the reject log, the complete header is added to the
39558 log. Header logging can be turned off individually for messages that are
39559 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39560 .next
39561 .cindex "log" "retry defer"
39562 &%retry_defer%&: A log line is written if a delivery is deferred because a
39563 retry time has not yet been reached. However, this &"retry time not reached"&
39564 message is always omitted from individual message logs after the first delivery
39565 attempt.
39566 .next
39567 .cindex "log" "return path"
39568 &%return_path_on_delivery%&: The return path that is being transmitted with
39569 the message is included in delivery and bounce lines, using the tag P=.
39570 This is omitted if no delivery actually happens, for example, if routing fails,
39571 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39572 .next
39573 .cindex "log" "sender on delivery"
39574 &%sender_on_delivery%&: The message's sender address is added to every delivery
39575 and bounce line, tagged by F= (for &"from"&).
39576 This is the original sender that was received with the message; it is not
39577 necessarily the same as the outgoing return path.
39578 .next
39579 .cindex "log" "sender verify failure"
39580 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39581 gives details of a sender verification failure is not written. Log lines for
39582 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39583 detail is lost.
39584 .next
39585 .cindex "log" "size rejection"
39586 &%size_reject%&: A log line is written whenever a message is rejected because
39587 it is too big.
39588 .next
39589 .cindex "log" "frozen messages; skipped"
39590 .cindex "frozen messages" "logging skipping"
39591 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39592 queue run because it another process is already delivering it or because
39593 it is frozen.
39594 .cindex "&""spool file is locked""&"
39595 .cindex "&""message is frozen""&"
39596 The message that is written is either &"spool file is locked"& or
39597 &"message is frozen"&.
39598 .next
39599 .cindex "log" "smtp confirmation"
39600 .cindex "SMTP" "logging confirmation"
39601 .cindex "LMTP" "logging confirmation"
39602 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39603 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39604 A number of MTAs (including Exim) return an identifying string in this
39605 response.
39606 .next
39607 .cindex "log" "SMTP connections"
39608 .cindex "SMTP" "logging connections"
39609 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39610 established or closed, unless the connection is from a host that matches
39611 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39612 only when the closure is unexpected.) This applies to connections from local
39613 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39614 dropped in the middle of a message, a log line is always written, whether or
39615 not this selector is set, but otherwise nothing is written at the start and end
39616 of connections unless this selector is enabled.
39617
39618 For TCP/IP connections to an Exim daemon, the current number of connections is
39619 included in the log message for each new connection, but note that the count is
39620 reset if the daemon is restarted.
39621 Also, because connections are closed (and the closure is logged) in
39622 subprocesses, the count may not include connections that have been closed but
39623 whose termination the daemon has not yet noticed. Thus, while it is possible to
39624 match up the opening and closing of connections in the log, the value of the
39625 logged counts may not be entirely accurate.
39626 .next
39627 .cindex "log" "SMTP transaction; incomplete"
39628 .cindex "SMTP" "logging incomplete transactions"
39629 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39630 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39631 and the message sender plus any accepted recipients are included in the log
39632 line. This can provide evidence of dictionary attacks.
39633 .next
39634 .cindex "log" "non-MAIL SMTP sessions"
39635 .cindex "MAIL" "logging session without"
39636 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39637 connection terminates without having issued a MAIL command. This includes both
39638 the case when the connection is dropped, and the case when QUIT is used. It
39639 does not include cases where the connection is rejected right at the start (by
39640 an ACL, or because there are too many connections, or whatever). These cases
39641 already have their own log lines.
39642
39643 The log line that is written contains the identity of the client in the usual
39644 way, followed by D= and a time, which records the duration of the connection.
39645 If the connection was authenticated, this fact is logged exactly as it is for
39646 an incoming message, with an A= item. If the connection was encrypted, CV=,
39647 DN=, and X= items may appear as they do for an incoming message, controlled by
39648 the same logging options.
39649
39650 Finally, if any SMTP commands were issued during the connection, a C= item
39651 is added to the line, listing the commands that were used. For example,
39652 .code
39653 C=EHLO,QUIT
39654 .endd
39655 shows that the client issued QUIT straight after EHLO. If there were fewer
39656 than 20 commands, they are all listed. If there were more than 20 commands,
39657 the last 20 are listed, preceded by &"..."&. However, with the default
39658 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39659 have been aborted before 20 non-mail commands are processed.
39660 .next
39661 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39662 colon-separated, is appended to the A= item for a message arrival or delivery
39663 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39664 was accepted or used.
39665 .next
39666 .cindex "log" "SMTP protocol error"
39667 .cindex "SMTP" "logging protocol error"
39668 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39669 encountered. Exim does not have perfect detection of all protocol errors
39670 because of transmission delays and the use of pipelining. If PIPELINING has
39671 been advertised to a client, an Exim server assumes that the client will use
39672 it, and therefore it does not count &"expected"& errors (for example, RCPT
39673 received after rejecting MAIL) as protocol errors.
39674 .next
39675 .cindex "SMTP" "logging syntax errors"
39676 .cindex "SMTP" "syntax errors; logging"
39677 .cindex "SMTP" "unknown command; logging"
39678 .cindex "log" "unknown SMTP command"
39679 .cindex "log" "SMTP syntax error"
39680 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39681 encountered. An unrecognized command is treated as a syntax error. For an
39682 external connection, the host identity is given; for an internal connection
39683 using &%-bs%& the sender identification (normally the calling user) is given.
39684 .next
39685 .cindex "log" "subject"
39686 .cindex "subject, logging"
39687 &%subject%&: The subject of the message is added to the arrival log line,
39688 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39689 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39690 specifies whether characters with values greater than 127 should be logged
39691 unchanged, or whether they should be rendered as escape sequences.
39692 .next
39693 .cindex "log" "certificate verification"
39694 .cindex log DANE
39695 .cindex DANE logging
39696 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39697 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39698 verified
39699 using a CA trust anchor,
39700 &`CV=dane`& if using a DNS trust anchor,
39701 and &`CV=no`& if not.
39702 .next
39703 .cindex "log" "TLS cipher"
39704 .cindex "TLS" "logging cipher"
39705 &%tls_cipher%&: When a message is sent or received over an encrypted
39706 connection, the cipher suite used is added to the log line, preceded by X=.
39707 .next
39708 .cindex "log" "TLS peer DN"
39709 .cindex "TLS" "logging peer DN"
39710 &%tls_peerdn%&: When a message is sent or received over an encrypted
39711 connection, and a certificate is supplied by the remote host, the peer DN is
39712 added to the log line, preceded by DN=.
39713 .next
39714 .cindex "log" "TLS resumption"
39715 .cindex "TLS" "logging session resumption"
39716 &%tls_resumption%&: When a message is sent or received over an encrypted
39717 connection and the TLS session resumed one used on a previous TCP connection,
39718 an asterisk is appended to the X= cipher field in the log line.
39719 .next
39720 .cindex "log" "TLS SNI"
39721 .cindex "TLS" "logging SNI"
39722 .cindex SNI logging
39723 &%tls_sni%&: When a message is received over an encrypted connection, and
39724 the remote host provided the Server Name Indication extension, the SNI is
39725 added to the log line, preceded by SNI=.
39726 .next
39727 .cindex "log" "DNS failure in list"
39728 &%unknown_in_list%&: This setting causes a log entry to be written when the
39729 result of a list match is failure because a DNS lookup failed, or because
39730 a bad IP address was in the list.
39731 .endlist
39732
39733
39734 .section "Message log" "SECID260"
39735 .cindex "message" "log file for"
39736 .cindex "log" "message log; description of"
39737 .cindex "&_msglog_& directory"
39738 .oindex "&%preserve_message_logs%&"
39739 In addition to the general log files, Exim writes a log file for each message
39740 that it handles. The names of these per-message logs are the message ids, and
39741 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39742 message log contains copies of the log lines that apply to the message. This
39743 makes it easier to inspect the status of an individual message without having
39744 to search the main log. A message log is deleted when processing of the message
39745 is complete, unless &%preserve_message_logs%& is set, but this should be used
39746 only with great care because they can fill up your disk very quickly.
39747
39748 On a heavily loaded system, it may be desirable to disable the use of
39749 per-message logs, in order to reduce disk I/O. This can be done by setting the
39750 &%message_logs%& option false.
39751 .ecindex IIDloggen
39752
39753
39754
39755
39756 . ////////////////////////////////////////////////////////////////////////////
39757 . ////////////////////////////////////////////////////////////////////////////
39758
39759 .chapter "Exim utilities" "CHAPutils"
39760 .scindex IIDutils "utilities"
39761 A number of utility scripts and programs are supplied with Exim and are
39762 described in this chapter. There is also the Exim Monitor, which is covered in
39763 the next chapter. The utilities described here are:
39764
39765 .itable none 0 0 3  7* left  15* left  40* left
39766 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39767   "list what Exim processes are doing"
39768 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39769 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39770 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39771 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39772                                                 various criteria"
39773 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39774 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39775   "extract statistics from the log"
39776 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39777   "check address acceptance from given IP"
39778 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39779 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39780 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39781 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39782 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39783 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39784 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39785 .endtable
39786
39787 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39788 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39789 &url(https://duncanthrax.net/exilog/) for details.
39790
39791
39792
39793
39794 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39795 .cindex "&'exiwhat'&"
39796 .cindex "process, querying"
39797 .cindex "SIGUSR1"
39798 On operating systems that can restart a system call after receiving a signal
39799 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39800 a line describing what it is doing to the file &_exim-process.info_& in the
39801 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39802 processes it can find, having first emptied the file. It then waits for one
39803 second to allow the Exim processes to react before displaying the results. In
39804 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39805 send the signal to the Exim processes, so it is normally run as root.
39806
39807 &*Warning*&: This is not an efficient process. It is intended for occasional
39808 use by system administrators. It is not sensible, for example, to set up a
39809 script that sends SIGUSR1 signals to Exim processes at short intervals.
39810
39811
39812 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39813 varies in different operating systems. Not only are different options used,
39814 but the format of the output is different. For this reason, there are some
39815 system configuration options that configure exactly how &'exiwhat'& works. If
39816 it doesn't seem to be working for you, check the following compile-time
39817 options:
39818 .itable none 0 0 2 30* left 70* left
39819 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39820 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39821 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39822 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39823 .endtable
39824 An example of typical output from &'exiwhat'& is
39825 .code
39826 164 daemon: -q1h, listening on port 25
39827 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39828 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39829   [10.19.42.42] (editor@ref.example)
39830 10592 handling incoming call from [192.168.243.242]
39831 10628 accepting a local non-SMTP message
39832 .endd
39833 The first number in the output line is the process number. The third line has
39834 been split here, in order to fit it on the page.
39835
39836
39837
39838 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39839 .cindex "&'exiqgrep'&"
39840 .cindex "queue" "grepping"
39841 This utility is a Perl script contributed by Matt Hubbard. It runs
39842 .code
39843 exim -bpu
39844 .endd
39845 or (in case &*-a*& switch is specified)
39846 .code
39847 exim -bp
39848 .endd
39849 to obtain a queue listing, and then greps the output to select messages
39850 that match given criteria. The following selection options are available:
39851
39852 .vlist
39853 .vitem &*-f*&&~<&'regex'&>
39854 Match the sender address using a case-insensitive search. The field that is
39855 tested is enclosed in angle brackets, so you can test for bounce messages with
39856 .code
39857 exiqgrep -f '^<>$'
39858 .endd
39859 .vitem &*-r*&&~<&'regex'&>
39860 Match a recipient address using a case-insensitive search. The field that is
39861 tested is not enclosed in angle brackets.
39862
39863 .vitem &*-s*&&~<&'regex'&>
39864 Match against the size field.
39865
39866 .vitem &*-y*&&~<&'seconds'&>
39867 Match messages that are younger than the given time.
39868
39869 .vitem &*-o*&&~<&'seconds'&>
39870 Match messages that are older than the given time.
39871
39872 .vitem &*-z*&
39873 Match only frozen messages.
39874
39875 .vitem &*-x*&
39876 Match only non-frozen messages.
39877
39878 .vitem &*-G*&&~<&'queuename'&>
39879 Match only messages in the given queue.  Without this, the default queue is searched.
39880 .endlist
39881
39882 The following options control the format of the output:
39883
39884 .vlist
39885 .vitem &*-c*&
39886 Display only the count of matching messages.
39887
39888 .vitem &*-l*&
39889 Long format &-- display the full message information as output by Exim. This is
39890 the default.
39891
39892 .vitem &*-i*&
39893 Display message ids only.
39894
39895 .vitem &*-b*&
39896 Brief format &-- one line per message.
39897
39898 .vitem &*-R*&
39899 Display messages in reverse order.
39900
39901 .vitem &*-a*&
39902 Include delivered recipients in queue listing.
39903 .endlist
39904
39905 The following options give alternates for configuration:
39906
39907 .vlist
39908 .vitem &*-C*&&~<&'config&~file'&>
39909 is used to specify an alternate &_exim.conf_& which might
39910 contain alternate exim configuration the queue management might be using.
39911
39912 .vitem &*-E*&&~<&'path'&>
39913 can be used to specify a path for the exim binary,
39914 overriding the built-in one.
39915 .endlist
39916
39917 There is one more option, &%-h%&, which outputs a list of options.
39918 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39919
39920
39921
39922 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39923 .cindex "&'exiqsumm'&"
39924 .cindex "queue" "summary"
39925 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39926 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39927 running a command such as
39928 .code
39929 exim -bp | exiqsumm
39930 .endd
39931 The output consists of one line for each domain that has messages waiting for
39932 it, as in the following example:
39933 .code
39934 3   2322   74m   66m  msn.com.example
39935 .endd
39936 Each line lists the number of pending deliveries for a domain, their total
39937 volume, and the length of time that the oldest and the newest messages have
39938 been waiting. Note that the number of pending deliveries is greater than the
39939 number of messages when messages have more than one recipient.
39940
39941 A summary line is output at the end. By default the output is sorted on the
39942 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39943 the output to be sorted by oldest message and by count of messages,
39944 respectively. There are also three options that split the messages for each
39945 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39946 separates frozen messages, and &%-s%& separates messages according to their
39947 sender.
39948
39949 The output of &'exim -bp'& contains the original addresses in the message, so
39950 this also applies to the output from &'exiqsumm'&. No domains from addresses
39951 generated by aliasing or forwarding are included (unless the &%one_time%&
39952 option of the &(redirect)& router has been used to convert them into &"top
39953 level"& addresses).
39954
39955
39956
39957
39958 .section "Extracting specific information from the log (exigrep)" &&&
39959          "SECTextspeinf"
39960 .cindex "&'exigrep'&"
39961 .cindex "log" "extracts; grepping for"
39962 The &'exigrep'& utility is a Perl script that searches one or more main log
39963 files for entries that match a given pattern. When it finds a match, it
39964 extracts all the log entries for the relevant message, not just those that
39965 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39966 given message, or all mail for a given user, or for a given host, for example.
39967 The input files can be in Exim log format or syslog format.
39968 If a matching log line is not associated with a specific message, it is
39969 included in &'exigrep'&'s output without any additional lines. The usage is:
39970 .display
39971 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39972 .endd
39973 If no log filenames are given on the command line, the standard input is read.
39974
39975 The &%-t%& argument specifies a number of seconds. It adds an additional
39976 condition for message selection. Messages that are complete are shown only if
39977 they spent more than <&'n'&> seconds in the queue.
39978
39979 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39980 makes it case-sensitive. This may give a performance improvement when searching
39981 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39982 option; with &%-I%& they do not. In both cases it is possible to change the
39983 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39984
39985 The &%-l%& option means &"literal"&, that is, treat all characters in the
39986 pattern as standing for themselves. Otherwise the pattern must be a Perl
39987 regular expression.
39988
39989 The &%-v%& option inverts the matching condition. That is, a line is selected
39990 if it does &'not'& match the pattern.
39991
39992 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39993 that are generated as a result/response to a message that &'exigrep'& matched
39994 normally.
39995
39996 Example of &%-M%&:
39997 user_a sends a message to user_b, which generates a bounce back to user_b. If
39998 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39999 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
40000 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
40001 when searching for &"user_a"& will show both messages since the bounce is
40002 &"related"& to or a &"result"& of the first message that was found by the
40003 search term.
40004
40005 If the location of a &'zcat'& command is known from the definition of
40006 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
40007 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
40008 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
40009 autodetection of some well known compression extensions.
40010
40011
40012 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
40013 .cindex "&'exipick'&"
40014 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
40015 lists messages from the queue according to a variety of criteria. For details
40016 of &'exipick'&'s facilities, run &'exipick'& with
40017 the &%--help%& option.
40018
40019
40020 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
40021 .cindex "log" "cycling local files"
40022 .cindex "cycling logs"
40023 .cindex "&'exicyclog'&"
40024 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
40025 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
40026 you are using log files with datestamps in their names (see section
40027 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
40028 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
40029 There are two command line options for &'exicyclog'&:
40030 .ilist
40031 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
40032 default that is set when Exim is built. The default default is 10.
40033 .next
40034 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
40035 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
40036 overriding the script's default, which is to find the setting from Exim's
40037 configuration.
40038 .endlist
40039
40040 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
40041 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
40042 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
40043 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
40044 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
40045 logs are handled similarly.
40046
40047 If the limit is greater than 99, the script uses 3-digit numbers such as
40048 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
40049 to one that is greater, or &'vice versa'&, you will have to fix the names of
40050 any existing log files.
40051
40052 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
40053 the end are deleted. All files with numbers greater than 01 are compressed,
40054 using a compression command which is configured by the COMPRESS_COMMAND
40055 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
40056 root &%crontab%& entry of the form
40057 .code
40058 1 0 * * * su exim -c /usr/exim/bin/exicyclog
40059 .endd
40060 assuming you have used the name &"exim"& for the Exim user. You can run
40061 &'exicyclog'& as root if you wish, but there is no need.
40062
40063
40064
40065 .section "Mail statistics (eximstats)" "SECTmailstat"
40066 .cindex "statistics"
40067 .cindex "&'eximstats'&"
40068 A Perl script called &'eximstats'& is provided for extracting statistical
40069 information from log files. The output is either plain text, or HTML.
40070 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
40071 . --- 404 error and everything else points to that.
40072
40073 The &'eximstats'& script has been hacked about quite a bit over time. The
40074 latest version is the result of some extensive revision by Steve Campbell. A
40075 lot of information is given by default, but there are options for suppressing
40076 various parts of it. Following any options, the arguments to the script are a
40077 list of files, which should be main log files. For example:
40078 .code
40079 eximstats -nr /var/spool/exim/log/mainlog.01
40080 .endd
40081 By default, &'eximstats'& extracts information about the number and volume of
40082 messages received from or delivered to various hosts. The information is sorted
40083 both by message count and by volume, and the top fifty hosts in each category
40084 are listed on the standard output. Similar information, based on email
40085 addresses or domains instead of hosts can be requested by means of various
40086 options. For messages delivered and received locally, similar statistics are
40087 also produced per user.
40088
40089 The output also includes total counts and statistics about delivery errors, and
40090 histograms showing the number of messages received and deliveries made in each
40091 hour of the day. A delivery with more than one address in its envelope (for
40092 example, an SMTP transaction with more than one RCPT command) is counted
40093 as a single delivery by &'eximstats'&.
40094
40095 Though normally more deliveries than receipts are reported (as messages may
40096 have multiple recipients), it is possible for &'eximstats'& to report more
40097 messages received than delivered, even though the queue is empty at the start
40098 and end of the period in question. If an incoming message contains no valid
40099 recipients, no deliveries are recorded for it. A bounce message is handled as
40100 an entirely separate message.
40101
40102 &'eximstats'& always outputs a grand total summary giving the volume and number
40103 of messages received and deliveries made, and the number of hosts involved in
40104 each case. It also outputs the number of messages that were delayed (that is,
40105 not completely delivered at the first attempt), and the number that had at
40106 least one address that failed.
40107
40108 The remainder of the output is in sections that can be independently disabled
40109 or modified by various options. It consists of a summary of deliveries by
40110 transport, histograms of messages received and delivered per time interval
40111 (default per hour), information about the time messages spent in the queue,
40112 a list of relayed messages, lists of the top fifty sending hosts, local
40113 senders, destination hosts, and destination local users by count and by volume,
40114 and a list of delivery errors that occurred.
40115
40116 The relay information lists messages that were actually relayed, that is, they
40117 came from a remote host and were directly delivered to some other remote host,
40118 without being processed (for example, for aliasing or forwarding) locally.
40119
40120 There are quite a few options for &'eximstats'& to control exactly what it
40121 outputs. These are documented in the Perl script itself, and can be extracted
40122 by running the command &(perldoc)& on the script. For example:
40123 .code
40124 perldoc /usr/exim/bin/eximstats
40125 .endd
40126
40127 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
40128 .cindex "&'exim_checkaccess'&"
40129 .cindex "policy control" "checking access"
40130 .cindex "checking access"
40131 The &%-bh%& command line argument allows you to run a fake SMTP session with
40132 debugging output, in order to check what Exim is doing when it is applying
40133 policy controls to incoming SMTP mail. However, not everybody is sufficiently
40134 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
40135 sometimes you just want to answer the question &"Does this address have
40136 access?"& without bothering with any further details.
40137
40138 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
40139 two arguments, an IP address and an email address:
40140 .code
40141 exim_checkaccess 10.9.8.7 A.User@a.domain.example
40142 .endd
40143 The utility runs a call to Exim with the &%-bh%& option, to test whether the
40144 given email address would be accepted in a RCPT command in a TCP/IP
40145 connection from the host with the given IP address. The output of the utility
40146 is either the word &"accepted"&, or the SMTP error response, for example:
40147 .code
40148 Rejected:
40149 550 Relay not permitted
40150 .endd
40151 When running this test, the utility uses &`<>`& as the envelope sender address
40152 for the MAIL command, but you can change this by providing additional
40153 options. These are passed directly to the Exim command. For example, to specify
40154 that the test is to be run with the sender address &'himself@there.example'&
40155 you can use:
40156 .code
40157 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
40158                  -f himself@there.example
40159 .endd
40160 Note that these additional Exim command line items must be given after the two
40161 mandatory arguments.
40162
40163 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
40164 while running its checks. You can run checks that include callouts by using
40165 &%-bhc%&, but this is not yet available in a &"packaged"& form.
40166
40167
40168
40169 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
40170 .cindex "DBM" "building dbm files"
40171 .cindex "building DBM files"
40172 .cindex "&'exim_dbmbuild'&"
40173 .cindex "lower casing"
40174 .cindex "binary zero" "in lookup key"
40175 The &'exim_dbmbuild'& program reads an input file containing keys and data in
40176 the format used by the &(lsearch)& lookup (see section
40177 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
40178 names as keys and the remainder of the information as data. The lower-casing
40179 can be prevented by calling the program with the &%-nolc%& option.
40180
40181 A terminating zero is included as part of the key string. This is expected by
40182 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
40183 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
40184 strings or the data strings. The &(dbmnz)& lookup type can be used with such
40185 files.
40186
40187 The program requires two arguments: the name of the input file (which can be a
40188 single hyphen to indicate the standard input), and the name of the output file.
40189 It creates the output under a temporary name, and then renames it if all went
40190 well.
40191
40192 .cindex "USE_DB"
40193 If the native DB interface is in use (USE_DB is set in a compile-time
40194 configuration file &-- this is common in free versions of Unix) the two
40195 filenames must be different, because in this mode the Berkeley DB functions
40196 create a single output file using exactly the name given. For example,
40197 .code
40198 exim_dbmbuild /etc/aliases /etc/aliases.db
40199 .endd
40200 reads the system alias file and creates a DBM version of it in
40201 &_/etc/aliases.db_&.
40202
40203 In systems that use the &'ndbm'& routines (mostly proprietary versions of
40204 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
40205 environment, the suffixes are added to the second argument of
40206 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
40207 when the Berkeley functions are used in compatibility mode (though this is not
40208 recommended), because in that case it adds a &_.db_& suffix to the filename.
40209
40210 If a duplicate key is encountered, the program outputs a warning, and when it
40211 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
40212 option is used. By default, only the first of a set of duplicates is used &--
40213 this makes it compatible with &(lsearch)& lookups. There is an option
40214 &%-lastdup%& which causes it to use the data for the last duplicate instead.
40215 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
40216 &%stderr%&. For other errors, where it doesn't actually make a new file, the
40217 return code is 2.
40218
40219
40220
40221
40222 .section "Finding individual retry times (exinext)" "SECTfinindret"
40223 .cindex "retry" "times"
40224 .cindex "&'exinext'&"
40225 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40226 fish specific information out of the retry database. Given a mail domain (or a
40227 complete address), it looks up the hosts for that domain, and outputs any retry
40228 information for the hosts or for the domain. At present, the retry information
40229 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40230 output. For example:
40231 .code
40232 $ exinext piglet@milne.fict.example
40233 kanga.milne.example:192.168.8.1 error 146: Connection refused
40234   first failed: 21-Feb-1996 14:57:34
40235   last tried:   21-Feb-1996 14:57:34
40236   next try at:  21-Feb-1996 15:02:34
40237 roo.milne.example:192.168.8.3 error 146: Connection refused
40238   first failed: 20-Jan-1996 13:12:08
40239   last tried:   21-Feb-1996 11:42:03
40240   next try at:  21-Feb-1996 19:42:03
40241   past final cutoff time
40242 .endd
40243 You can also give &'exinext'& a local part, without a domain, and it
40244 will give any retry information for that local part in your default domain.
40245 A message id can be used to obtain retry information pertaining to a specific
40246 message. This exists only when an attempt to deliver a message to a remote host
40247 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40248 &'exinext'& is not particularly efficient, but then it is not expected to be
40249 run very often.
40250
40251 The &'exinext'& utility calls Exim to find out information such as the location
40252 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40253 passed on to the &'exim'& commands. The first specifies an alternate Exim
40254 configuration file, and the second sets macros for use within the configuration
40255 file. These features are mainly to help in testing, but might also be useful in
40256 environments where more than one configuration file is in use.
40257
40258
40259
40260 .section "Hints database maintenance" "SECThindatmai"
40261 .cindex "hints database" "maintenance"
40262 .cindex "maintaining Exim's hints database"
40263 Three utility programs are provided for maintaining the DBM files that Exim
40264 uses to contain its delivery hint information. Each program requires two
40265 arguments. The first specifies the name of Exim's spool directory, and the
40266 second is the name of the database it is to operate on. These are as follows:
40267
40268 .ilist
40269 &'retry'&: the database of retry information
40270 .next
40271 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40272 for remote hosts
40273 .next
40274 &'callout'&: the callout cache
40275 .next
40276 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40277 .next
40278 &'tls'&: TLS session resumption data
40279 .next
40280 &'misc'&: other hints data
40281 .endlist
40282
40283 The &'misc'& database is used for
40284
40285 .ilist
40286 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40287 &(smtp)& transport)
40288 .next
40289 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40290 in a transport)
40291 .next
40292 Recording EHLO-time facilities advertised by hosts
40293 .next
40294 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40295 .endlist
40296
40297
40298
40299 .subsection "exim_dumpdb" "SECTdumpdb"
40300 .cindex "&'exim_dumpdb'&"
40301 The entire contents of a database are written to the standard output by the
40302 &'exim_dumpdb'& program,
40303 taking as arguments the spool and database names.
40304 An option &'-z'& may be given to request times in UTC;
40305 otherwise times are in the local timezone.
40306 An option &'-k'& may be given to dump only the record keys.
40307 For example, to dump the retry database:
40308 .code
40309 exim_dumpdb /var/spool/exim retry
40310 .endd
40311 For the retry database
40312 two lines of output are produced for each entry:
40313 .code
40314 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40315 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40316 .endd
40317 The first item on the first line is the key of the record. It starts with one
40318 of the letters R, or T, depending on whether it refers to a routing or
40319 transport retry. For a local delivery, the next part is the local address; for
40320 a remote delivery it is the name of the remote host, followed by its failing IP
40321 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40322 transport). If the remote port is not the standard one (port 25), it is added
40323 to the IP address. Then there follows an error code, an additional error code,
40324 and a textual description of the error.
40325
40326 The three times on the second line are the time of first failure, the time of
40327 the last delivery attempt, and the computed time for the next attempt. The line
40328 ends with an asterisk if the cutoff time for the last retry rule has been
40329 exceeded.
40330
40331 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40332 consists of a host name followed by a list of ids for messages that are or were
40333 waiting to be delivered to that host. If there are a very large number for any
40334 one host, continuation records, with a sequence number added to the host name,
40335 may be seen. The data in these records is often out of date, because a message
40336 may be routed to several alternative hosts, and Exim makes no effort to keep
40337 cross-references.
40338
40339
40340
40341 .subsection "exim_tidydb" "SECTtidydb"
40342 .cindex "&'exim_tidydb'&"
40343 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40344 database. If run with no options, it removes all records that are more than 30
40345 days old. The age is calculated from the date and time that the record was last
40346 updated. Note that, in the case of the retry database, it is &'not'& the time
40347 since the first delivery failure. Information about a host that has been down
40348 for more than 30 days will remain in the database, provided that the record is
40349 updated sufficiently often.
40350
40351 The cutoff date can be altered by means of the &%-t%& option, which must be
40352 followed by a time. For example, to remove all records older than a week from
40353 the retry database:
40354 .code
40355 exim_tidydb -t 7d /var/spool/exim retry
40356 .endd
40357 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40358 message ids. In the former these appear as data in records keyed by host &--
40359 they were messages that were waiting for that host &-- and in the latter they
40360 are the keys for retry information for messages that have suffered certain
40361 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40362 message ids in database records are those of messages that are still on the
40363 queue. Message ids for messages that no longer exist are removed from
40364 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40365 For the &'retry'& database, records whose keys are non-existent message ids are
40366 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40367 whenever it removes information from the database.
40368
40369 Certain records are automatically removed by Exim when they are no longer
40370 needed, but others are not. For example, if all the MX hosts for a domain are
40371 down, a retry record is created for each one. If the primary MX host comes back
40372 first, its record is removed when Exim successfully delivers to it, but the
40373 records for the others remain because Exim has not tried to use those hosts.
40374
40375 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40376 hints databases. You should do this at a quiet time of day, because it requires
40377 a database to be locked (and therefore inaccessible to Exim) while it does its
40378 work. Removing records from a DBM file does not normally make the file smaller,
40379 but all the common DBM libraries are able to re-use the space that is released.
40380 After an initial phase of increasing in size, the databases normally reach a
40381 point at which they no longer get any bigger, as long as they are regularly
40382 tidied.
40383
40384 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40385 databases is likely to keep on increasing.
40386
40387
40388
40389
40390 .subsection "exim_fixdb" "SECTfixdb"
40391 .cindex "&'exim_fixdb'&"
40392 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40393 Its main use is for testing Exim, but it might also be occasionally useful for
40394 getting round problems in a live system. Its interface
40395 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40396 key of a database record can then be entered, and the data for that record is
40397 displayed.
40398
40399 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40400 except the &'retry'& database, that is the only operation that can be carried
40401 out. For the &'retry'& database, each field is output preceded by a number, and
40402 data for individual fields can be changed by typing the field number followed
40403 by new data, for example:
40404 .code
40405 > 4 951102:1000
40406 .endd
40407 resets the time of the next delivery attempt. Time values are given as a
40408 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40409 used as optional separators.
40410
40411 Both displayed and input times are in the local timezone by default.
40412 If an option &'-z'& is used on the command line, displayed times
40413 are in UTC.
40414
40415
40416
40417
40418 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40419 .cindex "mailbox" "maintenance"
40420 .cindex "&'exim_lock'&"
40421 .cindex "locking mailboxes"
40422 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40423 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40424 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40425 a user agent while investigating a problem. The utility requires the name of
40426 the file as its first argument. If the locking is successful, the second
40427 argument is run as a command (using C's &[system()]& function); if there is no
40428 second argument, the value of the SHELL environment variable is used; if this
40429 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40430 is unlocked and the utility ends. The following options are available:
40431
40432 .vlist
40433 .vitem &%-fcntl%&
40434 Use &[fcntl()]& locking on the open mailbox.
40435
40436 .vitem &%-flock%&
40437 Use &[flock()]& locking on the open mailbox, provided the operating system
40438 supports it.
40439
40440 .vitem &%-interval%&
40441 This must be followed by a number, which is a number of seconds; it sets the
40442 interval to sleep between retries (default 3).
40443
40444 .vitem &%-lockfile%&
40445 Create a lock file before opening the mailbox.
40446
40447 .vitem &%-mbx%&
40448 Lock the mailbox using MBX rules.
40449
40450 .vitem &%-q%&
40451 Suppress verification output.
40452
40453 .vitem &%-retries%&
40454 This must be followed by a number; it sets the number of times to try to get
40455 the lock (default 10).
40456
40457 .vitem &%-restore_time%&
40458 This option causes &%exim_lock%& to restore the modified and read times to the
40459 locked file before exiting. This allows you to access a locked mailbox (for
40460 example, to take a backup copy) without disturbing the times that the user
40461 subsequently sees.
40462
40463 .vitem &%-timeout%&
40464 This must be followed by a number, which is a number of seconds; it sets a
40465 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40466 default), a non-blocking call is used.
40467
40468 .vitem &%-v%&
40469 Generate verbose output.
40470 .endlist
40471
40472 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40473 default is to create a lock file and also to use &[fcntl()]& locking on the
40474 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40475 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40476 requires that the directory containing the file be writeable. Locking by lock
40477 file does not last forever; Exim assumes that a lock file is expired if it is
40478 more than 30 minutes old.
40479
40480 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40481 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40482 to be taken out on the open mailbox, and an exclusive lock on the file
40483 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40484 number of the mailbox file. When the locking is released, if an exclusive lock
40485 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40486
40487 The default output contains verification of the locking that takes place. The
40488 &%-v%& option causes some additional information to be given. The &%-q%& option
40489 suppresses all output except error messages.
40490
40491 A command such as
40492 .code
40493 exim_lock /var/spool/mail/spqr
40494 .endd
40495 runs an interactive shell while the file is locked, whereas
40496 .display
40497 &`exim_lock -q /var/spool/mail/spqr <<End`&
40498 <&'some commands'&>
40499 &`End`&
40500 .endd
40501 runs a specific non-interactive sequence of commands while the file is locked,
40502 suppressing all verification output. A single command can be run by a command
40503 such as
40504 .code
40505 exim_lock -q /var/spool/mail/spqr \
40506   "cp /var/spool/mail/spqr /some/where"
40507 .endd
40508 Note that if a command is supplied, it must be entirely contained within the
40509 second argument &-- hence the quotes.
40510
40511
40512 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40513 .cindex "exim_msgdate"
40514 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40515 This Perl script converts an Exim Mesage ID back into a human readable form.
40516 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40517
40518 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40519 .ecindex IIDutils
40520 . ////////////////////////////////////////////////////////////////////////////
40521 . ////////////////////////////////////////////////////////////////////////////
40522
40523 .chapter "The Exim monitor" "CHAPeximon"
40524 .scindex IIDeximon "Exim monitor" "description"
40525 .cindex "X-windows"
40526 .cindex "&'eximon'&"
40527 .cindex "Local/eximon.conf"
40528 .cindex "&_exim_monitor/EDITME_&"
40529 The Exim monitor is an application which displays in an X window information
40530 about the state of Exim's queue and what Exim is doing. An admin user can
40531 perform certain operations on messages from this GUI interface; however all
40532 such facilities are also available from the command line, and indeed, the
40533 monitor itself makes use of the command line to perform any actions requested.
40534
40535
40536
40537 .section "Running the monitor" "SECID264"
40538 The monitor is started by running the script called &'eximon'&. This is a shell
40539 script that sets up a number of environment variables, and then runs the
40540 binary called &_eximon.bin_&. The default appearance of the monitor window can
40541 be changed by editing the &_Local/eximon.conf_& file created by editing
40542 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40543 parameters are for.
40544
40545 The parameters that get built into the &'eximon'& script can be overridden for
40546 a particular invocation by setting up environment variables of the same names,
40547 preceded by &`EXIMON_`&. For example, a shell command such as
40548 .code
40549 EXIMON_LOG_DEPTH=400 eximon
40550 .endd
40551 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40552 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40553 overrides the Exim log file configuration. This makes it possible to have
40554 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40555 syslog messages are routed to a file on the local host.
40556
40557 X resources can be used to change the appearance of the window in the normal
40558 way. For example, a resource setting of the form
40559 .code
40560 Eximon*background: gray94
40561 .endd
40562 changes the colour of the background to light grey rather than white. The
40563 stripcharts are drawn with both the data lines and the reference lines in
40564 black. This means that the reference lines are not visible when on top of the
40565 data. However, their colour can be changed by setting a resource called
40566 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40567 For example, if your X server is running Unix, you could set up lighter
40568 reference lines in the stripcharts by obeying
40569 .code
40570 xrdb -merge <<End
40571 Eximon*highlight: gray
40572 End
40573 .endd
40574 .cindex "admin user"
40575 In order to see the contents of messages in the queue, and to operate on them,
40576 &'eximon'& must either be run as root or by an admin user.
40577
40578 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40579 contain X11 resource parameters interpreted by the X11 library.  In addition,
40580 if the first parameter starts with the string "gdb" then it is removed and the
40581 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40582 versioned variants of gdb can be invoked).
40583
40584 The monitor's window is divided into three parts. The first contains one or
40585 more stripcharts and two action buttons, the second contains a &"tail"& of the
40586 main log file, and the third is a display of the queue of messages awaiting
40587 delivery, with two more action buttons. The following sections describe these
40588 different parts of the display.
40589
40590
40591
40592
40593 .section "The stripcharts" "SECID265"
40594 .cindex "stripchart"
40595 The first stripchart is always a count of messages in the queue. Its name can
40596 be configured by setting QUEUE_STRIPCHART_NAME in the
40597 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40598 configuration script by regular expression matches on log file entries, making
40599 it possible to display, for example, counts of messages delivered to certain
40600 hosts or using certain transports. The supplied defaults display counts of
40601 received and delivered messages, and of local and SMTP deliveries. The default
40602 period between stripchart updates is one minute; this can be adjusted by a
40603 parameter in the &_Local/eximon.conf_& file.
40604
40605 The stripchart displays rescale themselves automatically as the value they are
40606 displaying changes. There are always 10 horizontal lines in each chart; the
40607 title string indicates the value of each division when it is greater than one.
40608 For example, &"x2"& means that each division represents a value of 2.
40609
40610 It is also possible to have a stripchart which shows the percentage fullness of
40611 a particular disk partition, which is useful when local deliveries are confined
40612 to a single partition.
40613
40614 .cindex "&%statvfs%& function"
40615 This relies on the availability of the &[statvfs()]& function or equivalent in
40616 the operating system. Most, but not all versions of Unix that support Exim have
40617 this. For this particular stripchart, the top of the chart always represents
40618 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40619 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40620 &_Local/eximon.conf_& file.
40621
40622
40623
40624
40625 .section "Main action buttons" "SECID266"
40626 .cindex "size" "of monitor window"
40627 .cindex "Exim monitor" "window size"
40628 .cindex "window size"
40629 Below the stripcharts there is an action button for quitting the monitor. Next
40630 to this is another button marked &"Size"&. They are placed here so that
40631 shrinking the window to its default minimum size leaves just the queue count
40632 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40633 the window to expand to its maximum size, unless it is already at the maximum,
40634 in which case it is reduced to its minimum.
40635
40636 When expanding to the maximum, if the window cannot be fully seen where it
40637 currently is, it is moved back to where it was the last time it was at full
40638 size. When it is expanding from its minimum size, the old position is
40639 remembered, and next time it is reduced to the minimum it is moved back there.
40640
40641 The idea is that you can keep a reduced window just showing one or two
40642 stripcharts at a convenient place on your screen, easily expand it to show
40643 the full window when required, and just as easily put it back to what it was.
40644 The idea is copied from what the &'twm'& window manager does for its
40645 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40646 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40647
40648 Normally, the monitor starts up with the window at its full size, but it can be
40649 built so that it starts up with the window at its smallest size, by setting
40650 START_SMALL=yes in &_Local/eximon.conf_&.
40651
40652
40653
40654 .section "The log display" "SECID267"
40655 .cindex "log" "tail of; in monitor"
40656 The second section of the window is an area in which a display of the tail of
40657 the main log is maintained.
40658 To save space on the screen, the timestamp on each log line is shortened by
40659 removing the date and, if &%log_timezone%& is set, the timezone.
40660 The log tail is not available when the only destination for logging data is
40661 syslog, unless the syslog lines are routed to a local file whose name is passed
40662 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40663
40664 The log sub-window has a scroll bar at its lefthand side which can be used to
40665 move back to look at earlier text, and the up and down arrow keys also have a
40666 scrolling effect. The amount of log that is kept depends on the setting of
40667 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40668 to use. When this is full, the earlier 50% of data is discarded &-- this is
40669 much more efficient than throwing it away line by line. The sub-window also has
40670 a horizontal scroll bar for accessing the ends of long log lines. This is the
40671 only means of horizontal scrolling; the right and left arrow keys are not
40672 available. Text can be cut from this part of the window using the mouse in the
40673 normal way. The size of this subwindow is controlled by parameters in the
40674 configuration file &_Local/eximon.conf_&.
40675
40676 Searches of the text in the log window can be carried out by means of the ^R
40677 and ^S keystrokes, which default to a reverse and a forward search,
40678 respectively. The search covers only the text that is displayed in the window.
40679 It cannot go further back up the log.
40680
40681 The point from which the search starts is indicated by a caret marker. This is
40682 normally at the end of the text in the window, but can be positioned explicitly
40683 by pointing and clicking with the left mouse button, and is moved automatically
40684 by a successful search. If new text arrives in the window when it is scrolled
40685 back, the caret remains where it is, but if the window is not scrolled back,
40686 the caret is moved to the end of the new text.
40687
40688 Pressing ^R or ^S pops up a window into which the search text can be typed.
40689 There are buttons for selecting forward or reverse searching, for carrying out
40690 the search, and for cancelling. If the &"Search"& button is pressed, the search
40691 happens and the window remains so that further searches can be done. If the
40692 &"Return"& key is pressed, a single search is done and the window is closed. If
40693 ^C is typed the search is cancelled.
40694
40695 The searching facility is implemented using the facilities of the Athena text
40696 widget. By default this pops up a window containing both &"search"& and
40697 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40698 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40699 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40700 provided version of &%TextPop%& when the remaining parts of the text widget
40701 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40702 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40703 on these systems, at the expense of having unwanted items in the search popup
40704 window.
40705
40706
40707
40708 .section "The queue display" "SECID268"
40709 .cindex "queue" "display in monitor"
40710 The bottom section of the monitor window contains a list of all messages that
40711 are in the queue, which includes those currently being received or delivered,
40712 as well as those awaiting delivery. The size of this subwindow is controlled by
40713 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40714 at which it is updated is controlled by another parameter in the same file &--
40715 the default is 5 minutes, since queue scans can be quite expensive. However,
40716 there is an &"Update"& action button just above the display which can be used
40717 to force an update of the queue display at any time.
40718
40719 When a host is down for some time, a lot of pending mail can build up for it,
40720 and this can make it hard to deal with other messages in the queue. To help
40721 with this situation there is a button next to &"Update"& called &"Hide"&. If
40722 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40723 type anything in here and press &"Return"&, the text is added to a chain of
40724 such texts, and if every undelivered address in a message matches at least one
40725 of the texts, the message is not displayed.
40726
40727 If there is an address that does not match any of the texts, all the addresses
40728 are displayed as normal. The matching happens on the ends of addresses so, for
40729 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40730 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40731 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40732 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40733 a hide request is automatically cancelled after one hour.
40734
40735 While the dialogue box is displayed, you can't press any buttons or do anything
40736 else to the monitor window. For this reason, if you want to cut text from the
40737 queue display to use in the dialogue box, you have to do the cutting before
40738 pressing the &"Hide"& button.
40739
40740 The queue display contains, for each unhidden queued message, the length of
40741 time it has been in the queue, the size of the message, the message id, the
40742 message sender, and the first undelivered recipient, all on one line. If it is
40743 a bounce message, the sender is shown as &"<>"&. If there is more than one
40744 recipient to which the message has not yet been delivered, subsequent ones are
40745 listed on additional lines, up to a maximum configured number, following which
40746 an ellipsis is displayed. Recipients that have already received the message are
40747 not shown.
40748
40749 .cindex "frozen messages" "display"
40750 If a message is frozen, an asterisk is displayed at the left-hand side.
40751
40752 The queue display has a vertical scroll bar, and can also be scrolled by means
40753 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40754 The text searching facilities, as described above for the log window, are also
40755 available, but the caret is always moved to the end of the text when the queue
40756 display is updated.
40757
40758
40759
40760 .section "The queue menu" "SECID269"
40761 .cindex "queue" "menu in monitor"
40762 If the &%shift%& key is held down and the left button is clicked when the mouse
40763 pointer is over the text for any message, an action menu pops up, and the first
40764 line of the queue display for the message is highlighted. This does not affect
40765 any selected text.
40766
40767 If you want to use some other event for popping up the menu, you can set the
40768 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40769 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40770 value set in this parameter is a standard X event description. For example, to
40771 run eximon using &%ctrl%& rather than &%shift%& you could use
40772 .code
40773 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40774 .endd
40775 The title of the menu is the message id, and it contains entries which act as
40776 follows:
40777
40778 .ilist
40779 &'message log'&: The contents of the message log for the message are displayed
40780 in a new text window.
40781 .next
40782 &'headers'&: Information from the spool file that contains the envelope
40783 information and headers is displayed in a new text window. See chapter
40784 &<<CHAPspool>>& for a description of the format of spool files.
40785 .next
40786 &'body'&: The contents of the spool file containing the body of the message are
40787 displayed in a new text window. There is a default limit of 20,000 bytes to the
40788 amount of data displayed. This can be changed by setting the BODY_MAX
40789 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40790 .next
40791 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40792 delivery of the message. This causes an automatic thaw if the message is
40793 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40794 a new text window. The delivery is run in a separate process, to avoid holding
40795 up the monitor while the delivery proceeds.
40796 .next
40797 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40798 that the message be frozen.
40799 .next
40800 .cindex "thawing messages"
40801 .cindex "unfreezing messages"
40802 .cindex "frozen messages" "thawing"
40803 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40804 that the message be thawed.
40805 .next
40806 .cindex "delivery" "forcing failure"
40807 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40808 that Exim gives up trying to deliver the message. A bounce message is generated
40809 for any remaining undelivered addresses.
40810 .next
40811 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40812 that the message be deleted from the system without generating a bounce
40813 message.
40814 .next
40815 &'add recipient'&: A dialog box is displayed into which a recipient address can
40816 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40817 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40818 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40819 causes a call to Exim to be made using the &%-Mar%& option to request that an
40820 additional recipient be added to the message, unless the entry box is empty, in
40821 which case no action is taken.
40822 .next
40823 &'mark delivered'&: A dialog box is displayed into which a recipient address
40824 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40825 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40826 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40827 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40828 recipient address as already delivered, unless the entry box is empty, in which
40829 case no action is taken.
40830 .next
40831 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40832 mark all recipient addresses as already delivered.
40833 .next
40834 &'edit sender'&: A dialog box is displayed initialized with the current
40835 sender's address. Pressing RETURN causes a call to Exim to be made using the
40836 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40837 in which case no action is taken. If you want to set an empty sender (as in
40838 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40839 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40840 the address is qualified with that domain.
40841 .endlist
40842
40843 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40844 other cases when a call to Exim is made, if there is any output from Exim (in
40845 particular, if the command fails) a window containing the command and the
40846 output is displayed. Otherwise, the results of the action are normally apparent
40847 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40848 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40849 if no output is generated.
40850
40851 The queue display is automatically updated for actions such as freezing and
40852 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40853 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40854 force an update of the display after one of these actions.
40855
40856 In any text window that is displayed as result of a menu action, the normal
40857 cut-and-paste facility is available, and searching can be carried out using ^R
40858 and ^S, as described above for the log tail window.
40859 .ecindex IIDeximon
40860
40861
40862
40863
40864
40865 . ////////////////////////////////////////////////////////////////////////////
40866 . ////////////////////////////////////////////////////////////////////////////
40867
40868 .chapter "Security considerations" "CHAPsecurity"
40869 .scindex IIDsecurcon "security" "discussion of"
40870 This chapter discusses a number of issues concerned with security, some of
40871 which are also covered in other parts of this manual.
40872
40873 For reasons that this author does not understand, some people have promoted
40874 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40875 existence of this chapter in the documentation. However, the intent of the
40876 chapter is simply to describe the way Exim works in relation to certain
40877 security concerns, not to make any specific claims about the effectiveness of
40878 its security as compared with other MTAs.
40879
40880 What follows is a description of the way Exim is supposed to be. Best efforts
40881 have been made to try to ensure that the code agrees with the theory, but an
40882 absence of bugs can never be guaranteed. Any that are reported will get fixed
40883 as soon as possible.
40884
40885
40886 .section "Building a more &""hardened""& Exim" "SECID286"
40887 .cindex "security" "build-time features"
40888 There are a number of build-time options that can be set in &_Local/Makefile_&
40889 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40890 Exim administrator who does not have the root password, or by someone who has
40891 penetrated the Exim (but not the root) account. These options are as follows:
40892
40893 .ilist
40894 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40895 start of any filenames used with the &%-C%& option. When it is set, these
40896 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40897 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40898 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40899 default setting for &%ALT_CONFIG_PREFIX%&.
40900
40901 If the permitted configuration files are confined to a directory to
40902 which only root has access, this guards against someone who has broken
40903 into the Exim account from running a privileged Exim with an arbitrary
40904 configuration file, and using it to break into other accounts.
40905 .next
40906
40907 If a non-trusted configuration file (i.e. not the default configuration file
40908 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40909 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40910 the next item), then root privilege is retained only if the caller of Exim is
40911 root. This locks out the possibility of testing a configuration using &%-C%&
40912 right through message reception and delivery, even if the caller is root. The
40913 reception works, but by that time, Exim is running as the Exim user, so when
40914 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40915 privilege to be lost. However, root can test reception and delivery using two
40916 separate commands.
40917
40918 .next
40919 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40920 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40921 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40922 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40923 the restrictive side.  Requiring build-time selection of safe macros is onerous
40924 but this option is intended solely as a transition mechanism to permit
40925 previously-working configurations to continue to work after release 4.73.
40926 .next
40927 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40928 is disabled.
40929 .next
40930 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40931 never to be used for any deliveries. This is like the &%never_users%& runtime
40932 option, but it cannot be overridden; the runtime option adds additional users
40933 to the list. The default setting is &"root"&; this prevents a non-root user who
40934 is permitted to modify the runtime file from using Exim as a way to get root.
40935 .endlist
40936
40937
40938
40939 .section "Root privilege" "SECID270"
40940 .cindex "setuid"
40941 .cindex "root privilege"
40942 The Exim binary is normally setuid to root, which means that it gains root
40943 privilege (runs as root) when it starts execution. In some special cases (for
40944 example, when the daemon is not in use and there are no local deliveries), it
40945 may be possible to run Exim setuid to some user other than root. This is
40946 discussed in the next section. However, in most installations, root privilege
40947 is required for two things:
40948
40949 .ilist
40950 To set up a socket connected to the standard SMTP port (25) when initialising
40951 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40952 not required.
40953 .next
40954 To be able to change uid and gid in order to read users' &_.forward_& files and
40955 perform local deliveries as the receiving user or as specified in the
40956 configuration.
40957 .endlist
40958
40959 It is not necessary to be root to do any of the other things Exim does, such as
40960 receiving messages and delivering them externally over SMTP, and it is
40961 obviously more secure if Exim does not run as root except when necessary.
40962 For this reason, a user and group for Exim to use must be defined in
40963 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40964 group"&. Their values can be changed by the runtime configuration, though this
40965 is not recommended. Often a user called &'exim'& is used, but some sites use
40966 &'mail'& or another user name altogether.
40967
40968 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40969 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40970 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40971
40972 After a new Exim process has interpreted its command line options, it changes
40973 uid and gid in the following cases:
40974
40975 .ilist
40976 .oindex "&%-C%&"
40977 .oindex "&%-D%&"
40978 If the &%-C%& option is used to specify an alternate configuration file, or if
40979 the &%-D%& option is used to define macro values for the configuration, and the
40980 calling process is not running as root, the uid and gid are changed to those of
40981 the calling process.
40982 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40983 option may not be used at all.
40984 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40985 can be supplied if the calling process is running as root, the Exim run-time
40986 user or CONFIGURE_OWNER, if defined.
40987 .next
40988 .oindex "&%-be%&"
40989 .oindex "&%-bf%&"
40990 .oindex "&%-bF%&"
40991 If the expansion test option (&%-be%&) or one of the filter testing options
40992 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40993 calling process.
40994 .next
40995 If the process is not a daemon process or a queue runner process or a delivery
40996 process or a process for testing address routing (started with &%-bt%&), the
40997 uid and gid are changed to the Exim user and group. This means that Exim always
40998 runs under its own uid and gid when receiving messages. This also applies when
40999 testing address verification
41000 .oindex "&%-bv%&"
41001 .oindex "&%-bh%&"
41002 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
41003 option).
41004 .next
41005 For a daemon, queue runner, delivery, or address testing process, the uid
41006 remains as root at this stage, but the gid is changed to the Exim group.
41007 .endlist
41008
41009 The processes that initially retain root privilege behave as follows:
41010
41011 .ilist
41012 A daemon process changes the gid to the Exim group and the uid to the Exim
41013 user after setting up one or more listening sockets. The &[initgroups()]&
41014 function is called, so that if the Exim user is in any additional groups, they
41015 will be used during message reception.
41016 .next
41017 A queue runner process retains root privilege throughout its execution. Its
41018 job is to fork a controlled sequence of delivery processes.
41019 .next
41020 A delivery process retains root privilege throughout most of its execution,
41021 but any actual deliveries (that is, the transports themselves) are run in
41022 subprocesses which always change to a non-root uid and gid. For local
41023 deliveries this is typically the uid and gid of the owner of the mailbox; for
41024 remote deliveries, the Exim uid and gid are used. Once all the delivery
41025 subprocesses have been run, a delivery process changes to the Exim uid and gid
41026 while doing post-delivery tidying up such as updating the retry database and
41027 generating bounce and warning messages.
41028
41029 While the recipient addresses in a message are being routed, the delivery
41030 process runs as root. However, if a user's filter file has to be processed,
41031 this is done in a subprocess that runs under the individual user's uid and
41032 gid. A system filter is run as root unless &%system_filter_user%& is set.
41033 .next
41034 A process that is testing addresses (the &%-bt%& option) runs as root so that
41035 the routing is done in the same environment as a message delivery.
41036 .endlist
41037
41038
41039
41040
41041 .section "Running Exim without privilege" "SECTrunexiwitpri"
41042 .cindex "privilege, running without"
41043 .cindex "unprivileged running"
41044 .cindex "root privilege" "running without"
41045 Some installations like to run Exim in an unprivileged state for more of its
41046 operation, for added security. Support for this mode of operation is provided
41047 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
41048 gid are changed to the Exim user and group at the start of a delivery process
41049 (and also queue runner and address testing processes). This means that address
41050 routing is no longer run as root, and the deliveries themselves cannot change
41051 to any other uid.
41052
41053 .cindex SIGHUP
41054 .cindex "daemon" "restarting"
41055 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
41056 that the daemon can still be started in the usual way, and it can respond
41057 correctly to SIGHUP because the re-invocation regains root privilege.
41058
41059 An alternative approach is to make Exim setuid to the Exim user and also setgid
41060 to the Exim group. If you do this, the daemon must be started from a root
41061 process. (Calling Exim from a root process makes it behave in the way it does
41062 when it is setuid root.) However, the daemon cannot restart itself after a
41063 SIGHUP signal because it cannot regain privilege.
41064
41065 It is still useful to set &%deliver_drop_privilege%& in this case, because it
41066 stops Exim from trying to re-invoke itself to do a delivery after a message has
41067 been received. Such a re-invocation is a waste of resources because it has no
41068 effect.
41069
41070 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
41071 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
41072 to the Exim user seems a clean approach, but there is one complication:
41073
41074 In this style of operation, Exim is running with the real uid and gid set to
41075 those of the calling process, and the effective uid/gid set to Exim's values.
41076 Ideally, any association with the calling process' uid/gid should be dropped,
41077 that is, the real uid/gid should be reset to the effective values so as to
41078 discard any privileges that the caller may have. While some operating systems
41079 have a function that permits this action for a non-root effective uid, quite a
41080 number of them do not. Because of this lack of standardization, Exim does not
41081 address this problem at this time.
41082
41083 For this reason, the recommended approach for &"mostly unprivileged"& running
41084 is to keep the Exim binary setuid to root, and to set
41085 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
41086 be used in the most straightforward way.
41087
41088 If you configure Exim not to run delivery processes as root, there are a
41089 number of restrictions on what you can do:
41090
41091 .ilist
41092 You can deliver only as the Exim user/group. You should  explicitly use the
41093 &%user%& and &%group%& options to override routers or local transports that
41094 normally deliver as the recipient. This makes sure that configurations that
41095 work in this mode function the same way in normal mode. Any implicit or
41096 explicit specification of another user causes an error.
41097 .next
41098 Use of &_.forward_& files is severely restricted, such that it is usually
41099 not worthwhile to include them in the configuration.
41100 .next
41101 Users who wish to use &_.forward_& would have to make their home directory and
41102 the file itself accessible to the Exim user. Pipe and append-to-file entries,
41103 and their equivalents in Exim filters, cannot be used. While they could be
41104 enabled in the Exim user's name, that would be insecure and not very useful.
41105 .next
41106 Unless the local user mailboxes are all owned by the Exim user (possible in
41107 some POP3 or IMAP-only environments):
41108
41109 .olist
41110 They must be owned by the Exim group and be writeable by that group. This
41111 implies you must set &%mode%& in the appendfile configuration, as well as the
41112 mode of the mailbox files themselves.
41113 .next
41114 You must set &%no_check_owner%&, since most or all of the files will not be
41115 owned by the Exim user.
41116 .next
41117 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
41118 on a newly created mailbox when unprivileged. This also implies that new
41119 mailboxes need to be created manually.
41120 .endlist olist
41121 .endlist ilist
41122
41123
41124 These restrictions severely restrict what can be done in local deliveries.
41125 However, there are no restrictions on remote deliveries. If you are running a
41126 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
41127 gives more security at essentially no cost.
41128
41129 If you are using the &%mua_wrapper%& facility (see chapter
41130 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
41131
41132
41133
41134
41135 .section "Delivering to local files" "SECID271"
41136 Full details of the checks applied by &(appendfile)& before it writes to a file
41137 are given in chapter &<<CHAPappendfile>>&.
41138
41139
41140
41141 .section "Running local commands" "SECTsecconslocalcmds"
41142 .cindex "security" "local commands"
41143 .cindex "security" "command injection attacks"
41144 There are a number of ways in which an administrator can configure Exim to run
41145 commands based upon received, untrustworthy, data. Further, in some
41146 configurations a user who can control a &_.forward_& file can also arrange to
41147 run commands. Configuration to check includes, but is not limited to:
41148
41149 .ilist
41150 Use of &%use_shell%& in the pipe transport: various forms of shell command
41151 injection may be possible with this option present. It is dangerous and should
41152 be used only with considerable caution. Consider constraints which whitelist
41153 allowed characters in a variable which is to be used in a pipe transport that
41154 has &%use_shell%& enabled.
41155 .next
41156 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
41157 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
41158 &_.forward_& files in a redirect router. If Exim is running on a central mail
41159 hub to which ordinary users do not have shell access, but home directories are
41160 NFS mounted (for instance) then administrators should review the list of these
41161 forbid options available, and should bear in mind that the options that may
41162 need forbidding can change as new features are added between releases.
41163 .next
41164 The &%${run...}%& expansion item does not use a shell by default, but
41165 administrators can configure use of &_/bin/sh_& as part of the command.
41166 Such invocations should be viewed with prejudicial suspicion.
41167 .next
41168 Administrators who use embedded Perl are advised to explore how Perl's
41169 taint checking might apply to their usage.
41170 .next
41171 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
41172 administrators are well advised to view its use with suspicion, in case (for
41173 instance) it allows a local-part to contain embedded Exim directives.
41174 .next
41175 Use of &%${match_local_part...}%& and friends becomes more dangerous if
41176 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
41177 each can reference arbitrary lists and files, rather than just being a list
41178 of opaque strings.
41179 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
41180 real-world security vulnerabilities caused by its use with untrustworthy data
41181 injected in, for SQL injection attacks.
41182 Consider the use of the &%inlisti%& expansion condition instead.
41183 .endlist
41184
41185
41186
41187
41188 .section "Trust in configuration data" "SECTsecconfdata"
41189 .cindex "security" "data sources"
41190 .cindex "security" "regular expressions"
41191 .cindex "regular expressions" "security"
41192 .cindex "PCRE2" "security"
41193 If configuration data for Exim can come from untrustworthy sources, there
41194 are some issues to be aware of:
41195
41196 .ilist
41197 Use of &%${expand...}%& may provide a path for shell injection attacks.
41198 .next
41199 Letting untrusted data provide a regular expression is unwise.
41200 .next
41201 Using &%${match...}%& to apply a fixed regular expression against untrusted
41202 data may result in pathological behaviour within PCRE2.  Be aware of what
41203 "backtracking" means and consider options for being more strict with a regular
41204 expression. Avenues to explore include limiting what can match (avoiding &`.`&
41205 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
41206 possessive quantifiers or just not using regular expressions against untrusted
41207 data.
41208 .next
41209 It can be important to correctly use &%${quote:...}%&,
41210 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
41211 items to ensure that data is correctly constructed.
41212 .next
41213 Some lookups might return multiple results, even though normal usage is only
41214 expected to yield one result.
41215 .endlist
41216
41217
41218
41219
41220 .section "IPv4 source routing" "SECID272"
41221 .cindex "source routing" "in IP packets"
41222 .cindex "IP source routing"
41223 Many operating systems suppress IP source-routed packets in the kernel, but
41224 some cannot be made to do this, so Exim does its own check. It logs incoming
41225 IPv4 source-routed TCP calls, and then drops them. Things are all different in
41226 IPv6. No special checking is currently done.
41227
41228
41229
41230 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41231 Support for these SMTP commands is disabled by default. If required, they can
41232 be enabled by defining suitable ACLs.
41233
41234
41235
41236
41237 .section "Privileged users" "SECID274"
41238 .cindex "trusted users"
41239 .cindex "admin user"
41240 .cindex "privileged user"
41241 .cindex "user" "trusted"
41242 .cindex "user" "admin"
41243 Exim recognizes two sets of users with special privileges. Trusted users are
41244 able to submit new messages to Exim locally, but supply their own sender
41245 addresses and information about a sending host. For other users submitting
41246 local messages, Exim sets up the sender address from the uid, and doesn't
41247 permit a remote host to be specified.
41248
41249 .oindex "&%-f%&"
41250 However, an untrusted user is permitted to use the &%-f%& command line option
41251 in the special form &%-f <>%& to indicate that a delivery failure for the
41252 message should not cause an error report. This affects the message's envelope,
41253 but it does not affect the &'Sender:'& header. Untrusted users may also be
41254 permitted to use specific forms of address with the &%-f%& option by setting
41255 the &%untrusted_set_sender%& option.
41256
41257 Trusted users are used to run processes that receive mail messages from some
41258 other mail domain and pass them on to Exim for delivery either locally, or over
41259 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41260 as any user listed in the &%trusted_users%& configuration option, or under any
41261 group listed in the &%trusted_groups%& option.
41262
41263 Admin users are permitted to do things to the messages on Exim's queue. They
41264 can freeze or thaw messages, cause them to be returned to their senders, remove
41265 them entirely, or modify them in various ways. In addition, admin users can run
41266 the Exim monitor and see all the information it is capable of providing, which
41267 includes the contents of files on the spool.
41268
41269 .oindex "&%-M%&"
41270 .oindex "&%-q%&"
41271 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41272 delivery of messages on its queue is restricted to admin users. This
41273 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41274 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41275 queue is also restricted to admin users. This restriction can be relaxed by
41276 setting &%no_queue_list_requires_admin%&.
41277
41278 Exim recognizes an admin user if the calling process is running as root or as
41279 the Exim user or if any of the groups associated with the calling process is
41280 the Exim group. It is not necessary actually to be running under the Exim
41281 group. However, if admin users who are not root or the Exim user are to access
41282 the contents of files on the spool via the Exim monitor (which runs
41283 unprivileged), Exim must be built to allow group read access to its spool
41284 files.
41285
41286 By default, regular users are trusted to perform basic testing and
41287 introspection commands, as themselves.  This setting can be tightened by
41288 setting the &%commandline_checks_require_admin%& option.
41289 This affects most of the checking options,
41290 such as &%-be%& and anything else &%-b*%&.
41291
41292
41293 .section "Spool files" "SECID275"
41294 .cindex "spool directory" "files"
41295 Exim's spool directory and everything it contains is owned by the Exim user and
41296 set to the Exim group. The mode for spool files is defined in the
41297 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41298 any user who is a member of the Exim group can access these files.
41299
41300
41301
41302 .section "Use of argv[0]" "SECID276"
41303 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41304 of specific strings, Exim assumes certain options. For example, calling Exim
41305 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41306 to calling it with the option &%-bS%&. There are no security implications in
41307 this.
41308
41309
41310
41311 .section "Use of %f formatting" "SECID277"
41312 The only use made of &"%f"& by Exim is in formatting load average values. These
41313 are actually stored in integer variables as 1000 times the load average.
41314 Consequently, their range is limited and so therefore is the length of the
41315 converted output.
41316
41317
41318
41319 .section "Embedded Exim path" "SECID278"
41320 Exim uses its own path name, which is embedded in the code, only when it needs
41321 to re-exec in order to regain root privilege. Therefore, it is not root when it
41322 does so. If some bug allowed the path to get overwritten, it would lead to an
41323 arbitrary program's being run as exim, not as root.
41324
41325
41326
41327 .section "Dynamic module directory" "SECTdynmoddir"
41328 Any dynamically loadable modules must be installed into the directory
41329 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41330 loading it.
41331
41332
41333 .section "Use of sprintf()" "SECID279"
41334 .cindex "&[sprintf()]&"
41335 A large number of occurrences of &"sprintf"& in the code are actually calls to
41336 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41337 The intermediate formatting is done into a large fixed buffer by a function
41338 that runs through the format string itself, and checks the length of each
41339 conversion before performing it, thus preventing buffer overruns.
41340
41341 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41342 the output buffer is known to be sufficiently long to contain the converted
41343 string.
41344
41345
41346
41347 .section "Use of debug_printf() and log_write()" "SECID280"
41348 Arbitrary strings are passed to both these functions, but they do their
41349 formatting by calling the function &'string_vformat()'&, which runs through
41350 the format string itself, and checks the length of each conversion.
41351
41352
41353
41354 .section "Use of strcat() and strcpy()" "SECID281"
41355 These are used only in cases where the output buffer is known to be large
41356 enough to hold the result.
41357 .ecindex IIDsecurcon
41358
41359
41360
41361
41362 . ////////////////////////////////////////////////////////////////////////////
41363 . ////////////////////////////////////////////////////////////////////////////
41364
41365 .chapter "Format of spool files" "CHAPspool"
41366 .scindex IIDforspo1 "format" "spool files"
41367 .scindex IIDforspo2 "spool directory" "format of files"
41368 .scindex IIDforspo3 "spool files" "format of"
41369 .cindex "spool files" "editing"
41370 A message on Exim's queue consists of two files, whose names are the message id
41371 followed by -D and -H, respectively. The data portion of the message is kept in
41372 the -D file on its own. The message's envelope, status, and headers are all
41373 kept in the -H file, whose format is described in this chapter. Each of these
41374 two files contains the final component of its own name as its first line. This
41375 is insurance against disk crashes where the directory is lost but the files
41376 themselves are recoverable.
41377
41378 The file formats may be changed, or new formats added, at any release.
41379 Spool files are not intended as an interface to other programs
41380 and should not be used as such.
41381
41382 Some people are tempted into editing -D files in order to modify messages. You
41383 need to be extremely careful if you do this; it is not recommended and you are
41384 on your own if you do it. Here are some of the pitfalls:
41385
41386 .ilist
41387 You must ensure that Exim does not try to deliver the message while you are
41388 fiddling with it. The safest way is to take out a write lock on the -D file,
41389 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41390 place, the lock will be retained. If you write a new file and rename it, the
41391 lock will be lost at the instant of rename.
41392 .next
41393 .vindex "&$body_linecount$&"
41394 If you change the number of lines in the file, the value of
41395 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41396 cause incomplete transmission of messages or undeliverable messages.
41397 .next
41398 If the message is in MIME format, you must take care not to break it.
41399 .next
41400 If the message is cryptographically signed, any change will invalidate the
41401 signature.
41402 .endlist
41403 All in all, modifying -D files is fraught with danger.
41404
41405 Files whose names end with -J may also be seen in the &_input_& directory (or
41406 its subdirectories when &%split_spool_directory%& is set). These are journal
41407 files, used to record addresses to which the message has been delivered during
41408 the course of a delivery attempt. If there are still undelivered recipients at
41409 the end, the -H file is updated, and the -J file is deleted. If, however, there
41410 is some kind of crash (for example, a power outage) before this happens, the -J
41411 file remains in existence. When Exim next processes the message, it notices the
41412 -J file and uses it to update the -H file before starting the next delivery
41413 attempt.
41414
41415 Files whose names end with -K or .eml may also be seen in the spool.
41416 These are temporaries used for DKIM or malware processing, when that is used.
41417 They should be tidied up by normal operations; any old ones are probably
41418 relics of crashes and can be removed.
41419
41420 .section "Format of the -H file" "SECID282"
41421 .cindex "uid (user id)" "in spool file"
41422 .cindex "gid (group id)" "in spool file"
41423 The second line of the -H file contains the login name for the uid of the
41424 process that called Exim to read the message, followed by the numerical uid and
41425 gid. For a locally generated message, this is normally the user who sent the
41426 message. For a message received over TCP/IP via the daemon, it is
41427 normally the Exim user.
41428
41429 The third line of the file contains the address of the message's sender as
41430 transmitted in the envelope, contained in angle brackets. The sender address is
41431 empty for bounce messages. For incoming SMTP mail, the sender address is given
41432 in the MAIL command. For locally generated mail, the sender address is
41433 created by Exim from the login name of the current user and the configured
41434 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41435 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41436 &"<>"& or an address that matches &%untrusted_set_senders%&.
41437
41438 The fourth line contains two numbers. The first is the time that the message
41439 was received, in the conventional Unix form &-- the number of seconds since the
41440 start of the epoch. The second number is a count of the number of messages
41441 warning of delayed delivery that have been sent to the sender.
41442
41443 There follow a number of lines starting with a hyphen.
41444 These contain variables, can appear in any
41445 order, and are omitted when not relevant.
41446
41447 If there is a second hyphen after the first,
41448 the corresponding data is tainted.
41449 If there is a value in parentheses, the data is quoted for a lookup.
41450
41451 The following word specifies a variable,
41452 and the remainder of the item depends on the variable.
41453
41454 .vlist
41455 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41456 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41457 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41458 recognized, to provide backward compatibility. In the old format, a line of
41459 this form is present for every ACL variable that is not empty. The number
41460 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41461 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41462 the data string for the variable. The string itself starts at the beginning of
41463 the next line, and is followed by a newline character. It may contain internal
41464 newlines.
41465
41466 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41467 A line of this form is present for every ACL connection variable that is
41468 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41469 The length is the length of the data string for the variable. The string itself
41470 starts at the beginning of the next line, and is followed by a newline
41471 character. It may contain internal newlines.
41472
41473 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41474 A line of this form is present for every ACL message variable that is defined.
41475 Note that there is a space between &%-aclm%& and the rest of the name. The
41476 length is the length of the data string for the variable. The string itself
41477 starts at the beginning of the next line, and is followed by a newline
41478 character. It may contain internal newlines.
41479
41480 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41481 This is present if, when the message was received over SMTP, the value of
41482 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41483
41484 .vitem &%-allow_unqualified_recipient%&
41485 This is present if unqualified recipient addresses are permitted in header
41486 lines (to stop such addresses from being qualified if rewriting occurs at
41487 transport time). Local messages that were input using &%-bnq%& and remote
41488 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41489
41490 .vitem &%-allow_unqualified_sender%&
41491 This is present if unqualified sender addresses are permitted in header lines
41492 (to stop such addresses from being qualified if rewriting occurs at transport
41493 time). Local messages that were input using &%-bnq%& and remote messages from
41494 hosts that match &%sender_unqualified_hosts%& set this flag.
41495
41496 .vitem "&%-auth_id%&&~<&'text'&>"
41497 The id information for a message received on an authenticated SMTP connection
41498 &-- the value of the &$authenticated_id$& variable.
41499
41500 .vitem "&%-auth_sender%&&~<&'address'&>"
41501 The address of an authenticated sender &-- the value of the
41502 &$authenticated_sender$& variable.
41503
41504 .vitem "&%-body_linecount%&&~<&'number'&>"
41505 This records the number of lines in the body of the message, and is
41506 present unless &%-spool_file_wireformat%& is.
41507
41508 .vitem "&%-body_zerocount%&&~<&'number'&>"
41509 This records the number of binary zero bytes in the body of the message, and is
41510 present if the number is greater than zero.
41511
41512 .vitem &%-deliver_firsttime%&
41513 This is written when a new message is first added to the spool. When the spool
41514 file is updated after a deferral, it is omitted.
41515
41516 .vitem "&%-frozen%&&~<&'time'&>"
41517 .cindex "frozen messages" "spool data"
41518 The message is frozen, and the freezing happened at <&'time'&>.
41519
41520 .vitem "&%-helo_name%&&~<&'text'&>"
41521 This records the host name as specified by a remote host in a HELO or EHLO
41522 command.
41523
41524 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41525 This records the IP address of the host from which the message was received and
41526 the remote port number that was used. It is omitted for locally generated
41527 messages.
41528
41529 .vitem "&%-host_auth%&&~<&'text'&>"
41530 If the message was received on an authenticated SMTP connection, this records
41531 the name of the authenticator &-- the value of the
41532 &$sender_host_authenticated$& variable.
41533
41534 .vitem &%-host_lookup_failed%&
41535 This is present if an attempt to look up the sending host's name from its IP
41536 address failed. It corresponds to the &$host_lookup_failed$& variable.
41537
41538 .vitem "&%-host_name%&&~<&'text'&>"
41539 .cindex "reverse DNS lookup"
41540 .cindex "DNS" "reverse lookup"
41541 This records the name of the remote host from which the message was received,
41542 if the host name was looked up from the IP address when the message was being
41543 received. It is not present if no reverse lookup was done.
41544
41545 .vitem "&%-ident%&&~<&'text'&>"
41546 For locally submitted messages, this records the login of the originating user,
41547 unless it was a trusted user and the &%-oMt%& option was used to specify an
41548 ident value. For messages received over TCP/IP, this records the ident string
41549 supplied by the remote host, if any.
41550
41551 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41552 This records the IP address of the local interface and the port number through
41553 which a message was received from a remote host. It is omitted for locally
41554 generated messages.
41555
41556 .vitem &%-local%&
41557 The message is from a local sender.
41558
41559 .vitem &%-localerror%&
41560 The message is a locally-generated bounce message.
41561
41562 .vitem "&%-local_scan%&&~<&'string'&>"
41563 This records the data string that was returned by the &[local_scan()]& function
41564 when the message was received &-- the value of the &$local_scan_data$&
41565 variable. It is omitted if no data was returned.
41566
41567 .vitem &%-manual_thaw%&
41568 The message was frozen but has been thawed manually, that is, by an explicit
41569 Exim command rather than via the auto-thaw process.
41570
41571 .vitem &%-N%&
41572 A testing delivery process was started using the &%-N%& option to suppress any
41573 actual deliveries, but delivery was deferred. At any further delivery attempts,
41574 &%-N%& is assumed.
41575
41576 .vitem &%-received_protocol%&
41577 This records the value of the &$received_protocol$& variable, which contains
41578 the name of the protocol by which the message was received.
41579
41580 .vitem &%-sender_set_untrusted%&
41581 The envelope sender of this message was set by an untrusted local caller (used
41582 to ensure that the caller is displayed in queue listings).
41583
41584 .vitem "&%-spam_score_int%&&~<&'number'&>"
41585 If a message was scanned by SpamAssassin, this is present. It records the value
41586 of &$spam_score_int$&.
41587
41588 .vitem &%-spool_file_wireformat%&
41589 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41590 rather than Unix-format.
41591 The line-ending is CRLF rather than newline.
41592 There is still, however, no leading-dot-stuffing.
41593
41594 .vitem &%-tls_certificate_verified%&
41595 A TLS certificate was received from the client that sent this message, and the
41596 certificate was verified by the server.
41597
41598 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41599 When the message was received over an encrypted connection, this records the
41600 name of the cipher suite that was used.
41601
41602 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41603 When the message was received over an encrypted connection, and a certificate
41604 was received from the client, this records the Distinguished Name from that
41605 certificate.
41606 .endlist
41607
41608 Following the options there is a list of those addresses to which the message
41609 is not to be delivered. This set of addresses is initialized from the command
41610 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41611 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41612 the address is added to this set. The addresses are kept internally as a
41613 balanced binary tree, and it is a representation of that tree which is written
41614 to the spool file. If an address is expanded via an alias or forward file, the
41615 original address is added to the tree when deliveries to all its child
41616 addresses are complete.
41617
41618 If the tree is empty, there is a single line in the spool file containing just
41619 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41620 Y or N, followed by an address. The address is the value for the node of the
41621 tree, and the letters indicate whether the node has a left branch and/or a
41622 right branch attached to it, respectively. If branches exist, they immediately
41623 follow. Here is an example of a three-node tree:
41624 .code
41625 YY darcy@austen.fict.example
41626 NN alice@wonderland.fict.example
41627 NN editor@thesaurus.ref.example
41628 .endd
41629 After the non-recipients tree, there is a list of the message's recipients.
41630 This is a simple list, preceded by a count. It includes all the original
41631 recipients of the message, including those to whom the message has already been
41632 delivered. In the simplest case, the list contains one address per line. For
41633 example:
41634 .code
41635 4
41636 editor@thesaurus.ref.example
41637 darcy@austen.fict.example
41638 rdo@foundation
41639 alice@wonderland.fict.example
41640 .endd
41641 However, when a child address has been added to the top-level addresses as a
41642 result of the use of the &%one_time%& option on a &(redirect)& router, each
41643 line is of the following form:
41644 .display
41645 <&'top-level address'&> <&'errors_to address'&> &&&
41646   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41647 .endd
41648 The 01 flag bit indicates the presence of the three other fields that follow
41649 the top-level address. Other bits may be used in future to support additional
41650 fields. The <&'parent number'&> is the offset in the recipients list of the
41651 original parent of the &"one time"& address. The first two fields are the
41652 envelope sender that is associated with this address and its length. If the
41653 length is zero, there is no special envelope sender (there are then two space
41654 characters in the line). A non-empty field can arise from a &(redirect)& router
41655 that has an &%errors_to%& setting.
41656
41657
41658 A blank line separates the envelope and status information from the headers
41659 which follow. A header may occupy several lines of the file, and to save effort
41660 when reading it in, each header is preceded by a number and an identifying
41661 character. The number is the number of characters in the header, including any
41662 embedded newlines and the terminating newline. The character is one of the
41663 following:
41664
41665 .table2 50pt
41666 .row <&'blank'&>         "header in which Exim has no special interest"
41667 .row &`B`&               "&'Bcc:'& header"
41668 .row &`C`&               "&'Cc:'& header"
41669 .row &`F`&               "&'From:'& header"
41670 .row &`I`&               "&'Message-id:'& header"
41671 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41672 .row &`R`&               "&'Reply-To:'& header"
41673 .row &`S`&               "&'Sender:'& header"
41674 .row &`T`&               "&'To:'& header"
41675 .row &`*`&               "replaced or deleted header"
41676 .endtable
41677
41678 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41679 purposes. They are not transmitted when the message is delivered. Here is a
41680 typical set of headers:
41681 .code
41682 111P Received: by hobbit.fict.example with local (Exim 4.00)
41683 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41684 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41685 038* X-rewrote-sender: bb@hobbit.fict.example
41686 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41687 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41688 099* To: alice@wonderland.fict.example, rdo@foundation,
41689 darcy@austen.fict.example, editor@thesaurus.ref.example
41690 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41691 darcy@austen.fict.example, editor@thesaurus.ref.example
41692 038  Date: Fri, 11 May 2001 10:28:59 +0100
41693 .endd
41694 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41695 &'To:'& header have been rewritten, the last one because routing expanded the
41696 unqualified domain &'foundation'&.
41697 .ecindex IIDforspo1
41698 .ecindex IIDforspo2
41699 .ecindex IIDforspo3
41700
41701 .section "Format of the -D file" "SECID282a"
41702 The data file is traditionally in Unix-standard format: lines are ended with
41703 an ASCII newline character.
41704 However, when the &%spool_wireformat%& main option is used some -D files
41705 can have an alternate format.
41706 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41707 The -D file lines (not including the first name-component line) are
41708 suitable for direct copying to the wire when transmitting using the
41709 ESMTP CHUNKING option, meaning lower processing overhead.
41710 Lines are terminated with an ASCII CRLF pair.
41711 There is no dot-stuffing (and no dot-termination).
41712
41713 . ////////////////////////////////////////////////////////////////////////////
41714 . ////////////////////////////////////////////////////////////////////////////
41715
41716 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41717          "DKIM, SPF, SRS and DMARC Support"
41718
41719 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41720 .cindex "DKIM"
41721
41722 DKIM is a mechanism by which messages sent by some entity can be provably
41723 linked to a domain which that entity controls.  It permits reputation to
41724 be tracked on a per-domain basis, rather than merely upon source IP address.
41725 DKIM is documented in RFC 6376.
41726
41727 As DKIM relies on the message being unchanged in transit, messages handled
41728 by a mailing-list (which traditionally adds to the message) will not match
41729 any original DKIM signature.
41730
41731 DKIM support is compiled into Exim by default if TLS support is present.
41732 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41733
41734 Exim's DKIM implementation allows for
41735 .olist
41736 Signing outgoing messages: This function is implemented in the SMTP transport.
41737 It can co-exist with all other Exim features
41738 (including transport filters) except cutthrough delivery.
41739 However, signing options may not depend on headers modified by
41740 routers, the transport or a transport filter.
41741 .next
41742 Verifying signatures in incoming messages: This is implemented by an additional
41743 ACL (acl_smtp_dkim), which can be called several times per message, with
41744 different signature contexts.
41745 .endlist
41746
41747 In typical Exim style, the verification implementation does not include any
41748 default "policy". Instead it enables you to build your own policy using
41749 Exim's standard controls.
41750
41751 Please note that verification of DKIM signatures in incoming mail is turned
41752 on by default for logging (in the <= line) purposes.
41753
41754 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41755 When set, for each signature in incoming email,
41756 exim will log a line displaying the most important signature details, and the
41757 signature status. Here is an example (with line-breaks added for clarity):
41758 .code
41759 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41760     d=facebookmail.com s=q1-2009b
41761     c=relaxed/relaxed a=rsa-sha1
41762     i=@facebookmail.com t=1252484542 [verification succeeded]
41763 .endd
41764
41765 You might want to turn off DKIM verification processing entirely for internal
41766 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41767 control modifier. This should typically be done in the RCPT ACL, at points
41768 where you accept mail from relay sources (internal hosts or authenticated
41769 senders).
41770
41771
41772 .subsection "Signing outgoing messages" SECDKIMSIGN
41773 .cindex DKIM signing
41774
41775 For signing to be usable you must have published a DKIM record in DNS.
41776 Note that RFC 8301 (which does not cover EC keys) says:
41777 .code
41778 rsa-sha1 MUST NOT be used for signing or verifying.
41779
41780 Signers MUST use RSA keys of at least 1024 bits for all keys.
41781 Signers SHOULD use RSA keys of at least 2048 bits.
41782 .endd
41783
41784 Note also that the key content (the 'p=' field)
41785 in the DNS record is different between RSA and EC keys;
41786 for the former it is the base64 of the ASN.1 for the RSA public key
41787 (equivalent to the private-key .pem with the header/trailer stripped)
41788 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41789
41790 Signing is enabled by setting private options on the SMTP transport.
41791 These options take (expandable) strings as arguments.
41792
41793 .option dkim_domain smtp "string list&!!" unset
41794 The domain(s) you want to sign with.
41795 After expansion, this can be a list.
41796 Each element in turn,
41797 lowercased,
41798 .vindex "&$dkim_domain$&"
41799 is put into the &%$dkim_domain%& expansion variable
41800 while expanding the remaining signing options.
41801 If it is empty after expansion, DKIM signing is not done,
41802 and no error will result even if &%dkim_strict%& is set.
41803
41804 .option dkim_selector smtp "string list&!!" unset
41805 This sets the key selector string.
41806 After expansion, which can use &$dkim_domain$&, this can be a list.
41807 Each element in turn is put in the expansion
41808 .vindex "&$dkim_selector$&"
41809 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41810 option along with &%$dkim_domain%&.
41811 If the option is empty after expansion, DKIM signing is not done for this domain,
41812 and no error will result even if &%dkim_strict%& is set.
41813
41814 To do, for example, dual-signing with RSA and EC keys
41815 this could be be used:
41816 .code
41817 dkim_selector = ec_sel : rsa_sel
41818 dkim_private_key = KEYS_DIR/$dkim_selector
41819 .endd
41820
41821 .option dkim_private_key smtp string&!! unset
41822 This sets the private key to use.
41823 You can use the &%$dkim_domain%& and
41824 &%$dkim_selector%& expansion variables to determine the private key to use.
41825 The result can either
41826 .ilist
41827 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41828 .next
41829 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41830 be a valid Ed25519 private key (same format as above)
41831 .next
41832 start with a slash, in which case it is treated as a file that contains
41833 the private key
41834 .next
41835 be "0", "false" or the empty string, in which case the message will not
41836 be signed. This case will not result in an error, even if &%dkim_strict%&
41837 is set.
41838 .endlist
41839
41840 To generate keys under OpenSSL:
41841 .code
41842 openssl genrsa -out dkim_rsa.private 2048
41843 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41844 .endd
41845 The result file from the first command should be retained, and
41846 this option set to use it.
41847 Take the base-64 lines from the output of the second command, concatenated,
41848 for the DNS TXT record.
41849 See section 3.6 of RFC6376 for the record specification.
41850
41851 Under GnuTLS:
41852 .code
41853 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41854 certtool --load-privkey=dkim_rsa.private --pubkey-info
41855 .endd
41856
41857 Note that RFC 8301 says:
41858 .code
41859 Signers MUST use RSA keys of at least 1024 bits for all keys.
41860 Signers SHOULD use RSA keys of at least 2048 bits.
41861 .endd
41862
41863 EC keys for DKIM are defined by RFC 8463.
41864 They are considerably smaller than RSA keys for equivalent protection.
41865 As they are a recent development, users should consider dual-signing
41866 (by setting a list of selectors, and an expansion for this option)
41867 for some transition period.
41868 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41869 for EC keys.
41870
41871 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41872 .code
41873 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41874 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41875 .endd
41876
41877 To produce the required public key value for a DNS record:
41878 .code
41879 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41880 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41881 .endd
41882
41883 Exim also supports an alternate format
41884 of Ed25519 keys in DNS which was a candidate during development
41885 of the standard, but not adopted.
41886 A future release will probably drop that support.
41887
41888 .option dkim_hash smtp string&!! sha256
41889 Can be set to any one of the supported hash methods, which are:
41890 .ilist
41891 &`sha1`& &-- should not be used, is old and insecure
41892 .next
41893 &`sha256`& &-- the default
41894 .next
41895 &`sha512`& &-- possibly more secure but less well supported
41896 .endlist
41897
41898 Note that RFC 8301 says:
41899 .code
41900 rsa-sha1 MUST NOT be used for signing or verifying.
41901 .endd
41902
41903 .option dkim_identity smtp string&!! unset
41904 If set after expansion, the value is used to set an "i=" tag in
41905 the signing header.  The DKIM standards restrict the permissible
41906 syntax of this optional tag to a mail address, with possibly-empty
41907 local part, an @, and a domain identical to or subdomain of the "d="
41908 tag value.  Note that Exim does not check the value.
41909
41910 .option dkim_canon smtp string&!! unset
41911 This option sets the canonicalization method used when signing a message.
41912 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41913 The option defaults to "relaxed" when unset. Note: the current implementation
41914 only supports signing with the same canonicalization method for both headers and body.
41915
41916 .option dkim_strict smtp string&!! unset
41917 This  option  defines  how  Exim  behaves  when  signing a message that
41918 should be signed fails for some reason.  When the expansion evaluates to
41919 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41920 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41921 variables here.
41922
41923 .option dkim_sign_headers smtp string&!! "see below"
41924 If set, this option must expand to a colon-separated
41925 list of header names.
41926 Headers with these names, or the absence of such a header, will be included
41927 in the message signature.
41928 When unspecified, the header names listed in RFC4871 will be used,
41929 whether or not each header is present in the message.
41930 The default list is available for the expansion in the macro
41931 &"_DKIM_SIGN_HEADERS"&
41932 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41933
41934 If a name is repeated, multiple headers by that name (or the absence thereof)
41935 will be signed.  The textually later headers in the headers part of the
41936 message are signed first, if there are multiples.
41937
41938 A name can be prefixed with either an &"="& or a &"+"& character.
41939 If an &"="& prefix is used, all headers that are present with this name
41940 will be signed.
41941 If a &"+"& prefix if used, all headers that are present with this name
41942 will be signed, and one signature added for a missing header with the
41943 name will be appended.
41944
41945 .option dkim_timestamps smtp integer&!! unset
41946 This option controls the inclusion of timestamp information in the signature.
41947 If not set, no such information will be included.
41948 Otherwise, must be an unsigned number giving an offset in seconds from the
41949 current time for the expiry tag (e.g. 1209600 for two weeks); both creation
41950 (t=) and expiry (x=) tags will be included unless the offset is 0 (no expiry).
41951
41952 RFC 6376 lists these tags as RECOMMENDED.
41953
41954
41955 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41956 .cindex DKIM verification
41957
41958 Verification of DKIM signatures in SMTP incoming email is done for all
41959 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41960
41961 .cindex DKIM "selecting signature algorithms"
41962 Individual classes of DKIM signature algorithm can be ignored by changing
41963 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41964 The &%dkim_verify_minimal%& option can be set to cease verification
41965 processing for a message once the first passing signature is found.
41966
41967 .cindex authentication "expansion item"
41968 Performing verification sets up information used by the
41969 &%authresults%& expansion item.
41970
41971 For most purposes the default option settings suffice and the remainder
41972 of this section can be ignored.
41973
41974 The results of verification are made available to the
41975 &%acl_smtp_dkim%& ACL, which (for complex needs) can examine and modify them.
41976 A missing ACL definition defaults to accept.
41977 By default, the ACL is called once for each
41978 syntactically(!) correct signature in the incoming message.
41979 If any ACL call does not accept, the message is not accepted.
41980 If a cutthrough delivery was in progress for the message, that is
41981 summarily dropped (having wasted the transmission effort).
41982
41983 To evaluate the verification result in the ACL
41984 a large number of expansion variables
41985 containing the signature status and its details are set up during the
41986 runtime of the ACL.
41987
41988 Calling the ACL only for existing signatures is not sufficient to build
41989 more advanced policies. For that reason, the main option
41990 &%dkim_verify_signers%&, and an expansion variable
41991 &%$dkim_signers%& exist.
41992
41993 The main option &%dkim_verify_signers%& can be set to a colon-separated
41994 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41995 called. It is expanded when the message has been received. At this point,
41996 the expansion variable &%$dkim_signers%& already contains a colon-separated
41997 list of signer domains and identities for the message. When
41998 &%dkim_verify_signers%& is not specified in the main configuration,
41999 it defaults as:
42000 .code
42001 dkim_verify_signers = $dkim_signers
42002 .endd
42003 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
42004 DKIM signature in the message. Current DKIM verifiers may want to explicitly
42005 call the ACL for known domains or identities. This would be achieved as follows:
42006 .code
42007 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
42008 .endd
42009 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
42010 and "ebay.com", plus all domains and identities that have signatures in the message.
42011 You can also be more creative in constructing your policy. For example:
42012 .code
42013 dkim_verify_signers = $sender_address_domain:$dkim_signers
42014 .endd
42015
42016 If a domain or identity is listed several times in the (expanded) value of
42017 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
42018
42019 Note that if the option is set using untrustworthy data
42020 (such as the From: header)
42021 care should be taken to force lowercase for domains
42022 and for the domain part if identities.
42023 The default setting can be regarded as trustworthy in this respect.
42024
42025 If multiple signatures match a domain (or identity), the ACL is called once
42026 for each matching signature.
42027
42028
42029 Inside the DKIM ACL, the following expansion variables are
42030 available (from most to least important):
42031
42032
42033 .vlist
42034 .vitem &%$dkim_cur_signer%&
42035 The signer that is being evaluated in this ACL run. This can be a domain or
42036 an identity. This is one of the list items from the expanded main option
42037 &%dkim_verify_signers%& (see above).
42038
42039 .vitem &%$dkim_verify_status%&
42040 So long as a DKIM ACL is defined
42041 (it need do no more than accept, which is the default),
42042 after all the DKIM ACL runs have completed, the value becomes a
42043 colon-separated list of the values after each run.
42044 The value is maintained for the MIME, PRDR and DATA ACLs.
42045
42046 Within the DKIM ACL,
42047 a string describing the general status of the signature. One of
42048 .ilist
42049 &%none%&: There is no signature in the message for the current domain or
42050 identity (as reflected by &%$dkim_cur_signer%&).
42051 .next
42052 &%invalid%&: The signature could not be verified due to a processing error.
42053 More detail is available in &%$dkim_verify_reason%&.
42054 .next
42055 &%fail%&: Verification of the signature failed.  More detail is
42056 available in &%$dkim_verify_reason%&.
42057 .next
42058 &%pass%&: The signature passed verification. It is valid.
42059 .endlist
42060
42061 This variable can be overwritten using an ACL 'set' modifier.
42062 This might, for instance, be done to enforce a policy restriction on
42063 hash-method or key-size:
42064 .code
42065   warn condition       = ${if eq {$dkim_verify_status}{pass}}
42066        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
42067        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
42068                                   {< {$dkim_key_length}{1024}}}}
42069        logwrite        = NOTE: forcing DKIM verify fail (was pass)
42070        set dkim_verify_status = fail
42071        set dkim_verify_reason = hash too weak or key too short
42072 .endd
42073
42074 .vitem &%$dkim_verify_reason%&
42075 A string giving a little bit more detail when &%$dkim_verify_status%& is either
42076 "fail" or "invalid". One of
42077 .ilist
42078 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
42079 key for the domain could not be retrieved. This may be a temporary problem.
42080 .next
42081 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
42082 record for the domain is syntactically invalid.
42083 .next
42084 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
42085 body hash does not match the one specified in the signature header. This
42086 means that the message body was modified in transit.
42087 .next
42088 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
42089 could not be verified. This may mean that headers were modified,
42090 re-written or otherwise changed in a way which is incompatible with
42091 DKIM verification. It may of course also mean that the signature is forged.
42092 .endlist
42093
42094 This variable can be overwritten, with any value, using an ACL 'set' modifier.
42095
42096 .vitem &%$dkim_domain%&
42097 The signing domain. IMPORTANT: This variable is only populated if there is
42098 an actual signature in the message for the current domain or identity (as
42099 reflected by &%$dkim_cur_signer%&).
42100
42101 .vitem &%$dkim_identity%&
42102 The signing identity, if present. IMPORTANT: This variable is only populated
42103 if there is an actual signature in the message for the current domain or
42104 identity (as reflected by &%$dkim_cur_signer%&).
42105
42106 .vitem &%$dkim_selector%&
42107 The key record selector string.
42108
42109 .vitem &%$dkim_algo%&
42110 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
42111 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
42112 may also be 'ed25519-sha256'.
42113 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
42114 for EC keys.
42115
42116 Note that RFC 8301 says:
42117 .code
42118 rsa-sha1 MUST NOT be used for signing or verifying.
42119
42120 DKIM signatures identified as having been signed with historic
42121 algorithms (currently, rsa-sha1) have permanently failed evaluation
42122 .endd
42123
42124 To enforce this you must either have a DKIM ACL which checks this variable
42125 and overwrites the &$dkim_verify_status$& variable as discussed above,
42126 or have set the main option &%dkim_verify_hashes%& to exclude
42127 processing of such signatures.
42128
42129 .vitem &%$dkim_canon_body%&
42130 The body canonicalization method. One of 'relaxed' or 'simple'.
42131
42132 .vitem &%$dkim_canon_headers%&
42133 The header canonicalization method. One of 'relaxed' or 'simple'.
42134
42135 .vitem &%$dkim_copiedheaders%&
42136 A transcript of headers and their values which are included in the signature
42137 (copied from the 'z=' tag of the signature).
42138 Note that RFC6376 requires that verification fail if the From: header is
42139 not included in the signature.  Exim does not enforce this; sites wishing
42140 strict enforcement should code the check explicitly.
42141
42142 .vitem &%$dkim_bodylength%&
42143 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
42144 limit was set by the signer, "9999999999999" is returned. This makes sure
42145 that this variable always expands to an integer value.
42146 &*Note:*& The presence of the signature tag specifying a signing body length
42147 is one possible route to spoofing of valid DKIM signatures.
42148 A paranoid implementation might wish to regard signature where this variable
42149 shows less than the "no limit" return as being invalid.
42150
42151 .vitem &%$dkim_created%&
42152 UNIX timestamp reflecting the date and time when the signature was created.
42153 When this was not specified by the signer, "0" is returned.
42154
42155 .vitem &%$dkim_expires%&
42156 UNIX timestamp reflecting the date and time when the signer wants the
42157 signature to be treated as "expired". When this was not specified by the
42158 signer, "9999999999999" is returned. This makes it possible to do useful
42159 integer size comparisons against this value.
42160 Note that Exim does not check this value.
42161
42162 .vitem &%$dkim_headernames%&
42163 A colon-separated list of names of headers included in the signature.
42164
42165 .vitem &%$dkim_key_testing%&
42166 "1" if the key record has the "testing" flag set, "0" if not.
42167
42168 .vitem &%$dkim_key_nosubdomains%&
42169 "1" if the key record forbids subdomaining, "0" otherwise.
42170
42171 .vitem &%$dkim_key_srvtype%&
42172 Service type (tag s=) from the key record. Defaults to "*" if not specified
42173 in the key record.
42174
42175 .vitem &%$dkim_key_granularity%&
42176 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
42177 in the key record.
42178
42179 .vitem &%$dkim_key_notes%&
42180 Notes from the key record (tag n=).
42181
42182 .vitem &%$dkim_key_length%&
42183 Number of bits in the key.
42184 Valid only once the key is loaded, which is at the time the header signature
42185 is verified, which is after the body hash is.
42186
42187 Note that RFC 8301 says:
42188 .code
42189 Verifiers MUST NOT consider signatures using RSA keys of
42190 less than 1024 bits as valid signatures.
42191 .endd
42192
42193 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
42194 option.
42195
42196 .endlist
42197
42198 In addition, two ACL conditions are provided:
42199
42200 .vlist
42201 .vitem &%dkim_signers%&
42202 ACL condition that checks a colon-separated list of domains or identities
42203 for a match against the domain or identity that the ACL is currently verifying
42204 (reflected by &%$dkim_cur_signer%&).
42205 This condition is only usable in a DKIM ACL.
42206 This is typically used to restrict an ACL
42207 verb to a group of domains or identities. For example:
42208
42209 .code
42210 # Warn when Mail purportedly from GMail has no gmail signature
42211 warn sender_domains = gmail.com
42212      dkim_signers = gmail.com
42213      dkim_status = none
42214      log_message = GMail sender without gmail.com DKIM signature
42215 .endd
42216
42217 Note that the above does not check for a total lack of DKIM signing;
42218 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
42219
42220 .vitem &%dkim_status%&
42221 ACL condition that checks a colon-separated list of possible DKIM verification
42222 results against the actual result of verification,
42223 given by &$dkim_verify_status$& if that is non-empty or "none" if empty.
42224 This condition may be used in DKIM, MIME, PRDR and DATA ACLs.
42225
42226 A basic verification might be:
42227 .code
42228 deny !dkim_status = pass:none:invalid
42229 .endd
42230
42231 A more complex use could be
42232 to restrict an ACL verb to a list of verification outcomes, for example:
42233
42234 .code
42235 deny sender_domains = paypal.com:paypal.de
42236      dkim_signers = paypal.com:paypal.de
42237      dkim_status = none:invalid:fail
42238      message = Mail from Paypal with invalid/missing signature
42239 .endd
42240
42241 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42242 see the documentation of the &%$dkim_verify_status%& expansion variable above
42243 for more information of what they mean.
42244
42245 The condition is true if the status
42246 (or any of the list of status values)
42247 is any one of the supplied list.
42248 .endlist
42249
42250
42251
42252
42253 .section "SPF (Sender Policy Framework)" SECSPF
42254 .cindex SPF verification
42255
42256 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42257 messages with its domain in the envelope from, documented by RFC 7208.
42258 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42259 the &url(http://openspf.org).
42260 . --- 2019-10-28: still not https, open-spf.org is told to be a
42261 . --- web-archive copy of the now dead openspf.org site
42262 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42263 . --- discussion.
42264
42265 Messages sent by a system not authorised will fail checking of such assertions.
42266 This includes retransmissions done by traditional forwarders.
42267
42268 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42269 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42270 &url(https://www.libspf2.org/).
42271 There is no Exim involvement in the transmission of messages;
42272 publishing certain DNS records is all that is required.
42273
42274 For verification, an ACL condition and an expansion lookup are provided.
42275 .cindex authentication "expansion item"
42276 Performing verification sets up information used by the
42277 &%authresults%& expansion item.
42278
42279
42280 .cindex SPF "ACL condition"
42281 .cindex ACL "spf condition"
42282 The ACL condition "spf" can be used at or after the MAIL ACL.
42283 It takes as an argument a list of strings giving the outcome of the SPF check,
42284 and will succeed for any matching outcome.
42285 Valid strings are:
42286 .vlist
42287 .vitem &%pass%&
42288 The SPF check passed, the sending host is positively verified by SPF.
42289
42290 .vitem &%fail%&
42291 The SPF check failed, the sending host is NOT allowed to send mail for the
42292 domain in the envelope-from address.
42293
42294 .vitem &%softfail%&
42295 The SPF check failed, but the queried domain can't absolutely confirm that this
42296 is a forgery.
42297
42298 .vitem &%none%&
42299 The queried domain does not publish SPF records.
42300
42301 .vitem &%neutral%&
42302 The SPF check returned a "neutral" state.  This means the queried domain has
42303 published a SPF record, but wants to allow outside servers to send mail under
42304 its domain as well.  This should be treated like "none".
42305
42306 .vitem &%permerror%&
42307 This indicates a syntax error in the SPF record of the queried domain.
42308 You may deny messages when this occurs.
42309
42310 .vitem &%temperror%&
42311 This indicates a temporary error during all processing, including Exim's
42312 SPF processing.  You may defer messages when this occurs.
42313
42314 .vitem &%invalid%&
42315 There was an error during processing of the SPF lookup
42316 .endlist
42317
42318 You can prefix each string with an exclamation mark to  invert
42319 its meaning,  for example  "!fail" will  match all  results but
42320 "fail".  The  string  list is  evaluated  left-to-right,  in a
42321 short-circuit fashion.
42322
42323 Example:
42324 .code
42325 deny spf = fail
42326      message = $sender_host_address is not allowed to send mail from \
42327                ${if def:sender_address_domain \
42328                     {$sender_address_domain}{$sender_helo_name}}.  \
42329                Please see http://www.open-spf.org/Why;\
42330                identity=${if def:sender_address_domain \
42331                              {$sender_address}{$sender_helo_name}};\
42332                ip=$sender_host_address
42333 .endd
42334
42335 Note: The above mentioned URL may not be as helpful as expected. You are
42336 encouraged to replace the link with a link to a site with more
42337 explanations.
42338
42339 When the spf condition has run, it sets up several expansion
42340 variables:
42341
42342 .cindex SPF "verification variables"
42343 .vlist
42344 .vitem &$spf_header_comment$&
42345 .vindex &$spf_header_comment$&
42346   This contains a human-readable string describing the outcome
42347   of the SPF check. You can add it to a custom header or use
42348   it for logging purposes.
42349
42350 .vitem &$spf_received$&
42351 .vindex &$spf_received$&
42352   This contains a complete Received-SPF: header (name and
42353   content) that can be added to the message. Please note that
42354   according to the SPF draft, this header must be added at the
42355   top of the header list, i.e. with
42356 .code
42357 add_header = :at_start:$spf_received
42358 .endd
42359   See section &<<SECTaddheadacl>>& for further details.
42360
42361   Note: in case of "Best-guess" (see below), the convention is
42362   to put this string in a header called X-SPF-Guess: instead.
42363
42364 .vitem &$spf_result$&
42365 .vindex &$spf_result$&
42366   This contains the outcome of the SPF check in string form,
42367   currently one of pass, fail, softfail, none, neutral, permerror,
42368   temperror, or &"(invalid)"&.
42369
42370 .vitem &$spf_result_guessed$&
42371 .vindex &$spf_result_guessed$&
42372   This boolean is true only if a best-guess operation was used
42373   and required in order to obtain a result.
42374
42375 .vitem &$spf_smtp_comment$&
42376 .vindex &$spf_smtp_comment$&
42377 .vindex &%spf_smtp_comment_template%&
42378   This contains a string that can be used in a SMTP response
42379   to the calling party. Useful for "fail".
42380   The string is generated by the SPF library from the template configured in the main config
42381   option &%spf_smtp_comment_template%&.
42382 .endlist
42383
42384
42385 .cindex SPF "ACL condition"
42386 .cindex ACL "spf_guess condition"
42387 .cindex SPF "best guess"
42388 In addition to SPF, you can also perform checks for so-called
42389 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42390 SPF, but it is supported by the same framework that enables SPF
42391 capability.
42392 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42393 for a description of what it means.
42394 . --- 2019-10-28: still not https:
42395
42396 To access this feature, simply use the spf_guess condition in place
42397 of the spf one.  For example:
42398
42399 .code
42400 deny spf_guess = fail
42401      message = $sender_host_address doesn't look trustworthy to me
42402 .endd
42403
42404 In case you decide to reject messages based on this check, you
42405 should note that although it uses the same framework, "Best-guess"
42406 is not SPF, and therefore you should not mention SPF at all in your
42407 reject message.
42408
42409 When the spf_guess condition has run, it sets up the same expansion
42410 variables as when spf condition is run, described above.
42411
42412 Additionally, since Best-guess is not standardized, you may redefine
42413 what "Best-guess" means to you by redefining the main configuration
42414 &%spf_guess%& option.
42415 For example, the following:
42416
42417 .code
42418 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42419 .endd
42420
42421 would relax host matching rules to a broader network range.
42422
42423
42424 .cindex SPF "lookup expansion"
42425 .cindex lookup spf
42426 A lookup expansion is also available. It takes an email
42427 address as the key and an IP address
42428 (v4 or v6)
42429 as the database:
42430
42431 .code
42432   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42433 .endd
42434
42435 The lookup will return the same result strings as can appear in
42436 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42437
42438
42439
42440
42441
42442 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42443 .cindex SRS "sender rewriting scheme"
42444 .cindex VERP "variable envelope return path"
42445
42446 SRS can be used to modify sender addresses when forwarding so that
42447 SPF verification does not object to them.
42448 It can also be used to identify a received bounce message as
42449 likely (or not) having been trigged by a message from the
42450 local system, and for identifying dead addresses in mailing lists.
42451 It is one implementation of a VERP (Variable Envelope Return Path) method.
42452
42453 SRS operates by encoding the original envelope sender in a new
42454 sender local part and using a domain run by the forwarding site
42455 as the new domain for the sender.  Any DSN message should be returned
42456 to this new sender at the forwarding site, which can extract the
42457 original sender from the coded local part and forward the DSN to
42458 the originator.
42459
42460 This is a way of avoiding the breakage that SPF does to forwarding.
42461 The constructed local-part will be longer than the original,
42462 leading to possible problems with very long addresses.
42463 The changing of the sender address also hinders the tracing of mail
42464 problems.
42465
42466 Exim can be built to include native SRS support.  To do this
42467 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42468 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42469 will be defined.
42470 The support is limited to SRS0-encoding; SRS1 is not supported.
42471
42472 .cindex SRS excoding
42473 To encode an address use this expansion item:
42474 .vlist
42475 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42476 .cindex "&%srs_encode%& expansion item"
42477 .cindex SRS "expansion item"
42478 The first argument should be a secret known and used by all systems
42479 handling the recipient domain for the original message.
42480 There is no need to periodically change this key; a timestamp is also
42481 encoded.
42482 The second argument should be given as the envelope sender address before this
42483 encoding operation.
42484 If this value is empty the the expansion result will be empty.
42485 The third argument should be the recipient domain of the message when
42486 it arrived at this system.
42487 All arguments are expanded before use.
42488
42489 The result of the expansion is the replacement envelope-from (return path)
42490 to be used.
42491 .endlist
42492
42493 .cindex SRS decoding
42494 To decode an address use this expansion condition:
42495 .vlist
42496 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42497 The first argument should be the recipient local part as it was received.
42498 The second argument is the site secret.
42499 Both arguments are expanded before use.
42500
42501 If the messages is not for an SRS-encoded recipient the condition will
42502 return false.
42503 If it is, the condition will return true and the variable
42504 &$srs_recipient$& will be set to the decoded (original) value.
42505
42506 If the second argument is empty then the condition returns true if
42507 the first argument is in valid SRS formet, else false.
42508 The variable &$srs_recipient$& is not set for this case.
42509 .endlist
42510
42511 Example usage:
42512 .code
42513   #macro
42514   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42515
42516   #routers
42517
42518   outbound:
42519     driver =    dnslookup
42520     # if outbound, and forwarding has been done, use an alternate transport
42521     domains =   ! +my_domains
42522     transport = ${if eq {$local_part@$domain} \
42523                         {$original_local_part@$original_domain} \
42524                      {remote_smtp} {remote_forwarded_smtp}}
42525
42526   inbound_srs:
42527     driver =    redirect
42528     senders =   :
42529     domains =   +my_domains
42530     # detect inbound bounces which are SRS'd, and decode them
42531     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42532     data =      $srs_recipient
42533
42534   inbound_srs_failure:
42535     driver =    redirect
42536     senders =   :
42537     domains =   +my_domains
42538     # detect inbound bounces which look SRS'd but are invalid
42539     condition = ${if inbound_srs {$local_part} {}}
42540     allow_fail
42541     data =      :fail: Invalid SRS recipient address
42542
42543   #... further routers here get inbound_srs-redirected recipients
42544   # and any that were not SRS'd
42545
42546
42547   # transport; should look like the non-forward outbound
42548   # one, plus the max_rcpt and return_path options
42549   remote_forwarded_smtp:
42550     driver =              smtp
42551     # single-recipient so that $original_domain is valid
42552     max_rcpt =            1
42553     # modify the envelope from, for mails that we forward
42554     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42555 .endd
42556
42557
42558
42559
42560
42561 .section DMARC SECDMARC
42562 .cindex DMARC verification
42563
42564 DMARC combines feedback from SPF, DKIM, and header From: in order
42565 to attempt to provide better indicators of the authenticity of an
42566 email.  This document does not explain the fundamentals; you
42567 should read and understand how it works by visiting the website at
42568 &url(http://www.dmarc.org/).
42569
42570 If Exim is built with DMARC support,
42571 the libopendmarc library is used.
42572
42573 For building Exim yourself, obtain the library from
42574 &url(http://sourceforge.net/projects/opendmarc/)
42575 to obtain a copy, or find it in your favorite package
42576 repository.  You will need to attend to the local/Makefile feature
42577 SUPPORT_DMARC and the associated LDFLAGS addition.
42578 This description assumes
42579 that headers will be in /usr/local/include, and that the libraries
42580 are in /usr/local/lib.
42581
42582 .subsection Configuration SSECDMARCCONFIG
42583 .cindex DMARC configuration
42584
42585 There are three main-configuration options:
42586 .cindex DMARC "configuration options"
42587
42588 The &%dmarc_tld_file%& option
42589 .oindex &%dmarc_tld_file%&
42590 defines the location of a text file of valid
42591 top level domains the opendmarc library uses
42592 during domain parsing. Maintained by Mozilla,
42593 the most current version can be downloaded
42594 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42595 See also the util/renew-opendmarc-tlds.sh script.
42596 The default for the option is unset.
42597 If not set, DMARC processing is disabled.
42598
42599
42600 The &%dmarc_history_file%& option, if set
42601 .oindex &%dmarc_history_file%&
42602 defines the location of a file to log results
42603 of dmarc verification on inbound emails. The
42604 contents are importable by the opendmarc tools
42605 which will manage the data, send out DMARC
42606 reports, and expire the data. Make sure the
42607 directory of this file is writable by the user
42608 exim runs as.
42609 The default is unset.
42610
42611 The &%dmarc_forensic_sender%& option
42612 .oindex &%dmarc_forensic_sender%&
42613 defines an alternate email address to use when sending a
42614 forensic report detailing alignment failures
42615 if a sender domain's dmarc record specifies it
42616 and you have configured Exim to send them.
42617 If set, this is expanded and used for the
42618 From: header line; the address is extracted
42619 from it and used for the envelope from.
42620 If not set (the default), the From: header is expanded from
42621 the dsn_from option, and <> is used for the
42622 envelope from.
42623
42624 .subsection Controls SSECDMARCCONTROLS
42625 .cindex DMARC controls
42626
42627 By default, the DMARC processing will run for any remote,
42628 non-authenticated user.  It makes sense to only verify DMARC
42629 status of messages coming from remote, untrusted sources.  You can
42630 use standard conditions such as hosts, senders, etc, to decide that
42631 DMARC verification should *not* be performed for them and disable
42632 DMARC with an ACL control modifier:
42633 .code
42634   control = dmarc_disable_verify
42635 .endd
42636 A DMARC record can also specify a "forensic address", which gives
42637 exim an email address to submit reports about failed alignment.
42638 Exim does not do this by default because in certain conditions it
42639 results in unintended information leakage (what lists a user might
42640 be subscribed to, etc).  You must configure exim to submit forensic
42641 reports to the owner of the domain.  If the DMARC record contains a
42642 forensic address and you specify the control statement below, then
42643 exim will send these forensic emails.  It is also advised that you
42644 configure a &%dmarc_forensic_sender%& because the default sender address
42645 construction might be inadequate.
42646 .code
42647   control = dmarc_enable_forensic
42648 .endd
42649 (AGAIN: You can choose not to send these forensic reports by simply
42650 not putting the dmarc_enable_forensic control line at any point in
42651 your exim config.  If you don't tell exim to send them, it will not
42652 send them.)
42653
42654 There are no options to either control.  Both must appear before
42655 the DATA acl.
42656
42657 .subsection ACL SSECDMARCACL
42658 .cindex DMARC "ACL condition"
42659
42660 DMARC checks can be run on incoming SMTP  messages by using the
42661 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42662 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42663 condition.  Putting this condition in the ACLs is required in order
42664 for a DMARC check to actually occur.  All of the variables are set
42665 up before the DATA ACL, but there is no actual DMARC check that
42666 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42667
42668 The &"dmarc_status"& condition takes a list of strings on its
42669 right-hand side.  These strings describe recommended action based
42670 on the DMARC check.  To understand what the policy recommendations
42671 mean, refer to the DMARC website above.  Valid strings are:
42672 .itable none 0 0 2 20* left 80* left
42673 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42674 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42675 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42676 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42677 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42678 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42679 .irow &'temperror'&     "Library error or dns error"
42680 .irow &'off'&           "The DMARC check was disabled for this email"
42681 .endtable
42682 You can prefix each string with an exclamation mark to invert its
42683 meaning, for example "!accept" will match all results but
42684 "accept".  The string list is evaluated left-to-right in a
42685 short-circuit fashion.  When a string matches the outcome of the
42686 DMARC check, the condition succeeds.  If none of the listed
42687 strings matches the outcome of the DMARC check, the condition
42688 fails.
42689
42690 Of course, you can also use any other lookup method that Exim
42691 supports, including LDAP, Postgres, MySQL, etc, as long as the
42692 result is a list of colon-separated strings.
42693
42694 Performing the check sets up information used by the
42695 &%authresults%& expansion item.
42696
42697 Several expansion variables are set before the DATA ACL is
42698 processed, and you can use them in this ACL.  The following
42699 expansion variables are available:
42700
42701 .vlist
42702 .vitem &$dmarc_status$&
42703 .vindex &$dmarc_status$&
42704 .cindex DMARC result
42705 A one word status indicating what the DMARC library
42706 thinks of the email.  It is a combination of the results of
42707 DMARC record lookup and the SPF/DKIM/DMARC processing results
42708 (if a DMARC record was found).  The actual policy declared
42709 in the DMARC record is in a separate expansion variable.
42710
42711 .vitem &$dmarc_status_text$&
42712 .vindex &$dmarc_status_text$&
42713 Slightly longer, human readable status.
42714
42715 .vitem &$dmarc_used_domain$&
42716 .vindex &$dmarc_used_domain$&
42717 The domain which DMARC used to look up the DMARC policy record.
42718
42719 .vitem &$dmarc_domain_policy$&
42720 .vindex &$dmarc_domain_policy$&
42721 The policy declared in the DMARC record.  Valid values
42722 are "none", "reject" and "quarantine".  It is blank when there
42723 is any error, including no DMARC record.
42724 .endlist
42725
42726 .subsection Logging SSECDMARCLOGGING
42727 .cindex DMARC logging
42728
42729 By default, Exim's DMARC configuration is intended to be
42730 non-intrusive and conservative.  To facilitate this, Exim will not
42731 create any type of logging files without explicit configuration by
42732 you, the admin.  Nor will Exim send out any emails/reports about
42733 DMARC issues without explicit configuration by you, the admin (other
42734 than typical bounce messages that may come about due to ACL
42735 processing or failure delivery issues).
42736
42737 In order to log statistics suitable to be imported by the opendmarc
42738 tools, you need to:
42739 .ilist
42740 Configure the global option &%dmarc_history_file%&
42741 .next
42742 Configure cron jobs to call the appropriate opendmarc history
42743 import scripts and truncating the dmarc_history_file
42744 .endlist
42745
42746 In order to send forensic reports, you need to:
42747 .ilist
42748 Configure the global option &%dmarc_forensic_sender%&
42749 .next
42750 Configure, somewhere before the DATA ACL, the control option to
42751 enable sending DMARC forensic reports
42752 .endlist
42753
42754 .subsection Example SSECDMARCEXAMPLE
42755 .cindex DMARC example
42756
42757 Example usage:
42758 .code
42759 (RCPT ACL)
42760   warn    domains        = +local_domains
42761           hosts          = +local_hosts
42762           control        = dmarc_disable_verify
42763
42764   warn    !domains       = +screwed_up_dmarc_records
42765           control        = dmarc_enable_forensic
42766
42767   warn    condition      = (lookup if destined to mailing list)
42768           set acl_m_mailing_list = 1
42769
42770 (DATA ACL)
42771   warn    dmarc_status   = accept : none : off
42772           !authenticated = *
42773           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42774
42775   warn    dmarc_status   = !accept
42776           !authenticated = *
42777           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42778
42779   warn    dmarc_status   = quarantine
42780           !authenticated = *
42781           set $acl_m_quarantine = 1
42782           # Do something in a transport with this flag variable
42783
42784   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42785           condition      = ${if eq{$acl_m_mailing_list}{1}}
42786           message        = Messages from $dmarc_used_domain break mailing lists
42787
42788   deny    dmarc_status   = reject
42789           !authenticated = *
42790           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42791
42792   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42793 .endd
42794
42795
42796
42797
42798
42799 . ////////////////////////////////////////////////////////////////////////////
42800 . ////////////////////////////////////////////////////////////////////////////
42801
42802 .chapter "Proxies" "CHAPproxies" &&&
42803          "Proxy support"
42804 .cindex "proxy support"
42805 .cindex "proxy" "access via"
42806
42807 A proxy is an intermediate system through which communication is passed.
42808 Proxies may provide a security, availability or load-distribution function.
42809
42810
42811 .section "Inbound proxies" SECTproxyInbound
42812 .cindex proxy inbound
42813 .cindex proxy "server side"
42814 .cindex proxy "Proxy protocol"
42815 .cindex "Proxy protocol" proxy
42816
42817 Exim has support for receiving inbound SMTP connections via a proxy
42818 that uses &"Proxy Protocol"& to speak to it.
42819 To include this support, include &"SUPPORT_PROXY=yes"&
42820 in Local/Makefile.
42821
42822 It was built on the HAProxy specification, found at
42823 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42824
42825 The purpose of this facility is so that an application load balancer,
42826 such as HAProxy, can sit in front of several Exim servers
42827 to distribute load.
42828 Exim uses the local protocol communication with the proxy to obtain
42829 the remote SMTP system IP address and port information.
42830 There is no logging if a host passes or
42831 fails Proxy Protocol negotiation, but it can easily be determined and
42832 recorded in an ACL (example is below).
42833
42834 Use of a proxy is enabled by setting the &%hosts_proxy%&
42835 main configuration option to a hostlist; connections from these
42836 hosts will use Proxy Protocol.
42837 Exim supports both version 1 and version 2 of the Proxy Protocol and
42838 automatically determines which version is in use.
42839
42840 The Proxy Protocol header is the first data received on a TCP connection
42841 and is inserted before any TLS-on-connect handshake from the client; Exim
42842 negotiates TLS between Exim-as-server and the remote client, not between
42843 Exim and the proxy server. The Proxy Protocol header must be received
42844 within &%proxy_protocol_timeout%&, which defaults to 3s.
42845
42846 The following expansion variables are usable
42847 (&"internal"& and &"external"& here refer to the interfaces
42848 of the proxy):
42849 .itable none 0 0 2 30* left 70* left
42850 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42851 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42852 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42853 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42854 .irow $proxy_session            "boolean: SMTP connection via proxy"
42855 .endtable
42856 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42857 there was a protocol error.
42858 The variables &$sender_host_address$& and &$sender_host_port$&
42859 will have values for the actual client system, not the proxy.
42860
42861 Since the real connections are all coming from the proxy, and the
42862 per host connection tracking is done before Proxy Protocol is
42863 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42864 handle all of the parallel volume you expect per inbound proxy.
42865 With the option set so high, you lose the ability
42866 to protect your server from many connections from one IP.
42867 In order to prevent your server from overload, you
42868 need to add a per connection ratelimit to your connect ACL.
42869 A possible solution is:
42870 .display
42871   # Set max number of connections per host
42872   LIMIT   = 5
42873   # Or do some kind of IP lookup in a flat file or database
42874   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42875
42876   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42877           message        = Too many connections from this IP right now
42878 .endd
42879
42880
42881
42882 .section "Outbound proxies" SECTproxySOCKS
42883 .cindex proxy outbound
42884 .cindex proxy "client side"
42885 .cindex proxy SOCKS
42886 .cindex SOCKS proxy
42887 Exim has support for sending outbound SMTP via a proxy
42888 using a protocol called SOCKS5 (defined by RFC1928).
42889 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42890 Local/Makefile.
42891
42892 Use of a proxy is enabled by setting the &%socks_proxy%& option
42893 on an smtp transport.
42894 The option value is expanded and should then be a list
42895 (colon-separated by default) of proxy specifiers.
42896 Each proxy specifier is a list
42897 (space-separated by default) where the initial element
42898 is an IP address and any subsequent elements are options.
42899
42900 Options are a string <name>=<value>.
42901 The list of options is in the following table:
42902 .itable none 0 0 2 10* left 90* left
42903 .irow &'auth'&  "authentication method"
42904 .irow &'name'&  "authentication username"
42905 .irow &'pass'&  "authentication password"
42906 .irow &'port'&  "tcp port"
42907 .irow &'tmo'&   "connection timeout"
42908 .irow &'pri'&   "priority"
42909 .irow &'weight'& "selection bias"
42910 .endtable
42911
42912 More details on each of these options follows:
42913
42914 .ilist
42915 .cindex authentication "to proxy"
42916 .cindex proxy authentication
42917 &%auth%&: Either &"none"& (default) or &"name"&.
42918 Using &"name"& selects username/password authentication per RFC 1929
42919 for access to the proxy.
42920 Default is &"none"&.
42921 .next
42922 &%name%&: sets the username for the &"name"& authentication method.
42923 Default is empty.
42924 .next
42925 &%pass%&: sets the password for the &"name"& authentication method.
42926 Default is empty.
42927 .next
42928 &%port%&: the TCP port number to use for the connection to the proxy.
42929 Default is 1080.
42930 .next
42931 &%tmo%&: sets a connection timeout in seconds for this proxy.
42932 Default is 5.
42933 .next
42934 &%pri%&: specifies a priority for the proxy within the list,
42935 higher values being tried first.
42936 The default priority is 1.
42937 .next
42938 &%weight%&: specifies a selection bias.
42939 Within a priority set servers are queried in a random fashion,
42940 weighted by this value.
42941 The default value for selection bias is 1.
42942 .endlist
42943
42944 Proxies from the list are tried according to their priority
42945 and weight settings until one responds.  The timeout for the
42946 overall connection applies to the set of proxied attempts.
42947
42948 .section Logging SECTproxyLog
42949 To log the (local) IP of a proxy in the incoming or delivery logline,
42950 add &"+proxy"& to the &%log_selector%& option.
42951 This will add a component tagged with &"PRX="& to the line.
42952
42953 . ////////////////////////////////////////////////////////////////////////////
42954 . ////////////////////////////////////////////////////////////////////////////
42955
42956 .chapter "Internationalisation" "CHAPi18n" &&&
42957          "Internationalisation""
42958 .cindex internationalisation "email address"
42959 .cindex EAI
42960 .cindex i18n
42961 .cindex utf8 "mail name handling"
42962
42963 Exim has support for Internationalised mail names.
42964 To include this it must be built with SUPPORT_I18N and the libidn library.
42965 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42966
42967 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42968 instead of it) then IDNA2008 is supported; this adds an extra library
42969 requirement, upon libidn2.
42970
42971 .section "MTA operations" SECTi18nMTA
42972 .cindex SMTPUTF8 "ESMTP option"
42973 .cindex "ESMTP extensions" SMTPUTF8
42974 The main configuration option &%smtputf8_advertise_hosts%& specifies
42975 a host list.  If this matches the sending host and
42976 accept_8bitmime is true (the default) then the ESMTP option
42977 SMTPUTF8 will be advertised.
42978
42979 If the sender specifies the SMTPUTF8 option on a MAIL command
42980 international handling for the message is enabled and
42981 the expansion variable &$message_smtputf8$& will have value TRUE.
42982
42983 The option &%allow_utf8_domains%& is set to true for this
42984 message. All DNS lookups are converted to a-label form
42985 whatever the setting of &%allow_utf8_domains%&
42986 when Exim is built with SUPPORT_I18N.
42987
42988 Both localparts and domain are maintained as the original
42989 UTF-8 form internally; any comparison or regular-expression use will
42990 require appropriate care.  Filenames created, eg. by
42991 the appendfile transport, will have UTF-8 names.
42992
42993 HELO names sent by the smtp transport will have any UTF-8
42994 components expanded to a-label form,
42995 and any certificate name checks will be done using the a-label
42996 form of the name.
42997
42998 .cindex log protocol
42999 .cindex SMTPUTF8 logging
43000 .cindex i18n logging
43001 Log lines and Received-by: header lines will acquire a "utf8"
43002 prefix on the protocol element, eg. utf8esmtp.
43003
43004 The following expansion operators can be used:
43005 .code
43006 ${utf8_domain_to_alabel:str}
43007 ${utf8_domain_from_alabel:str}
43008 ${utf8_localpart_to_alabel:str}
43009 ${utf8_localpart_from_alabel:str}
43010 .endd
43011
43012 .cindex utf8 "address downconversion"
43013 .cindex i18n "utf8 address downconversion"
43014 The RCPT ACL
43015 may use the following modifier:
43016 .display
43017 control = utf8_downconvert
43018 control = utf8_downconvert/<value>
43019 .endd
43020 This sets a flag requiring that envelope addresses are converted to
43021 a-label form before smtp delivery.
43022 This is usually for use in a Message Submission Agent context,
43023 but could be used for any message.
43024
43025 If a value is appended it may be:
43026 .itable none 0 0 2 5* right 95* left
43027 .irow &`1`&     "mandatory downconversion"
43028 .irow &`0`&     "no downconversion"
43029 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
43030 .endtable
43031 If no value is given, 1 is used.
43032
43033 If mua_wrapper is set, the utf8_downconvert control
43034 is initially set to -1.
43035
43036 The smtp transport has an option &%utf8_downconvert%&.
43037 If set it must expand to one of the three values described above,
43038 or an empty string.
43039 If non-empty it overrides value previously set
43040 (due to mua_wrapper or by an ACL control).
43041
43042
43043 There is no explicit support for VRFY and EXPN.
43044 Configurations supporting these should inspect
43045 &$smtp_command_argument$& for an SMTPUTF8 argument.
43046
43047 There is no support for LMTP on Unix sockets.
43048 Using the "lmtp" protocol option on an smtp transport,
43049 for LMTP over TCP, should work as expected.
43050
43051 There is no support for DSN unitext handling,
43052 and no provision for converting logging from or to UTF-8.
43053
43054
43055
43056 .section "MDA operations" SECTi18nMDA
43057 To aid in constructing names suitable for IMAP folders
43058 the following expansion operator can be used:
43059 .code
43060 ${imapfolder {<string>} {<sep>} {<specials>}}
43061 .endd
43062
43063 The string is converted from the charset specified by
43064 the "headers charset" command (in a filter file)
43065 or &%headers_charset%& main configuration option (otherwise),
43066 to the
43067 modified UTF-7 encoding specified by RFC 2060,
43068 with the following exception: All occurrences of <sep>
43069 (which has to be a single character)
43070 are replaced with periods ("."), and all periods and slashes that are not
43071 <sep> and are not in the <specials> string are BASE64 encoded.
43072
43073 The third argument can be omitted, defaulting to an empty string.
43074 The second argument can be omitted, defaulting to "/".
43075
43076 This is the encoding used by Courier for Maildir names on disk, and followed
43077 by many other IMAP servers.
43078
43079 Examples:
43080 .display
43081 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
43082 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
43083 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
43084 .endd
43085
43086 Note that the source charset setting is vital, and also that characters
43087 must be representable in UTF-16.
43088
43089
43090 . ////////////////////////////////////////////////////////////////////////////
43091 . ////////////////////////////////////////////////////////////////////////////
43092
43093 .chapter "Events" "CHAPevents" &&&
43094          "Events"
43095 .cindex events
43096
43097 The events mechanism in Exim can be used to intercept processing at a number
43098 of points.  It was originally invented to give a way to do customised logging
43099 actions (for example, to a database) but can also be used to modify some
43100 processing actions.
43101
43102 Most installations will never need to use Events.
43103 The support can be left out of a build by defining DISABLE_EVENT=yes
43104 in &_Local/Makefile_&.
43105
43106 There are two major classes of events: main and transport.
43107 The main configuration option &%event_action%& controls reception events;
43108 a transport option &%event_action%& controls delivery events.
43109
43110 Both options are a string which is expanded when the event fires.
43111 An example might look like:
43112 .cindex logging custom
43113 .code
43114 event_action = ${if eq {msg:delivery}{$event_name} \
43115 {${lookup pgsql {SELECT * FROM record_Delivery( \
43116     '${quote_pgsql:$sender_address_domain}',\
43117     '${quote_pgsql:${lc:$sender_address_local_part}}', \
43118     '${quote_pgsql:$domain}', \
43119     '${quote_pgsql:${lc:$local_part}}', \
43120     '${quote_pgsql:$host_address}', \
43121     '${quote_pgsql:${lc:$host}}', \
43122     '${quote_pgsql:$message_exim_id}')}} \
43123 } {}}
43124 .endd
43125
43126 Events have names which correspond to the point in process at which they fire.
43127 The name is placed in the variable &$event_name$& and the event action
43128 expansion must check this, as it will be called for every possible event type.
43129
43130 The current list of events is:
43131 .itable all 0 0 4 25* left 10* center 15* center 50* left
43132 .row auth:fail              after    both       "per driver per authentication attempt"
43133 .row dane:fail              after    transport  "per connection"
43134 .row dns:fail               after    both       "per lookup"
43135 .row msg:complete           after    main       "per message"
43136 .row msg:defer              after    transport  "per message per delivery try"
43137 .row msg:delivery           after    transport  "per recipient"
43138 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
43139 .row msg:rcpt:defer         after    transport  "per recipient"
43140 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
43141 .row msg:fail:delivery      after    transport  "per recipient"
43142 .row msg:fail:internal      after    main       "per recipient"
43143 .row tcp:connect            before   transport  "per connection"
43144 .row tcp:close              after    transport  "per connection"
43145 .row tls:cert               before   both       "per certificate in verification chain"
43146 .row tls:fail:connect       after    main       "per connection"
43147 .row smtp:connect           after    transport  "per connection"
43148 .row smtp:ehlo              after    transport  "per connection"
43149 .endtable
43150 New event types may be added in future.
43151
43152 The event name is a colon-separated list, defining the type of
43153 event in a tree of possibilities.  It may be used as a list
43154 or just matched on as a whole.  There will be no spaces in the name.
43155
43156 The second column in the table above describes whether the event fires
43157 before or after the action is associates with.  Those which fire before
43158 can be used to affect that action (more on this below).
43159
43160 The third column in the table above says what section of the configuration
43161 should define the event action.
43162
43163 An additional variable, &$event_data$&, is filled with information varying
43164 with the event type:
43165 .itable all 0 0 2 20* left 80* left
43166 .row auth:fail            "smtp response"
43167 .row dane:fail            "failure reason"
43168 .row dns:fail             "failure reason, key and lookup-type"
43169 .row msg:defer            "error string"
43170 .row msg:delivery         "smtp confirmation message"
43171 .row msg:fail:internal    "failure reason"
43172 .row msg:fail:delivery    "smtp error message"
43173 .row msg:host:defer       "error string"
43174 .row msg:rcpt:host:defer  "error string"
43175 .row msg:rcpt:defer       "error string"
43176 .row tls:cert             "verification chain depth"
43177 .row tls:fail:connect     "error string"
43178 .row smtp:connect         "smtp banner"
43179 .row smtp:ehlo            "smtp ehlo response"
43180 .endtable
43181
43182 The :defer events populate one extra variable: &$event_defer_errno$&.
43183
43184 For complex operations an ACL expansion can be used in &%event_action%&,
43185 however due to the multiple contexts that Exim operates in during
43186 the course of its processing:
43187 .ilist
43188 variables set in transport events will not be visible outside that
43189 transport call
43190 .next
43191 acl_m variables in a server context are lost on a new connection,
43192 and after smtp helo/ehlo/mail/starttls/rset commands
43193 .endlist
43194 Using an ACL expansion with the logwrite modifier can be
43195 a useful way of writing to the main log.
43196
43197 The expansion of the event_action option should normally
43198 return an empty string.  Should it return anything else the
43199 following will be forced:
43200 .itable all 0 0 2 20* left 80* left
43201 .row auth:fail        "log information to write"
43202 .row tcp:connect      "do not connect"
43203 .row tls:cert         "refuse verification"
43204 .row smtp:connect     "close connection"
43205 .endtable
43206 All other message types ignore the result string, and
43207 no other use is made of it.
43208
43209 For a tcp:connect event, if the connection is being made to a proxy
43210 then the &$host_address$& and &$host_port$& variables
43211 will be that of the proxy and not the target system.
43212
43213 For tls:cert events, if GnuTLS is in use this will trigger only per
43214 chain element received on the connection.
43215 For OpenSSL it will trigger for every chain element including those
43216 loaded locally.
43217
43218 For dns:fail events from dnsdb lookups, a &"defer_never"& option does not
43219 affect the reporting of DNS_AGAIN.
43220
43221 . ////////////////////////////////////////////////////////////////////////////
43222 . ////////////////////////////////////////////////////////////////////////////
43223
43224 .chapter "Adding new drivers or lookup types" "CHID13" &&&
43225          "Adding drivers or lookups"
43226 .cindex "adding drivers"
43227 .cindex "new drivers, adding"
43228 .cindex "drivers" "adding new"
43229 The following actions have to be taken in order to add a new router, transport,
43230 authenticator, or lookup type to Exim:
43231
43232 .olist
43233 Choose a name for the driver or lookup type that does not conflict with any
43234 existing name; I will use &"newdriver"& in what follows.
43235 .next
43236 Add to &_src/EDITME_& the line:
43237 .display
43238 <&'type'&>&`_NEWDRIVER=yes`&
43239 .endd
43240 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
43241 code is not to be included in the binary by default, comment this line out. You
43242 should also add any relevant comments about the driver or lookup type.
43243 .next
43244 Add to &_src/config.h.defaults_& the line:
43245 .code
43246 #define <type>_NEWDRIVER
43247 .endd
43248 .next
43249 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
43250 and create a table entry as is done for all the other drivers and lookup types.
43251 .next
43252 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
43253 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
43254 Add your &`NEWDRIVER`& to that list.
43255 As long as the dynamic module would be named &_newdriver.so_&, you can use the
43256 simple form that most lookups have.
43257 .next
43258 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
43259 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
43260 driver or lookup type and add it to the definition of OBJ.
43261 .next
43262 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
43263 definition of OBJ_MACRO.  Add a set of line to do the compile also.
43264 .next
43265 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43266 &_src_&.
43267 .next
43268 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43269 as for other drivers and lookups.
43270 .endlist
43271
43272 Then all you need to do is write the code! A good way to start is to make a
43273 proforma by copying an existing module of the same type, globally changing all
43274 occurrences of the name, and cutting out most of the code. Note that any
43275 options you create must be listed in alphabetical order, because the tables are
43276 searched using a binary chop procedure.
43277
43278 There is a &_README_& file in each of the sub-directories of &_src_& describing
43279 the interface that is expected.
43280
43281
43282
43283
43284 . ////////////////////////////////////////////////////////////////////////////
43285 . ////////////////////////////////////////////////////////////////////////////
43286
43287 . /////////////////////////////////////////////////////////////////////////////
43288 . These lines are processing instructions for the Simple DocBook Processor that
43289 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43290 . PDFs than using xmlto and fop. They will be ignored by all other XML
43291 . processors.
43292 . /////////////////////////////////////////////////////////////////////////////
43293
43294 .literal xml
43295 <?sdop
43296   format="newpage"
43297   foot_right_recto="&chaptertitle;"
43298   foot_right_verso="&chaptertitle;"
43299 ?>
43300 .literal off
43301
43302 .makeindex "Options index"   "option"
43303 .makeindex "Variables index" "variable"
43304 .makeindex "Concept index"   "concept"
43305
43306
43307 . /////////////////////////////////////////////////////////////////////////////
43308 . /////////////////////////////////////////////////////////////////////////////